aboutsummaryrefslogtreecommitdiffstats
path: root/calendar/gui/e-timezone-entry.c
blob: 28660fd3b9fe85f557aaf5081468d7a54df3bed7 (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
/*
 * 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:
 *      Damon Chaplin <damon@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

/*
 * ETimezoneEntry - a field for setting a timezone. It shows the timezone in
 * a GtkEntry with a '...' button beside it which shows a dialog for changing
 * the timezone. The dialog contains a map of the world with a point for each
 * timezone, and an option menu as an alternative way of selecting the
 * timezone.
 */

#include <config.h>
#include <widgets/e-timezone-dialog/e-timezone-dialog.h>
#include <glib/gi18n.h>
#include "e-timezone-entry.h"

struct _ETimezoneEntryPrivate {
    /* The current timezone, set in e_timezone_entry_set_timezone()
       or from the timezone dialog. Note that we don't copy it or
       use a ref count - we assume it is never destroyed for the
       lifetime of this widget. */
    icaltimezone *zone;

    /* This can be set to the default timezone. If the current timezone
       setting in the ETimezoneEntry matches this, then the entry field
       is hidden. This makes the user interface simpler. */
    icaltimezone *default_zone;

    GtkWidget *entry;
    GtkWidget *button;
};


enum {
  CHANGED,
  LAST_SIGNAL
};

static void e_timezone_entry_destroy    (GtkObject  *object);

static gboolean e_timezone_entry_mnemonic_activate (GtkWidget *widget,
                                                    gboolean   group_cycling);
static gboolean e_timezone_entry_focus (GtkWidget *widget,
                    GtkDirectionType direction);
static void on_entry_changed        (GtkEntry   *entry,
                     ETimezoneEntry *tentry);
static void on_button_clicked       (GtkWidget  *widget,
                     ETimezoneEntry *tentry);
static void add_relation        (ETimezoneEntry *tentry,
                     GtkWidget *widget);

static void e_timezone_entry_set_entry  (ETimezoneEntry *tentry);


static guint timezone_entry_signals[LAST_SIGNAL] = { 0 };

G_DEFINE_TYPE (ETimezoneEntry, e_timezone_entry, GTK_TYPE_HBOX)

static void
e_timezone_entry_class_init     (ETimezoneEntryClass    *class)
{
    GtkObjectClass *object_class = (GtkObjectClass *) class;
    GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);

    object_class = (GtkObjectClass*) class;

    widget_class->mnemonic_activate = e_timezone_entry_mnemonic_activate;
    widget_class->focus = e_timezone_entry_focus;
    timezone_entry_signals[CHANGED] =
        g_signal_new ("changed",
                  G_TYPE_FROM_CLASS (object_class),
                  G_SIGNAL_RUN_LAST,
                  G_STRUCT_OFFSET (ETimezoneEntryClass, changed),
                  NULL, NULL,
                  g_cclosure_marshal_VOID__VOID,
                  G_TYPE_NONE, 0);

    object_class->destroy       = e_timezone_entry_destroy;

    class->changed = NULL;
}


static void
e_timezone_entry_init       (ETimezoneEntry *tentry)
{
    ETimezoneEntryPrivate *priv;
    AtkObject *a11y;

    tentry->priv = priv = g_new0 (ETimezoneEntryPrivate, 1);

    priv->zone = NULL;
    priv->default_zone = NULL;

    priv->entry  = gtk_entry_new ();
    gtk_editable_set_editable (GTK_EDITABLE (priv->entry), FALSE);
    /*gtk_widget_set_usize (priv->date_entry, 90, 0);*/
    gtk_box_pack_start (GTK_BOX (tentry), priv->entry, TRUE, TRUE, 0);
    gtk_widget_show (priv->entry);
    g_signal_connect (priv->entry, "changed", G_CALLBACK (on_entry_changed), tentry);

    priv->button = gtk_button_new_with_label (_("Select..."));
    g_signal_connect (priv->button, "clicked", G_CALLBACK (on_button_clicked), tentry);
    gtk_box_pack_start (GTK_BOX (tentry), priv->button, FALSE, FALSE, 6);
    gtk_widget_show (priv->button);
    a11y = gtk_widget_get_accessible (priv->button);
    if (a11y != NULL) {
        atk_object_set_name (a11y, _("Select Timezone"));
    }
}


/**
 * e_timezone_entry_new:
 *
 * Description: Creates a new #ETimezoneEntry widget which can be used
 * to provide an easy to use way for entering dates and times.
 *
 * Returns: a new #ETimezoneEntry widget.
 */
GtkWidget *
e_timezone_entry_new            (void)
{
    ETimezoneEntry *tentry;

    tentry = g_object_new (e_timezone_entry_get_type (), NULL);

    GTK_WIDGET_SET_FLAGS (GTK_WIDGET(tentry), GTK_CAN_FOCUS);

    return GTK_WIDGET (tentry);
}


static void
e_timezone_entry_destroy        (GtkObject  *object)
{
    ETimezoneEntry *tentry;

    g_return_if_fail (E_IS_TIMEZONE_ENTRY (object));

    tentry = E_TIMEZONE_ENTRY (object);

    g_free (tentry->priv);
    tentry->priv = NULL;

    if (GTK_OBJECT_CLASS (e_timezone_entry_parent_class)->destroy)
        (* GTK_OBJECT_CLASS (e_timezone_entry_parent_class)->destroy) (object);
}


/* The arrow button beside the date field has been clicked, so we show the
   popup with the ECalendar in. */
static void
on_button_clicked       (GtkWidget  *widget,
                 ETimezoneEntry *tentry)
{
    ETimezoneEntryPrivate *priv;
    ETimezoneDialog *timezone_dialog;
    GtkWidget *dialog;

    priv = tentry->priv;

    timezone_dialog = e_timezone_dialog_new ();

    e_timezone_dialog_set_timezone (timezone_dialog, priv->zone);

    dialog = e_timezone_dialog_get_toplevel (timezone_dialog);

    if (gtk_dialog_run (GTK_DIALOG (dialog)) == GTK_RESPONSE_ACCEPT) {
        priv->zone = e_timezone_dialog_get_timezone (timezone_dialog);
        e_timezone_entry_set_entry (tentry);
    }

    g_object_unref (timezone_dialog);
}


static void
on_entry_changed            (GtkEntry   *entry,
                     ETimezoneEntry *tentry)
{
    g_signal_emit (GTK_OBJECT (tentry), timezone_entry_signals[CHANGED], 0);
}


icaltimezone*
e_timezone_entry_get_timezone       (ETimezoneEntry *tentry)
{
    ETimezoneEntryPrivate *priv;

    g_return_val_if_fail (E_IS_TIMEZONE_ENTRY (tentry), NULL);

    priv = tentry->priv;

    return priv->zone;
}

static void
add_relation                (ETimezoneEntry *tentry,
                     GtkWidget *widget)
{
    AtkObject *a11ytentry, *a11yWidget;
    AtkRelationSet *set;
    AtkRelation *relation;
    GPtrArray *target;
    gpointer target_object;

    /* add a labelled_by relation for widget for accessibility */

    a11ytentry = gtk_widget_get_accessible (GTK_WIDGET (tentry));
    a11yWidget = gtk_widget_get_accessible (widget);

    set = atk_object_ref_relation_set (a11yWidget);
    if (set != NULL) {
        relation = atk_relation_set_get_relation_by_type (set,
                    ATK_RELATION_LABELLED_BY);
        /* check whether has a labelled_by relation already */
        if (relation != NULL)
            return;
    }

    set = atk_object_ref_relation_set (a11ytentry);
    if (!set)
        return;

    relation = atk_relation_set_get_relation_by_type (set,
                    ATK_RELATION_LABELLED_BY);
    if (relation != NULL) {
        target = atk_relation_get_target (relation);
        target_object = g_ptr_array_index (target, 0);
        if (ATK_IS_OBJECT (target_object)) {
            atk_object_add_relationship (a11yWidget,
                    ATK_RELATION_LABELLED_BY,
                    ATK_OBJECT (target_object));
        }
    }
}

void
e_timezone_entry_set_timezone       (ETimezoneEntry *tentry,
                     icaltimezone   *zone)
{
    ETimezoneEntryPrivate *priv;

    g_return_if_fail (E_IS_TIMEZONE_ENTRY (tentry));

    priv = tentry->priv;

    priv->zone = zone;

    e_timezone_entry_set_entry (tentry);

    add_relation (tentry, priv->entry);
}


/* Sets the default timezone. If the current timezone matches this, then the
   entry field is hidden. This is useful since most people do not use timezones
   so it makes the user interface simpler. */
void
e_timezone_entry_set_default_timezone   (ETimezoneEntry *tentry,
                     icaltimezone   *zone)
{
    ETimezoneEntryPrivate *priv;

    g_return_if_fail (E_IS_TIMEZONE_ENTRY (tentry));

    priv = tentry->priv;

    priv->default_zone = zone;

    e_timezone_entry_set_entry (tentry);
}


static void
e_timezone_entry_set_entry (ETimezoneEntry *tentry)
{
    ETimezoneEntryPrivate *priv;
    const gchar *display_name;
    gchar *name_buffer;

    priv = tentry->priv;

    if (priv->zone) {
        display_name = icaltimezone_get_display_name (priv->zone);

        /* We check if it is one of our builtin timezone
           names, in which case we call gettext to translate
           it. If it isn't a builtin timezone name, we
           don't. */
        if (icaltimezone_get_builtin_timezone (display_name))
            display_name = _(display_name);
    } else
        display_name = "";

    name_buffer = g_strdup (display_name);

    gtk_entry_set_text (GTK_ENTRY (priv->entry), name_buffer);

    /* do we need to hide the timezone entry at all? i know this overrules the previous case of hiding the timezone
     * entry field when we select the default timezone
         */
    gtk_widget_show (priv->entry);

    g_free (name_buffer);
}


static gboolean
e_timezone_entry_mnemonic_activate (GtkWidget *widget,
                                    gboolean   group_cycling)
{
        GtkButton *button = NULL;

        if (GTK_WIDGET_CAN_FOCUS (widget)) {
                button = GTK_BUTTON (((ETimezoneEntryPrivate *) ((ETimezoneEntry *) widget)->priv)->button);
                if (button != NULL)
                        gtk_widget_grab_focus (GTK_WIDGET (button));
        }

        return TRUE;
}

static gboolean
e_timezone_entry_focus (GtkWidget *widget, GtkDirectionType direction)
{
    ETimezoneEntry *tentry;

    tentry = E_TIMEZONE_ENTRY (widget);

    if (direction == GTK_DIR_TAB_FORWARD) {
        if (GTK_WIDGET_HAS_FOCUS (tentry->priv->entry))
            gtk_widget_grab_focus (tentry->priv->button);
        else if (GTK_WIDGET_HAS_FOCUS (tentry->priv->button))
            return FALSE;
        else if (GTK_WIDGET_VISIBLE (tentry->priv->entry))
            gtk_widget_grab_focus (tentry->priv->entry);
        else
            gtk_widget_grab_focus (tentry->priv->button);
    } else if (direction == GTK_DIR_TAB_BACKWARD) {
        if (GTK_WIDGET_HAS_FOCUS (tentry->priv->entry))
            return FALSE;
        else if (GTK_WIDGET_HAS_FOCUS (tentry->priv->button)) {
            if (GTK_WIDGET_VISIBLE (tentry->priv->entry))
                gtk_widget_grab_focus (tentry->priv->entry);
            else
                return FALSE;
        } else
            gtk_widget_grab_focus (tentry->priv->button);
    } else
        return FALSE;
    return TRUE;
}