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);
131 invalid_input (GtkWidget *widget,
132 GtkInvalidInputType reason,
146 /* Private functions */
148 hildon_get_password_set_property (GObject *object,
153 HildonGetPasswordDialog *dialog = HILDON_GET_PASSWORD_DIALOG (object);
154 HildonGetPasswordDialogPrivate *priv;
156 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (object);
162 /* Set label text representing password domain */
163 gtk_label_set_text (priv->message_label, g_value_get_string (value));
167 gtk_entry_set_text(GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))),
168 g_value_get_string(value));
171 case PROP_NUMBERS_ONLY:
172 /* Set input mode for the password entry */
173 g_object_set(G_OBJECT (gtk_bin_get_child GTK_BIN ((priv->password_entry))),
175 (g_value_get_boolean (value)
176 ? HILDON_GTK_INPUT_MODE_NUMERIC
177 : HILDON_GTK_INPUT_MODE_FULL),
181 case PROP_CAPTION_LABEL:
182 hildon_get_password_dialog_set_caption (dialog, g_value_get_string (value));
186 hildon_get_password_dialog_set_max_characters (dialog, g_value_get_int (value));
190 priv->get_old = g_value_get_boolean (value);
191 create_contents (dialog);
195 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
201 hildon_get_password_get_property (GObject *object,
206 HildonGetPasswordDialog *dialog = HILDON_GET_PASSWORD_DIALOG (object);
207 HildonGetPasswordDialogPrivate *priv;
212 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
218 string = gtk_label_get_text (priv->message_label);
219 g_value_set_string (value, string);
223 string = gtk_entry_get_text (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))));
224 g_value_set_string (value, string);
227 case PROP_NUMBERS_ONLY:
228 /* This property is set if and only if the input mode
229 of the password entry has been set to numeric only */
230 g_object_get (G_OBJECT (gtk_bin_get_child (GTK_BIN (priv->password_entry))),
231 "hildon-input-mode", &input_mode, NULL);
232 g_value_set_boolean (value,
233 (input_mode == HILDON_GTK_INPUT_MODE_NUMERIC));
236 case PROP_CAPTION_LABEL:
237 string = hildon_caption_get_label (priv->password_entry);
238 g_value_set_string (value, string);
242 max_length = gtk_entry_get_max_length
243 (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry))));
244 g_value_set_int (value, max_length);
248 g_value_set_boolean (value, priv->get_old);
252 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
258 hildon_get_password_dialog_class_init (HildonGetPasswordDialogClass *class)
260 GObjectClass *object_class = G_OBJECT_CLASS (class);
262 parent_class = g_type_class_peek_parent (class);
264 /* Override virtual functions */
265 object_class->set_property = hildon_get_password_set_property;
266 object_class->get_property = hildon_get_password_get_property;
268 /* Install new properties */
271 * HildonGetPasswordDialog:message:
273 * Optional message displayed to the user.
275 g_object_class_install_property
278 g_param_spec_string ("message",
280 "Set optional message",
285 * HildonGetPasswordDialog:password:
287 * Password field contents.
289 g_object_class_install_property
292 g_param_spec_string ("password",
299 * HildonGetPasswordDialog:numbers-only:
301 * If the password entry field is operating in numbers-only mode.
303 g_object_class_install_property
306 g_param_spec_boolean ("numbers-only",
308 "Set entry to accept only numeric values",
313 * HildonGetPasswordDialog:caption-label:
317 g_object_class_install_property
320 g_param_spec_string ("caption-label",
322 "The text to be set as the caption label",
327 * HildonGetPasswordDialog:max-characters:
329 * Maximum characters than can be entered.
331 g_object_class_install_property
334 g_param_spec_int ("max-characters",
335 "Maximum Characters",
336 "The maximum number of characters the password"
344 * HildonGetPasswordDialog:get-old:
346 * If the dialog is used to retrieve an old password or set a new one.
348 g_object_class_install_property
351 g_param_spec_boolean ("get-old",
353 "TRUE if dialog is a get old password dialog, "
354 "FALSE if dialog is a get password dialog",
356 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
358 /* Install private structure */
359 g_type_class_add_private (class, sizeof (HildonGetPasswordDialogPrivate));
363 hildon_get_password_dialog_init (HildonGetPasswordDialog *dialog)
365 /* Set initial properties for the dialog; the actual contents are
366 created once the 'get-old' property is set with g_object_new */
368 gtk_dialog_set_has_separator (GTK_DIALOG (dialog), FALSE);
369 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
370 gtk_dialog_set_default_response (GTK_DIALOG (dialog), GTK_RESPONSE_OK);
374 create_contents (HildonGetPasswordDialog *dialog)
376 HildonGetPasswordDialogPrivate *priv;
377 GtkSizeGroup * group;
380 /* Cache private pointer for faster member access */
381 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
384 /* Sizegroup for captions */
385 group = GTK_SIZE_GROUP (gtk_size_group_new
386 (GTK_SIZE_GROUP_HORIZONTAL));
389 gtk_window_set_title (GTK_WINDOW (dialog),
391 ? _(HILDON_GET_PASSWORD_DIALOG_TITLE)
392 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_TITLE));
394 /* Optional password domain label */
395 priv->message_label = GTK_LABEL (gtk_label_new (NULL));
398 gtk_dialog_add_button (GTK_DIALOG (dialog),
400 ? _(HILDON_GET_PASSWORD_DIALOG_OK)
401 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_OK)),
404 gtk_dialog_add_button (GTK_DIALOG (dialog),
406 ? _(HILDON_GET_PASSWORD_DIALOG_CANCEL)
407 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_CANCEL)),
408 GTK_RESPONSE_CANCEL);
410 /* Create password text entry */
411 control = gtk_entry_new ();
412 gtk_entry_set_width_chars (GTK_ENTRY (control), 20);
414 g_object_set (control, "hildon-input-mode", HILDON_GTK_INPUT_MODE_FULL, NULL);
416 gtk_entry_set_visibility (GTK_ENTRY(control), FALSE);
417 priv->password_entry = HILDON_CAPTION
418 (hildon_caption_new(group,
420 ? _(HILDON_GET_PASSWORD_DIALOG_PASSWORD)
421 : _(HILDON_GET_PASSWORD_VERIFY_DIALOG_PASSWORD)),
423 HILDON_CAPTION_OPTIONAL));
424 hildon_caption_set_separator (HILDON_CAPTION (priv->password_entry), "");
426 /* Do the basic layout */
427 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
428 GTK_WIDGET (priv->message_label), FALSE, FALSE, 0);
429 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
430 GTK_WIDGET (priv->password_entry), FALSE, FALSE, 0);
431 gtk_widget_show_all (GTK_DIALOG (dialog)->vbox);
433 /* Ensure group is freed when all its contents have been removed */
434 g_object_unref (group);
438 * hildon_get_password_dialog_get_type:
440 * Returns GType for HildonGetPasswordDialog as produced by
441 * g_type_register_static().
443 * Returns: HildonGetPasswordDialog type
446 hildon_get_password_dialog_get_type (void)
448 static GType dialog_type = 0;
451 static const GTypeInfo dialog_info = {
452 sizeof (HildonGetPasswordDialogClass),
453 NULL, /* base_init */
454 NULL, /* base_finalize */
455 (GClassInitFunc) hildon_get_password_dialog_class_init,
456 NULL, /* class_finalize */
457 NULL, /* class_data */
458 sizeof (HildonGetPasswordDialog),
460 (GInstanceInitFunc) hildon_get_password_dialog_init
463 dialog_type = g_type_register_static (GTK_TYPE_DIALOG,
464 "HildonGetPasswordDialog",
471 * hildon_get_password_dialog_new:
472 * @parent: parent window; can be NULL
473 * @get_old: FALSE creates a new get password dialog and
474 * TRUE creates a new get old password dialog. That is,
475 * if the password to be obtained is the old password,
476 * this parameter is specified TRUE.
478 * Construct a new HildonGetPasswordDialog.
480 * Returns: a new #GtkWidget of type HildonGetPasswordDialog
483 hildon_get_password_dialog_new (GtkWindow *parent,
486 HildonGetPasswordDialog *dialog = g_object_new
487 (HILDON_TYPE_GET_PASSWORD_DIALOG,
488 "get-old", get_old, NULL);
490 if (parent != NULL) {
491 gtk_window_set_transient_for (GTK_WINDOW (dialog), parent);
494 return (GtkWidget *) dialog;
498 * hildon_get_password_dialog_new_with_default:
499 * @parent: parent window; can be NULL
500 * @password: a default password to be shown in password field
501 * @get_old: FALSE creates a new get password dialog and
502 * TRUE creates a new get old password dialog. That is,
503 * if the password to be obtained is the old password,
504 * this parameter is specified TRUE.
507 * Same as #hildon_get_password_dialog_new but with a default password
510 * Returns: a new #GtkWidget of type HildonGetPasswordDialog
513 hildon_get_password_dialog_new_with_default (GtkWindow *parent,
514 const gchar *password,
519 dialog = hildon_get_password_dialog_new (parent, get_old);
521 if (password != NULL)
522 g_object_set (G_OBJECT (dialog), "password", password, NULL);
524 return GTK_WIDGET (dialog);
528 * hildon_get_password_dialog_get_password:
529 * @dialog: pointer to HildonSetPasswordDialog
531 * Gets the currently entered password. The string should not be freed.
533 * Returns: current password entered by the user.
536 hildon_get_password_dialog_get_password (HildonGetPasswordDialog *dialog)
541 HildonGetPasswordDialogPrivate *priv;
543 g_return_val_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog), NULL);
544 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
547 /* Retrieve the password entry widget */
548 entry1 = GTK_ENTRY (gtk_bin_get_child (GTK_BIN (priv->password_entry)));
549 text1 = GTK_ENTRY (entry1)->text;
555 * hildon_get_password_dialog_set_message
556 * @dialog: the dialog
557 * @message: a custom message or some other descriptive text to be set
559 * Sets the optional descriptive text displayed at the top of the dialog.
562 hildon_get_password_dialog_set_message (HildonGetPasswordDialog *dialog,
563 const gchar *message)
565 HildonGetPasswordDialogPrivate *priv;
567 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
569 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
572 gtk_label_set_text (priv->message_label, message);
577 * hildon_get_password_dialog_set_caption:
578 * @dialog: the dialog
579 * @new_caption: the text to be set as the caption label
581 * Sets the password entry field's neigbouring label.
584 hildon_get_password_dialog_set_caption (HildonGetPasswordDialog *dialog,
585 const gchar *new_caption)
587 HildonGetPasswordDialogPrivate *priv;
589 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
590 g_return_if_fail (new_caption != NULL);
592 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
595 hildon_caption_set_label (priv->password_entry, new_caption);
599 * hildon_get_password_dialog_set_max_characters:
600 * @dialog: the dialog
601 * @max_characters: the maximum number of characters the password dialog
604 * sets the maximum number of characters allowed as the password
607 hildon_get_password_dialog_set_max_characters (HildonGetPasswordDialog *dialog,
610 HildonGetPasswordDialogPrivate *priv;
612 g_return_if_fail (max_characters > 0);
613 g_return_if_fail (HILDON_IS_GET_PASSWORD_DIALOG (dialog));
615 priv = HILDON_GET_PASSWORD_DIALOG_GET_PRIVATE (dialog);
618 /* Apply the given length to password entry */
619 gtk_entry_set_max_length (GTK_ENTRY
621 GTK_BIN ((priv->password_entry))),
624 /* FIXME There is a bug here -- the prev. signal needs to be
625 * disconnected before connecting the new signal. Besides, this
626 * should go into the constructor */
628 /* Connect callback to show error banner if the limit is exceeded */
629 g_signal_connect (GTK_ENTRY
631 GTK_BIN ((priv->password_entry))),
633 G_CALLBACK (invalid_input),
638 /* Callback that gets called when maximum chars is reached in the entry */
640 invalid_input (GtkWidget *widget,
641 GtkInvalidInputType reason,
644 if (reason == GTK_INVALID_INPUT_MAX_CHARS_REACHED)
646 hildon_banner_show_information (widget, NULL, _(HILDON_GET_PASSWORD_DIALOG_MAX_CHARS));