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
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));
81 #include "hildon-get-password-dialog.h"
82 #include "hildon-caption.h"
83 #include "hildon-banner.h"
84 #include "hildon-get-password-dialog-private.h"
86 #define _(String) dgettext("hildon-libs", String)
88 #define HILDON_GET_PASSWORD_DIALOG_TITLE "ecdg_ti_get_old_password"
90 #define HILDON_GET_PASSWORD_DIALOG_PASSWORD "ecdg_fi_get_old_pwd_enter_pwd"
92 #define HILDON_GET_PASSWORD_DIALOG_OK "ecdg_bd_get_old_password_dialog_ok"
94 #define HILDON_GET_PASSWORD_DIALOG_CANCEL "ecdg_bd_get_old_password_dialog_cancel"
96 #define HILDON_GET_PASSWORD_VERIFY_DIALOG_TITLE "ecdg_ti_verify_password"
98 #define HILDON_GET_PASSWORD_VERIFY_DIALOG_PASSWORD "ecdg_fi_verify_pwd_enter_pwd"
100 #define HILDON_GET_PASSWORD_VERIFY_DIALOG_OK "ecdg_bd_verify_password_dialog_ok"
102 #define HILDON_GET_PASSWORD_VERIFY_DIALOG_CANCEL "ecdg_bd_verify_password_dialog_cancel"
104 #define HILDON_GET_PASSWORD_DIALOG_MAX_CHARS "ckdg_ib_maximum_characters_reached"
106 static GtkDialogClass* parent_class;
109 hildon_get_password_dialog_class_init (HildonGetPasswordDialogClass *class);
112 hildon_get_password_dialog_init (HildonGetPasswordDialog *widget);
115 hildon_get_password_set_property (GObject *object,
121 hildon_get_password_get_property (GObject *object,
127 create_contents (HildonGetPasswordDialog *dialog);
131 invalid_input (GtkWidget *widget,
132 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:
174 /* Set input mode for the password entry */
175 g_object_set(G_OBJECT (gtk_bin_get_child GTK_BIN ((priv->password_entry))),
177 (g_value_get_boolean (value)
178 ? HILDON_GTK_INPUT_MODE_NUMERIC
179 : HILDON_GTK_INPUT_MODE_FULL),
184 case PROP_CAPTION_LABEL:
185 hildon_get_password_dialog_set_caption (dialog, g_value_get_string (value));
189 hildon_get_password_dialog_set_max_characters (dialog, g_value_get_int (value));
193 priv->get_old = g_value_get_boolean (value);
194 create_contents (dialog);
198 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
204 hildon_get_password_get_property (GObject *object,
209 HildonGetPasswordDialog *dialog = HILDON_GET_PASSWORD_DIALOG (object);
210 HildonGetPasswordDialogPrivate *priv;
217 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
223 string = gtk_label_get_text (priv->message_label);
224 g_value_set_string (value, string);
228 string = gtk_entry_get_text (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))));
229 g_value_set_string (value, string);
232 case PROP_NUMBERS_ONLY:
234 /* This property is set if and only if the input mode
235 of the password entry has been set to numeric only */
236 g_object_get (G_OBJECT (gtk_bin_get_child (GTK_BIN (priv->password_entry))),
237 "hildon-input-mode", &input_mode, NULL);
238 g_value_set_boolean (value,
239 (input_mode == HILDON_GTK_INPUT_MODE_NUMERIC));
241 g_value_set_boolean (value, FALSE);
245 case PROP_CAPTION_LABEL:
246 string = hildon_caption_get_label (priv->password_entry);
247 g_value_set_string (value, string);
251 max_length = gtk_entry_get_max_length
252 (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))));
253 g_value_set_int (value, max_length);
257 g_value_set_boolean (value, priv->get_old);
261 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
267 hildon_get_password_dialog_class_init (HildonGetPasswordDialogClass *class)
269 GObjectClass *object_class = G_OBJECT_CLASS (class);
271 parent_class = g_type_class_peek_parent (class);
273 /* Override virtual functions */
274 object_class->set_property = hildon_get_password_set_property;
275 object_class->get_property = hildon_get_password_get_property;
277 /* Install new properties */
280 * HildonGetPasswordDialog:message:
282 * Optional message displayed to the user.
284 g_object_class_install_property
287 g_param_spec_string ("message",
289 "Set optional message",
294 * HildonGetPasswordDialog:password:
296 * Password field contents.
298 g_object_class_install_property
301 g_param_spec_string ("password",
308 * HildonGetPasswordDialog:numbers-only:
310 * If the password entry field is operating in numbers-only mode.
312 g_object_class_install_property
315 g_param_spec_boolean ("numbers-only",
317 "Set entry to accept only numeric values",
322 * HildonGetPasswordDialog:caption-label:
326 g_object_class_install_property
329 g_param_spec_string ("caption-label",
331 "The text to be set as the caption label",
336 * HildonGetPasswordDialog:max-characters:
338 * Maximum characters than can be entered.
340 g_object_class_install_property
343 g_param_spec_int ("max-characters",
344 "Maximum Characters",
345 "The maximum number of characters the password"
353 * HildonGetPasswordDialog:get-old:
355 * If the dialog is used to retrieve an old password or set a new one.
357 g_object_class_install_property
360 g_param_spec_boolean ("get-old",
362 "TRUE if dialog is a get old password dialog, "
363 "FALSE if dialog is a get password dialog",
365 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
367 /* Install private structure */
368 g_type_class_add_private (class, sizeof (HildonGetPasswordDialogPrivate));
372 hildon_get_password_dialog_init (HildonGetPasswordDialog *dialog)
374 /* Set initial properties for the dialog; the actual contents are
375 created once the 'get-old' property is set with g_object_new */
377 gtk_dialog_set_has_separator (GTK_DIALOG (dialog), FALSE);
378 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
379 gtk_dialog_set_default_response (GTK_DIALOG (dialog), GTK_RESPONSE_OK);
383 create_contents (HildonGetPasswordDialog *dialog)
385 HildonGetPasswordDialogPrivate *priv;
386 GtkSizeGroup * group;
388 AtkObject *atk_aux = NULL;
390 /* Cache private pointer for faster member access */
391 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
394 /* Sizegroup for captions */
395 group = GTK_SIZE_GROUP (gtk_size_group_new
396 (GTK_SIZE_GROUP_HORIZONTAL));
399 gtk_window_set_title (GTK_WINDOW (dialog),
401 ? _(HILDON_GET_PASSWORD_DIALOG_TITLE)
402 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_TITLE));
404 /* Optional password domain label */
405 priv->message_label = GTK_LABEL (gtk_label_new (NULL));
408 gtk_dialog_add_button (GTK_DIALOG (dialog),
410 ? _(HILDON_GET_PASSWORD_DIALOG_OK)
411 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_OK)),
414 gtk_dialog_add_button (GTK_DIALOG (dialog),
416 ? _(HILDON_GET_PASSWORD_DIALOG_CANCEL)
417 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_CANCEL)),
418 GTK_RESPONSE_CANCEL);
420 /* Create password text entry */
421 control = gtk_entry_new ();
422 if ((atk_aux = gtk_widget_get_accessible(control)))
424 atk_object_set_name(atk_aux, _("Passwd"));
427 gtk_entry_set_width_chars (GTK_ENTRY (control), 20);
430 g_object_set (control, "hildon-input-mode", HILDON_GTK_INPUT_MODE_FULL, NULL);
433 gtk_entry_set_visibility (GTK_ENTRY(control), FALSE);
434 priv->password_entry = HILDON_CAPTION
435 (hildon_caption_new(group,
437 ? _(HILDON_GET_PASSWORD_DIALOG_PASSWORD)
438 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_PASSWORD)),
440 HILDON_CAPTION_OPTIONAL));
441 hildon_caption_set_separator (HILDON_CAPTION (priv->password_entry), "");
443 /* Do the basic layout */
444 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
445 GTK_WIDGET (priv->message_label), FALSE, FALSE, 0);
446 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
447 GTK_WIDGET (priv->password_entry), FALSE, FALSE, 0);
448 gtk_widget_show_all (GTK_DIALOG (dialog)->vbox);
450 /* Ensure group is freed when all its contents have been removed */
451 g_object_unref (group);
455 * hildon_get_password_dialog_get_type:
457 * Returns GType for HildonGetPasswordDialog as produced by
458 * g_type_register_static().
460 * Returns: HildonGetPasswordDialog type
463 hildon_get_password_dialog_get_type (void)
465 static GType dialog_type = 0;
468 static const GTypeInfo dialog_info = {
469 sizeof (HildonGetPasswordDialogClass),
470 NULL, /* base_init */
471 NULL, /* base_finalize */
472 (GClassInitFunc) hildon_get_password_dialog_class_init,
473 NULL, /* class_finalize */
474 NULL, /* class_data */
475 sizeof (HildonGetPasswordDialog),
477 (GInstanceInitFunc) hildon_get_password_dialog_init
480 dialog_type = g_type_register_static (GTK_TYPE_DIALOG,
481 "HildonGetPasswordDialog",
488 * hildon_get_password_dialog_new:
489 * @parent: parent window; can be NULL
490 * @get_old: FALSE creates a new get password dialog and
491 * TRUE creates a new get old password dialog. That is,
492 * if the password to be obtained is the old password,
493 * this parameter is specified TRUE.
495 * Construct a new HildonGetPasswordDialog.
497 * Returns: a new #GtkWidget of type HildonGetPasswordDialog
500 hildon_get_password_dialog_new (GtkWindow *parent,
503 HildonGetPasswordDialog *dialog = g_object_new
504 (HILDON_TYPE_GET_PASSWORD_DIALOG,
505 "get-old", get_old, NULL);
507 if (parent != NULL) {
508 gtk_window_set_transient_for (GTK_WINDOW (dialog), parent);
511 return (GtkWidget *) dialog;
515 * hildon_get_password_dialog_new_with_default:
516 * @parent: parent window; can be NULL
517 * @password: a default password to be shown in password field
518 * @get_old: FALSE creates a new get password dialog and
519 * TRUE creates a new get old password dialog. That is,
520 * if the password to be obtained is the old password,
521 * this parameter is specified TRUE.
524 * Same as #hildon_get_password_dialog_new but with a default password
527 * Returns: a new #GtkWidget of type HildonGetPasswordDialog
530 hildon_get_password_dialog_new_with_default (GtkWindow *parent,
531 const gchar *password,
536 dialog = hildon_get_password_dialog_new (parent, get_old);
538 if (password != NULL)
539 g_object_set (G_OBJECT (dialog), "password", password, NULL);
541 return GTK_WIDGET (dialog);
545 * hildon_get_password_dialog_get_password:
546 * @dialog: pointer to HildonSetPasswordDialog
548 * Gets the currently entered password. The string should not be freed.
550 * Returns: current password entered by the user.
553 hildon_get_password_dialog_get_password (HildonGetPasswordDialog *dialog)
558 HildonGetPasswordDialogPrivate *priv;
560 g_return_val_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog), NULL);
561 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
564 /* Retrieve the password entry widget */
565 entry1 = GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry)));
566 text1 = GTK_ENTRY (entry1)->text;
572 * hildon_get_password_dialog_set_message
573 * @dialog: the dialog
574 * @message: a custom message or some other descriptive text to be set
576 * Sets the optional descriptive text displayed at the top of the dialog.
579 hildon_get_password_dialog_set_message (HildonGetPasswordDialog *dialog,
580 const gchar *message)
582 HildonGetPasswordDialogPrivate *priv;
584 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
586 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
589 gtk_label_set_text (priv->message_label, message);
594 * hildon_get_password_dialog_set_caption:
595 * @dialog: the dialog
596 * @new_caption: the text to be set as the caption label
598 * Sets the password entry field's neigbouring label.
601 hildon_get_password_dialog_set_caption (HildonGetPasswordDialog *dialog,
602 const gchar *new_caption)
604 HildonGetPasswordDialogPrivate *priv;
606 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
607 g_return_if_fail (new_caption != NULL);
609 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
612 hildon_caption_set_label (priv->password_entry, new_caption);
616 * hildon_get_password_dialog_set_max_characters:
617 * @dialog: the dialog
618 * @max_characters: the maximum number of characters the password dialog
621 * sets the maximum number of characters allowed as the password
624 hildon_get_password_dialog_set_max_characters (HildonGetPasswordDialog *dialog,
627 HildonGetPasswordDialogPrivate *priv;
629 g_return_if_fail (max_characters > 0);
630 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
632 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
635 /* Apply the given length to password entry */
636 gtk_entry_set_max_length (GTK_ENTRY
638 GTK_BIN ((priv->password_entry))),
641 /* FIXME There is a bug here -- the prev. signal needs to be
642 * disconnected before connecting the new signal. Besides, this
643 * should go into the constructor */
646 /* Connect callback to show error banner if the limit is exceeded */
647 g_signal_connect (GTK_ENTRY
649 GTK_BIN ((priv->password_entry))),
651 G_CALLBACK (invalid_input),
658 /* Callback that gets called when maximum chars is reached in the entry */
660 invalid_input (GtkWidget *widget,
661 GtkInvalidInputType reason,
664 if (reason == GTK_INVALID_INPUT_MAX_CHARS_REACHED)
666 hildon_banner_show_information (widget, NULL, _(HILDON_GET_PASSWORD_DIALOG_MAX_CHARS));