2 * This file is a part of hildon
4 * Copyright (C) 2006 Nokia Corporation, all rights reserved.
6 * Contact: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public License
10 * as published by the Free Software Foundation; version 2.1 of
11 * the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
26 * SECTION:hildon-code-dialog
27 * @short_description: A keypad-like widget used to enter pincodes.
29 * #HildonCodeDialog displays a keypad that can be used to enter
30 * numerical pin codes or lock codes. It emits a 'input' signal each time
31 * an input action is performed on the dialog.
35 /* FIXME We need property access in this widget */
41 #include "hildon-code-dialog.h"
42 #include "hildon-defines.h"
43 #include "hildon-banner.h"
45 #include <gdk/gdkkeysyms.h>
46 #include <gtk/gtkbutton.h>
47 #include <gtk/gtkentry.h>
48 #include <gtk/gtkicontheme.h>
49 #include <gtk/gtktable.h>
50 #include <gtk/gtkvbox.h>
51 #include <gtk/gtkbbox.h>
52 #include <gtk/gtklabel.h>
53 #include <gtk/gtkalignment.h>
55 #include "hildon-code-dialog-private.h"
57 #define HEIGHT (48-HILDON_MARGIN_DEFAULT)
59 #define WIDTH (100-HILDON_MARGIN_DEFAULT)
61 #define BACKSPACE_ICON "qgn_calculator_backspace"
64 dgettext("hildon-libs", String)
67 dgettext("hildon-common-strings", String)
69 #define DEVICELOCK_OK _("secu_enter_lock_code_dialog_ok")
71 #define DEVICELOCK_CANCEL _("secu_enter_lock_code_dialog_cancel")
73 #define DEVICELOCK_TITLE _("secu_application_title")
75 #define DEVICELOCK_MAX_CHAR_REACHED c_("ckdg_ib_maximum_characters_reached")
77 #define MAX_PINCODE_LEN (10)
80 hildon_code_dialog_class_init (HildonCodeDialogClass *cd_class);
83 hildon_code_dialog_init (HildonCodeDialog *self);
86 hildon_code_dialog_realize (GtkWidget *widget);
89 hildon_code_dialog_unrealize (GtkWidget *widget);
92 hildon_code_dialog_finalize (GObject *object);
95 hildon_code_dialog_button_clicked (GtkButton *buttonm,
99 hildon_code_dialog_backspace (HildonCodeDialog *dialog);
102 hildon_code_dialog_im_commit (GtkIMContext *im_context,
107 hildon_code_dialog_insert_text (GtkEditable *editable,
109 gint new_text_length,
114 hildon_code_dialog_key_press_event (GtkWidget *widget,
119 hildon_code_dialog_real_input (HildonCodeDialog *dialog);
122 hildon_code_dialog_input (HildonCodeDialog *dialog);
124 static GtkDialogClass* parent_class = NULL;
126 static guint input_signal;
129 * hildon_code_dialog_get_type:
131 * Initializes and returns the type of a hildon code dialog.
133 * @Returns: GType of #HildonCodeDialog
136 hildon_code_dialog_get_type (void)
138 static GType type = 0;
142 static const GTypeInfo info =
144 sizeof (HildonCodeDialogClass),
145 NULL, /* base_init */
146 NULL, /* base_finalize */
147 (GClassInitFunc) hildon_code_dialog_class_init,
148 NULL, /* class_finalize */
149 NULL, /* class_data */
150 sizeof (HildonCodeDialog),
152 (GInstanceInitFunc) hildon_code_dialog_init
154 type = g_type_register_static (GTK_TYPE_DIALOG,
155 "HildonCodeDialog", &info, 0);
161 hildon_code_dialog_class_init (HildonCodeDialogClass *cd_class)
163 GObjectClass *gobject_class = G_OBJECT_CLASS (cd_class);
164 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (cd_class);
166 parent_class = GTK_DIALOG_CLASS (g_type_class_peek_parent (cd_class));
167 g_type_class_add_private (cd_class, sizeof (HildonCodeDialogPrivate));
169 gobject_class->finalize = hildon_code_dialog_finalize;
171 widget_class->realize = hildon_code_dialog_realize;
172 widget_class->unrealize = hildon_code_dialog_unrealize;
174 cd_class->input = hildon_code_dialog_real_input;
176 /* FIXME Document this signal! */
177 input_signal = g_signal_new("input",
178 HILDON_TYPE_CODE_DIALOG,
180 G_STRUCT_OFFSET (HildonCodeDialogClass, input),
182 g_cclosure_marshal_VOID__VOID,
188 hildon_code_dialog_init (HildonCodeDialog *dialog)
190 HildonCodeDialogPrivate *priv;
192 GtkWidget *dialog_vbox1 = NULL;
193 GtkWidget *table = NULL;
194 GtkWidget *alignment = NULL;
195 GtkWidget *vbox1 = NULL;
196 GtkWidget *image1 = NULL;
197 GtkWidget *dialog_action_area1 = NULL;
200 GtkWidget *cancelButton;
202 priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
205 const gchar* numstrs[10] = {
206 "0","1","2","3","4","5","6","7","8","9"
209 GdkPixbuf* pixbuf = NULL;
210 GtkIconTheme* icon_theme = NULL;
211 GtkIconInfo *icon_info = NULL;
214 /* Set default title */
215 gtk_window_set_title (GTK_WINDOW (dialog), DEVICELOCK_TITLE);
217 gtk_window_set_type_hint (GTK_WINDOW (dialog), GDK_WINDOW_TYPE_HINT_DIALOG);
218 gtk_dialog_set_has_separator ((GtkDialog *) dialog, FALSE);
220 hints.min_width = -1;
221 hints.min_height = -1;
222 hints.max_width = -1;
223 hints.max_height = -1;
225 gtk_window_set_geometry_hints (GTK_WINDOW (dialog), GTK_WIDGET (dialog), &hints,
226 GDK_HINT_MIN_SIZE | GDK_HINT_MAX_SIZE);
228 table = gtk_table_new (4, 3, FALSE);
229 gtk_table_set_row_spacings (GTK_TABLE (table), HILDON_MARGIN_DEFAULT );
230 gtk_table_set_col_spacings (GTK_TABLE (table), HILDON_MARGIN_DEFAULT );
232 dialog_vbox1 = GTK_DIALOG (dialog)->vbox;
233 vbox1 = gtk_vbox_new (FALSE, 0);
234 gtk_box_set_spacing (GTK_BOX (vbox1), HILDON_MARGIN_DOUBLE);
236 priv->help_text = gtk_label_new ("");
237 alignment = gtk_alignment_new (0.5,0,1,1);
238 gtk_container_add (GTK_CONTAINER (alignment), priv->help_text);
240 priv->entry = gtk_entry_new ();
242 GTK_WIDGET_UNSET_FLAGS (GTK_WIDGET (priv->entry), GTK_CAN_FOCUS);
243 gtk_entry_set_invisible_char (GTK_ENTRY (priv->entry), g_utf8_get_char ("*"));
244 gtk_entry_set_alignment (GTK_ENTRY (priv->entry), 1.0);
246 gtk_editable_set_editable (GTK_EDITABLE (priv->entry),FALSE);
247 gtk_entry_set_visibility (GTK_ENTRY (priv->entry), FALSE);
249 gtk_box_pack_start (GTK_BOX (vbox1), alignment, TRUE,FALSE,0);
250 gtk_box_pack_start (GTK_BOX (vbox1), priv->entry, TRUE,FALSE,0);
251 gtk_box_pack_start (GTK_BOX (vbox1), table, FALSE,TRUE,0);
253 gtk_box_pack_start (GTK_BOX (dialog_vbox1), vbox1, FALSE,TRUE,0);
255 for(i = 1;i <= 3; i++) {
256 priv->buttons[0][i-1] = gtk_button_new_with_mnemonic (numstrs[i]);
257 gtk_widget_set_size_request (priv->buttons[0][i-1], WIDTH, HEIGHT);
258 gtk_table_attach_defaults (GTK_TABLE (table), priv->buttons[0][i-1],
262 for(i = 4;i <= 6;i++) {
263 priv->buttons[1][i-4] = gtk_button_new_with_mnemonic (numstrs[i]);
264 gtk_widget_set_size_request (priv->buttons[1][i-4], WIDTH, HEIGHT);
265 gtk_table_attach_defaults (GTK_TABLE (table), priv->buttons[1][i-4],
270 priv->buttons[2][i-7] = gtk_button_new_with_mnemonic (numstrs[i]);
271 gtk_widget_set_size_request (priv->buttons[2][i-7], WIDTH, HEIGHT);
272 gtk_table_attach_defaults (GTK_TABLE (table), priv->buttons[2][i-7],
276 priv->buttons[3][0] = priv->buttons[3][1] =
277 gtk_button_new_with_mnemonic (numstrs[0]);
278 gtk_widget_set_size_request (priv->buttons[3][0], WIDTH, HEIGHT);
279 gtk_table_attach (GTK_TABLE (table), priv->buttons[3][0],
280 0,2,3,4, (GtkAttachOptions) (GTK_FILL),
281 (GtkAttachOptions) (0), 0, 0);
283 priv->buttons[3][2] = gtk_button_new ();
284 gtk_widget_set_size_request (priv->buttons[3][2], WIDTH, HEIGHT);
285 gtk_table_attach_defaults (GTK_TABLE (table), priv->buttons[3][2],
288 icon_theme = gtk_icon_theme_get_default ();
290 icon_info = gtk_icon_theme_lookup_icon (icon_theme, BACKSPACE_ICON, 1,
291 GTK_ICON_LOOKUP_NO_SVG);
292 base_size = gtk_icon_info_get_base_size (icon_info);
293 gtk_icon_info_free (icon_info);
295 pixbuf = gtk_icon_theme_load_icon (icon_theme,
296 BACKSPACE_ICON, base_size,
297 GTK_ICON_LOOKUP_NO_SVG,
300 image1 = gtk_image_new_from_pixbuf (pixbuf);
301 g_object_unref (G_OBJECT(pixbuf));
302 gtk_container_add (GTK_CONTAINER (priv->buttons[3][2]), image1);
303 dialog_action_area1 = GTK_DIALOG (dialog)->action_area;
304 gtk_button_box_set_layout (GTK_BUTTON_BOX (dialog_action_area1),
305 GTK_BUTTONBOX_CENTER);
307 okButton = gtk_dialog_add_button (GTK_DIALOG (dialog) ,DEVICELOCK_OK,
310 gtk_dialog_add_button (GTK_DIALOG (dialog), DEVICELOCK_CANCEL,
311 GTK_RESPONSE_CANCEL);
313 gtk_widget_set_sensitive (okButton, FALSE);
315 priv->buttons[4][0] = priv->buttons[4][1] = okButton;
316 priv->buttons[4][2] = cancelButton;
318 priv->im_context = gtk_im_multicontext_new();
320 g_object_set (G_OBJECT (priv->im_context), "hildon-input-mode",
321 HILDON_GTK_INPUT_MODE_NUMERIC, NULL);
327 g_signal_connect (G_OBJECT (priv->im_context), "commit",
328 G_CALLBACK (hildon_code_dialog_im_commit), dialog);
330 g_signal_connect (G_OBJECT (priv->entry), "insert_text",
331 G_CALLBACK (hildon_code_dialog_insert_text), dialog);
333 gtk_entry_set_max_length (GTK_ENTRY (priv->entry), MAX_PINCODE_LEN);
335 for (x = 0; x < 3; x++)
337 for (y = 0; y < 3; y++)
339 g_signal_connect (G_OBJECT (priv->buttons[x][y]), "clicked",
340 G_CALLBACK (hildon_code_dialog_button_clicked), dialog);
341 g_signal_connect (G_OBJECT (priv->buttons[x][y]), "key-press-event",
342 G_CALLBACK (hildon_code_dialog_key_press_event), dialog);
346 g_signal_connect (G_OBJECT (priv->buttons[3][0]), "clicked",
347 G_CALLBACK (hildon_code_dialog_button_clicked), dialog);
348 g_signal_connect (G_OBJECT (priv->buttons[3][0]), "key-press-event",
349 G_CALLBACK (hildon_code_dialog_key_press_event), dialog);
351 g_signal_connect (G_OBJECT (priv->buttons[3][2]), "clicked",
352 G_CALLBACK (hildon_code_dialog_button_clicked), dialog);
353 g_signal_connect (G_OBJECT (priv->buttons[3][2]), "key-press-event",
354 G_CALLBACK (hildon_code_dialog_key_press_event), dialog);
356 g_signal_connect (G_OBJECT (okButton), "key-press-event",
357 G_CALLBACK(hildon_code_dialog_key_press_event), dialog);
359 g_signal_connect (G_OBJECT (cancelButton), "key-press-event",
360 G_CALLBACK (hildon_code_dialog_key_press_event), dialog);
362 gtk_widget_show_all (GTK_WIDGET (GTK_DIALOG (dialog)->vbox));
366 hildon_code_dialog_realize (GtkWidget *widget)
368 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (widget);
369 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
371 if (GTK_WIDGET_CLASS (parent_class)->realize)
372 (* GTK_WIDGET_CLASS (parent_class)->realize) (widget);
374 gtk_im_context_set_client_window (GTK_IM_CONTEXT (priv->im_context),
375 GTK_WIDGET (dialog)->window);
376 gtk_im_context_focus_in (priv->im_context);
380 hildon_code_dialog_unrealize (GtkWidget *widget)
382 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (widget);
383 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
385 gtk_im_context_set_client_window (GTK_IM_CONTEXT (priv->im_context), NULL);
387 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
388 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
392 hildon_code_dialog_finalize (GObject *object)
394 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (object);
395 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
397 g_object_unref (priv->im_context);
399 G_OBJECT_CLASS(parent_class)->finalize(object);
403 hildon_code_dialog_backspace (HildonCodeDialog *dialog)
405 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
410 text = g_strdup (gtk_entry_get_text (GTK_ENTRY (priv->entry)));
419 pos = g_utf8_find_prev_char (text, pos);
426 gtk_entry_set_text (GTK_ENTRY (priv->entry), text);
430 gtk_widget_set_sensitive (priv->buttons[4][0], FALSE);
437 hildon_code_dialog_button_clicked (GtkButton *button,
440 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (user_data);
441 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
444 const char *number = gtk_button_get_label (button);
446 if (number && *number )
448 gtk_entry_append_text (GTK_ENTRY (priv->entry), number);
452 hildon_code_dialog_backspace (dialog);
457 hildon_code_dialog_im_commit (GtkIMContext *im_context,
461 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (user_data);
462 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
467 digit = g_ascii_strtod(utf8, NULL);
469 if (g_ascii_isdigit(*utf8))
471 gtk_entry_append_text (GTK_ENTRY (priv->entry), utf8);
476 hildon_code_dialog_insert_text (GtkEditable *editable,
478 gint new_text_length,
482 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (user_data);
483 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
484 gchar *text = g_strdup(gtk_entry_get_text (GTK_ENTRY (priv->entry)));
485 glong length = g_utf8_strlen (text, -1);
489 if (length == MAX_PINCODE_LEN)
491 hildon_banner_show_information (GTK_WIDGET (dialog),
493 DEVICELOCK_MAX_CHAR_REACHED);
498 /* make the Ok button sensitive */
499 gtk_widget_set_sensitive (priv->buttons[4][0], TRUE);
502 hildon_code_dialog_input (dialog);
506 hildon_code_dialog_key_press_event (GtkWidget *widget,
510 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (user_data);
511 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
512 GtkWidget *new_widget = widget;
517 if (gtk_im_context_filter_keypress (priv->im_context, event))
520 if (event->keyval == GDK_BackSpace)
522 hildon_code_dialog_backspace (dialog);
526 for (x = 0; x < 5; x++)
528 for (y = 0; y < 3; y++)
530 if (priv->buttons[x][y] == widget)
538 while (new_widget == widget)
540 switch (event->keyval)
562 new_widget = priv->buttons[x][y];
565 gtk_widget_grab_focus (new_widget);
571 * hildon_code_dialog_new:
573 * Use this function to create a new HildonCodeDialog.
575 * Return value: A @HildonCodeDialog.
578 hildon_code_dialog_new (void)
580 HildonCodeDialog *dialog = g_object_new (HILDON_TYPE_CODE_DIALOG, NULL);
582 return GTK_WIDGET (dialog);
586 * hildon_code_dialog_get_code:
587 * @dialog: The #HildonCodeDialog from which to get the entered code
589 * Use this function to access the code entered by the user.
591 * Return value: The entered code.
594 hildon_code_dialog_get_code (HildonCodeDialog *dialog)
596 g_return_val_if_fail (HILDON_IS_CODE_DIALOG (dialog), NULL);
598 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
601 return gtk_entry_get_text (GTK_ENTRY (priv->entry));
605 * hildon_code_dialog_clear_clode:
606 * @dialog: The #HildonCodeDialog whose entry should be cleared:
608 * Use this function to clear the user entered code.
611 hildon_code_dialog_clear_code (HildonCodeDialog *dialog)
613 g_return_if_fail (HILDON_IS_CODE_DIALOG (dialog));
615 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
618 gtk_entry_set_text (GTK_ENTRY (priv->entry), "");
619 gtk_widget_set_sensitive (priv->buttons[4][0], FALSE);
623 * hildon_code_dialog_set_help_text:
624 * @dialog: The #HildonCodeDialog whose entry should be cleared:
625 * @text: The text to use in the help label.
627 * Use this function to set the text that will be displayd in the
631 hildon_code_dialog_set_help_text (HildonCodeDialog *dialog,
634 g_return_if_fail (HILDON_IS_CODE_DIALOG (dialog));
636 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
639 gtk_label_set_text (GTK_LABEL (priv->help_text), text);
643 hildon_code_dialog_real_input (HildonCodeDialog *dialog)
648 hildon_code_dialog_input (HildonCodeDialog *dialog)
650 /* Emit the signal */
651 g_signal_emit (dialog, input_signal, 0);
655 * hildon_code_dialog_set_input_sensitive
656 * @dialog: The #HildonCodeDialog whose state is to be changed
657 * @sensitive: The new state
659 * This function will block or enable the input on the code dialog by
660 * making the input button sensitive (or not).
663 hildon_code_dialog_set_input_sensitive (HildonCodeDialog *dialog,
669 g_return_if_fail (HILDON_IS_CODE_DIALOG (dialog));
671 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
674 for (i = 0; i < 5; i++)
675 for (k = 0; k < 3; k++)
676 if (i != 4 && (k != 0 || k != 2))
677 gtk_widget_set_sensitive (priv->buttons [i][k], sensitive);
679 gtk_widget_set_sensitive (priv->help_text, sensitive);
680 gtk_widget_set_sensitive (priv->entry, sensitive);