evolution-data-server-doc 3.18.5-1ubuntu1 / usr / share / gtk-doc / html / eds / eds-EUserPrompterServerExtension.html

This file is indexed.

/usr/share/gtk-doc/html/eds/eds-EUserPrompterServerExtension.html is in evolution-data-server-doc 3.18.5-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EUserPrompterServerExtension: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch11.html" title="Available only for backends">
<link rel="prev" href="eds-EUserPrompterServer.html" title="EUserPrompterServer">
<link rel="next" href="ch12.html" title="Addressbook related utilities">
<meta name="generator" content="GTK-Doc V1.24 (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="#eds-EUserPrompterServerExtension.description" class="shortcut">Description</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="eds-EUserPrompterServer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch12.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-EUserPrompterServerExtension"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-EUserPrompterServerExtension.top_of_page"></a>EUserPrompterServerExtension</span></h2>
<p>EUserPrompterServerExtension — Extension for a server-side user prompter</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-EUserPrompterServerExtension.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/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EUserPrompterServerExtension.html#e-user-prompter-server-extension-prompt" title="e_user_prompter_server_extension_prompt ()">e_user_prompter_server_extension_prompt</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="eds-EUserPrompterServerExtension.html#e-user-prompter-server-extension-response" title="e_user_prompter_server_extension_response ()">e_user_prompter_server_extension_response</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EUserPrompterServerExtension.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="eds-EUserPrompterServerExtension.html#EUserPrompterServerExtension" title="struct EUserPrompterServerExtension">EUserPrompterServerExtension</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-EUserPrompterServerExtension.html#EUserPrompterServerExtensionClass" title="struct EUserPrompterServerExtensionClass">EUserPrompterServerExtensionClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EUserPrompterServerExtension.description"></a><h2>Description</h2>
<p>The <a class="link" href="eds-EUserPrompterServerExtension.html#EUserPrompterServerExtension" title="struct EUserPrompterServerExtension"><span class="type">EUserPrompterServerExtension</span></a> is a base struct for extension
of EUserPrompterServer, to provide customized or specialized dialog
prompts.</p>
<p>A descendant defines two virtual functions,
the EUserPrompterServerExtensionClass::register_dialogs which is used as
a convenient function, where the descendant registers all the dialogs it
provides on the server with <a class="link" href="eds-EUserPrompterServer.html#e-user-prompter-server-register" title="e_user_prompter_server_register ()"><code class="function">e_user_prompter_server_register()</code></a>.</p>
<p>The next function is EUserPrompterServerExtensionClass::prompt, which is
used to initiate user prompt. The implementor should not block main thread
with this function, because this is treated fully asynchronously.
User's response is passed to the server with
<a class="link" href="eds-EUserPrompterServerExtension.html#e-user-prompter-server-extension-response" title="e_user_prompter_server_extension_response ()"><code class="function">e_user_prompter_server_extension_response()</code></a> call.</p>
</div>
<div class="refsect1">
<a name="eds-EUserPrompterServerExtension.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-user-prompter-server-extension-prompt"></a><h3>e_user_prompter_server_extension_prompt ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_user_prompter_server_extension_prompt
                               (<em class="parameter"><code><a class="link" href="eds-EUserPrompterServerExtension.html#EUserPrompterServerExtension" title="struct EUserPrompterServerExtension"><span class="type">EUserPrompterServerExtension</span></a> *extension</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> prompt_id</code></em>,
                                <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dialog_name</code></em>,
                                <em class="parameter"><code>const <a class="link" href="eds-Main-Utility-Toolbox.html#ENamedParameters" title="ENamedParameters"><span class="type">ENamedParameters</span></a> *parameters</code></em>);</pre>
<p>Instructs extension to show dialog <em class="parameter"><code>dialog_name</code></em>
. If it cannot be found,
or any error, then return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>. The caller can pass optional <em class="parameter"><code>parameters</code></em>
,
if <em class="parameter"><code>extension</code></em>
 uses any. Meaning of <em class="parameter"><code>parameters</code></em>
 is known only to the caller
and to the dialog implementor, it's not interpretted nor checked for correctness
in any way in <a class="link" href="eds-EUserPrompterServer.html#EUserPrompterServer" title="struct EUserPrompterServer"><span class="type">EUserPrompterServer</span></a>. The only limitation of <em class="parameter"><code>parameters</code></em>
 is that
the array elements are strings.</p>
<p>The <em class="parameter"><code>prompt_id</code></em>
 is used as an identificator of the prompt itself,
and is used in <a class="link" href="eds-EUserPrompterServerExtension.html#e-user-prompter-server-extension-response" title="e_user_prompter_server_extension_response ()"><code class="function">e_user_prompter_server_extension_response()</code></a> call,
which finishes the prompt.</p>
<p>Note: The function call should not block main loop, it should
just show dialog and return.</p>
<div class="refsect3">
<a name="id-1.5.3.8.6.2.7"></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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EUserPrompterServerExtension.html#EUserPrompterServerExtension" title="struct EUserPrompterServerExtension"><span class="type">EUserPrompterServerExtension</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prompt_id</p></td>
<td class="parameter_description"><p>Prompt identificator, which is used in call to <a class="link" href="eds-EUserPrompterServerExtension.html#e-user-prompter-server-extension-response" title="e_user_prompter_server_extension_response ()"><code class="function">e_user_prompter_server_extension_response()</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dialog_name</p></td>
<td class="parameter_description"><p>Name of a dialog to run</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>parameters</p></td>
<td class="parameter_description"><p> Optional extension parameters for the dialog, as passed by a caller. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.3.8.6.2.8"></a><h4>Returns</h4>
<p> Whether dialog was found and shown.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-user-prompter-server-extension-response"></a><h3>e_user_prompter_server_extension_response ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_user_prompter_server_extension_response
                               (<em class="parameter"><code><a class="link" href="eds-EUserPrompterServerExtension.html#EUserPrompterServerExtension" title="struct EUserPrompterServerExtension"><span class="type">EUserPrompterServerExtension</span></a> *extension</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> prompt_id</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> response</code></em>,
                                <em class="parameter"><code>const <a class="link" href="eds-Main-Utility-Toolbox.html#ENamedParameters" title="ENamedParameters"><span class="type">ENamedParameters</span></a> *values</code></em>);</pre>
<p>A conveniente wrapper function around <a class="link" href="eds-EUserPrompterServer.html#e-user-prompter-server-response" title="e_user_prompter_server_response ()"><code class="function">e_user_prompter_server_response()</code></a>,
which ends previous call of <a class="link" href="eds-EUserPrompterServerExtension.html#e-user-prompter-server-extension-prompt" title="e_user_prompter_server_extension_prompt ()"><code class="function">e_user_prompter_server_extension_prompt()</code></a>.
The <em class="parameter"><code>response</code></em>
 and <em class="parameter"><code>values</code></em>
 is known only to the caller and to the dialog implementor,
it's not interpretted nor checked for correctness in any way in <a class="link" href="eds-EUserPrompterServer.html#EUserPrompterServer" title="struct EUserPrompterServer"><span class="type">EUserPrompterServer</span></a>.
The only limitation of <em class="parameter"><code>values</code></em>
 is that the array elements are strings.</p>
<div class="refsect3">
<a name="id-1.5.3.8.6.3.5"></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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EUserPrompterServerExtension.html#EUserPrompterServerExtension" title="struct EUserPrompterServerExtension"><span class="type">EUserPrompterServerExtension</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prompt_id</p></td>
<td class="parameter_description"><p>Prompt identificator</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>response</p></td>
<td class="parameter_description"><p>Response of the prompt</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>values</p></td>
<td class="parameter_description"><p> Additional response values, if extension defines any. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
</div>
<div class="refsect1">
<a name="eds-EUserPrompterServerExtension.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EUserPrompterServerExtension"></a><h3>struct EUserPrompterServerExtension</h3>
<pre class="programlisting">struct EUserPrompterServerExtension {
	EExtension parent;
	EUserPrompterServerExtensionPrivate *priv;
};
</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="EUserPrompterServerExtensionClass"></a><h3>struct EUserPrompterServerExtensionClass</h3>
<pre class="programlisting">struct EUserPrompterServerExtensionClass {
	EExtensionClass parent_class;

	/* virtual methods */
	void		(*register_dialogs)
					(EExtension *extension,
					 struct _EUserPrompterServer *server);
	gboolean (*prompt) (EUserPrompterServerExtension *extension,
					 gint prompt_id,
					 const gchar *dialog_name,
					 const ENamedParameters *parameters);
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.