1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
<?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>
"<link linkend="ESourceSelector-popup-event">popup-event</link>" : Run Last
"<link linkend="ESourceSelector-primary-selection-changed">primary-selection-changed</link>" : Run Last
"<link linkend="ESourceSelector-selection-changed">selection-changed</link>" : 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> :</term>
<listitem><simpara> A source list.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</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> :</term>
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</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> :</term>
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</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> :</term>
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> An <link linkend="ESource"><type>ESource</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</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> :</term>
<listitem><simpara> an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</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> :</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> :</term>
<listitem><simpara> An ESourceSelector widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>show</parameter> :</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> :</term>
<listitem><simpara> an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</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> :</term>
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter> :</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> :</term>
<listitem><simpara> An <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</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> :</term>
<listitem><simpara> an <link linkend="ESourceSelector"><type>ESourceSelector</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</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> :</term>
<listitem><simpara> an <link linkend="ESourceSelector"><type>ESourceSelector</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</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>"popup-event"</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> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>event</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="ESourceSelector-primary-selection-changed"><title>The <literal>"primary-selection-changed"</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> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</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>"selection-changed"</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> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
