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>
54 #include <gtk/gtkversion.h>
56 #include "hildon-code-dialog-private.h"
58 #define HEIGHT (48-HILDON_MARGIN_DEFAULT)
60 #define WIDTH (100-HILDON_MARGIN_DEFAULT)
62 #define BACKSPACE_ICON "qgn_calculator_backspace"
65 dgettext("hildon-libs", String)
68 dgettext("hildon-common-strings", String)
70 #define DEVICELOCK_OK _("secu_enter_lock_code_dialog_ok")
72 #define DEVICELOCK_CANCEL _("secu_enter_lock_code_dialog_cancel")
74 #define DEVICELOCK_TITLE _("secu_application_title")
76 #define DEVICELOCK_MAX_CHAR_REACHED c_("ckdg_ib_maximum_characters_reached")
78 #define MAX_PINCODE_LEN (10)
81 hildon_code_dialog_class_init (HildonCodeDialogClass *cd_class);
84 hildon_code_dialog_init (HildonCodeDialog *self);
87 hildon_code_dialog_realize (GtkWidget *widget);
90 hildon_code_dialog_unrealize (GtkWidget *widget);
93 hildon_code_dialog_finalize (GObject *object);
96 hildon_code_dialog_button_clicked (GtkButton *buttonm,
100 hildon_code_dialog_backspace (HildonCodeDialog *dialog);
103 hildon_code_dialog_im_commit (GtkIMContext *im_context,
108 hildon_code_dialog_insert_text (GtkEditable *editable,
110 gint new_text_length,
115 hildon_code_dialog_key_press_event (GtkWidget *widget,
120 hildon_code_dialog_real_input (HildonCodeDialog *dialog);
123 hildon_code_dialog_input (HildonCodeDialog *dialog);
125 static GtkDialogClass* parent_class = NULL;
127 static guint input_signal;
130 * hildon_code_dialog_get_type:
132 * Initializes and returns the type of a hildon code dialog.
134 * @Returns: GType of #HildonCodeDialog
137 hildon_code_dialog_get_type (void)
139 static GType type = 0;
143 static const GTypeInfo info =
145 sizeof (HildonCodeDialogClass),
146 NULL, /* base_init */
147 NULL, /* base_finalize */
148 (GClassInitFunc) hildon_code_dialog_class_init,
149 NULL, /* class_finalize */
150 NULL, /* class_data */
151 sizeof (HildonCodeDialog),
153 (GInstanceInitFunc) hildon_code_dialog_init
155 type = g_type_register_static (GTK_TYPE_DIALOG,
156 "HildonCodeDialog", &info, 0);
162 hildon_code_dialog_class_init (HildonCodeDialogClass *cd_class)
164 GObjectClass *gobject_class = G_OBJECT_CLASS (cd_class);
165 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (cd_class);
167 parent_class = GTK_DIALOG_CLASS (g_type_class_peek_parent (cd_class));
168 g_type_class_add_private (cd_class, sizeof (HildonCodeDialogPrivate));
170 gobject_class->finalize = hildon_code_dialog_finalize;
172 widget_class->realize = hildon_code_dialog_realize;
173 widget_class->unrealize = hildon_code_dialog_unrealize;
175 cd_class->input = hildon_code_dialog_real_input;
177 /* FIXME Document this signal! */
178 input_signal = g_signal_new("input",
179 HILDON_TYPE_CODE_DIALOG,
181 G_STRUCT_OFFSET (HildonCodeDialogClass, input),
183 g_cclosure_marshal_VOID__VOID,
189 hildon_code_dialog_init (HildonCodeDialog *dialog)
191 HildonCodeDialogPrivate *priv;
193 GtkWidget *dialog_vbox1 = NULL;
194 GtkWidget *table = NULL;
195 GtkWidget *alignment = NULL;
196 GtkWidget *vbox1 = NULL;
197 GtkWidget *image1 = NULL;
198 GtkWidget *dialog_action_area1 = NULL;
201 GtkWidget *cancelButton;
203 priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
206 const gchar* numstrs[10] = {
207 "0","1","2","3","4","5","6","7","8","9"
210 GdkPixbuf* pixbuf = NULL;
211 GtkIconTheme* icon_theme = NULL;
212 GtkIconInfo *icon_info = NULL;
215 /* Set default title */
216 gtk_window_set_title (GTK_WINDOW (dialog), DEVICELOCK_TITLE);
218 gtk_window_set_type_hint (GTK_WINDOW (dialog), GDK_WINDOW_TYPE_HINT_DIALOG);
219 gtk_dialog_set_has_separator ((GtkDialog *) dialog, FALSE);
221 hints.min_width = -1;
222 hints.min_height = -1;
223 hints.max_width = -1;
224 hints.max_height = -1;
226 gtk_window_set_geometry_hints (GTK_WINDOW (dialog), GTK_WIDGET (dialog), &hints,
227 GDK_HINT_MIN_SIZE | GDK_HINT_MAX_SIZE);
229 table = gtk_table_new (4, 3, FALSE);
230 gtk_table_set_row_spacings (GTK_TABLE (table), HILDON_MARGIN_DEFAULT );
231 gtk_table_set_col_spacings (GTK_TABLE (table), HILDON_MARGIN_DEFAULT );
233 dialog_vbox1 = GTK_DIALOG (dialog)->vbox;
234 vbox1 = gtk_vbox_new (FALSE, 0);
235 gtk_box_set_spacing (GTK_BOX (vbox1), HILDON_MARGIN_DOUBLE);
237 priv->help_text = gtk_label_new ("");
238 alignment = gtk_alignment_new (0.5,0,1,1);
239 gtk_container_add (GTK_CONTAINER (alignment), priv->help_text);
241 priv->entry = gtk_entry_new ();
243 GTK_WIDGET_UNSET_FLAGS (GTK_WIDGET (priv->entry), GTK_CAN_FOCUS);
244 gtk_entry_set_invisible_char (GTK_ENTRY (priv->entry), g_utf8_get_char ("*"));
245 gtk_entry_set_alignment (GTK_ENTRY (priv->entry), 1.0);
247 gtk_editable_set_editable (GTK_EDITABLE (priv->entry),FALSE);
248 gtk_entry_set_visibility (GTK_ENTRY (priv->entry), FALSE);
250 gtk_box_pack_start (GTK_BOX (vbox1), alignment, TRUE,FALSE,0);
251 gtk_box_pack_start (GTK_BOX (vbox1), priv->entry, TRUE,FALSE,0);
252 gtk_box_pack_start (GTK_BOX (vbox1), table, FALSE,TRUE,0);
254 gtk_box_pack_start (GTK_BOX (dialog_vbox1), vbox1, FALSE,TRUE,0);
256 for(i = 1;i <= 3; i++) {
257 priv->buttons[0][i-1] = gtk_button_new_with_mnemonic (numstrs[i]);
258 gtk_widget_set_size_request (priv->buttons[0][i-1], WIDTH, HEIGHT);
259 gtk_table_attach_defaults (GTK_TABLE (table), priv->buttons[0][i-1],
263 for(i = 4;i <= 6;i++) {
264 priv->buttons[1][i-4] = gtk_button_new_with_mnemonic (numstrs[i]);
265 gtk_widget_set_size_request (priv->buttons[1][i-4], WIDTH, HEIGHT);
266 gtk_table_attach_defaults (GTK_TABLE (table), priv->buttons[1][i-4],
271 priv->buttons[2][i-7] = gtk_button_new_with_mnemonic (numstrs[i]);
272 gtk_widget_set_size_request (priv->buttons[2][i-7], WIDTH, HEIGHT);
273 gtk_table_attach_defaults (GTK_TABLE (table), priv->buttons[2][i-7],
277 priv->buttons[3][0] = priv->buttons[3][1] =
278 gtk_button_new_with_mnemonic (numstrs[0]);
279 gtk_widget_set_size_request (priv->buttons[3][0], WIDTH, HEIGHT);
280 gtk_table_attach (GTK_TABLE (table), priv->buttons[3][0],
281 0,2,3,4, (GtkAttachOptions) (GTK_FILL),
282 (GtkAttachOptions) (0), 0, 0);
284 priv->buttons[3][2] = gtk_button_new ();
285 gtk_widget_set_size_request (priv->buttons[3][2], WIDTH, HEIGHT);
286 gtk_table_attach_defaults (GTK_TABLE (table), priv->buttons[3][2],
289 icon_theme = gtk_icon_theme_get_default ();
291 icon_info = gtk_icon_theme_lookup_icon (icon_theme, BACKSPACE_ICON, 1,
292 GTK_ICON_LOOKUP_NO_SVG);
293 base_size = gtk_icon_info_get_base_size (icon_info);
294 gtk_icon_info_free (icon_info);
296 pixbuf = gtk_icon_theme_load_icon (icon_theme,
297 BACKSPACE_ICON, base_size,
298 GTK_ICON_LOOKUP_NO_SVG,
301 image1 = gtk_image_new_from_pixbuf (pixbuf);
302 g_object_unref (G_OBJECT(pixbuf));
303 gtk_container_add (GTK_CONTAINER (priv->buttons[3][2]), image1);
304 dialog_action_area1 = GTK_DIALOG (dialog)->action_area;
305 gtk_button_box_set_layout (GTK_BUTTON_BOX (dialog_action_area1),
306 #if GTK_CHECK_VERSION(2,11,0) || defined(MAEMO_GTK)
307 GTK_BUTTONBOX_CENTER);
309 GTK_BUTTONBOX_DEFAULT_STYLE);
312 okButton = gtk_dialog_add_button (GTK_DIALOG (dialog) ,DEVICELOCK_OK,
315 gtk_dialog_add_button (GTK_DIALOG (dialog), DEVICELOCK_CANCEL,
316 GTK_RESPONSE_CANCEL);
318 gtk_widget_set_sensitive (okButton, FALSE);
320 priv->buttons[4][0] = priv->buttons[4][1] = okButton;
321 priv->buttons[4][2] = cancelButton;
323 priv->im_context = gtk_im_multicontext_new();
325 g_object_set (G_OBJECT (priv->im_context), "hildon-input-mode",
326 HILDON_GTK_INPUT_MODE_NUMERIC, NULL);
332 g_signal_connect (G_OBJECT (priv->im_context), "commit",
333 G_CALLBACK (hildon_code_dialog_im_commit), dialog);
335 g_signal_connect (G_OBJECT (priv->entry), "insert_text",
336 G_CALLBACK (hildon_code_dialog_insert_text), dialog);
338 gtk_entry_set_max_length (GTK_ENTRY (priv->entry), MAX_PINCODE_LEN);
340 for (x = 0; x < 3; x++)
342 for (y = 0; y < 3; y++)
344 g_signal_connect (G_OBJECT (priv->buttons[x][y]), "clicked",
345 G_CALLBACK (hildon_code_dialog_button_clicked), dialog);
346 g_signal_connect (G_OBJECT (priv->buttons[x][y]), "key-press-event",
347 G_CALLBACK (hildon_code_dialog_key_press_event), dialog);
351 g_signal_connect (G_OBJECT (priv->buttons[3][0]), "clicked",
352 G_CALLBACK (hildon_code_dialog_button_clicked), dialog);
353 g_signal_connect (G_OBJECT (priv->buttons[3][0]), "key-press-event",
354 G_CALLBACK (hildon_code_dialog_key_press_event), dialog);
356 g_signal_connect (G_OBJECT (priv->buttons[3][2]), "clicked",
357 G_CALLBACK (hildon_code_dialog_button_clicked), dialog);
358 g_signal_connect (G_OBJECT (priv->buttons[3][2]), "key-press-event",
359 G_CALLBACK (hildon_code_dialog_key_press_event), dialog);
361 g_signal_connect (G_OBJECT (okButton), "key-press-event",
362 G_CALLBACK(hildon_code_dialog_key_press_event), dialog);
364 g_signal_connect (G_OBJECT (cancelButton), "key-press-event",
365 G_CALLBACK (hildon_code_dialog_key_press_event), dialog);
367 gtk_widget_show_all (GTK_WIDGET (GTK_DIALOG (dialog)->vbox));
371 hildon_code_dialog_realize (GtkWidget *widget)
373 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (widget);
374 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
376 if (GTK_WIDGET_CLASS (parent_class)->realize)
377 (* GTK_WIDGET_CLASS (parent_class)->realize) (widget);
379 gtk_im_context_set_client_window (GTK_IM_CONTEXT (priv->im_context),
380 GTK_WIDGET (dialog)->window);
381 gtk_im_context_focus_in (priv->im_context);
385 hildon_code_dialog_unrealize (GtkWidget *widget)
387 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (widget);
388 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
390 gtk_im_context_set_client_window (GTK_IM_CONTEXT (priv->im_context), NULL);
392 if (GTK_WIDGET_CLASS (parent_class)->unrealize)
393 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
397 hildon_code_dialog_finalize (GObject *object)
399 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (object);
400 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
402 g_object_unref (priv->im_context);
404 G_OBJECT_CLASS(parent_class)->finalize(object);
408 hildon_code_dialog_backspace (HildonCodeDialog *dialog)
410 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
415 text = g_strdup (gtk_entry_get_text (GTK_ENTRY (priv->entry)));
424 pos = g_utf8_find_prev_char (text, pos);
431 gtk_entry_set_text (GTK_ENTRY (priv->entry), text);
435 gtk_widget_set_sensitive (priv->buttons[4][0], FALSE);
442 hildon_code_dialog_button_clicked (GtkButton *button,
445 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (user_data);
446 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
449 const char *number = gtk_button_get_label (button);
451 if (number && *number )
453 gtk_editable_set_editable (GTK_EDITABLE (priv->entry), TRUE);
455 g_signal_emit_by_name (GTK_ENTRY (priv->entry)->im_context, "commit",
458 gtk_editable_set_editable (GTK_EDITABLE (priv->entry), FALSE);
460 gtk_editable_set_position (GTK_EDITABLE (priv->entry), -1);
464 hildon_code_dialog_backspace (dialog);
469 hildon_code_dialog_im_commit (GtkIMContext *im_context,
473 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (user_data);
474 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
479 digit = g_ascii_strtod(utf8, NULL);
481 if (g_ascii_isdigit(*utf8))
483 gtk_editable_set_editable (GTK_EDITABLE (priv->entry), TRUE);
485 g_signal_emit_by_name (GTK_ENTRY (priv->entry)->im_context, "commit",
488 gtk_editable_set_editable (GTK_EDITABLE (priv->entry), FALSE);
490 gtk_editable_set_position (GTK_EDITABLE (priv->entry), -1);
495 hildon_code_dialog_insert_text (GtkEditable *editable,
497 gint new_text_length,
501 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (user_data);
502 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
503 gchar *text = g_strdup(gtk_entry_get_text (GTK_ENTRY (priv->entry)));
504 glong length = g_utf8_strlen (text, -1);
508 if (length == MAX_PINCODE_LEN)
510 hildon_banner_show_information (GTK_WIDGET (dialog),
512 DEVICELOCK_MAX_CHAR_REACHED);
517 /* make the Ok button sensitive */
518 gtk_widget_set_sensitive (priv->buttons[4][0], TRUE);
521 hildon_code_dialog_input (dialog);
525 hildon_code_dialog_key_press_event (GtkWidget *widget,
529 HildonCodeDialog *dialog = HILDON_CODE_DIALOG (user_data);
530 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
531 GtkWidget *new_widget = widget;
536 if (gtk_im_context_filter_keypress (priv->im_context, event))
539 if (event->keyval == GDK_BackSpace)
541 hildon_code_dialog_backspace (dialog);
545 for (x = 0; x < 5; x++)
547 for (y = 0; y < 3; y++)
549 if (priv->buttons[x][y] == widget)
557 while (new_widget == widget)
559 switch (event->keyval)
581 new_widget = priv->buttons[x][y];
584 gtk_widget_grab_focus (new_widget);
590 * hildon_code_dialog_new:
592 * Use this function to create a new HildonCodeDialog.
594 * Return value: A @HildonCodeDialog.
597 hildon_code_dialog_new (void)
599 HildonCodeDialog *dialog = g_object_new (HILDON_TYPE_CODE_DIALOG, NULL);
601 return GTK_WIDGET (dialog);
605 * hildon_code_dialog_get_code:
606 * @dialog: The #HildonCodeDialog from which to get the entered code
608 * Use this function to access the code entered by the user.
610 * Return value: The entered code.
613 hildon_code_dialog_get_code (HildonCodeDialog *dialog)
615 g_return_val_if_fail (HILDON_IS_CODE_DIALOG (dialog), NULL);
617 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
620 return gtk_entry_get_text (GTK_ENTRY (priv->entry));
624 * hildon_code_dialog_clear_clode:
625 * @dialog: The #HildonCodeDialog whose entry should be cleared:
627 * Use this function to clear the user entered code.
630 hildon_code_dialog_clear_code (HildonCodeDialog *dialog)
632 g_return_if_fail (HILDON_IS_CODE_DIALOG (dialog));
634 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
637 gtk_entry_set_text (GTK_ENTRY (priv->entry), "");
638 gtk_widget_set_sensitive (priv->buttons[4][0], FALSE);
642 * hildon_code_dialog_set_help_text:
643 * @dialog: The #HildonCodeDialog whose entry should be cleared:
644 * @text: The text to use in the help label.
646 * Use this function to set the text that will be displayd in the
650 hildon_code_dialog_set_help_text (HildonCodeDialog *dialog,
653 g_return_if_fail (HILDON_IS_CODE_DIALOG (dialog));
655 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
658 gtk_label_set_text (GTK_LABEL (priv->help_text), text);
662 hildon_code_dialog_real_input (HildonCodeDialog *dialog)
667 hildon_code_dialog_input (HildonCodeDialog *dialog)
669 /* Emit the signal */
670 g_signal_emit (dialog, input_signal, 0);
674 * hildon_code_dialog_set_input_sensitive
675 * @dialog: The #HildonCodeDialog whose state is to be changed
676 * @sensitive: The new state
678 * This function will block or enable the input on the code dialog by
679 * making the input button sensitive (or not).
682 hildon_code_dialog_set_input_sensitive (HildonCodeDialog *dialog,
688 g_return_if_fail (HILDON_IS_CODE_DIALOG (dialog));
690 HildonCodeDialogPrivate *priv = HILDON_CODE_DIALOG_GET_PRIVATE (dialog);
693 for (i = 0; i < 5; i++)
694 for (k = 0; k < 3; k++)
695 if (i != 4 && (k != 0 || k != 2))
696 gtk_widget_set_sensitive (priv->buttons [i][k], sensitive);
698 gtk_widget_set_sensitive (priv->help_text, sensitive);
699 gtk_widget_set_sensitive (priv->entry, sensitive);