aboutsummaryrefslogtreecommitdiffstats
path: root/calendar/gui/calendar-config.h
blob: 6f0a9ee0fd62a849f28324c582a112c56a500986 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */

/*
 * Authors :
 *  Damon Chaplin <damon@ximian.com>
 *  Rodrigo Moya <rodrigo@ximian.com>
 *
 * Copyright 2000, Ximian, Inc.
 * Copyright 2000, Ximian, Inc.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */

/*
 * calendar-config.h - functions to load/save/get/set user settings.
 */

#ifndef _CALENDAR_CONFIG_H_
#define _CALENDAR_CONFIG_H_

#include <widgets/misc/e-calendar.h>
#include <widgets/misc/e-dateedit.h>
#include <widgets/misc/e-cell-date-edit.h>
#include "e-calendar-table.h"


/* These are used to get/set the working days in the week. The bit-flags are
   combined together. The bits must be from 0 (Sun) to 6 (Sat) to match the
   day values used by localtime etc. */
typedef enum
{
    CAL_SUNDAY  = 1 << 0,
    CAL_MONDAY  = 1 << 1,
    CAL_TUESDAY = 1 << 2,
    CAL_WEDNESDAY   = 1 << 3,
    CAL_THURSDAY    = 1 << 4,
    CAL_FRIDAY  = 1 << 5,
    CAL_SATURDAY    = 1 << 6
} CalWeekdays;


/* Units for settings. */
typedef enum
{
    CAL_DAYS,
    CAL_HOURS,
    CAL_MINUTES
} CalUnits;


void      calendar_config_init          (void);
void      calendar_config_write         (void);
void      calendar_config_write_on_exit     (void);


/*
 * Calendar Settings.
 */

/* The current timezone, e.g. "Europe/London". */
gchar*    calendar_config_get_timezone      (void);
void      calendar_config_set_timezone      (gchar       *timezone);

/* The working days of the week, a bit-wise combination of flags. */
CalWeekdays calendar_config_get_working_days    (void);
void      calendar_config_set_working_days  (CalWeekdays  days);

/* The start day of the week (0 = Sun to 6 = Sat). */
gint      calendar_config_get_week_start_day    (void);
void      calendar_config_set_week_start_day    (gint         week_start_day);

/* The start and end times of the work-day. */
gint      calendar_config_get_day_start_hour    (void);
void      calendar_config_set_day_start_hour    (gint         day_start_hour);

gint      calendar_config_get_day_start_minute  (void);
void      calendar_config_set_day_start_minute  (gint         day_start_min);

gint      calendar_config_get_day_end_hour  (void);
void      calendar_config_set_day_end_hour  (gint         day_end_hour);

gint      calendar_config_get_day_end_minute    (void);
void      calendar_config_set_day_end_minute    (gint         day_end_min);

/* Whether we use 24-hour format or 12-hour format (AM/PM). */
gboolean  calendar_config_get_24_hour_format    (void);
void      calendar_config_set_24_hour_format    (gboolean     use_24_hour);

/* The time divisions in the Day/Work-Week view in minutes (5/10/15/30/60). */
gint      calendar_config_get_time_divisions    (void);
void      calendar_config_set_time_divisions    (gint         divisions);

/* Whether we show event end times. */
gboolean  calendar_config_get_show_event_end    (void);
void      calendar_config_set_show_event_end    (gboolean     show_end);

/* Whether we compress the weekend in the week/month views. */
gboolean  calendar_config_get_compress_weekend  (void);
void      calendar_config_set_compress_weekend  (gboolean     compress);

/* Whether we show week numbers in the Date Navigator. */
gboolean  calendar_config_get_dnav_show_week_no (void);
void      calendar_config_set_dnav_show_week_no (gboolean     show_week_no);

/* The view to show on start-up, 0 = Day, 1 = WorkWeek, 2 = Week, 3 = Month. */
gint      calendar_config_get_default_view  (void);
void      calendar_config_set_default_view  (gint         view);

/* The positions of the panes in the normal and month views. */
gfloat    calendar_config_get_hpane_pos     (void);
void      calendar_config_set_hpane_pos     (gfloat       hpane_pos);

gfloat    calendar_config_get_vpane_pos     (void);
void      calendar_config_set_vpane_pos     (gfloat       vpane_pos);

gfloat    calendar_config_get_month_hpane_pos   (void);
void      calendar_config_set_month_hpane_pos   (gfloat       hpane_pos);

gfloat    calendar_config_get_month_vpane_pos   (void);
void      calendar_config_set_month_vpane_pos   (gfloat       vpane_pos);

/* Colors for the task list */
const char *calendar_config_get_tasks_due_today_color   (void);
void        calendar_config_set_tasks_due_today_color   (const char *color);

const char *calendar_config_get_tasks_overdue_color (void);
void        calendar_config_set_tasks_overdue_color (const char *color);

/* Settings to hide completed tasks. */
gboolean  calendar_config_get_hide_completed_tasks  (void);
void      calendar_config_set_hide_completed_tasks  (gboolean   hide);

CalUnits  calendar_config_get_hide_completed_tasks_units(void);
void      calendar_config_set_hide_completed_tasks_units(CalUnits   units);

gint      calendar_config_get_hide_completed_tasks_value(void);
void      calendar_config_set_hide_completed_tasks_value(gint       value);

char*     calendar_config_get_hide_completed_tasks_sexp (void);

/* Confirmation options */
gboolean  calendar_config_get_confirm_delete (void);
void      calendar_config_set_confirm_delete (gboolean confirm);

gboolean  calendar_config_get_confirm_expunge (void);
void      calendar_config_set_confirm_expunge (gboolean confirm);

/* Default reminder options */
gboolean calendar_config_get_use_default_reminder (void);
void     calendar_config_set_use_default_reminder (gboolean value);

int      calendar_config_get_default_reminder_interval (void);
void     calendar_config_set_default_reminder_interval (int interval);

CalUnits calendar_config_get_default_reminder_units (void);
void     calendar_config_set_default_reminder_units (CalUnits units);


/* Convenience functions to configure common properties of ECalendar,
   EDateEdit & ECalendarTable widgets, and the ECellDateEdit ETable cell. */
void      calendar_config_configure_e_calendar      (ECalendar  *cal);
void      calendar_config_configure_e_date_edit     (EDateEdit  *dedit);
void      calendar_config_configure_e_calendar_table    (ECalendarTable *cal_table);
void      calendar_config_configure_e_cell_date_edit    (ECellDateEdit  *ecde);

/* Shows the timezone dialog if the user hasn't set a default timezone. */
void      calendar_config_check_timezone_set    (void);

/* Returns TRUE if the locale has 'am' and 'pm' strings defined, i.e. it
   supports 12-hour time format. */
gboolean  calendar_config_locale_supports_12_hour_format(void);

/* Default folders, read-only */
char *calendar_config_default_calendar_folder (void);
char *calendar_config_default_tasks_folder (void);

#endif /* _CALENDAR_CONFIG_H_ */