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));
74 #include "hildon-get-password-dialog.h"
82 #include "hildon-caption.h"
83 #include "hildon-banner.h"
85 #include "hildon-get-password-dialog-private.h"
87 #define _(String) dgettext("hildon-libs", String)
89 #define HILDON_GET_PASSWORD_DIALOG_TITLE "ecdg_ti_get_old_password"
91 #define HILDON_GET_PASSWORD_DIALOG_PASSWORD "ecdg_fi_get_old_pwd_enter_pwd"
93 #define HILDON_GET_PASSWORD_DIALOG_OK "ecdg_bd_get_old_password_dialog_ok"
95 #define HILDON_GET_PASSWORD_DIALOG_CANCEL "ecdg_bd_get_old_password_dialog_cancel"
97 #define HILDON_GET_PASSWORD_VERIFY_DIALOG_TITLE "ecdg_ti_verify_password"
99 #define HILDON_GET_PASSWORD_VERIFY_DIALOG_PASSWORD "ecdg_fi_verify_pwd_enter_pwd"
101 #define HILDON_GET_PASSWORD_VERIFY_DIALOG_OK "ecdg_bd_verify_password_dialog_ok"
103 #define HILDON_GET_PASSWORD_VERIFY_DIALOG_CANCEL "ecdg_bd_verify_password_dialog_cancel"
105 #define HILDON_GET_PASSWORD_DIALOG_MAX_CHARS "ckdg_ib_maximum_characters_reached"
107 static GtkDialogClass* parent_class;
110 hildon_get_password_dialog_class_init (HildonGetPasswordDialogClass *class);
113 hildon_get_password_dialog_init (HildonGetPasswordDialog *widget);
116 hildon_get_password_set_property (GObject *object,
122 hildon_get_password_get_property (GObject *object,
128 create_contents (HildonGetPasswordDialog *dialog);
132 invalid_input (GtkWidget *widget,
133 GtkInvalidInputType reason,
148 /* Private functions */
150 hildon_get_password_set_property (GObject *object,
155 HildonGetPasswordDialog *dialog = HILDON_GET_PASSWORD_DIALOG (object);
156 HildonGetPasswordDialogPrivate *priv;
158 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (object);
164 /* Set label text representing password domain */
165 gtk_label_set_text (priv->message_label, g_value_get_string (value));
169 gtk_entry_set_text(GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))),
170 g_value_get_string(value));
173 case PROP_NUMBERS_ONLY:
175 /* Set input mode for the password entry */
176 g_object_set(G_OBJECT (gtk_bin_get_child GTK_BIN ((priv->password_entry))),
178 (g_value_get_boolean (value)
179 ? HILDON_GTK_INPUT_MODE_NUMERIC
180 : HILDON_GTK_INPUT_MODE_FULL),
185 case PROP_CAPTION_LABEL:
186 hildon_get_password_dialog_set_caption (dialog, g_value_get_string (value));
190 hildon_get_password_dialog_set_max_characters (dialog, g_value_get_int (value));
194 priv->get_old = g_value_get_boolean (value);
195 create_contents (dialog);
199 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
205 hildon_get_password_get_property (GObject *object,
210 HildonGetPasswordDialog *dialog = HILDON_GET_PASSWORD_DIALOG (object);
211 HildonGetPasswordDialogPrivate *priv;
218 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
224 string = gtk_label_get_text (priv->message_label);
225 g_value_set_string (value, string);
229 string = gtk_entry_get_text (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))));
230 g_value_set_string (value, string);
233 case PROP_NUMBERS_ONLY:
235 /* This property is set if and only if the input mode
236 of the password entry has been set to numeric only */
237 g_object_get (G_OBJECT (gtk_bin_get_child (GTK_BIN (priv->password_entry))),
238 "hildon-input-mode", &input_mode, NULL);
239 g_value_set_boolean (value,
240 (input_mode == HILDON_GTK_INPUT_MODE_NUMERIC));
242 g_value_set_boolean (value, FALSE);
246 case PROP_CAPTION_LABEL:
247 string = hildon_caption_get_label (priv->password_entry);
248 g_value_set_string (value, string);
252 max_length = gtk_entry_get_max_length
253 (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))));
254 g_value_set_int (value, max_length);
258 g_value_set_boolean (value, priv->get_old);
262 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
268 hildon_get_password_dialog_class_init (HildonGetPasswordDialogClass *class)
270 GObjectClass *object_class = G_OBJECT_CLASS (class);
272 parent_class = g_type_class_peek_parent (class);
274 /* Override virtual functions */
275 object_class->set_property = hildon_get_password_set_property;
276 object_class->get_property = hildon_get_password_get_property;
278 /* Install new properties */
281 * HildonGetPasswordDialog:message:
283 * Optional message displayed to the user.
285 g_object_class_install_property
288 g_param_spec_string ("message",
290 "Set optional message",
295 * HildonGetPasswordDialog:password:
297 * Password field contents.
299 g_object_class_install_property
302 g_param_spec_string ("password",
309 * HildonGetPasswordDialog:numbers-only:
311 * If the password entry field is operating in numbers-only mode.
313 g_object_class_install_property
316 g_param_spec_boolean ("numbers-only",
318 "Set entry to accept only numeric values",
323 * HildonGetPasswordDialog:caption-label:
327 g_object_class_install_property
330 g_param_spec_string ("caption-label",
332 "The text to be set as the caption label",
337 * HildonGetPasswordDialog:max-characters:
339 * Maximum characters than can be entered.
341 g_object_class_install_property
344 g_param_spec_int ("max-characters",
345 "Maximum Characters",
346 "The maximum number of characters the password"
354 * HildonGetPasswordDialog:get-old:
356 * If the dialog is used to retrieve an old password or set a new one.
358 g_object_class_install_property
361 g_param_spec_boolean ("get-old",
363 "TRUE if dialog is a get old password dialog, "
364 "FALSE if dialog is a get password dialog",
366 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
368 /* Install private structure */
369 g_type_class_add_private (class, sizeof (HildonGetPasswordDialogPrivate));
373 hildon_get_password_dialog_init (HildonGetPasswordDialog *dialog)
375 /* Set initial properties for the dialog; the actual contents are
376 created once the 'get-old' property is set with g_object_new */
378 gtk_dialog_set_has_separator (GTK_DIALOG (dialog), FALSE);
379 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
380 gtk_dialog_set_default_response (GTK_DIALOG (dialog), GTK_RESPONSE_OK);
384 create_contents (HildonGetPasswordDialog *dialog)
386 HildonGetPasswordDialogPrivate *priv;
387 GtkSizeGroup * group;
389 AtkObject *atk_aux = NULL;
391 /* Cache private pointer for faster member access */
392 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
395 /* Sizegroup for captions */
396 group = GTK_SIZE_GROUP (gtk_size_group_new
397 (GTK_SIZE_GROUP_HORIZONTAL));
400 gtk_window_set_title (GTK_WINDOW (dialog),
402 ? _(HILDON_GET_PASSWORD_DIALOG_TITLE)
403 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_TITLE));
405 /* Optional password domain label */
406 priv->message_label = GTK_LABEL (gtk_label_new (NULL));
409 gtk_dialog_add_button (GTK_DIALOG (dialog),
411 ? _(HILDON_GET_PASSWORD_DIALOG_OK)
412 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_OK)),
415 gtk_dialog_add_button (GTK_DIALOG (dialog),
417 ? _(HILDON_GET_PASSWORD_DIALOG_CANCEL)
418 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_CANCEL)),
419 GTK_RESPONSE_CANCEL);
421 /* Create password text entry */
422 control = gtk_entry_new ();
423 if ((atk_aux = gtk_widget_get_accessible(control)))
425 atk_object_set_name(atk_aux, _("Passwd"));
428 gtk_entry_set_width_chars (GTK_ENTRY (control), 20);
431 g_object_set (control, "hildon-input-mode", HILDON_GTK_INPUT_MODE_FULL, NULL);
434 gtk_entry_set_visibility (GTK_ENTRY(control), FALSE);
435 priv->password_entry = HILDON_CAPTION
436 (hildon_caption_new(group,
438 ? _(HILDON_GET_PASSWORD_DIALOG_PASSWORD)
439 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_PASSWORD)),
441 HILDON_CAPTION_OPTIONAL));
442 hildon_caption_set_separator (HILDON_CAPTION (priv->password_entry), "");
444 /* Do the basic layout */
445 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
446 GTK_WIDGET (priv->message_label), FALSE, FALSE, 0);
447 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
448 GTK_WIDGET (priv->password_entry), FALSE, FALSE, 0);
449 gtk_widget_show_all (GTK_DIALOG (dialog)->vbox);
451 /* Ensure group is freed when all its contents have been removed */
452 g_object_unref (group);
456 * hildon_get_password_dialog_get_type:
458 * Returns GType for HildonGetPasswordDialog as produced by
459 * g_type_register_static().
461 * Returns: HildonGetPasswordDialog type
464 hildon_get_password_dialog_get_type (void)
466 static GType dialog_type = 0;
469 static const GTypeInfo dialog_info = {
470 sizeof (HildonGetPasswordDialogClass),
471 NULL, /* base_init */
472 NULL, /* base_finalize */
473 (GClassInitFunc) hildon_get_password_dialog_class_init,
474 NULL, /* class_finalize */
475 NULL, /* class_data */
476 sizeof (HildonGetPasswordDialog),
478 (GInstanceInitFunc) hildon_get_password_dialog_init
481 dialog_type = g_type_register_static (GTK_TYPE_DIALOG,
482 "HildonGetPasswordDialog",
489 * hildon_get_password_dialog_new:
490 * @parent: parent window; can be NULL
491 * @get_old: FALSE creates a new get password dialog and
492 * TRUE creates a new get old password dialog. That is,
493 * if the password to be obtained is the old password,
494 * this parameter is specified TRUE.
496 * Construct a new HildonGetPasswordDialog.
498 * Returns: a new #GtkWidget of type HildonGetPasswordDialog
501 hildon_get_password_dialog_new (GtkWindow *parent,
504 HildonGetPasswordDialog *dialog = g_object_new
505 (HILDON_TYPE_GET_PASSWORD_DIALOG,
506 "get-old", get_old, NULL);
508 if (parent != NULL) {
509 gtk_window_set_transient_for (GTK_WINDOW (dialog), parent);
512 return (GtkWidget *) dialog;
516 * hildon_get_password_dialog_new_with_default:
517 * @parent: parent window; can be NULL
518 * @password: a default password to be shown in password field
519 * @get_old: FALSE creates a new get password dialog and
520 * TRUE creates a new get old password dialog. That is,
521 * if the password to be obtained is the old password,
522 * this parameter is specified TRUE.
525 * Same as #hildon_get_password_dialog_new but with a default password
528 * Returns: a new #GtkWidget of type HildonGetPasswordDialog
531 hildon_get_password_dialog_new_with_default (GtkWindow *parent,
532 const gchar *password,
537 dialog = hildon_get_password_dialog_new (parent, get_old);
539 if (password != NULL)
540 g_object_set (G_OBJECT (dialog), "password", password, NULL);
542 return GTK_WIDGET (dialog);
546 * hildon_get_password_dialog_get_password:
547 * @dialog: pointer to HildonSetPasswordDialog
549 * Gets the currently entered password. The string should not be freed.
551 * Returns: current password entered by the user.
554 hildon_get_password_dialog_get_password (HildonGetPasswordDialog *dialog)
559 HildonGetPasswordDialogPrivate *priv;
561 g_return_val_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog), NULL);
562 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
565 /* Retrieve the password entry widget */
566 entry1 = GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry)));
567 text1 = GTK_ENTRY (entry1)->text;
573 * hildon_get_password_dialog_set_message
574 * @dialog: the dialog
575 * @message: a custom message or some other descriptive text to be set
577 * Sets the optional descriptive text displayed at the top of the dialog.
580 hildon_get_password_dialog_set_message (HildonGetPasswordDialog *dialog,
581 const gchar *message)
583 HildonGetPasswordDialogPrivate *priv;
585 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
587 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
590 gtk_label_set_text (priv->message_label, message);
595 * hildon_get_password_dialog_set_caption:
596 * @dialog: the dialog
597 * @new_caption: the text to be set as the caption label
599 * Sets the password entry field's neigbouring label.
602 hildon_get_password_dialog_set_caption (HildonGetPasswordDialog *dialog,
603 const gchar *new_caption)
605 HildonGetPasswordDialogPrivate *priv;
607 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
608 g_return_if_fail (new_caption != NULL);
610 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
613 hildon_caption_set_label (priv->password_entry, new_caption);
617 * hildon_get_password_dialog_set_max_characters:
618 * @dialog: the dialog
619 * @max_characters: the maximum number of characters the password dialog
622 * sets the maximum number of characters allowed as the password
625 hildon_get_password_dialog_set_max_characters (HildonGetPasswordDialog *dialog,
628 HildonGetPasswordDialogPrivate *priv;
630 g_return_if_fail (max_characters > 0);
631 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
633 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
636 /* Apply the given length to password entry */
637 gtk_entry_set_max_length (GTK_ENTRY
639 GTK_BIN ((priv->password_entry))),
642 /* FIXME There is a bug here -- the prev. signal needs to be
643 * disconnected before connecting the new signal. Besides, this
644 * should go into the constructor */
647 /* Connect callback to show error banner if the limit is exceeded */
648 g_signal_connect (GTK_ENTRY
650 GTK_BIN ((priv->password_entry))),
652 G_CALLBACK (invalid_input),
659 /* Callback that gets called when maximum chars is reached in the entry */
661 invalid_input (GtkWidget *widget,
662 GtkInvalidInputType reason,
665 if (reason == GTK_INVALID_INPUT_MAX_CHARS_REACHED)
667 hildon_banner_show_information (widget, NULL, _(HILDON_GET_PASSWORD_DIALOG_MAX_CHARS));