HildonSetPasswordDialog

HildonSetPasswordDialog — A dialog used to set, change or remove a password.

Synopsis




            HildonSetPasswordDialog;
GtkWidget*  hildon_set_password_dialog_new  (GtkWindow *parent,
                                             gboolean modify_protection);
GtkWidget*  hildon_set_password_dialog_new_with_default
                                            (GtkWindow *parent,
                                             const gchar *password,
                                             gboolean modify_protection);
const gchar* hildon_set_password_dialog_get_password
                                            (HildonSetPasswordDialog *dialog);
gboolean    hildon_set_password_dialog_get_protected
                                            (HildonSetPasswordDialog *dialog);
void        hildon_set_password_dialog_set_message
                                            (HildonSetPasswordDialog *dialog,
                                             const gchar *message);

Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkWindow
                                       +----GtkDialog
                                             +----HildonSetPasswordDialog

Implemented Interfaces

HildonSetPasswordDialog implements GtkBuildable and AtkImplementorIface.

Properties


  "message"              gchararray            : Read / Write
  "modify-protection"    gboolean              : Read / Write / Construct Only
  "password"             gchararray            : Read / Write

Description

HildonSetPasswordDialog allows setting and changing a password.

In Change mode: Dialog is used to change or remove an existing password. Unselecting the check box dims the password fields below it. If the dialog is accepted with 'OK' while the check box is unselected, a Confirmation Note is shown. If the Confirmation Note Dialog is accepted with 'Remove', the password protection is removed.

In Set mode: Set Password Dialog is used to define a password, or change a password that cannot be removed.

Details

HildonSetPasswordDialog

typedef struct _HildonSetPasswordDialog HildonSetPasswordDialog;

hildon_set_password_dialog_new ()

GtkWidget*  hildon_set_password_dialog_new  (GtkWindow *parent,
                                             gboolean modify_protection);

Constructs a new HildonSetPasswordDialog.

parent : parent window; can be NULL
modify_protection : TRUE creates a new change password dialog and FALSE creates a new set password dialog
Returns : a new GtkWidget of type HildonSetPasswordDialog

hildon_set_password_dialog_new_with_default ()

GtkWidget*  hildon_set_password_dialog_new_with_default
                                            (GtkWindow *parent,
                                             const gchar *password,
                                             gboolean modify_protection);

Same as hildon_set_password_dialog_new, but with a default password in password field.

parent : parent window; can be NULL
password : a default password to be shown in password field
modify_protection : TRUE creates a new change password dialog and FALSE creates a new set password dialog
Returns : a new GtkWidget of type HildonSetPasswordDialog

hildon_set_password_dialog_get_password ()

const gchar* hildon_set_password_dialog_get_password
                                            (HildonSetPasswordDialog *dialog);

Returns current password.

dialog : pointer to HildonSetPasswordDialog
Returns : changed password ( if the dialog is successfully accepted with 'OK' ( and when the check box is 'ON' ( in Change Password Dialog ))

hildon_set_password_dialog_get_protected ()

gboolean    hildon_set_password_dialog_get_protected
                                            (HildonSetPasswordDialog *dialog);

Returns the protection mode.

dialog : pointer to HildonSetPasswordDialog
Returns : password protection mode ( TRUE when the protection is 'ON' and FALSE when the protection is 'OFF' )

hildon_set_password_dialog_set_message ()

void        hildon_set_password_dialog_set_message
                                            (HildonSetPasswordDialog *dialog,
                                             const gchar *message);

Sets the optional descriptive text.

dialog : the dialog
message : the message or some other descriptive text to be set

Property Details

The "message" property

  "message"              gchararray            : Read / Write

A message to display to the user.

Default value: NULL

The "modify-protection" property

  "modify-protection"    gboolean              : Read / Write / Construct Only

Password type.

Default value: TRUE

The "password" property

  "password"             gchararray            : Read / Write

Content of the password field.

Default value: "DEFAULT"

See Also

HildonGetPasswordDialog