## GnomeDbLogin GnomeDbLogin — Login widget |

## Synopsis

                        GnomeDbLogin;
                        GnomeDbLoginClass;
                        GnomeDbLoginPrivate;
    GtkWidget *         gnome_db_login_new                  (const gchar *dsn);
    const gchar *       gnome_db_login_get_dsn              (GnomeDbLogin *login);
    void                gnome_db_login_set_dsn              (GnomeDbLogin *login,
                                                             const gchar *dsn);
    const gchar *       gnome_db_login_get_auth             (GnomeDbLogin *login);
    void                gnome_db_login_set_auth             (GnomeDbLogin *login,
                                                             const gchar *auth);
    const gchar *       gnome_db_login_get_username         (GnomeDbLogin *login);
    void                gnome_db_login_set_username         (GnomeDbLogin *login,
                                                             const gchar *username);
    const gchar *       gnome_db_login_get_password         (GnomeDbLogin *login);
    void                gnome_db_login_set_password         (GnomeDbLogin *login,
                                                             const gchar *password);
    void                gnome_db_login_set_enable_create_button
                                                            (GnomeDbLogin *login,
                                                             gboolean enable);
    gboolean            gnome_db_login_get_enable_create_button
                                                            (GnomeDbLogin *login);
    void                gnome_db_login_set_show_dsn_selector
                                                            (GnomeDbLogin *login,
                                                             gboolean show);
    gboolean            gnome_db_login_get_show_dsn_selector
                                                            (GnomeDbLogin *login);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBox
                                     +----GtkVBox
                                           +----GnomeDbLogin

## Implemented Interfaces

GnomeDbLogin implements GtkBuildable, GtkOrientable and AtkImplementorIface.

## Properties

      "dsn"                      gchar*                : Read
      "hiding-button"            gboolean              : Read / Write
      "hiding-dsn"               gboolean              : Read / Write
      "password"                 gchar*                : Read
      "username"                 gchar*                : Read

## Signals

      "dsn-changed"                                    : Run First

## Description

## Details

### GnomeDbLogin

    typedef struct _GnomeDbLogin GnomeDbLogin;

### GnomeDbLoginClass

    typedef struct {
    	GtkVBoxClass         parent_class;

    	/* signals */
    	void               (*dsn_changed) (GnomeDbLogin *login);
    } GnomeDbLoginClass;

### GnomeDbLoginPrivate

    typedef struct _GnomeDbLoginPrivate GnomeDbLoginPrivate;

### gnome_db_login_new ()

    GtkWidget *         gnome_db_login_new                  (const gchar *dsn);

`dsn` : |
Returns : |

### gnome_db_login_get_dsn ()

    const gchar *       gnome_db_login_get_dsn              (GnomeDbLogin *login);

`login` : |
Returns : |

### gnome_db_login_set_dsn ()

    void                gnome_db_login_set_dsn              (GnomeDbLogin *login,
                                                             const gchar *dsn);

Set the data source name on the given GnomeDbLogin widget.

`login` : | A GnomeDbLogin widget.
`dsn` : | Data source name.

### gnome_db_login_get_auth ()

    const gchar *       gnome_db_login_get_auth             (GnomeDbLogin *login);

`login` : | a GnomeDbLogin widget
Returns : | the authentication string

### gnome_db_login_set_auth ()

    void                gnome_db_login_set_auth             (GnomeDbLogin *login,
                                                             const gchar *auth);

Update the authentication part of `login` using `auth`

`login` : | a GnomeDbLogin widget
`auth` : | an authentication string, or `NULL`

### gnome_db_login_get_username ()

    const gchar *       gnome_db_login_get_username         (GnomeDbLogin *login);

Get the value currently entered in the username text entry.

`login` : | A GnomeDbLogin widget.
Returns : | the username being entered in the login widget.

### gnome_db_login_set_username ()

    void                gnome_db_login_set_username         (GnomeDbLogin *login,
                                                             const gchar *username);

Sets the user name to be displayed in the given GnomeDbLogin widget.

`login` : | a GnomeDbLogin widget.
`username` : | username to display in the widget.

### gnome_db_login_get_password ()

    const gchar *       gnome_db_login_get_password         (GnomeDbLogin *login);

`login` : |
Returns : |

### gnome_db_login_set_password ()

    void                gnome_db_login_set_password         (GnomeDbLogin *login,
                                                             const gchar *password);

Sets the password to be displayed in the given GnomeDbLogin widget.

`login` : | a GnomeDbLogin widget.
`password` : | password to display in the widget.

### gnome_db_login_set_enable_create_button ()

    void                gnome_db_login_set_enable_create_button
                                                            (GnomeDbLogin *login,
                                                             gboolean enable);

Enable/disable the button allowing the user to create new data sources from the login widget. This button is disabled by default, and when enabled, allows the user to start the database properties configuration applet.

`login` : | A GnomeDbLogin widget.
`enable` : | Flag to enable/disable the button.

### gnome_db_login_get_enable_create_button ()

    gboolean            gnome_db_login_get_enable_create_button
                                                            (GnomeDbLogin *login);

Tell if the the button allowing the user to create new data sources is shown or not. This button is disabled by default,

`login` : | A GnomeDbLogin widget.
Returns : | TRUE if the button is shown

### gnome_db_login_set_show_dsn_selector ()

    void                gnome_db_login_set_show_dsn_selector
                                                            (GnomeDbLogin *login,
                                                             gboolean show);

Show/hide the combo box which allows to select the datasource to log into.

`login` : | A GnomeDbLogin widget.
`show` : |

### gnome_db_login_get_show_dsn_selector ()

    gboolean            gnome_db_login_get_show_dsn_selector
                                                            (GnomeDbLogin *login);

Tells if the combo box which allows to select the datasource to log into is shown or not.

`login` : | A GnomeDbLogin widget.
Returns : | TRUE if the combo box is shown

## Property Details

### The `"dsn"` property

      "dsn"                      gchar*                : Read

Default value: NULL

### The `"hiding-button"` property

      "hiding-button"            gboolean              : Read / Write

Default value: TRUE

### The `"hiding-dsn"` property

      "hiding-dsn"               gboolean              : Read / Write

Default value: FALSE

### The `"password"` property

      "password"                 gchar*                : Read

Default value: NULL

### The `"username"` property

      "username"                 gchar*                : Read

Default value: NULL

## Signal Details

### The `"dsn-changed"` signal

    void                user_function                      (GnomeDbLogin *dblogin,
                                                            gpointer      user_data)      : Run First

`dblogin` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.