<refentry id="GnomeDbLogin">
<refmeta>
<refentrytitle>GnomeDbLogin</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEDB-4.0 Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GnomeDbLogin</refname><refpurpose>Login widget</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



struct      <link linkend="GnomeDbLogin-struct">GnomeDbLogin</link>;
struct      <link linkend="GnomeDbLoginClass">GnomeDbLoginClass</link>;
struct      <link linkend="GnomeDbLoginPrivate">GnomeDbLoginPrivate</link>;
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gnome-db-login-new">gnome_db_login_new</link>              (const <link linkend="gchar">gchar</link> *dsn);
const <link linkend="gchar">gchar</link>* <link linkend="gnome-db-login-get-dsn">gnome_db_login_get_dsn</link>         (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login);
<link linkend="void">void</link>        <link linkend="gnome-db-login-set-dsn">gnome_db_login_set_dsn</link>          (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login,
                                             const <link linkend="gchar">gchar</link> *dsn);
const <link linkend="gchar">gchar</link>* <link linkend="gnome-db-login-get-auth">gnome_db_login_get_auth</link>        (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login);
<link linkend="void">void</link>        <link linkend="gnome-db-login-set-auth">gnome_db_login_set_auth</link>         (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login,
                                             const <link linkend="gchar">gchar</link> *auth);
const <link linkend="gchar">gchar</link>* <link linkend="gnome-db-login-get-username">gnome_db_login_get_username</link>    (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login);
<link linkend="void">void</link>        <link linkend="gnome-db-login-set-username">gnome_db_login_set_username</link>     (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login,
                                             const <link linkend="gchar">gchar</link> *username);
const <link linkend="gchar">gchar</link>* <link linkend="gnome-db-login-get-password">gnome_db_login_get_password</link>    (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login);
<link linkend="void">void</link>        <link linkend="gnome-db-login-set-password">gnome_db_login_set_password</link>     (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login,
                                             const <link linkend="gchar">gchar</link> *password);
<link linkend="void">void</link>        <link linkend="gnome-db-login-set-enable-create-button">gnome_db_login_set_enable_create_button</link>
                                            (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login,
                                             <link linkend="gboolean">gboolean</link> enable);
<link linkend="gboolean">gboolean</link>    <link linkend="gnome-db-login-get-enable-create-button">gnome_db_login_get_enable_create_button</link>
                                            (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login);
<link linkend="void">void</link>        <link linkend="gnome-db-login-set-show-dsn-selector">gnome_db_login_set_show_dsn_selector</link>
                                            (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login,
                                             <link linkend="gboolean">gboolean</link> show);
<link linkend="gboolean">gboolean</link>    <link linkend="gnome-db-login-get-show-dsn-selector">gnome_db_login_get_show_dsn_selector</link>
                                            (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login);

</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBox">GtkBox</link>
                                 +----<link linkend="GtkVBox">GtkVBox</link>
                                       +----GnomeDbLogin
</synopsis>

</refsect1>



<refsect1>
<title>Implemented Interfaces</title>
<para>
GnomeDbLogin implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>

</refsect1>


<refsect1>
<title>Properties</title>
<synopsis>

  &quot;<link linkend="GnomeDbLogin--dsn">dsn</link>&quot;                  <link linkend="gchararray">gchararray</link>           : Read
  &quot;<link linkend="GnomeDbLogin--hiding-button">hiding-button</link>&quot;        <link linkend="gboolean">gboolean</link>             : Read / Write
  &quot;<link linkend="GnomeDbLogin--hiding-dsn">hiding-dsn</link>&quot;           <link linkend="gboolean">gboolean</link>             : Read / Write
  &quot;<link linkend="GnomeDbLogin--password">password</link>&quot;             <link linkend="gchararray">gchararray</link>           : Read
  &quot;<link linkend="GnomeDbLogin--username">username</link>&quot;             <link linkend="gchararray">gchararray</link>           : Read
</synopsis>
</refsect1>

<refsect1>
<title>Signal Prototypes</title>
<synopsis>

&quot;<link linkend="GnomeDbLogin-dsn-changed">dsn-changed</link>&quot;
            <link linkend="void">void</link>        user_function      (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *dblogin,
                                            <link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsect1>


<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GnomeDbLogin-struct"/>struct GnomeDbLogin</title>
<indexterm><primary>GnomeDbLogin</primary></indexterm><programlisting>struct GnomeDbLogin;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GnomeDbLoginClass"/>struct GnomeDbLoginClass</title>
<indexterm><primary>GnomeDbLoginClass</primary></indexterm><programlisting>struct GnomeDbLoginClass {

	GtkVBoxClass         parent_class;

	/* signals */
	void               (*dsn_changed) (GnomeDbLogin *login);
};
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GnomeDbLoginPrivate"/>struct GnomeDbLoginPrivate</title>
<indexterm><primary>GnomeDbLoginPrivate</primary></indexterm><programlisting>struct GnomeDbLoginPrivate;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gnome-db-login-new"/>gnome_db_login_new ()</title>
<indexterm><primary>gnome_db_login_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gnome_db_login_new              (const <link linkend="gchar">gchar</link> *dsn);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>dsn</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-login-get-dsn"/>gnome_db_login_get_dsn ()</title>
<indexterm><primary>gnome_db_login_get_dsn</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gnome_db_login_get_dsn         (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>login</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-login-set-dsn"/>gnome_db_login_set_dsn ()</title>
<indexterm><primary>gnome_db_login_set_dsn</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_login_set_dsn          (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login,
                                             const <link linkend="gchar">gchar</link> *dsn);</programlisting>
<para>
Set the data source name on the given <link linkend="GnomeDbLogin"><type>GnomeDbLogin</type></link> widget.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>login</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GnomeDbLogin"><type>GnomeDbLogin</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dsn</parameter>&nbsp;:</term>
<listitem><simpara> Data source name.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-login-get-auth"/>gnome_db_login_get_auth ()</title>
<indexterm><primary>gnome_db_login_get_auth</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gnome_db_login_get_auth        (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>login</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbLogin"><type>GnomeDbLogin</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the authentication string
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-login-set-auth"/>gnome_db_login_set_auth ()</title>
<indexterm><primary>gnome_db_login_set_auth</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_login_set_auth         (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login,
                                             const <link linkend="gchar">gchar</link> *auth);</programlisting>
<para>
Update the authentication part of <parameter>login</parameter> using <parameter>auth</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>login</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbLogin"><type>GnomeDbLogin</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>auth</parameter>&nbsp;:</term>
<listitem><simpara> an authentication string, or <literal>NULL</literal>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-login-get-username"/>gnome_db_login_get_username ()</title>
<indexterm><primary>gnome_db_login_get_username</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gnome_db_login_get_username    (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login);</programlisting>
<para>
Get the value currently entered in the username text entry.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>login</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GnomeDbLogin"><type>GnomeDbLogin</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the username being entered in the login widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-login-set-username"/>gnome_db_login_set_username ()</title>
<indexterm><primary>gnome_db_login_set_username</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_login_set_username     (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login,
                                             const <link linkend="gchar">gchar</link> *username);</programlisting>
<para>
Sets the user name to be displayed in the given <link linkend="GnomeDbLogin"><type>GnomeDbLogin</type></link> widget.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>login</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbLogin"><type>GnomeDbLogin</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>username</parameter>&nbsp;:</term>
<listitem><simpara> username to display in the widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-login-get-password"/>gnome_db_login_get_password ()</title>
<indexterm><primary>gnome_db_login_get_password</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gnome_db_login_get_password    (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>login</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-login-set-password"/>gnome_db_login_set_password ()</title>
<indexterm><primary>gnome_db_login_set_password</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_login_set_password     (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login,
                                             const <link linkend="gchar">gchar</link> *password);</programlisting>
<para>
Sets the password to be displayed in the given <link linkend="GnomeDbLogin"><type>GnomeDbLogin</type></link> widget.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>login</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbLogin"><type>GnomeDbLogin</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>password</parameter>&nbsp;:</term>
<listitem><simpara> password to display in the widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-login-set-enable-create-button"/>gnome_db_login_set_enable_create_button ()</title>
<indexterm><primary>gnome_db_login_set_enable_create_button</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_login_set_enable_create_button
                                            (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login,
                                             <link linkend="gboolean">gboolean</link> enable);</programlisting>
<para>
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.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>login</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GnomeDbLogin"><type>GnomeDbLogin</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>enable</parameter>&nbsp;:</term>
<listitem><simpara> Flag to enable/disable the button.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-login-get-enable-create-button"/>gnome_db_login_get_enable_create_button ()</title>
<indexterm><primary>gnome_db_login_get_enable_create_button</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_db_login_get_enable_create_button
                                            (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login);</programlisting>
<para>
Tell if the the button allowing the user to create new data sources is shown
or not. This button is disabled by default,</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>login</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GnomeDbLogin"><type>GnomeDbLogin</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the button is shown
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-login-set-show-dsn-selector"/>gnome_db_login_set_show_dsn_selector ()</title>
<indexterm><primary>gnome_db_login_set_show_dsn_selector</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_login_set_show_dsn_selector
                                            (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login,
                                             <link linkend="gboolean">gboolean</link> show);</programlisting>
<para>
Show/hide the combo box which allows to select the datasource to log into.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>login</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GnomeDbLogin"><type>GnomeDbLogin</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>show</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-login-get-show-dsn-selector"/>gnome_db_login_get_show_dsn_selector ()</title>
<indexterm><primary>gnome_db_login_get_show_dsn_selector</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_db_login_get_show_dsn_selector
                                            (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *login);</programlisting>
<para>
Tells if the combo box which allows to select the datasource to log into is shown
or not.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>login</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GnomeDbLogin"><type>GnomeDbLogin</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the combo box is shown
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1>
<title>Properties</title>
<variablelist>
<varlistentry><term><anchor id="GnomeDbLogin--dsn"/>&quot;<literal>dsn</literal>&quot; (<link linkend="gchararray">gchararray</link> : Read)</term>
<listitem>
<para></para>
</listitem></varlistentry>
<varlistentry><term><anchor id="GnomeDbLogin--hiding-button"/>&quot;<literal>hiding-button</literal>&quot; (<link linkend="gboolean">gboolean</link> : Read / Write)</term>
<listitem>
<para></para>
</listitem></varlistentry>
<varlistentry><term><anchor id="GnomeDbLogin--hiding-dsn"/>&quot;<literal>hiding-dsn</literal>&quot; (<link linkend="gboolean">gboolean</link> : Read / Write)</term>
<listitem>
<para></para>
</listitem></varlistentry>
<varlistentry><term><anchor id="GnomeDbLogin--password"/>&quot;<literal>password</literal>&quot; (<link linkend="gchararray">gchararray</link> : Read)</term>
<listitem>
<para></para>
</listitem></varlistentry>
<varlistentry><term><anchor id="GnomeDbLogin--username"/>&quot;<literal>username</literal>&quot; (<link linkend="gchararray">gchararray</link> : Read)</term>
<listitem>
<para></para>
</listitem></varlistentry>

</variablelist>
</refsect1>

<refsect1>
<title>Signals</title>
<refsect2><title><anchor id="GnomeDbLogin-dsn-changed"/>The &quot;dsn-changed&quot; signal</title>
<programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GnomeDbLogin">GnomeDbLogin</link> *dblogin,
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>dblogin</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>



</refentry>
