/*
* This file is part of hildon-libs
*
- * Copyright (C) 2005 Nokia Corporation.
+ * Copyright (C) 2005, 2006 Nokia Corporation, all rights reserved.
*
- * Contact: Luc Pionchon <luc.pionchon@nokia.com>
+ * Contact: Michael Dominic Kostrzewa <michael.kostrzewa@nokia.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 2.1 of
- * the License, or (at your option) any later version.
+ * as published by the Free Software Foundation; version 2.1 of
+ * the License or any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
*
*/
+/**
+ * SECTION:hildon-get-password-dialog
+ * @short_description: A widget used to get a password
+ * @see_also: #HildonSetPasswordDialog
+ *
+ * HildonGetPasswordDialog prompts the user for a password. It allows
+ * inputting password, with an optional configurable label eg. for
+ * showing the domain. The maximum length of the password can be set.
+ */
+
#include <glib.h>
#include <errno.h>
* Returns GType for HildonGetPasswordDialog as produced by
* g_type_register_static().
*
- * Return value: HildonGetPasswordDialog type
- **/
+ * Returns: HildonGetPasswordDialog type
+ */
GType hildon_get_password_dialog_get_type(void)
{
static GType dialog_type = 0;
/**
* hildon_get_password_dialog_new:
* @parent: parent window; can be NULL
- * @get_old_password_title: FALSE creates a new get password dialog and
- * TRUE creates a new get old password dialog
+ * @get_old: FALSE creates a new get password dialog and
+ * TRUE creates a new get old password dialog. That is,
+ * if the password to be obtained is the old password,
+ * this parameter is specified TRUE.
*
* Construct a new HildonGetPasswordDialog.
*
- * Return value: a new #GtkWidget of type HildonGetPasswordDialog
- **/
+ * Returns: a new #GtkWidget of type HildonGetPasswordDialog
+ */
GtkWidget *hildon_get_password_dialog_new(GtkWindow * parent,
- gboolean get_old_password_title)
+ gboolean get_old)
{
HildonGetPasswordDialog *dialog = g_object_new
(HILDON_TYPE_GET_PASSWORD_DIALOG,
- "get-old", get_old_password_title, NULL);
+ "get-old", get_old, NULL);
if (parent != NULL) {
gtk_window_set_transient_for(GTK_WINDOW(dialog), parent);
}
/**
- * hildon_get_password_dialog_new:
+ * hildon_get_password_dialog_new_with_default:
* @parent: parent window; can be NULL
- * @password: a default password to be shown in password field.
- * @get_old_password_title: FALSE creates a new get password dialog and
- * TRUE creates a new get old password dialog
+ * @password: a default password to be shown in password field
+ * @get_old: FALSE creates a new get password dialog and
+ * TRUE creates a new get old password dialog.That is,
+ * if the password to be obtained is the old password,
+ * this parameter is specified TRUE.
+ *
*
* Same as #hildon_get_password_dialog_new but with a default password
* in password field.
*
- * Return value: a new #GtkWidget of type HildonGetPasswordDialog
- **/
+ * Returns: a new #GtkWidget of type HildonGetPasswordDialog
+ */
GtkWidget *hildon_get_password_dialog_new_with_default (GtkWindow * parent,
const gchar *password,
- gboolean get_old_password_title)
+ gboolean get_old)
{
GtkWidget *dialog;
- dialog = hildon_get_password_dialog_new(parent, get_old_password_title);
+ dialog = hildon_get_password_dialog_new(parent, get_old);
if(password != NULL)
g_object_set(G_OBJECT(dialog), "password", password, NULL);
*
* Gets the currently inputted password.
*
- * Return value: current password ( if the dialog is successfully
+ * Returns: current password ( if the dialog is successfully
* accepted with 'OK' )
- **/
+ */
const gchar
*hildon_get_password_dialog_get_password(HildonGetPasswordDialog *
dialog)
/**
* hildon_get_password_dialog_set_domain(GtkWidget *dialog,
* @dialog: the dialog
- * @domain: the domain or some other descriptive text to be set.
+ * @domain: the domain or some other descriptive text to be set
*
- * sets the optional descriptive text
+ * Sets the optional descriptive text.
*/
void hildon_get_password_dialog_set_domain(HildonGetPasswordDialog *dialog,
/**
* hildon_get_password_dialog_set_title:
* @dialog: the dialog
- * @new_title: the text to be set as the dialog title.
+ * @new_title: the text to be set as the dialog title
*
- * sets the dialog title
+ * Sets the dialog title.
+ *
+ * DEPRECATED! use gtk_window_set_title instead.
*/
void hildon_get_password_dialog_set_title(HildonGetPasswordDialog *dialog,
const gchar *new_title)
/**
* hildon_get_password_dialog_set_caption:
* @dialog: the dialog
- * @new_caption: the text to be set as the caption label.
+ * @new_caption: the text to be set as the caption label
*
- * sets the password entry field's neigbouring label.
+ * Sets the password entry field's neigbouring label.
*/
void hildon_get_password_dialog_set_caption(HildonGetPasswordDialog *dialog,
* hildon_get_password_dialog_set_max_characters:
* @dialog: the dialog
* @max_characters: the maximum number of characters the password dialog
- * accepts.
+ * accepts
+ * @new_caption: the text to be set as the caption label
*
* sets the maximum number of characters allowed as the password
*/
projects / hildon / blobdiff