aboutsummaryrefslogtreecommitdiffstats
path: root/calendar/gui/dialogs/comp-editor-page.c
blob: e24bca5c1e7db52f4ff431b28cf6059c19c17c79 (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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
/*
 *
 * Evolution calendar - Base class for calendar component editor pages
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Authors:
 *      Federico Mena-Quintero <federico@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <glib/gi18n.h>
#include "comp-editor.h"
#include "comp-editor-page.h"

#define COMP_EDITOR_PAGE_GET_PRIVATE(obj) \
    (G_TYPE_INSTANCE_GET_PRIVATE \
    ((obj), TYPE_COMP_EDITOR_PAGE, CompEditorPagePrivate))

struct _CompEditorPagePrivate {
    CompEditor *editor;  /* not referenced */
    gboolean updating;
};

enum {
    PROP_0,
    PROP_EDITOR,
    PROP_UPDATING
};

enum {
    DATES_CHANGED,
    LAST_SIGNAL
};

static gpointer parent_class;
static guint comp_editor_page_signals[LAST_SIGNAL];

G_DEFINE_TYPE (CompEditorPage, comp_editor_page, G_TYPE_OBJECT)

static void
comp_editor_page_set_property (GObject *object,
                               guint property_id,
                               const GValue *value,
                               GParamSpec *pspec)
{
    CompEditorPagePrivate *priv;

    priv = COMP_EDITOR_PAGE_GET_PRIVATE (object);

    switch (property_id) {
        case PROP_EDITOR:
            priv->editor = g_value_get_object (value);
            return;

        case PROP_UPDATING:
            comp_editor_page_set_updating (
                COMP_EDITOR_PAGE (object),
                g_value_get_boolean (value));
            return;
    }

    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}

static void
comp_editor_page_get_property (GObject *object,
                               guint property_id,
                               GValue *value,
                               GParamSpec *pspec)
{
    switch (property_id) {
        case PROP_EDITOR:
            g_value_set_object (
                value, comp_editor_page_get_editor (
                COMP_EDITOR_PAGE (object)));
            return;

        case PROP_UPDATING:
            g_value_set_boolean (
                value, comp_editor_page_get_updating (
                COMP_EDITOR_PAGE (object)));
    }

    G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
}

static void
comp_editor_page_dispose (GObject *object)
{
    CompEditorPage *page;

    g_return_if_fail (object != NULL);
    g_return_if_fail (IS_COMP_EDITOR_PAGE (object));

    page = COMP_EDITOR_PAGE (object);

    if (page->accel_group) {
        g_object_unref (page->accel_group);
        page->accel_group = NULL;
    }

    /* Chain up to parent's dispose() method. */
    G_OBJECT_CLASS (parent_class)->dispose (object);
}

static void
comp_editor_page_class_init (CompEditorPageClass *class)
{
    GObjectClass *object_class;

    parent_class = g_type_class_peek_parent (class);
    g_type_class_add_private (class, sizeof (CompEditorPagePrivate));

    object_class = G_OBJECT_CLASS (class);
    object_class->set_property = comp_editor_page_set_property;
    object_class->get_property = comp_editor_page_get_property;
    object_class->dispose = comp_editor_page_dispose;

    g_object_class_install_property (
        object_class,
        PROP_EDITOR,
        g_param_spec_object (
            "editor",
            NULL,
            NULL,
            TYPE_COMP_EDITOR,
            G_PARAM_READWRITE |
            G_PARAM_CONSTRUCT_ONLY));

    g_object_class_install_property (
        object_class,
        PROP_UPDATING,
        g_param_spec_boolean (
            "updating",
            NULL,
            NULL,
            FALSE,
            G_PARAM_READWRITE));

    comp_editor_page_signals[DATES_CHANGED] =
        g_signal_new ("dates_changed",
                  G_TYPE_FROM_CLASS (class),
                  G_SIGNAL_RUN_FIRST,
                  G_STRUCT_OFFSET (CompEditorPageClass, dates_changed),
                  NULL, NULL,
                  g_cclosure_marshal_VOID__POINTER,
                  G_TYPE_NONE, 1, G_TYPE_POINTER);
}

static void
comp_editor_page_init (CompEditorPage *page)
{
    page->priv = COMP_EDITOR_PAGE_GET_PRIVATE (page);
}

/**
 * comp_editor_page_get_editor:
 * @page: a #CompEditorPage
 *
 * Returns the #CompEditor to which @page belongs.
 *
 * Returns: the parent #CompEditor
 **/
CompEditor *
comp_editor_page_get_editor (CompEditorPage *page)
{
    g_return_val_if_fail (IS_COMP_EDITOR_PAGE (page), NULL);

    return page->priv->editor;
}

/**
 * comp_editor_page_get_widget:
 * @page: An editor page.
 *
 * Queries the main widget of an editor page.
 *
 * Return value: The widget that is the page's upper container.  It should
 * normally be inserted in a notebook widget.
 **/
GtkWidget *
comp_editor_page_get_widget (CompEditorPage *page)
{
    CompEditorPageClass *class;

    g_return_val_if_fail (IS_COMP_EDITOR_PAGE (page), NULL);

    class = COMP_EDITOR_PAGE_GET_CLASS (page);
    g_return_val_if_fail (class->get_widget != NULL, NULL);

    return class->get_widget (page);
}

gboolean
comp_editor_page_get_updating (CompEditorPage *page)
{
    g_return_val_if_fail (IS_COMP_EDITOR_PAGE (page), FALSE);

    return page->priv->updating;
}

void
comp_editor_page_set_updating (CompEditorPage *page,
                               gboolean updating)
{
    g_return_if_fail (IS_COMP_EDITOR_PAGE (page));

    if ((page->priv->updating ? 1 : 0) == (updating ? 1 : 0))
        return;

    page->priv->updating = updating;

    g_object_notify (G_OBJECT (page), "updating");
}

void
comp_editor_page_changed (CompEditorPage *page)
{
    CompEditor *editor;

    g_return_if_fail (IS_COMP_EDITOR_PAGE (page));

    /* Block change notifications if the page is updating.  This right
     * here is why we have an 'updating' flag.  It's up to subclasses
     * to set and clear it at appropriate times. */
    if (page->priv->updating)
        return;

    editor = comp_editor_page_get_editor (page);
    comp_editor_set_changed (editor, TRUE);
}

/**
 * comp_editor_page_focus_main_widget:
 * @page: An editor page.
 *
 * Makes an editor page focus its main widget.  This is used by the component
 * editor when it first pops up so that it can focus the main widget in the
 * first page.
 **/
void
comp_editor_page_focus_main_widget (CompEditorPage *page)
{
    CompEditorPageClass *class;

    g_return_if_fail (IS_COMP_EDITOR_PAGE (page));

    class = COMP_EDITOR_PAGE_GET_CLASS (page);
    g_return_if_fail (class->focus_main_widget != NULL);

    class->focus_main_widget (page);
}

/**
 * comp_editor_page_fill_widgets:
 * @page: An editor page.
 * @comp: A calendar component.
 *
 * Fills the widgets of an editor page with the data from a calendar component.
 **/
gboolean
comp_editor_page_fill_widgets (CompEditorPage *page,
                               ECalComponent *comp)
{
    CompEditorPageClass *class;
    gboolean success;

    g_return_val_if_fail (IS_COMP_EDITOR_PAGE (page), FALSE);
    g_return_val_if_fail (E_IS_CAL_COMPONENT (comp), FALSE);

    class = COMP_EDITOR_PAGE_GET_CLASS (page);
    g_return_val_if_fail (class->fill_widgets != NULL, FALSE);

    comp_editor_page_set_updating (page, TRUE);
    success = class->fill_widgets (page, comp);
    comp_editor_page_set_updating (page, FALSE);

    return success;
}

/**
 * comp_editor_page_fill_component:
 * @page: An editor page.
 * @comp: A calendar component.
 *
 * Takes the data from the widgets of an editor page and sets it on a calendar
 * component, replacing the contents of the properties that the editor page
 * knows how to manipulate.
 *
 * Returns: TRUE if the component could be filled, FALSE otherwise
 **/
gboolean
comp_editor_page_fill_component (CompEditorPage *page,
                                 ECalComponent *comp)
{
    CompEditorPageClass *class;

    g_return_val_if_fail (IS_COMP_EDITOR_PAGE (page), FALSE);
    g_return_val_if_fail (comp != NULL, FALSE);

    class = COMP_EDITOR_PAGE_GET_CLASS (page);

    if (class->fill_component != NULL)
        return class->fill_component (page, comp);

    return TRUE;
}

/**
 * comp_editor_page_fill_timezones:
 * @page: An editor page.
 * @timezones: Hash table to which timezones will be added.
 *
 * Fills the given hash table with all the timezones used by the dates in the
 * specific editor page.
 *
 * Returns: TRUE if the timezones were added, FALSE otherwise.
 */
gboolean
comp_editor_page_fill_timezones (CompEditorPage *page,
                                 GHashTable *timezones)
{
    CompEditorPageClass *class;

    g_return_val_if_fail (IS_COMP_EDITOR_PAGE (page), FALSE);
    g_return_val_if_fail (timezones != NULL, FALSE);

    class = COMP_EDITOR_PAGE_GET_CLASS (page);

    if (class->fill_timezones != NULL)
        return class->fill_timezones (page, timezones);

    return TRUE;
}

/**
 * comp_editor_page_set_dates:
 * @page: An editor page
 * @dates: A collection of various dates in time_t format
 *
 * Sets the date values for this group of widgets
 **/
void
comp_editor_page_set_dates (CompEditorPage *page,
                            CompEditorPageDates *dates)
{
    CompEditorPageClass *class;

    g_return_if_fail (IS_COMP_EDITOR_PAGE (page));

    class = COMP_EDITOR_PAGE_GET_CLASS (page);

    if (class->set_dates != NULL)
        class->set_dates (page, dates);
}

/**
 * comp_editor_page_add_attendee:
 * @page: a #CompEditorPage
 * @attendee: an #EMeetingAttendee
 *
 * Adds @attendee to an internal meeting store.
 **/
void
comp_editor_page_add_attendee (CompEditorPage *page,
                               EMeetingAttendee *attendee)
{
    CompEditorPageClass *class;

    g_return_if_fail (IS_COMP_EDITOR_PAGE (page));
    g_return_if_fail (E_IS_MEETING_ATTENDEE (attendee));

    class = COMP_EDITOR_PAGE_GET_CLASS (page);
    g_return_if_fail (class->add_attendee != NULL);

    class->add_attendee (page, attendee);
}

/**
 * comp_editor_page_notify_dates_changed:
 * @page: An editor page.
 *
 * Makes an editor page emit the "dates_changed" signal.  This is meant to be
 * used only by page implementations.
 **/
void
comp_editor_page_notify_dates_changed (CompEditorPage *page,
                                       CompEditorPageDates *dates)
{
    g_return_if_fail (IS_COMP_EDITOR_PAGE (page));

    g_signal_emit (page,
               comp_editor_page_signals[DATES_CHANGED], 0,
               dates);
}

/**
 * comp_editor_page_display_validation_error:
 * @page: An editor page.
 * @msg: Error message to display.
 * @field: Widget that caused the validation error.
 *
 * Displays an error message about a validation problem in the
 * given field. Once the error message has been displayed, the
 * focus is set to the widget that caused the validation error.
 */
void
comp_editor_page_display_validation_error (CompEditorPage *page,
                                           const gchar *msg,
                                           GtkWidget *field)
{
    GtkWidget *dialog;

    g_return_if_fail (IS_COMP_EDITOR_PAGE (page));
    g_return_if_fail (msg != NULL);
    g_return_if_fail (GTK_IS_WIDGET (field));

    dialog = gtk_message_dialog_new (
        NULL, 0,
        GTK_MESSAGE_ERROR,
        GTK_BUTTONS_CLOSE,
        _("Validation error: %s"), msg);
    gtk_dialog_run (GTK_DIALOG (dialog));
    gtk_widget_destroy (dialog);

    gtk_widget_grab_focus (field);
}