<?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="ESourceSelector">
<refmeta>
<refentrytitle role="top_of_page" id="ESourceSelector.top_of_page">ESourceSelector</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATASERVERUI Library</refmiscinfo>
</refmeta>

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

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

<synopsis>
                    <link linkend="ESourceSelector-struct">ESourceSelector</link>;
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="e-source-selector-new">e_source_selector_new</link>               (<link linkend="ESourceList">ESourceList</link> *list);
<link linkend="void">void</link>                <link linkend="e-source-selector-select-source">e_source_selector_select_source</link>     (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
                                                         <link linkend="ESource">ESource</link> *source);
<link linkend="void">void</link>                <link linkend="e-source-selector-unselect-source">e_source_selector_unselect_source</link>   (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
                                                         <link linkend="ESource">ESource</link> *source);
<link linkend="gboolean">gboolean</link>            <link linkend="e-source-selector-source-is-selected">e_source_selector_source_is_selected</link>
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
                                                         <link linkend="ESource">ESource</link> *source);
<link linkend="GSList">GSList</link>*             <link linkend="e-source-selector-get-selection">e_source_selector_get_selection</link>     (<link linkend="ESourceSelector">ESourceSelector</link> *selector);
<link linkend="void">void</link>                <link linkend="e-source-selector-free-selection">e_source_selector_free_selection</link>    (<link linkend="GSList">GSList</link> *list);
<link linkend="void">void</link>                <link linkend="e-source-selector-show-selection">e_source_selector_show_selection</link>    (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
                                                         <link linkend="gboolean">gboolean</link> show);
<link linkend="gboolean">gboolean</link>            <link linkend="e-source-selector-selection-shown">e_source_selector_selection_shown</link>   (<link linkend="ESourceSelector">ESourceSelector</link> *selector);
<link linkend="void">void</link>                <link linkend="e-source-selector-set-select-new">e_source_selector_set_select_new</link>    (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
                                                         <link linkend="gboolean">gboolean</link> state);
<link linkend="ESource">ESource</link>*            <link linkend="e-source-selector-peek-primary-selection">e_source_selector_peek_primary_selection</link>
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector);
<link linkend="void">void</link>                <link linkend="e-source-selector-set-primary-selection">e_source_selector_set_primary_selection</link>
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
                                                         <link linkend="ESource">ESource</link> *source);
<link linkend="ESourceGroup">ESourceGroup</link>*       <link linkend="e-source-selector-get-primary-source-group">e_source_selector_get_primary_source_group</link>
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector);
</synopsis>
</refsynopsisdiv>

<refsect1 id="ESourceSelector.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.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="GtkTreeView">GtkTreeView</link>
                                 +----ESourceSelector
</synopsis>

</refsect1>



<refsect1 id="ESourceSelector.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
ESourceSelector implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>

</refsect1>



<refsect1 id="ESourceSelector.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="ESourceSelector-popup-event">popup-event</link>&quot;                                    : Run Last
  &quot;<link linkend="ESourceSelector-primary-selection-changed">primary-selection-changed</link>&quot;                      : Run Last
  &quot;<link linkend="ESourceSelector-selection-changed">selection-changed</link>&quot;                              : Run Last
</synopsis>
</refsect1>


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

</para>
</refsect1>

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

</para></refsect2>
<refsect2 id="e-source-selector-new" role="function">
<title>e_source_selector_new ()</title>
<indexterm zone="e-source-selector-new"><primary>e_source_selector_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          e_source_selector_new               (<link linkend="ESourceList">ESourceList</link> *list);</programlisting>
<para>
Create a new view for <parameter>list</parameter>.  The view will update automatically when <parameter>list</parameter>
changes.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter>&nbsp;:</term>
<listitem><simpara> A source list.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The newly created widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-source-selector-select-source" role="function">
<title>e_source_selector_select_source ()</title>
<indexterm zone="e-source-selector-select-source"><primary>e_source_selector_select_source</primary></indexterm><programlisting><link linkend="void">void</link>                e_source_selector_select_source     (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
                                                         <link linkend="ESource">ESource</link> *source);</programlisting>
<para>
Select <parameter>source</parameter> in <parameter>selector</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ESource"><type>ESource</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-source-selector-unselect-source" role="function">
<title>e_source_selector_unselect_source ()</title>
<indexterm zone="e-source-selector-unselect-source"><primary>e_source_selector_unselect_source</primary></indexterm><programlisting><link linkend="void">void</link>                e_source_selector_unselect_source   (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
                                                         <link linkend="ESource">ESource</link> *source);</programlisting>
<para>
Unselect <parameter>source</parameter> in <parameter>selector</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ESource"><type>ESource</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-source-selector-source-is-selected" role="function">
<title>e_source_selector_source_is_selected ()</title>
<indexterm zone="e-source-selector-source-is-selected"><primary>e_source_selector_source_is_selected</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_source_selector_source_is_selected
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
                                                         <link linkend="ESource">ESource</link> *source);</programlisting>
<para>
Check whether <parameter>source</parameter> is selected in <parameter>selector</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ESource"><type>ESource</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>source</parameter> is currently selected, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-source-selector-get-selection" role="function">
<title>e_source_selector_get_selection ()</title>
<indexterm zone="e-source-selector-get-selection"><primary>e_source_selector_get_selection</primary></indexterm><programlisting><link linkend="GSList">GSList</link>*             e_source_selector_get_selection     (<link linkend="ESourceSelector">ESourceSelector</link> *selector);</programlisting>
<para>
Get the list of selected sources, i.e. those that were enabled through the
corresponding checkboxes in the tree.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A list of the ESources currently selected.  The sources will
be in the same order as they appear on the screen, and the list should be
freed using <link linkend="e-source-selector-free-selection"><function>e_source_selector_free_selection()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-source-selector-free-selection" role="function">
<title>e_source_selector_free_selection ()</title>
<indexterm zone="e-source-selector-free-selection"><primary>e_source_selector_free_selection</primary></indexterm><programlisting><link linkend="void">void</link>                e_source_selector_free_selection    (<link linkend="GSList">GSList</link> *list);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-source-selector-show-selection" role="function">
<title>e_source_selector_show_selection ()</title>
<indexterm zone="e-source-selector-show-selection"><primary>e_source_selector_show_selection</primary></indexterm><programlisting><link linkend="void">void</link>                e_source_selector_show_selection    (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
                                                         <link linkend="gboolean">gboolean</link> show);</programlisting>
<para>
Specify whether the checkboxes in the ESourceSelector should be shown or
not.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
<listitem><simpara> An ESourceSelector widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>show</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-source-selector-selection-shown" role="function">
<title>e_source_selector_selection_shown ()</title>
<indexterm zone="e-source-selector-selection-shown"><primary>e_source_selector_selection_shown</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_source_selector_selection_shown   (<link linkend="ESourceSelector">ESourceSelector</link> *selector);</programlisting>
<para>
Check whether the checkboxes in the ESourceSelector are being shown or not.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the checkboxes are shown, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-source-selector-set-select-new" role="function">
<title>e_source_selector_set_select_new ()</title>
<indexterm zone="e-source-selector-set-select-new"><primary>e_source_selector_set_select_new</primary></indexterm><programlisting><link linkend="void">void</link>                e_source_selector_set_select_new    (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
                                                         <link linkend="gboolean">gboolean</link> state);</programlisting>
<para>
Set whether or not to select new sources added to <parameter>selector</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter>&nbsp;:</term>
<listitem><simpara> A gboolean
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-source-selector-peek-primary-selection" role="function">
<title>e_source_selector_peek_primary_selection ()</title>
<indexterm zone="e-source-selector-peek-primary-selection"><primary>e_source_selector_peek_primary_selection</primary></indexterm><programlisting><link linkend="ESource">ESource</link>*            e_source_selector_peek_primary_selection
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector);</programlisting>
<para>
Get the primary selected source.  The primary selection is the one that is
highlighted through the normal <link linkend="GtkTreeView"><type>GtkTreeView</type></link> selection mechanism (as opposed
to the "normal" selection, which is the set of source whose checkboxes are
checked).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The selected source.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-source-selector-set-primary-selection" role="function">
<title>e_source_selector_set_primary_selection ()</title>
<indexterm zone="e-source-selector-set-primary-selection"><primary>e_source_selector_set_primary_selection</primary></indexterm><programlisting><link linkend="void">void</link>                e_source_selector_set_primary_selection
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
                                                         <link linkend="ESource">ESource</link> *source);</programlisting>
<para>
Set the primary selected source.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="ESource"><type>ESource</type></link> to select
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-source-selector-get-primary-source-group" role="function">
<title>e_source_selector_get_primary_source_group ()</title>
<indexterm zone="e-source-selector-get-primary-source-group"><primary>e_source_selector_get_primary_source_group</primary></indexterm><programlisting><link linkend="ESourceGroup">ESourceGroup</link>*       e_source_selector_get_primary_source_group
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector);</programlisting>
<para>
Gets the primary source group associated with the selector.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>selector</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> primary_source_group if selector is valid, NULL otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>

<refsect1 id="ESourceSelector.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="ESourceSelector-popup-event"><title>The <literal>&quot;popup-event&quot;</literal> signal</title>
<indexterm zone="ESourceSelector-popup-event"><primary>ESourceSelector::popup-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            user_function                      (<link linkend="ESourceSelector">ESourceSelector</link> *esourceselector,
                                                        <link linkend="GObject">GObject</link>         *arg1,
                                                        <link linkend="GdkEvent">GdkEvent</link>        *event,
                                                        <link linkend="gpointer">gpointer</link>         user_data)            : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>esourceselector</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>event</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>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>

</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="ESourceSelector-primary-selection-changed"><title>The <literal>&quot;primary-selection-changed&quot;</literal> signal</title>
<indexterm zone="ESourceSelector-primary-selection-changed"><primary>ESourceSelector::primary-selection-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ESourceSelector">ESourceSelector</link> *esourceselector,
                                                        <link linkend="gpointer">gpointer</link>         user_data)            : Run Last</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>esourceselector</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><refsect2 id="ESourceSelector-selection-changed"><title>The <literal>&quot;selection-changed&quot;</literal> signal</title>
<indexterm zone="ESourceSelector-selection-changed"><primary>ESourceSelector::selection-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ESourceSelector">ESourceSelector</link> *esourceselector,
                                                        <link linkend="gpointer">gpointer</link>         user_data)            : Run Last</programlisting>
<para>

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