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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EProxySelector: Evolution Utilities Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution Utilities Reference Manual">
<link rel="up" href="ch11.html" title="Network Proxies">
<link rel="prev" href="EProxyEditor.html" title="EProxyEditor">
<link rel="next" href="EProxyLinkSelector.html" title="EProxyLinkSelector">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#EProxySelector.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#EProxySelector.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#EProxySelector.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#EProxySelector.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch11.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="EProxyEditor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="EProxyLinkSelector.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="EProxySelector"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EProxySelector.top_of_page"></a>EProxySelector</span></h2>
<p>EProxySelector — Select and manage proxy profiles</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="EProxySelector.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gtk3GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="EProxySelector.html#e-proxy-selector-new" title="e_proxy_selector_new ()">e_proxy_selector_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="EProxySelector.html#e-proxy-selector-refresh" title="e_proxy_selector_refresh ()">e_proxy_selector_refresh</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ESourceRegistry</span> *
</td>
<td class="function_name">
<a class="link" href="EProxySelector.html#e-proxy-selector-get-registry" title="e_proxy_selector_get_registry ()">e_proxy_selector_get_registry</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ESource</span> *
</td>
<td class="function_name">
<a class="link" href="EProxySelector.html#e-proxy-selector-ref-selected" title="e_proxy_selector_ref_selected ()">e_proxy_selector_ref_selected</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EProxySelector.html#e-proxy-selector-set-selected" title="e_proxy_selector_set_selected ()">e_proxy_selector_set_selected</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EProxySelector.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">ESourceRegistry</span> *</td>
<td class="property_name"><a class="link" href="EProxySelector.html#EProxySelector--registry" title="The “registry” property">registry</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">ESource</span> *</td>
<td class="property_name"><a class="link" href="EProxySelector.html#EProxySelector--selected" title="The “selected” property">selected</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EProxySelector.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="EProxySelector.html#EProxySelector-struct" title="struct EProxySelector">EProxySelector</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EProxySelector.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3GtkWidget.html#GtkWidget-struct">GtkWidget</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3GtkContainer.html#GtkContainer-struct">GtkContainer</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gtk3GtkBox.html#GtkBox-struct">GtkBox</a>
<span class="lineart">╰──</span> <a class="link" href="ETreeViewFrame.html" title="ETreeViewFrame">ETreeViewFrame</a>
<span class="lineart">╰──</span> EProxySelector
</pre>
</div>
<div class="refsect1">
<a name="EProxySelector.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EProxySelector implements
AtkImplementorIface, <a href="/usr/share/gtk-doc/html/gtk3GtkBuildable.html#GtkBuildable-struct">GtkBuildable</a>, <a href="/usr/share/gtk-doc/html/gtk3gtk3-Orientable.html#GtkOrientable-struct">GtkOrientable</a> and EExtensible.</p>
</div>
<div class="refsect1">
<a name="EProxySelector.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <e-util/e-util.h>
</pre>
</div>
<div class="refsect1">
<a name="EProxySelector.description"></a><h2>Description</h2>
<p><a class="link" href="EProxySelector.html" title="EProxySelector"><span class="type">EProxySelector</span></a> displays a list of available proxy profiles, with inline
toolbar controls for adding and removing profiles.</p>
</div>
<div class="refsect1">
<a name="EProxySelector.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-proxy-selector-new"></a><h3>e_proxy_selector_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3GtkWidget.html#GtkWidget-struct"><span class="returnvalue">GtkWidget</span></a> *
e_proxy_selector_new (<em class="parameter"><code><span class="type">ESourceRegistry</span> *registry</code></em>);</pre>
<p>Creates a new <a class="link" href="EProxySelector.html" title="EProxySelector"><span class="type">EProxySelector</span></a> widget using <span class="type">ESource</span> instances in <em class="parameter"><code>registry</code></em>
.</p>
<div class="refsect3">
<a name="e-proxy-selector-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>registry</p></td>
<td class="parameter_description"><p>an <span class="type">ESourceRegistry</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-proxy-selector-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="EProxySelector.html" title="EProxySelector"><span class="type">EProxySelector</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-proxy-selector-refresh"></a><h3>e_proxy_selector_refresh ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_proxy_selector_refresh (<em class="parameter"><code><a class="link" href="EProxySelector.html" title="EProxySelector"><span class="type">EProxySelector</span></a> *selector</code></em>);</pre>
<p>Rebuilds the <em class="parameter"><code>selector</code></em>
's list store with an updated list of <span class="type">ESource</span>
instances that describe a network proxy profile, without disrupting the
previously selected item (if possible).</p>
<p>This funtion is called automatically in response to <span class="type">ESourceRegistry</span>
signals which are pertinent to the <em class="parameter"><code>selector</code></em>
.</p>
<div class="refsect3">
<a name="e-proxy-selector-refresh.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>selector</p></td>
<td class="parameter_description"><p>an <a class="link" href="EProxySelector.html" title="EProxySelector"><span class="type">EProxySelector</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-proxy-selector-get-registry"></a><h3>e_proxy_selector_get_registry ()</h3>
<pre class="programlisting"><span class="returnvalue">ESourceRegistry</span> *
e_proxy_selector_get_registry (<em class="parameter"><code><a class="link" href="EProxySelector.html" title="EProxySelector"><span class="type">EProxySelector</span></a> *selector</code></em>);</pre>
<p>Returns the <span class="type">ESourceRegistry</span> passed to <a class="link" href="EProxySelector.html#e-proxy-selector-get-registry" title="e_proxy_selector_get_registry ()"><code class="function">e_proxy_selector_get_registry()</code></a>.</p>
<div class="refsect3">
<a name="e-proxy-selector-get-registry.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>selector</p></td>
<td class="parameter_description"><p>an <a class="link" href="EProxySelector.html" title="EProxySelector"><span class="type">EProxySelector</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-proxy-selector-get-registry.returns"></a><h4>Returns</h4>
<p> an <span class="type">ESourceRegistry</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-proxy-selector-ref-selected"></a><h3>e_proxy_selector_ref_selected ()</h3>
<pre class="programlisting"><span class="returnvalue">ESource</span> *
e_proxy_selector_ref_selected (<em class="parameter"><code><a class="link" href="EProxySelector.html" title="EProxySelector"><span class="type">EProxySelector</span></a> *selector</code></em>);</pre>
<p>Returns the selected <span class="type">ESource</span> in <em class="parameter"><code>selector</code></em>
.</p>
<p>The function tries to ensure a valid <span class="type">ESource</span> is always returned,
falling back to <code class="function">e_source_registry_ref_builtin_proxy()</code> if necessary.</p>
<p>The returned <span class="type">ESource</span> is referenced for thread-safety and must be
unreferenced with <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="e-proxy-selector-ref-selected.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>selector</p></td>
<td class="parameter_description"><p>an <a class="link" href="EProxySelector.html" title="EProxySelector"><span class="type">EProxySelector</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-proxy-selector-ref-selected.returns"></a><h4>Returns</h4>
<p> an <span class="type">ESource</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-proxy-selector-set-selected"></a><h3>e_proxy_selector_set_selected ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_proxy_selector_set_selected (<em class="parameter"><code><a class="link" href="EProxySelector.html" title="EProxySelector"><span class="type">EProxySelector</span></a> *selector</code></em>,
<em class="parameter"><code><span class="type">ESource</span> *source</code></em>);</pre>
<p>Finds the corresponding tree model row for <em class="parameter"><code>source</code></em>
, selects the row,
and returns <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. If no corresponding tree model row for <em class="parameter"><code>source</code></em>
is
found, the selection remains unchanged and the function returns <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
<div class="refsect3">
<a name="e-proxy-selector-set-selected.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>selector</p></td>
<td class="parameter_description"><p>an <a class="link" href="EProxySelector.html" title="EProxySelector"><span class="type">EProxySelector</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>an <span class="type">ESource</span>, or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the built-in proxy profile</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-proxy-selector-set-selected.returns"></a><h4>Returns</h4>
<p> whether <em class="parameter"><code>source</code></em>
was selected</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="EProxySelector.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EProxySelector-struct"></a><h3>struct EProxySelector</h3>
<pre class="programlisting">struct EProxySelector;</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
</div>
</div>
<div class="refsect1">
<a name="EProxySelector.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EProxySelector--registry"></a><h3>The <code class="literal">“registry”</code> property</h3>
<pre class="programlisting"> “registry” <span class="type">ESourceRegistry</span> *</pre>
<p>Data source registry.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="EProxySelector--selected"></a><h3>The <code class="literal">“selected”</code> property</h3>
<pre class="programlisting"> “selected” <span class="type">ESource</span> *</pre>
<p>The selected data source.</p>
<p>Flags: Read / Write</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|
