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

<refnamediv>
<refname>GnomeDbProviderSpecEditor</refname><refpurpose>Widget to display and edit connection data associated to a database provider</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



struct      <link linkend="GnomeDbProviderSpecEditor-struct">GnomeDbProviderSpecEditor</link>;
struct      <link linkend="GnomeDbProviderSpecEditorClass">GnomeDbProviderSpecEditorClass</link>;
struct      <link linkend="GnomeDbProviderSpecEditorPrivate">GnomeDbProviderSpecEditorPrivate</link>;
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gnome-db-provider-spec-editor-new">gnome_db_provider_spec_editor_new</link>
                                            (const <link linkend="gchar">gchar</link> *provider);
<link linkend="void">void</link>        <link linkend="gnome-db-provider-spec-editor-set-provider">gnome_db_provider_spec_editor_set_provider</link>
                                            (<link linkend="GnomeDbProviderSpecEditor">GnomeDbProviderSpecEditor</link> *spec,
                                             const <link linkend="gchar">gchar</link> *provider);
<link linkend="gboolean">gboolean</link>    <link linkend="gnome-db-provider-spec-editor-is-valid">gnome_db_provider_spec_editor_is_valid</link>
                                            (<link linkend="GnomeDbProviderSpecEditor">GnomeDbProviderSpecEditor</link> *spec);
<link linkend="gchar">gchar</link>*      <link linkend="gnome-db-provider-spec-editor-get-specs">gnome_db_provider_spec_editor_get_specs</link>
                                            (<link linkend="GnomeDbProviderSpecEditor">GnomeDbProviderSpecEditor</link> *spec);
<link linkend="void">void</link>        <link linkend="gnome-db-provider-spec-editor-set-specs">gnome_db_provider_spec_editor_set_specs</link>
                                            (<link linkend="GnomeDbProviderSpecEditor">GnomeDbProviderSpecEditor</link> *spec,
                                             const <link linkend="gchar">gchar</link> *specs_string);

</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>
                                       +----GnomeDbProviderSpecEditor
</synopsis>

</refsect1>



<refsect1>
<title>Implemented Interfaces</title>
<para>
GnomeDbProviderSpecEditor 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="GnomeDbProviderSpecEditor--provider">provider</link>&quot;             <link linkend="gchararray">gchararray</link>           : Read / Write
</synopsis>
</refsect1>

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

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


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

</para>
</refsect1>

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

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

	GtkVBoxClass           parent_class;

	/* signals */
	void                (* changed) (GnomeDbProviderSpecEditor *spec);
};
</programlisting>
<para>

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

</para></refsect2>
<refsect2>
<title><anchor id="gnome-db-provider-spec-editor-new"/>gnome_db_provider_spec_editor_new ()</title>
<indexterm><primary>gnome_db_provider_spec_editor_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gnome_db_provider_spec_editor_new
                                            (const <link linkend="gchar">gchar</link> *provider);</programlisting>
<para>
Creates a new <link linkend="GnomeDbProviderSpecEditor"><type>GnomeDbProviderSpecEditor</type></link> widget</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>provider</parameter>&nbsp;:</term>
<listitem><simpara> the provider to be used 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-provider-spec-editor-set-provider"/>gnome_db_provider_spec_editor_set_provider ()</title>
<indexterm><primary>gnome_db_provider_spec_editor_set_provider</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_provider_spec_editor_set_provider
                                            (<link linkend="GnomeDbProviderSpecEditor">GnomeDbProviderSpecEditor</link> *spec,
                                             const <link linkend="gchar">gchar</link> *provider);</programlisting>
<para>
Updates the displayed fields in <parameter>spec</parameter> to represent the required
and possible arguments that a connection to a database through 
<parameter>provider</parameter> would require</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>spec</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbProviderSpecEditor"><type>GnomeDbProviderSpecEditor</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>provider</parameter>&nbsp;:</term>
<listitem><simpara> the provider to be used 
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-provider-spec-editor-is-valid"/>gnome_db_provider_spec_editor_is_valid ()</title>
<indexterm><primary>gnome_db_provider_spec_editor_is_valid</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_db_provider_spec_editor_is_valid
                                            (<link linkend="GnomeDbProviderSpecEditor">GnomeDbProviderSpecEditor</link> *spec);</programlisting>
<para>
Tells if the current information displayed in <parameter>spec</parameter> respects the
provider's specifications (about non NULL values for example)</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>spec</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbProviderSpecEditor"><type>GnomeDbProviderSpecEditor</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-provider-spec-editor-get-specs"/>gnome_db_provider_spec_editor_get_specs ()</title>
<indexterm><primary>gnome_db_provider_spec_editor_get_specs</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gnome_db_provider_spec_editor_get_specs
                                            (<link linkend="GnomeDbProviderSpecEditor">GnomeDbProviderSpecEditor</link> *spec);</programlisting>
<para>
Get the currently displayed provider's specific
connection string</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>spec</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbProviderSpecEditor"><type>GnomeDbProviderSpecEditor</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new string, or <literal>NULL</literal> if no provider have been specified
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-provider-spec-editor-set-specs"/>gnome_db_provider_spec_editor_set_specs ()</title>
<indexterm><primary>gnome_db_provider_spec_editor_set_specs</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_provider_spec_editor_set_specs
                                            (<link linkend="GnomeDbProviderSpecEditor">GnomeDbProviderSpecEditor</link> *spec,
                                             const <link linkend="gchar">gchar</link> *specs_string);</programlisting>
<para>
Sets the connection string to be displayed in the widget</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>spec</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbProviderSpecEditor"><type>GnomeDbProviderSpecEditor</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>specs_string</parameter>&nbsp;:</term>
<listitem><simpara> 
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1>
<title>Properties</title>
<variablelist>
<varlistentry><term><anchor id="GnomeDbProviderSpecEditor--provider"/>&quot;<literal>provider</literal>&quot; (<link linkend="gchararray">gchararray</link> : Read / Write)</term>
<listitem>
<para></para>
</listitem></varlistentry>

</variablelist>
</refsect1>

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

</para><variablelist role="params">
<varlistentry><term><parameter>dbdsnspec</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>
