2 * This file is a part of hildon
4 * Copyright (C) 2005, 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
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-get-password-dialog
27 * @short_description: A widget used to get a password
28 * @see_also: #HildonSetPasswordDialog
30 * HildonGetPasswordDialog prompts the user for a password. It allows
31 * inputting password, with an optional configurable label eg. for
32 * showing a custom message. The maximum length of the password can be set.
35 * <title>HildonGetPassword example</title>
37 * get_dialog = HILDON_GET_PASSWORD_DIALOG (hildon_get_password_dialog_new (parent, FALSE));
39 * gtk_widget_show (GTK_WIDGET (get_dialog));
41 * i = gtk_dialog_run (GTK_DIALOG (get_dialog));
43 * pass = hildon_get_password_dialog_get_password (get_dialog);
45 * if (i == GTK_RESPONSE_OK && (strcmp (pass, dialog.current_password) != 0))
47 * gtk_infoprint (GTK_WINDOW (parent), STR_PASSWORD_INCORRECT);
48 * gtk_widget_set_sensitive (GTK_WIDGET (dialog.button2), FALSE);
49 * gtk_widget_set_sensitive (GTK_WIDGET (dialog.button3), FALSE);
50 * gtk_widget_set_sensitive (GTK_WIDGET (dialog.button4), FALSE);
53 * else if (i == GTK_RESPONSE_OK)
55 * gtk_widget_set_sensitive( GTK_WIDGET( dialog.button2 ), TRUE);
60 * gtk_widget_set_sensitive (GTK_WIDGET (dialog.button2), FALSE);
61 * gtk_widget_set_sensitive (GTK_WIDGET (dialog.button3), FALSE);
62 * gtk_widget_set_sensitive (GTK_WIDGET (dialog.button4), FALSE);
64 * gtk_widget_destroy (GTK_WIDGET (get_dialog));
74 #include "hildon-get-password-dialog.h"
82 #include "hildon-input-mode-hint.h"
83 #include "hildon-caption.h"
84 #include "hildon-banner.h"
86 #include "hildon-get-password-dialog-private.h"
88 #define _(String) dgettext("hildon-libs", String)
90 #define HILDON_GET_PASSWORD_DIALOG_TITLE "ecdg_ti_get_old_password"
92 #define HILDON_GET_PASSWORD_DIALOG_PASSWORD "ecdg_fi_get_old_pwd_enter_pwd"
94 #define HILDON_GET_PASSWORD_DIALOG_OK "ecdg_bd_get_old_password_dialog_ok"
96 #define HILDON_GET_PASSWORD_DIALOG_CANCEL "ecdg_bd_get_old_password_dialog_cancel"
98 #define HILDON_GET_PASSWORD_VERIFY_DIALOG_TITLE "ecdg_ti_verify_password"
100 #define HILDON_GET_PASSWORD_VERIFY_DIALOG_PASSWORD "ecdg_fi_verify_pwd_enter_pwd"
102 #define HILDON_GET_PASSWORD_VERIFY_DIALOG_OK "ecdg_bd_verify_password_dialog_ok"
104 #define HILDON_GET_PASSWORD_VERIFY_DIALOG_CANCEL "ecdg_bd_verify_password_dialog_cancel"
106 #define HILDON_GET_PASSWORD_DIALOG_MAX_CHARS "ckdg_ib_maximum_characters_reached"
108 static GtkDialogClass* parent_class;
111 hildon_get_password_dialog_class_init (HildonGetPasswordDialogClass *class);
114 hildon_get_password_dialog_init (HildonGetPasswordDialog *widget);
117 hildon_get_password_set_property (GObject *object,
123 hildon_get_password_get_property (GObject *object,
129 create_contents (HildonGetPasswordDialog *dialog);
132 invalid_input (GtkWidget *widget,
133 GtkInvalidInputType reason,
147 /* Private functions */
149 hildon_get_password_set_property (GObject *object,
154 HildonGetPasswordDialog *dialog = HILDON_GET_PASSWORD_DIALOG (object);
155 HildonGetPasswordDialogPrivate *priv;
157 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (object);
163 /* Set label text representing password domain */
164 gtk_label_set_text (priv->message_label, g_value_get_string (value));
168 gtk_entry_set_text(GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))),
169 g_value_get_string(value));
172 case PROP_NUMBERS_ONLY:
173 /* Set input mode for the password entry */
174 g_object_set(G_OBJECT (gtk_bin_get_child GTK_BIN ((priv->password_entry))),
176 (g_value_get_boolean (value)
177 ? HILDON_INPUT_MODE_HINT_NUMERIC
178 : HILDON_INPUT_MODE_HINT_ALPHANUMERICSPECIAL),
182 case PROP_CAPTION_LABEL:
183 hildon_get_password_dialog_set_caption (dialog, g_value_get_string (value));
187 hildon_get_password_dialog_set_max_characters (dialog, g_value_get_int (value));
191 priv->get_old = g_value_get_boolean (value);
192 create_contents (dialog);
196 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
202 hildon_get_password_get_property (GObject *object,
207 HildonGetPasswordDialog *dialog = HILDON_GET_PASSWORD_DIALOG (object);
208 HildonGetPasswordDialogPrivate *priv;
213 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
219 string = gtk_label_get_text (priv->message_label);
220 g_value_set_string (value, string);
224 string = gtk_entry_get_text (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))));
225 g_value_set_string (value, string);
228 case PROP_NUMBERS_ONLY:
229 /* This property is set if and only if the input mode
230 of the password entry has been set to numeric only */
231 g_object_get (G_OBJECT (gtk_bin_get_child (GTK_BIN (priv->password_entry))),
232 "input-mode", &input_mode, NULL);
233 g_value_set_boolean (value,
234 (input_mode == HILDON_INPUT_MODE_HINT_NUMERIC));
237 case PROP_CAPTION_LABEL:
238 string = hildon_caption_get_label (priv->password_entry);
239 g_value_set_string (value, string);
243 max_length = gtk_entry_get_max_length
244 (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))));
245 g_value_set_int (value, max_length);
249 g_value_set_boolean (value, priv->get_old);
253 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
259 hildon_get_password_dialog_class_init (HildonGetPasswordDialogClass *class)
261 GObjectClass *object_class = G_OBJECT_CLASS (class);
263 parent_class = g_type_class_peek_parent (class);
265 /* Override virtual functions */
266 object_class->set_property = hildon_get_password_set_property;
267 object_class->get_property = hildon_get_password_get_property;
269 /* Install new properties */
272 * HildonGetPasswordDialog:message:
274 * Optional message displayed to the user.
276 g_object_class_install_property
279 g_param_spec_string ("message",
281 "Set optional message",
286 * HildonGetPasswordDialog:password:
288 * Password field contents.
290 g_object_class_install_property
293 g_param_spec_string ("password",
300 * HildonGetPasswordDialog:numbers-only:
302 * If the password entry field is operating in numbers-only mode.
304 g_object_class_install_property
307 g_param_spec_boolean ("numbers-only",
309 "Set entry to accept only numeric values",
314 * HildonGetPasswordDialog:caption-label:
318 g_object_class_install_property
321 g_param_spec_string ("caption-label",
323 "The text to be set as the caption label",
328 * HildonGetPasswordDialog:max-characters:
330 * Maximum characters than can be entered.
332 g_object_class_install_property
335 g_param_spec_int ("max-characters",
336 "Maximum Characters",
337 "The maximum number of characters the password"
345 * HildonGetPasswordDialog:get-old:
347 * If the dialog is used to retrieve an old password or set a new one.
349 g_object_class_install_property
352 g_param_spec_boolean ("get-old",
354 "TRUE if dialog is a get old password dialog, "
355 "FALSE if dialog is a get password dialog",
357 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
359 /* Install private structure */
360 g_type_class_add_private (class, sizeof (HildonGetPasswordDialogPrivate));
364 hildon_get_password_dialog_init (HildonGetPasswordDialog *dialog)
366 /* Set initial properties for the dialog; the actual contents are
367 created once the 'get-old' property is set with g_object_new */
369 gtk_dialog_set_has_separator (GTK_DIALOG (dialog), FALSE);
370 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
371 gtk_dialog_set_default_response (GTK_DIALOG (dialog), GTK_RESPONSE_OK);
375 create_contents (HildonGetPasswordDialog *dialog)
377 HildonGetPasswordDialogPrivate *priv;
378 GtkSizeGroup * group;
381 /* Cache private pointer for faster member access */
382 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
385 /* Sizegroup for captions */
386 group = GTK_SIZE_GROUP (gtk_size_group_new
387 (GTK_SIZE_GROUP_HORIZONTAL));
390 gtk_window_set_title (GTK_WINDOW (dialog),
392 ? _(HILDON_GET_PASSWORD_DIALOG_TITLE)
393 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_TITLE));
395 /* Optional password domain label */
396 priv->message_label = GTK_LABEL (gtk_label_new (NULL));
399 gtk_dialog_add_button (GTK_DIALOG (dialog),
401 ? _(HILDON_GET_PASSWORD_DIALOG_OK)
402 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_OK)),
405 gtk_dialog_add_button (GTK_DIALOG (dialog),
407 ? _(HILDON_GET_PASSWORD_DIALOG_CANCEL)
408 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_CANCEL)),
409 GTK_RESPONSE_CANCEL);
411 /* Create password text entry */
412 control = gtk_entry_new ();
413 gtk_entry_set_width_chars (GTK_ENTRY (control), 20);
415 g_object_set (control, "hildon-input-mode", HILDON_GTK_INPUT_MODE_FULL, NULL);
417 gtk_entry_set_visibility (GTK_ENTRY(control), FALSE);
418 priv->password_entry = HILDON_CAPTION
419 (hildon_caption_new(group,
421 ? _(HILDON_GET_PASSWORD_DIALOG_PASSWORD)
422 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_PASSWORD)),
424 HILDON_CAPTION_OPTIONAL));
425 hildon_caption_set_separator (HILDON_CAPTION (priv->password_entry), "");
427 /* Do the basic layout */
428 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
429 GTK_WIDGET (priv->message_label), FALSE, FALSE, 0);
430 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
431 GTK_WIDGET (priv->password_entry), FALSE, FALSE, 0);
432 gtk_widget_show_all (GTK_DIALOG (dialog)->vbox);
434 /* Ensure group is freed when all its contents have been removed */
435 g_object_unref (group);
439 * hildon_get_password_dialog_get_type:
441 * Returns GType for HildonGetPasswordDialog as produced by
442 * g_type_register_static().
444 * Returns: HildonGetPasswordDialog type
447 hildon_get_password_dialog_get_type (void)
449 static GType dialog_type = 0;
452 static const GTypeInfo dialog_info = {
453 sizeof (HildonGetPasswordDialogClass),
454 NULL, /* base_init */
455 NULL, /* base_finalize */
456 (GClassInitFunc) hildon_get_password_dialog_class_init,
457 NULL, /* class_finalize */
458 NULL, /* class_data */
459 sizeof (HildonGetPasswordDialog),
461 (GInstanceInitFunc) hildon_get_password_dialog_init
464 dialog_type = g_type_register_static (GTK_TYPE_DIALOG,
465 "HildonGetPasswordDialog",
472 * hildon_get_password_dialog_new:
473 * @parent: parent window; can be NULL
474 * @get_old: FALSE creates a new get password dialog and
475 * TRUE creates a new get old password dialog. That is,
476 * if the password to be obtained is the old password,
477 * this parameter is specified TRUE.
479 * Construct a new HildonGetPasswordDialog.
481 * Returns: a new #GtkWidget of type HildonGetPasswordDialog
484 hildon_get_password_dialog_new (GtkWindow *parent,
487 HildonGetPasswordDialog *dialog = g_object_new
488 (HILDON_TYPE_GET_PASSWORD_DIALOG,
489 "get-old", get_old, NULL);
491 if (parent != NULL) {
492 gtk_window_set_transient_for (GTK_WINDOW (dialog), parent);
495 return (GtkWidget *) dialog;
499 * hildon_get_password_dialog_new_with_default:
500 * @parent: parent window; can be NULL
501 * @password: a default password to be shown in password field
502 * @get_old: FALSE creates a new get password dialog and
503 * TRUE creates a new get old password dialog.That is,
504 * if the password to be obtained is the old password,
505 * this parameter is specified TRUE.
508 * Same as #hildon_get_password_dialog_new but with a default password
511 * Returns: a new #GtkWidget of type HildonGetPasswordDialog
514 hildon_get_password_dialog_new_with_default (GtkWindow *parent,
515 const gchar *password,
520 dialog = hildon_get_password_dialog_new (parent, get_old);
522 if (password != NULL)
523 g_object_set (G_OBJECT (dialog), "password", password, NULL);
525 return GTK_WIDGET (dialog);
529 * hildon_get_password_dialog_get_password:
530 * @dialog: pointer to HildonSetPasswordDialog
532 * Gets the currently entered password. The string should not be freed.
534 * Returns: current password entered by the user.
537 hildon_get_password_dialog_get_password (HildonGetPasswordDialog *dialog)
542 HildonGetPasswordDialogPrivate *priv;
544 g_return_val_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog), NULL);
545 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
548 /* Retrieve the password entry widget */
549 entry1 = GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry)));
550 text1 = GTK_ENTRY (entry1)->text;
556 * hildon_get_password_dialog_set_message
557 * @dialog: the dialog
558 * @message: a custom message or some other descriptive text to be set
560 * Sets the optional descriptive text displayed at the top of the dialog.
563 hildon_get_password_dialog_set_message (HildonGetPasswordDialog *dialog,
564 const gchar *message)
566 HildonGetPasswordDialogPrivate *priv;
568 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
570 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
573 gtk_label_set_text (priv->message_label, message);
578 * hildon_get_password_dialog_set_caption:
579 * @dialog: the dialog
580 * @new_caption: the text to be set as the caption label
582 * Sets the password entry field's neigbouring label.
585 hildon_get_password_dialog_set_caption (HildonGetPasswordDialog *dialog,
586 const gchar *new_caption)
588 HildonGetPasswordDialogPrivate *priv;
590 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
591 g_return_if_fail (new_caption != NULL);
593 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
596 hildon_caption_set_label (priv->password_entry, new_caption);
600 * hildon_get_password_dialog_set_max_characters:
601 * @dialog: the dialog
602 * @max_characters: the maximum number of characters the password dialog
605 * sets the maximum number of characters allowed as the password
608 hildon_get_password_dialog_set_max_characters (HildonGetPasswordDialog *dialog,
611 HildonGetPasswordDialogPrivate *priv;
613 g_return_if_fail (max_characters > 0);
614 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
616 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
619 /* Apply the given length to password entry */
620 gtk_entry_set_max_length (GTK_ENTRY
622 GTK_BIN ((priv->password_entry))),
625 /* FIXME There is a bug here -- the prev. signal needs to be
626 * disconnected before connecting the new signal. Besides, this
627 * should go into the constructor */
629 /* Connect callback to show error banner if the limit is exceeded */
630 g_signal_connect (GTK_ENTRY
632 GTK_BIN ((priv->password_entry))),
634 G_CALLBACK (invalid_input),
639 /* Callback that gets called when maximum chars is reached in the entry */
641 invalid_input (GtkWidget *widget,
642 GtkInvalidInputType reason,
645 if (reason == GTK_INVALID_INPUT_MAX_CHARS_REACHED)
647 hildon_banner_show_information (widget, NULL, _(HILDON_GET_PASSWORD_DIALOG_MAX_CHARS));