<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="ENameSelectorModel">
<refmeta>
<refentrytitle role="top_of_page" id="ENameSelectorModel.top_of_page">ENameSelectorModel</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATASERVERUI Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>ENameSelectorModel</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="ENameSelectorModel.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="ENameSelectorModel-struct">ENameSelectorModel</link>;
<link linkend="ENameSelectorModel">ENameSelectorModel</link>* <link linkend="e-name-selector-model-new">e_name_selector_model_new</link>           (void);
<link linkend="EContactStore">EContactStore</link>*      <link linkend="e-name-selector-model-peek-contact-store">e_name_selector_model_peek_contact_store</link>
                                                        (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *name_selector_model);
<link linkend="ETreeModelGenerator">ETreeModelGenerator</link>* <link linkend="e-name-selector-model-peek-contact-filter">e_name_selector_model_peek_contact_filter</link>
                                                        (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *name_selector_model);
<link linkend="GList">GList</link>*              <link linkend="e-name-selector-model-list-sections">e_name_selector_model_list_sections</link> (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *name_selector_model);
<link linkend="gboolean">gboolean</link>            <link linkend="e-name-selector-model-peek-section">e_name_selector_model_peek_section</link>  (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *name_selector_model,
                                                         const <link linkend="gchar">gchar</link> *name,
                                                         <link linkend="gchar">gchar</link> **pretty_name,
                                                         <link linkend="EDestinationStore">EDestinationStore</link> **destination_store);
<link linkend="void">void</link>                <link linkend="e-name-selector-model-add-section">e_name_selector_model_add_section</link>   (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *name_selector_model,
                                                         const <link linkend="gchar">gchar</link> *name,
                                                         const <link linkend="gchar">gchar</link> *pretty_name,
                                                         <link linkend="EDestinationStore">EDestinationStore</link> *destination_store);
<link linkend="void">void</link>                <link linkend="e-name-selector-model-remove-section">e_name_selector_model_remove_section</link>
                                                        (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *name_selector_model,
                                                         const <link linkend="gchar">gchar</link> *name);
</synopsis>
</refsynopsisdiv>

<refsect1 id="ENameSelectorModel.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----ENameSelectorModel
</synopsis>

</refsect1>






<refsect1 id="ENameSelectorModel.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="ENameSelectorModel-section-added">section-added</link>&quot;                                  : Run Last
  &quot;<link linkend="ENameSelectorModel-section-removed">section-removed</link>&quot;                                : Run Last
</synopsis>
</refsect1>


<refsect1 id="ENameSelectorModel.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="ENameSelectorModel.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="ENameSelectorModel-struct" role="struct">
<title>ENameSelectorModel</title>
<indexterm zone="ENameSelectorModel-struct"><primary>ENameSelectorModel</primary></indexterm><programlisting>typedef struct _ENameSelectorModel ENameSelectorModel;</programlisting>
<para>

</para></refsect2>
<refsect2 id="e-name-selector-model-new" role="function">
<title>e_name_selector_model_new ()</title>
<indexterm zone="e-name-selector-model-new"><primary>e_name_selector_model_new</primary></indexterm><programlisting><link linkend="ENameSelectorModel">ENameSelectorModel</link>* e_name_selector_model_new           (void);</programlisting>
<para>
Creates a new <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-name-selector-model-peek-contact-store" role="function">
<title>e_name_selector_model_peek_contact_store ()</title>
<indexterm zone="e-name-selector-model-peek-contact-store"><primary>e_name_selector_model_peek_contact_store</primary></indexterm><programlisting><link linkend="EContactStore">EContactStore</link>*      e_name_selector_model_peek_contact_store
                                                        (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *name_selector_model);</programlisting>
<para>
Gets the <link linkend="EContactStore"><type>EContactStore</type></link> associated with <parameter>name_selector_model</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>name_selector_model</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="EContactStore"><type>EContactStore</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-name-selector-model-peek-contact-filter" role="function">
<title>e_name_selector_model_peek_contact_filter ()</title>
<indexterm zone="e-name-selector-model-peek-contact-filter"><primary>e_name_selector_model_peek_contact_filter</primary></indexterm><programlisting><link linkend="ETreeModelGenerator">ETreeModelGenerator</link>* e_name_selector_model_peek_contact_filter
                                                        (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *name_selector_model);</programlisting>
<para>
Gets the <link linkend="ETreeModelGenerator"><type>ETreeModelGenerator</type></link> being used to filter and/or extend the
list of contacts in <parameter>name_selector_model</parameter>'s <link linkend="EContactStore"><type>EContactStore</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>name_selector_model</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An <link linkend="ETreeModelGenerator"><type>ETreeModelGenerator</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-name-selector-model-list-sections" role="function">
<title>e_name_selector_model_list_sections ()</title>
<indexterm zone="e-name-selector-model-list-sections"><primary>e_name_selector_model_list_sections</primary></indexterm><programlisting><link linkend="GList">GList</link>*              e_name_selector_model_list_sections (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *name_selector_model);</programlisting>
<para>
Gets a list of the destination sections in <parameter>name_selector_model</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>name_selector_model</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of pointers to strings. The <link linkend="GList"><type>GList</type></link> and the
strings belong to the caller, and must be freed when no longer needed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-name-selector-model-peek-section" role="function">
<title>e_name_selector_model_peek_section ()</title>
<indexterm zone="e-name-selector-model-peek-section"><primary>e_name_selector_model_peek_section</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_name_selector_model_peek_section  (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *name_selector_model,
                                                         const <link linkend="gchar">gchar</link> *name,
                                                         <link linkend="gchar">gchar</link> **pretty_name,
                                                         <link linkend="EDestinationStore">EDestinationStore</link> **destination_store);</programlisting>
<para>
Gets the parameters for a destination section.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>name_selector_model</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> internal name of the section to peek
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pretty_name</parameter>&nbsp;:</term>
<listitem><simpara> location in which to store a pointer to the user-visible name of the section,
or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if undesired.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>destination_store</parameter>&nbsp;:</term>
<listitem><simpara> location in which to store a pointer to the <link linkend="EDestinationStore"><type>EDestinationStore</type></link> being used
by the section, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if undesired
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-name-selector-model-add-section" role="function">
<title>e_name_selector_model_add_section ()</title>
<indexterm zone="e-name-selector-model-add-section"><primary>e_name_selector_model_add_section</primary></indexterm><programlisting><link linkend="void">void</link>                e_name_selector_model_add_section   (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *name_selector_model,
                                                         const <link linkend="gchar">gchar</link> *name,
                                                         const <link linkend="gchar">gchar</link> *pretty_name,
                                                         <link linkend="EDestinationStore">EDestinationStore</link> *destination_store);</programlisting>
<para>
Adds a destination section to <parameter>name_selector_model</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>name_selector_model</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> internal name of this section
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pretty_name</parameter>&nbsp;:</term>
<listitem><simpara> user-visible name of this section
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>destination_store</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="EDestinationStore"><type>EDestinationStore</type></link> to use to store the destinations for this
section, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>name_selector_model</parameter> should create its own.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-name-selector-model-remove-section" role="function">
<title>e_name_selector_model_remove_section ()</title>
<indexterm zone="e-name-selector-model-remove-section"><primary>e_name_selector_model_remove_section</primary></indexterm><programlisting><link linkend="void">void</link>                e_name_selector_model_remove_section
                                                        (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *name_selector_model,
                                                         const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Removes a destination section from <parameter>name_selector_model</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>name_selector_model</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="ENameSelectorModel"><type>ENameSelectorModel</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> internal name of the section to remove
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>

<refsect1 id="ENameSelectorModel.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="ENameSelectorModel-section-added"><title>The <literal>&quot;section-added&quot;</literal> signal</title>
<indexterm zone="ENameSelectorModel-section-added"><primary>ENameSelectorModel::section-added</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *enameselectormodel,
                                                        <link linkend="gchar">gchar</link>              *arg1,
                                                        <link linkend="gpointer">gpointer</link>            user_data)               : Run Last</programlisting>
<para>

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

</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><refsect2 id="ENameSelectorModel-section-removed"><title>The <literal>&quot;section-removed&quot;</literal> signal</title>
<indexterm zone="ENameSelectorModel-section-removed"><primary>ENameSelectorModel::section-removed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ENameSelectorModel">ENameSelectorModel</link> *enameselectormodel,
                                                        <link linkend="gchar">gchar</link>              *arg1,
                                                        <link linkend="gpointer">gpointer</link>            user_data)               : Run Last</programlisting>
<para>

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

</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>
