← Back to branch summary

~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/libedataserverui/xml/e-source-selector.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserverui/xml/e-source-selector.xml
5
5
<refmeta>
6
6
<refentrytitle role="top_of_page" id="ESourceSelector.top_of_page">ESourceSelector</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>LIBEDATASERVERUI Library</refmiscinfo>
 
8
<refmiscinfo>
 
9
  LIBEDATASERVERUI Library
 
10
</refmiscinfo>
9
11
</refmeta>
10
 
 
11
12
<refnamediv>
12
13
<refname>ESourceSelector</refname>
13
14
<refpurpose></refpurpose>
16
17
<refsynopsisdiv id="ESourceSelector.synopsis" role="synopsis">
17
18
<title role="synopsis.title">Synopsis</title>
18
19
 
19
 
<synopsis>
20
 
                    <link linkend="ESourceSelector-struct">ESourceSelector</link>;
21
 
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="e-source-selector-new">e_source_selector_new</link>               (<link linkend="ESourceList">ESourceList</link> *list);
22
 
<link linkend="ESourceList">ESourceList</link> *       <link linkend="e-source-selector-get-source-list">e_source_selector_get_source_list</link>   (<link linkend="ESourceSelector">ESourceSelector</link> *selector);
23
 
<link linkend="void">void</link>                <link linkend="e-source-selector-select-source">e_source_selector_select_source</link>     (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
24
 
                                                         <link linkend="ESource">ESource</link> *source);
25
 
<link linkend="void">void</link>                <link linkend="e-source-selector-unselect-source">e_source_selector_unselect_source</link>   (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
26
 
                                                         <link linkend="ESource">ESource</link> *source);
27
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-source-selector-source-is-selected">e_source_selector_source_is_selected</link>
28
 
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
29
 
                                                         <link linkend="ESource">ESource</link> *source);
30
 
<link linkend="GSList">GSList</link> *            <link linkend="e-source-selector-get-selection">e_source_selector_get_selection</link>     (<link linkend="ESourceSelector">ESourceSelector</link> *selector);
31
 
<link linkend="void">void</link>                <link linkend="e-source-selector-free-selection">e_source_selector_free_selection</link>    (<link linkend="GSList">GSList</link> *list);
32
 
<link linkend="void">void</link>                <link linkend="e-source-selector-show-selection">e_source_selector_show_selection</link>    (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
33
 
                                                         <link linkend="gboolean">gboolean</link> show);
34
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-source-selector-selection-shown">e_source_selector_selection_shown</link>   (<link linkend="ESourceSelector">ESourceSelector</link> *selector);
35
 
<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,
36
 
                                                         <link linkend="gboolean">gboolean</link> state);
37
 
<link linkend="void">void</link>                <link linkend="e-source-selector-edit-primary-selection">e_source_selector_edit_primary_selection</link>
38
 
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector);
39
 
<link linkend="ESource">ESource</link> *           <link linkend="e-source-selector-peek-primary-selection">e_source_selector_peek_primary_selection</link>
40
 
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector);
41
 
<link linkend="void">void</link>                <link linkend="e-source-selector-set-primary-selection">e_source_selector_set_primary_selection</link>
42
 
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
43
 
                                                         <link linkend="ESource">ESource</link> *source);
44
 
<link linkend="ESourceGroup">ESourceGroup</link> *      <link linkend="e-source-selector-get-primary-source-group">e_source_selector_get_primary_source_group</link>
45
 
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector);
 
20
<synopsis>                    <link linkend="ESourceSelector-struct">ESourceSelector</link>;
 
21
<link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link> *         <link linkend="e-source-selector-new">e_source_selector_new</link>               (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>);
 
22
<link linkend="ESourceList"><returnvalue>ESourceList</returnvalue></link> *       <link linkend="e-source-selector-get-source-list">e_source_selector_get_source_list</link>   (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>);
 
23
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-source-selector-select-source">e_source_selector_select_source</link>     (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>,
 
24
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
 
25
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-source-selector-unselect-source">e_source_selector_unselect_source</link>   (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>,
 
26
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
 
27
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-selector-source-is-selected">e_source_selector_source_is_selected</link>
 
28
                                                        (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>,
 
29
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
 
30
<link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            <link linkend="e-source-selector-get-selection">e_source_selector_get_selection</link>     (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>);
 
31
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-source-selector-free-selection">e_source_selector_free_selection</link>    (<parameter><link linkend="GSList"><type>GSList</type></link> *list</parameter>);
 
32
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-source-selector-show-selection">e_source_selector_show_selection</link>    (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>,
 
33
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> show</parameter>);
 
34
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-source-selector-selection-shown">e_source_selector_selection_shown</link>   (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>);
 
35
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-source-selector-set-select-new">e_source_selector_set_select_new</link>    (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>,
 
36
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> state</parameter>);
 
37
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-source-selector-edit-primary-selection">e_source_selector_edit_primary_selection</link>
 
38
                                                        (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>);
 
39
<link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           <link linkend="e-source-selector-peek-primary-selection">e_source_selector_peek_primary_selection</link>
 
40
                                                        (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>);
 
41
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-source-selector-set-primary-selection">e_source_selector_set_primary_selection</link>
 
42
                                                        (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>,
 
43
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);
 
44
<link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      <link linkend="e-source-selector-get-primary-source-group">e_source_selector_get_primary_source_group</link>
 
45
                                                        (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>);
46
46
</synopsis>
47
47
</refsynopsisdiv>
48
 
 
49
48
<refsect1 id="ESourceSelector.object-hierarchy" role="object_hierarchy">
50
49
<title role="object_hierarchy.title">Object Hierarchy</title>
51
50
<synopsis>
58
57
                                 +----ESourceSelector
59
58
</synopsis>
60
59
</refsect1>
61
 
 
62
 
 
63
 
 
64
60
<refsect1 id="ESourceSelector.implemented-interfaces" role="impl_interfaces">
65
61
<title role="impl_interfaces.title">Implemented Interfaces</title>
66
62
<para>
67
63
ESourceSelector implements
68
 
 <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
 
64
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
69
65
</refsect1>
70
 
 
71
 
 
72
66
<refsect1 id="ESourceSelector.properties" role="properties">
73
67
<title role="properties.title">Properties</title>
74
68
<synopsis>
75
 
  &quot;<link linkend="ESourceSelector--source-list">source-list</link>&quot;              <link linkend="ESourceList">ESourceList</link>*          : Read / Write / Construct Only
 
69
  &quot;<link linkend="ESourceSelector--source-list">source-list</link>&quot;              <link linkend="ESourceList"><type>ESourceList</type></link>*          : Read / Write / Construct Only
76
70
</synopsis>
77
71
</refsect1>
78
 
 
79
72
<refsect1 id="ESourceSelector.signals" role="signal_proto">
80
73
<title role="signal_proto.title">Signals</title>
81
74
<synopsis>
86
79
</synopsis>
87
80
</refsect1>
88
81
 
89
 
 
90
82
<refsect1 id="ESourceSelector.description" role="desc">
91
83
<title role="desc.title">Description</title>
92
84
<para>
93
85
</para>
94
86
</refsect1>
95
 
 
96
87
<refsect1 id="ESourceSelector.details" role="details">
97
88
<title role="details.title">Details</title>
98
89
<refsect2 id="ESourceSelector-struct" role="struct">
99
90
<title>ESourceSelector</title>
100
 
<indexterm zone="ESourceSelector-struct"><primary sortas="ESourceSelector">ESourceSelector</primary></indexterm><programlisting>typedef struct _ESourceSelector ESourceSelector;</programlisting>
 
91
<indexterm zone="ESourceSelector-struct"><primary>ESourceSelector</primary></indexterm>
 
92
<programlisting>typedef struct _ESourceSelector ESourceSelector;</programlisting>
101
93
<para>
102
94
</para></refsect2>
103
95
<refsect2 id="e-source-selector-new" role="function">
104
96
<title>e_source_selector_new ()</title>
105
 
<indexterm zone="e-source-selector-new"><primary sortas="e_source_selector_new">e_source_selector_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         e_source_selector_new               (<link linkend="ESourceList">ESourceList</link> *list);</programlisting>
 
97
<indexterm zone="e-source-selector-new"><primary>e_source_selector_new</primary></indexterm>
 
98
<programlisting><link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link> *         e_source_selector_new               (<parameter><link linkend="ESourceList"><type>ESourceList</type></link> *list</parameter>);</programlisting>
106
99
<para>
107
100
Create a new view for <parameter>list</parameter>.  The view will update automatically when <parameter>list</parameter>
108
101
changes.</para>
109
 
<para>
110
 
</para><variablelist role="params">
 
102
<variablelist role="params">
111
103
<varlistentry><term><parameter>list</parameter>&#160;:</term>
112
 
<listitem><simpara> A source list.
 
104
<listitem><simpara>A source list.
113
105
</simpara></listitem></varlistentry>
114
106
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly created widget.
115
107
</simpara></listitem></varlistentry>
116
108
</variablelist></refsect2>
117
109
<refsect2 id="e-source-selector-get-source-list" role="function">
118
110
<title>e_source_selector_get_source_list ()</title>
119
 
<indexterm zone="e-source-selector-get-source-list"><primary sortas="e_source_selector_get_source_list">e_source_selector_get_source_list</primary></indexterm><programlisting><link linkend="ESourceList">ESourceList</link> *       e_source_selector_get_source_list   (<link linkend="ESourceSelector">ESourceSelector</link> *selector);</programlisting>
 
111
<indexterm zone="e-source-selector-get-source-list"><primary>e_source_selector_get_source_list</primary></indexterm>
 
112
<programlisting><link linkend="ESourceList"><returnvalue>ESourceList</returnvalue></link> *       e_source_selector_get_source_list   (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>);</programlisting>
120
113
<para>
121
114
Returns the <link linkend="ESourceList"><type>ESourceList</type></link> that <parameter>selector</parameter> is rendering.</para>
122
 
<para>
123
 
</para><variablelist role="params">
 
115
<variablelist role="params">
124
116
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
125
 
<listitem><simpara> an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
 
117
<listitem><simpara>an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
126
118
</simpara></listitem></varlistentry>
127
119
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an <link linkend="ESourceList"><type>ESourceList</type></link>
128
120
</simpara></listitem></varlistentry>
129
121
</variablelist></refsect2>
130
122
<refsect2 id="e-source-selector-select-source" role="function">
131
123
<title>e_source_selector_select_source ()</title>
132
 
<indexterm zone="e-source-selector-select-source"><primary sortas="e_source_selector_select_source">e_source_selector_select_source</primary></indexterm><programlisting><link linkend="void">void</link>                e_source_selector_select_source     (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
133
 
                                                         <link linkend="ESource">ESource</link> *source);</programlisting>
 
124
<indexterm zone="e-source-selector-select-source"><primary>e_source_selector_select_source</primary></indexterm>
 
125
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_source_selector_select_source     (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>,
 
126
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
134
127
<para>
135
128
Select <parameter>source</parameter> in <parameter>selector</parameter>.</para>
136
 
<para>
137
 
</para><variablelist role="params">
 
129
<variablelist role="params">
138
130
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
139
 
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
 
131
<listitem><simpara>An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
140
132
</simpara></listitem></varlistentry>
141
133
<varlistentry><term><parameter>source</parameter>&#160;:</term>
142
 
<listitem><simpara> An <link linkend="ESource"><type>ESource</type></link>.
 
134
<listitem><simpara>An <link linkend="ESource"><type>ESource</type></link>.
143
135
</simpara></listitem></varlistentry>
144
136
</variablelist></refsect2>
145
137
<refsect2 id="e-source-selector-unselect-source" role="function">
146
138
<title>e_source_selector_unselect_source ()</title>
147
 
<indexterm zone="e-source-selector-unselect-source"><primary sortas="e_source_selector_unselect_source">e_source_selector_unselect_source</primary></indexterm><programlisting><link linkend="void">void</link>                e_source_selector_unselect_source   (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
148
 
                                                         <link linkend="ESource">ESource</link> *source);</programlisting>
 
139
<indexterm zone="e-source-selector-unselect-source"><primary>e_source_selector_unselect_source</primary></indexterm>
 
140
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_source_selector_unselect_source   (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>,
 
141
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
149
142
<para>
150
143
Unselect <parameter>source</parameter> in <parameter>selector</parameter>.</para>
151
 
<para>
152
 
</para><variablelist role="params">
 
144
<variablelist role="params">
153
145
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
154
 
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
 
146
<listitem><simpara>An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
155
147
</simpara></listitem></varlistentry>
156
148
<varlistentry><term><parameter>source</parameter>&#160;:</term>
157
 
<listitem><simpara> An <link linkend="ESource"><type>ESource</type></link>.
 
149
<listitem><simpara>An <link linkend="ESource"><type>ESource</type></link>.
158
150
</simpara></listitem></varlistentry>
159
151
</variablelist></refsect2>
160
152
<refsect2 id="e-source-selector-source-is-selected" role="function">
161
153
<title>e_source_selector_source_is_selected ()</title>
162
 
<indexterm zone="e-source-selector-source-is-selected"><primary sortas="e_source_selector_source_is_selected">e_source_selector_source_is_selected</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_source_selector_source_is_selected
163
 
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
164
 
                                                         <link linkend="ESource">ESource</link> *source);</programlisting>
 
154
<indexterm zone="e-source-selector-source-is-selected"><primary>e_source_selector_source_is_selected</primary></indexterm>
 
155
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_selector_source_is_selected
 
156
                                                        (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>,
 
157
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
165
158
<para>
166
159
Check whether <parameter>source</parameter> is selected in <parameter>selector</parameter>.</para>
167
 
<para>
168
 
</para><variablelist role="params">
 
160
<variablelist role="params">
169
161
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
170
 
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
 
162
<listitem><simpara>An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
171
163
</simpara></listitem></varlistentry>
172
164
<varlistentry><term><parameter>source</parameter>&#160;:</term>
173
 
<listitem><simpara> An <link linkend="ESource"><type>ESource</type></link>.
 
165
<listitem><simpara>An <link linkend="ESource"><type>ESource</type></link>.
174
166
</simpara></listitem></varlistentry>
175
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</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.
 
167
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</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.
176
168
</simpara></listitem></varlistentry>
177
169
</variablelist></refsect2>
178
170
<refsect2 id="e-source-selector-get-selection" role="function">
179
171
<title>e_source_selector_get_selection ()</title>
180
 
<indexterm zone="e-source-selector-get-selection"><primary sortas="e_source_selector_get_selection">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>
 
172
<indexterm zone="e-source-selector-get-selection"><primary>e_source_selector_get_selection</primary></indexterm>
 
173
<programlisting><link linkend="GSList"><returnvalue>GSList</returnvalue></link> *            e_source_selector_get_selection     (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>);</programlisting>
181
174
<para>
182
175
Get the list of selected sources, i.e. those that were enabled through the
183
176
corresponding checkboxes in the tree.</para>
184
 
<para>
185
 
</para><variablelist role="params">
 
177
<variablelist role="params">
186
178
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
187
 
<listitem><simpara> an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
 
179
<listitem><simpara>an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
188
180
</simpara></listitem></varlistentry>
189
181
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A list of the ESources currently selected.  The sources will
190
182
be in the same order as they appear on the screen, and the list should be
193
185
</variablelist></refsect2>
194
186
<refsect2 id="e-source-selector-free-selection" role="function">
195
187
<title>e_source_selector_free_selection ()</title>
196
 
<indexterm zone="e-source-selector-free-selection"><primary sortas="e_source_selector_free_selection">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>
 
188
<indexterm zone="e-source-selector-free-selection"><primary>e_source_selector_free_selection</primary></indexterm>
 
189
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_source_selector_free_selection    (<parameter><link linkend="GSList"><type>GSList</type></link> *list</parameter>);</programlisting>
197
190
<para>
198
191
</para><variablelist role="params">
199
192
<varlistentry><term><parameter>list</parameter>&#160;:</term>
202
195
</variablelist></refsect2>
203
196
<refsect2 id="e-source-selector-show-selection" role="function">
204
197
<title>e_source_selector_show_selection ()</title>
205
 
<indexterm zone="e-source-selector-show-selection"><primary sortas="e_source_selector_show_selection">e_source_selector_show_selection</primary></indexterm><programlisting><link linkend="void">void</link>                e_source_selector_show_selection    (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
206
 
                                                         <link linkend="gboolean">gboolean</link> show);</programlisting>
 
198
<indexterm zone="e-source-selector-show-selection"><primary>e_source_selector_show_selection</primary></indexterm>
 
199
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_source_selector_show_selection    (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>,
 
200
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> show</parameter>);</programlisting>
207
201
<para>
208
202
Specify whether the checkboxes in the ESourceSelector should be shown or
209
203
not.</para>
210
 
<para>
211
 
</para><variablelist role="params">
 
204
<variablelist role="params">
212
205
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
213
 
<listitem><simpara> An ESourceSelector widget
 
206
<listitem><simpara>An ESourceSelector widget
214
207
</simpara></listitem></varlistentry>
215
208
<varlistentry><term><parameter>show</parameter>&#160;:</term>
216
209
<listitem><simpara>
218
211
</variablelist></refsect2>
219
212
<refsect2 id="e-source-selector-selection-shown" role="function">
220
213
<title>e_source_selector_selection_shown ()</title>
221
 
<indexterm zone="e-source-selector-selection-shown"><primary sortas="e_source_selector_selection_shown">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>
 
214
<indexterm zone="e-source-selector-selection-shown"><primary>e_source_selector_selection_shown</primary></indexterm>
 
215
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_source_selector_selection_shown   (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>);</programlisting>
222
216
<para>
223
217
Check whether the checkboxes in the ESourceSelector are being shown or not.</para>
224
 
<para>
225
 
</para><variablelist role="params">
 
218
<variablelist role="params">
226
219
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
227
 
<listitem><simpara> an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
 
220
<listitem><simpara>an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
228
221
</simpara></listitem></varlistentry>
229
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</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.
 
222
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</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.
230
223
</simpara></listitem></varlistentry>
231
224
</variablelist></refsect2>
232
225
<refsect2 id="e-source-selector-set-select-new" role="function">
233
226
<title>e_source_selector_set_select_new ()</title>
234
 
<indexterm zone="e-source-selector-set-select-new"><primary sortas="e_source_selector_set_select_new">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,
235
 
                                                         <link linkend="gboolean">gboolean</link> state);</programlisting>
 
227
<indexterm zone="e-source-selector-set-select-new"><primary>e_source_selector_set_select_new</primary></indexterm>
 
228
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_source_selector_set_select_new    (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>,
 
229
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> state</parameter>);</programlisting>
236
230
<para>
237
231
Set whether or not to select new sources added to <parameter>selector</parameter>.</para>
238
 
<para>
239
 
</para><variablelist role="params">
 
232
<variablelist role="params">
240
233
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
241
 
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
 
234
<listitem><simpara>An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
242
235
</simpara></listitem></varlistentry>
243
236
<varlistentry><term><parameter>state</parameter>&#160;:</term>
244
 
<listitem><simpara> A gboolean
 
237
<listitem><simpara>A gboolean
245
238
</simpara></listitem></varlistentry>
246
239
</variablelist></refsect2>
247
240
<refsect2 id="e-source-selector-edit-primary-selection" role="function">
248
241
<title>e_source_selector_edit_primary_selection ()</title>
249
 
<indexterm zone="e-source-selector-edit-primary-selection"><primary sortas="e_source_selector_edit_primary_selection">e_source_selector_edit_primary_selection</primary></indexterm><programlisting><link linkend="void">void</link>                e_source_selector_edit_primary_selection
250
 
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector);</programlisting>
 
242
<indexterm zone="e-source-selector-edit-primary-selection"><primary>e_source_selector_edit_primary_selection</primary></indexterm>
 
243
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_source_selector_edit_primary_selection
 
244
                                                        (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>);</programlisting>
251
245
<para>
252
246
Allows the user to rename the primary selected source by opening an
253
247
entry box directly in <parameter>selector</parameter>.</para>
254
 
<para>
255
 
</para><variablelist role="params">
 
248
<variablelist role="params">
256
249
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
257
 
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
 
250
<listitem><simpara>An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
258
251
</simpara></listitem></varlistentry>
259
252
</variablelist></refsect2>
260
253
<refsect2 id="e-source-selector-peek-primary-selection" role="function">
261
254
<title>e_source_selector_peek_primary_selection ()</title>
262
 
<indexterm zone="e-source-selector-peek-primary-selection"><primary sortas="e_source_selector_peek_primary_selection">e_source_selector_peek_primary_selection</primary></indexterm><programlisting><link linkend="ESource">ESource</link> *           e_source_selector_peek_primary_selection
263
 
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector);</programlisting>
 
255
<indexterm zone="e-source-selector-peek-primary-selection"><primary>e_source_selector_peek_primary_selection</primary></indexterm>
 
256
<programlisting><link linkend="ESource"><returnvalue>ESource</returnvalue></link> *           e_source_selector_peek_primary_selection
 
257
                                                        (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>);</programlisting>
264
258
<para>
265
259
Get the primary selected source.  The primary selection is the one that is
266
260
highlighted through the normal <link linkend="GtkTreeView"><type>GtkTreeView</type></link> selection mechanism (as opposed
267
261
to the "normal" selection, which is the set of source whose checkboxes are
268
262
checked).</para>
269
 
<para>
270
 
</para><variablelist role="params">
 
263
<variablelist role="params">
271
264
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
272
 
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
 
265
<listitem><simpara>An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
273
266
</simpara></listitem></varlistentry>
274
267
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The selected source.
275
268
</simpara></listitem></varlistentry>
276
269
</variablelist></refsect2>
277
270
<refsect2 id="e-source-selector-set-primary-selection" role="function">
278
271
<title>e_source_selector_set_primary_selection ()</title>
279
 
<indexterm zone="e-source-selector-set-primary-selection"><primary sortas="e_source_selector_set_primary_selection">e_source_selector_set_primary_selection</primary></indexterm><programlisting><link linkend="void">void</link>                e_source_selector_set_primary_selection
280
 
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector,
281
 
                                                         <link linkend="ESource">ESource</link> *source);</programlisting>
 
272
<indexterm zone="e-source-selector-set-primary-selection"><primary>e_source_selector_set_primary_selection</primary></indexterm>
 
273
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_source_selector_set_primary_selection
 
274
                                                        (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>,
 
275
                                                         <parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>);</programlisting>
282
276
<para>
283
277
Set the primary selected source.</para>
284
 
<para>
285
 
</para><variablelist role="params">
 
278
<variablelist role="params">
286
279
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
287
 
<listitem><simpara> an <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
 
280
<listitem><simpara>an <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
288
281
</simpara></listitem></varlistentry>
289
282
<varlistentry><term><parameter>source</parameter>&#160;:</term>
290
 
<listitem><simpara> an <link linkend="ESource"><type>ESource</type></link> to select
 
283
<listitem><simpara>an <link linkend="ESource"><type>ESource</type></link> to select
291
284
</simpara></listitem></varlistentry>
292
285
</variablelist></refsect2>
293
286
<refsect2 id="e-source-selector-get-primary-source-group" role="function">
294
287
<title>e_source_selector_get_primary_source_group ()</title>
295
 
<indexterm zone="e-source-selector-get-primary-source-group"><primary sortas="e_source_selector_get_primary_source_group">e_source_selector_get_primary_source_group</primary></indexterm><programlisting><link linkend="ESourceGroup">ESourceGroup</link> *      e_source_selector_get_primary_source_group
296
 
                                                        (<link linkend="ESourceSelector">ESourceSelector</link> *selector);</programlisting>
 
288
<indexterm zone="e-source-selector-get-primary-source-group"><primary>e_source_selector_get_primary_source_group</primary></indexterm>
 
289
<programlisting><link linkend="ESourceGroup"><returnvalue>ESourceGroup</returnvalue></link> *      e_source_selector_get_primary_source_group
 
290
                                                        (<parameter><link linkend="ESourceSelector"><type>ESourceSelector</type></link> *selector</parameter>);</programlisting>
297
291
<para>
298
292
Gets the primary source group associated with the selector.</para>
299
 
<para>
300
 
</para><variablelist role="params">
 
293
<variablelist role="params">
301
294
<varlistentry><term><parameter>selector</parameter>&#160;:</term>
302
 
<listitem><simpara> an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
 
295
<listitem><simpara>an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
303
296
</simpara></listitem></varlistentry>
304
297
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> primary_source_group if selector is valid, NULL otherwise.
305
298
</simpara></listitem></varlistentry>
309
302
<refsect1 id="ESourceSelector.property-details" role="property_details">
310
303
<title role="property_details.title">Property Details</title>
311
304
<refsect2 id="ESourceSelector--source-list" role="property"><title>The <literal>&quot;source-list&quot;</literal> property</title>
312
 
<indexterm zone="ESourceSelector--source-list"><primary sortas="ESourceSelector:source-list">ESourceSelector:source-list</primary></indexterm><programlisting>  &quot;source-list&quot;              <link linkend="ESourceList">ESourceList</link>*          : Read / Write / Construct Only</programlisting>
 
305
<indexterm zone="ESourceSelector--source-list"><primary>ESourceSelector:source-list</primary></indexterm>
 
306
<programlisting>  &quot;source-list&quot;              <link linkend="ESourceList"><type>ESourceList</type></link>*          : Read / Write / Construct Only</programlisting>
313
307
<para></para></refsect2>
314
308
</refsect1>
315
 
 
316
309
<refsect1 id="ESourceSelector.signal-details" role="signals">
317
310
<title role="signals.title">Signal Details</title>
318
311
<refsect2 id="ESourceSelector-data-dropped" role="signal"><title>The <literal>&quot;data-dropped&quot;</literal> signal</title>
319
 
<indexterm zone="ESourceSelector-data-dropped"><primary sortas="ESourceSelector::data-dropped">ESourceSelector::data-dropped</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            user_function                      (<link linkend="ESourceSelector">ESourceSelector</link>  *esourceselector,
320
 
                                                        <link linkend="GtkSelectionData">GtkSelectionData</link> *arg1,
321
 
                                                        <link linkend="ESource">ESource</link>          *arg2,
322
 
                                                        <link linkend="GdkDragAction">GdkDragAction</link>     arg3,
323
 
                                                        <link linkend="guint">guint</link>             arg4,
324
 
                                                        <link linkend="gpointer">gpointer</link>          user_data)            : Run Last</programlisting>
 
312
<indexterm zone="ESourceSelector-data-dropped"><primary>ESourceSelector::data-dropped</primary></indexterm>
 
313
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            user_function                      (<link linkend="ESourceSelector"><type>ESourceSelector</type></link>  *esourceselector,
 
314
                                                        <link linkend="GtkSelectionData"><type>GtkSelectionData</type></link> *arg1,
 
315
                                                        <link linkend="ESource"><type>ESource</type></link>          *arg2,
 
316
                                                        <link linkend="GdkDragAction"><type>GdkDragAction</type></link>     arg3,
 
317
                                                        <link linkend="guint"><type>guint</type></link>             arg4,
 
318
                                                        <link linkend="gpointer"><type>gpointer</type></link>          user_data)            : Run Last</programlisting>
325
319
<para>
326
320
</para><variablelist role="params">
327
321
<varlistentry><term><parameter>esourceselector</parameter>&#160;:</term>
344
338
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
345
339
</simpara></listitem></varlistentry>
346
340
</variablelist></refsect2><refsect2 id="ESourceSelector-popup-event" role="signal"><title>The <literal>&quot;popup-event&quot;</literal> signal</title>
347
 
<indexterm zone="ESourceSelector-popup-event"><primary sortas="ESourceSelector::popup-event">ESourceSelector::popup-event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            user_function                      (<link linkend="ESourceSelector">ESourceSelector</link> *esourceselector,
348
 
                                                        <link linkend="GObject">GObject</link>         *arg1,
349
 
                                                        <link linkend="GdkEvent">GdkEvent</link>        *event,
350
 
                                                        <link linkend="gpointer">gpointer</link>         user_data)            : Run Last</programlisting>
 
341
<indexterm zone="ESourceSelector-popup-event"><primary>ESourceSelector::popup-event</primary></indexterm>
 
342
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            user_function                      (<link linkend="ESourceSelector"><type>ESourceSelector</type></link> *esourceselector,
 
343
                                                        <link linkend="GObject"><type>GObject</type></link>         *arg1,
 
344
                                                        <link linkend="GdkEvent"><type>GdkEvent</type></link>        *event,
 
345
                                                        <link linkend="gpointer"><type>gpointer</type></link>         user_data)            : Run Last</programlisting>
351
346
<para>
352
347
</para><variablelist role="params">
353
348
<varlistentry><term><parameter>esourceselector</parameter>&#160;:</term>
364
359
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
365
360
</simpara></listitem></varlistentry>
366
361
</variablelist></refsect2><refsect2 id="ESourceSelector-primary-selection-changed" role="signal"><title>The <literal>&quot;primary-selection-changed&quot;</literal> signal</title>
367
 
<indexterm zone="ESourceSelector-primary-selection-changed"><primary sortas="ESourceSelector::primary-selection-changed">ESourceSelector::primary-selection-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ESourceSelector">ESourceSelector</link> *esourceselector,
368
 
                                                        <link linkend="gpointer">gpointer</link>         user_data)            : Run Last</programlisting>
 
362
<indexterm zone="ESourceSelector-primary-selection-changed"><primary>ESourceSelector::primary-selection-changed</primary></indexterm>
 
363
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ESourceSelector"><type>ESourceSelector</type></link> *esourceselector,
 
364
                                                        <link linkend="gpointer"><type>gpointer</type></link>         user_data)            : Run Last</programlisting>
369
365
<para>
370
366
</para><variablelist role="params">
371
367
<varlistentry><term><parameter>esourceselector</parameter>&#160;:</term>
374
370
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
375
371
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
376
372
</variablelist></refsect2><refsect2 id="ESourceSelector-selection-changed" role="signal"><title>The <literal>&quot;selection-changed&quot;</literal> signal</title>
377
 
<indexterm zone="ESourceSelector-selection-changed"><primary sortas="ESourceSelector::selection-changed">ESourceSelector::selection-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="ESourceSelector">ESourceSelector</link> *esourceselector,
378
 
                                                        <link linkend="gpointer">gpointer</link>         user_data)            : Run Last</programlisting>
 
373
<indexterm zone="ESourceSelector-selection-changed"><primary>ESourceSelector::selection-changed</primary></indexterm>
 
374
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="ESourceSelector"><type>ESourceSelector</type></link> *esourceselector,
 
375
                                                        <link linkend="gpointer"><type>gpointer</type></link>         user_data)            : Run Last</programlisting>
379
376
<para>
380
377
</para><variablelist role="params">
381
378
<varlistentry><term><parameter>esourceselector</parameter>&#160;:</term>
386
383
</variablelist></refsect2>
387
384
</refsect1>
388
385
 
389
 
 
390
 
 
391
386
</refentry>