2 * This file is a part of hildon
4 * Copyright (C) 2005, 2006 Nokia Corporation, all rights reserved.
6 * Contact: Rodrigo Novo <rodrigo.novo@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-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));
70 #undef HILDON_DISABLE_DEPRECATED
83 #include "hildon-get-password-dialog.h"
84 #include "hildon-caption.h"
85 #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);
133 invalid_input (GtkWidget *widget,
134 GtkInvalidInputType reason,
149 /* Private functions */
151 hildon_get_password_set_property (GObject *object,
156 HildonGetPasswordDialog *dialog = HILDON_GET_PASSWORD_DIALOG (object);
157 HildonGetPasswordDialogPrivate *priv;
159 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (object);
165 /* Set label text representing password domain */
166 gtk_label_set_text (priv->message_label, g_value_get_string (value));
170 gtk_entry_set_text(GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))),
171 g_value_get_string(value));
174 case PROP_NUMBERS_ONLY:
176 /* Set input mode for the password entry */
177 g_object_set(G_OBJECT (gtk_bin_get_child GTK_BIN ((priv->password_entry))),
179 (g_value_get_boolean (value)
180 ? HILDON_GTK_INPUT_MODE_NUMERIC
181 : HILDON_GTK_INPUT_MODE_FULL),
186 case PROP_CAPTION_LABEL:
187 hildon_get_password_dialog_set_caption (dialog, g_value_get_string (value));
191 hildon_get_password_dialog_set_max_characters (dialog, g_value_get_int (value));
195 priv->get_old = g_value_get_boolean (value);
196 create_contents (dialog);
200 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
206 hildon_get_password_get_property (GObject *object,
211 HildonGetPasswordDialog *dialog = HILDON_GET_PASSWORD_DIALOG (object);
212 HildonGetPasswordDialogPrivate *priv;
219 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
225 string = gtk_label_get_text (priv->message_label);
226 g_value_set_string (value, string);
230 string = gtk_entry_get_text (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))));
231 g_value_set_string (value, string);
234 case PROP_NUMBERS_ONLY:
236 /* This property is set if and only if the input mode
237 of the password entry has been set to numeric only */
238 g_object_get (G_OBJECT (gtk_bin_get_child (GTK_BIN (priv->password_entry))),
239 "hildon-input-mode", &input_mode, NULL);
240 g_value_set_boolean (value,
241 (input_mode == HILDON_GTK_INPUT_MODE_NUMERIC));
243 g_value_set_boolean (value, FALSE);
247 case PROP_CAPTION_LABEL:
248 string = hildon_caption_get_label (priv->password_entry);
249 g_value_set_string (value, string);
253 max_length = gtk_entry_get_max_length
254 (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))));
255 g_value_set_int (value, max_length);
259 g_value_set_boolean (value, priv->get_old);
263 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
269 hildon_get_password_dialog_class_init (HildonGetPasswordDialogClass *class)
271 GObjectClass *object_class = G_OBJECT_CLASS (class);
273 parent_class = g_type_class_peek_parent (class);
275 /* Override virtual functions */
276 object_class->set_property = hildon_get_password_set_property;
277 object_class->get_property = hildon_get_password_get_property;
279 /* Install new properties */
282 * HildonGetPasswordDialog:message:
284 * Optional message displayed to the user.
286 g_object_class_install_property
289 g_param_spec_string ("message",
291 "Set optional message",
296 * HildonGetPasswordDialog:password:
298 * Password field contents.
300 g_object_class_install_property
303 g_param_spec_string ("password",
310 * HildonGetPasswordDialog:numbers-only:
312 * If the password entry field is operating in numbers-only mode.
314 g_object_class_install_property
317 g_param_spec_boolean ("numbers-only",
319 "Set entry to accept only numeric values",
324 * HildonGetPasswordDialog:caption-label:
328 g_object_class_install_property
331 g_param_spec_string ("caption-label",
333 "The text to be set as the caption label",
338 * HildonGetPasswordDialog:max-characters:
340 * Maximum characters than can be entered.
342 g_object_class_install_property
345 g_param_spec_int ("max-characters",
346 "Maximum Characters",
347 "The maximum number of characters the password"
355 * HildonGetPasswordDialog:get-old:
357 * If the dialog is used to retrieve an old password or set a new one.
359 g_object_class_install_property
362 g_param_spec_boolean ("get-old",
364 "TRUE if dialog is a get old password dialog, "
365 "FALSE if dialog is a get password dialog",
367 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
369 /* Install private structure */
370 g_type_class_add_private (class, sizeof (HildonGetPasswordDialogPrivate));
374 hildon_get_password_dialog_init (HildonGetPasswordDialog *dialog)
376 /* Set initial properties for the dialog; the actual contents are
377 created once the 'get-old' property is set with g_object_new */
379 gtk_dialog_set_has_separator (GTK_DIALOG (dialog), FALSE);
380 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
381 gtk_dialog_set_default_response (GTK_DIALOG (dialog), GTK_RESPONSE_OK);
385 create_contents (HildonGetPasswordDialog *dialog)
387 HildonGetPasswordDialogPrivate *priv;
388 GtkSizeGroup * group;
390 AtkObject *atk_aux = NULL;
392 /* Cache private pointer for faster member access */
393 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
396 /* Sizegroup for captions */
397 group = GTK_SIZE_GROUP (gtk_size_group_new
398 (GTK_SIZE_GROUP_HORIZONTAL));
401 gtk_window_set_title (GTK_WINDOW (dialog),
403 ? _(HILDON_GET_PASSWORD_DIALOG_TITLE)
404 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_TITLE));
406 /* Optional password domain label */
407 priv->message_label = GTK_LABEL (gtk_label_new (NULL));
410 gtk_dialog_add_button (GTK_DIALOG (dialog),
412 ? _(HILDON_GET_PASSWORD_DIALOG_OK)
413 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_OK)),
416 gtk_dialog_add_button (GTK_DIALOG (dialog),
418 ? _(HILDON_GET_PASSWORD_DIALOG_CANCEL)
419 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_CANCEL)),
420 GTK_RESPONSE_CANCEL);
422 /* Create password text entry */
423 control = gtk_entry_new ();
424 if ((atk_aux = gtk_widget_get_accessible(control)))
426 atk_object_set_name(atk_aux, _("Passwd"));
429 gtk_entry_set_width_chars (GTK_ENTRY (control), 20);
432 g_object_set (control, "hildon-input-mode", HILDON_GTK_INPUT_MODE_FULL, NULL);
435 gtk_entry_set_visibility (GTK_ENTRY(control), FALSE);
436 priv->password_entry = HILDON_CAPTION
437 (hildon_caption_new(group,
439 ? _(HILDON_GET_PASSWORD_DIALOG_PASSWORD)
440 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_PASSWORD)),
442 HILDON_CAPTION_OPTIONAL));
443 hildon_caption_set_separator (HILDON_CAPTION (priv->password_entry), "");
445 /* Do the basic layout */
446 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
447 GTK_WIDGET (priv->message_label), FALSE, FALSE, 0);
448 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
449 GTK_WIDGET (priv->password_entry), FALSE, FALSE, 0);
450 gtk_widget_show_all (GTK_DIALOG (dialog)->vbox);
452 /* Ensure group is freed when all its contents have been removed */
453 g_object_unref (group);
457 * hildon_get_password_dialog_get_type:
459 * Returns GType for HildonGetPasswordDialog as produced by
460 * g_type_register_static().
462 * Returns: HildonGetPasswordDialog type
465 hildon_get_password_dialog_get_type (void)
467 static GType dialog_type = 0;
470 static const GTypeInfo dialog_info = {
471 sizeof (HildonGetPasswordDialogClass),
472 NULL, /* base_init */
473 NULL, /* base_finalize */
474 (GClassInitFunc) hildon_get_password_dialog_class_init,
475 NULL, /* class_finalize */
476 NULL, /* class_data */
477 sizeof (HildonGetPasswordDialog),
479 (GInstanceInitFunc) hildon_get_password_dialog_init
482 dialog_type = g_type_register_static (GTK_TYPE_DIALOG,
483 "HildonGetPasswordDialog",
490 * hildon_get_password_dialog_new:
491 * @parent: parent window; can be NULL
492 * @get_old: FALSE creates a new get password dialog and
493 * TRUE creates a new get old password dialog. That is,
494 * if the password to be obtained is the old password,
495 * this parameter is specified TRUE.
497 * Construct a new HildonGetPasswordDialog.
499 * Returns: a new #GtkWidget of type HildonGetPasswordDialog
502 hildon_get_password_dialog_new (GtkWindow *parent,
505 HildonGetPasswordDialog *dialog = g_object_new
506 (HILDON_TYPE_GET_PASSWORD_DIALOG,
507 "get-old", get_old, NULL);
509 if (parent != NULL) {
510 gtk_window_set_transient_for (GTK_WINDOW (dialog), parent);
513 return (GtkWidget *) dialog;
517 * hildon_get_password_dialog_new_with_default:
518 * @parent: parent window; can be NULL
519 * @password: a default password to be shown in password field
520 * @get_old: FALSE creates a new get password dialog and
521 * TRUE creates a new get old password dialog. That is,
522 * if the password to be obtained is the old password,
523 * this parameter is specified TRUE.
526 * Same as #hildon_get_password_dialog_new but with a default password
529 * Returns: a new #GtkWidget of type HildonGetPasswordDialog
532 hildon_get_password_dialog_new_with_default (GtkWindow *parent,
533 const gchar *password,
538 dialog = hildon_get_password_dialog_new (parent, get_old);
540 if (password != NULL)
541 g_object_set (G_OBJECT (dialog), "password", password, NULL);
543 return GTK_WIDGET (dialog);
547 * hildon_get_password_dialog_get_password:
548 * @dialog: pointer to HildonSetPasswordDialog
550 * Gets the currently entered password. The string should not be freed.
552 * Returns: current password entered by the user.
555 hildon_get_password_dialog_get_password (HildonGetPasswordDialog *dialog)
560 HildonGetPasswordDialogPrivate *priv;
562 g_return_val_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog), NULL);
563 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
566 /* Retrieve the password entry widget */
567 entry1 = GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry)));
568 text1 = GTK_ENTRY (entry1)->text;
574 * hildon_get_password_dialog_set_message
575 * @dialog: the dialog
576 * @message: a custom message or some other descriptive text to be set
578 * Sets the optional descriptive text displayed at the top of the dialog.
581 hildon_get_password_dialog_set_message (HildonGetPasswordDialog *dialog,
582 const gchar *message)
584 HildonGetPasswordDialogPrivate *priv;
586 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
588 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
591 gtk_label_set_text (priv->message_label, message);
596 * hildon_get_password_dialog_set_caption:
597 * @dialog: the dialog
598 * @new_caption: the text to be set as the caption label
600 * Sets the password entry field's neigbouring label.
603 hildon_get_password_dialog_set_caption (HildonGetPasswordDialog *dialog,
604 const gchar *new_caption)
606 HildonGetPasswordDialogPrivate *priv;
608 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
609 g_return_if_fail (new_caption != NULL);
611 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
614 hildon_caption_set_label (priv->password_entry, new_caption);
618 * hildon_get_password_dialog_set_max_characters:
619 * @dialog: the dialog
620 * @max_characters: the maximum number of characters the password dialog
623 * sets the maximum number of characters allowed as the password
626 hildon_get_password_dialog_set_max_characters (HildonGetPasswordDialog *dialog,
629 HildonGetPasswordDialogPrivate *priv;
631 g_return_if_fail (max_characters > 0);
632 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
634 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
637 /* Apply the given length to password entry */
638 gtk_entry_set_max_length (GTK_ENTRY
640 GTK_BIN ((priv->password_entry))),
643 /* FIXME There is a bug here -- the prev. signal needs to be
644 * disconnected before connecting the new signal. Besides, this
645 * should go into the constructor */
648 /* Connect callback to show error banner if the limit is exceeded */
649 g_signal_connect (GTK_ENTRY
651 GTK_BIN ((priv->password_entry))),
653 G_CALLBACK (invalid_input),
660 /* Callback that gets called when maximum chars is reached in the entry */
662 invalid_input (GtkWidget *widget,
663 GtkInvalidInputType reason,
666 if (reason == GTK_INVALID_INPUT_MAX_CHARS_REACHED)
668 hildon_banner_show_information (widget, NULL, _(HILDON_GET_PASSWORD_DIALOG_MAX_CHARS));