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

This file is indexed.

/usr/share/gtk-doc/html/eds/eds-EUserPrompterServer.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
248
249
250
251
252
253
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EUserPrompterServer: 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-EUserPrompter.html" title="EUserPrompter">
<link rel="next" href="eds-EUserPrompterServerExtension.html" title="EUserPrompterServerExtension">
<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-EUserPrompterServer.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-EUserPrompter.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="eds-EUserPrompterServerExtension.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-EUserPrompterServer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-EUserPrompterServer.top_of_page"></a>EUserPrompterServer</span></h2>
<p>EUserPrompterServer — Server-side user prompter</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-EUserPrompterServer.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 class="link" href="eds-EDBusServer.html#EDBusServer" title="struct EDBusServer"><span class="returnvalue">EDBusServer</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EUserPrompterServer.html#e-user-prompter-server-new" title="e_user_prompter_server_new ()">e_user_prompter_server_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="eds-EUserPrompterServer.html#e-user-prompter-server-response" title="e_user_prompter_server_response ()">e_user_prompter_server_response</a> <span class="c_punctuation">()</span>
</td>
</tr>
<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-EUserPrompterServer.html#e-user-prompter-server-register" title="e_user_prompter_server_register ()">e_user_prompter_server_register</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EUserPrompterServer.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="eds-EUserPrompterServer.html#E-USER-PROMPTER-SERVER-OBJECT-PATH:CAPS" title="E_USER_PROMPTER_SERVER_OBJECT_PATH">E_USER_PROMPTER_SERVER_OBJECT_PATH</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-EUserPrompterServer.html#EUserPrompterServer" title="struct EUserPrompterServer">EUserPrompterServer</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-EUserPrompterServer.html#EUserPrompterServerClass" title="struct EUserPrompterServerClass">EUserPrompterServerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EUserPrompterServer.description"></a><h2>Description</h2>
<p>The <a class="link" href="eds-EUserPrompterServer.html#EUserPrompterServer" title="struct EUserPrompterServer"><span class="type">EUserPrompterServer</span></a> is the heart of the user prompter D-Bus service.
Acting as a global singleton for user prompts from backends.</p>
</div>
<div class="refsect1">
<a name="eds-EUserPrompterServer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-user-prompter-server-new"></a><h3>e_user_prompter_server_new ()</h3>
<pre class="programlisting"><a class="link" href="eds-EDBusServer.html#EDBusServer" title="struct EDBusServer"><span class="returnvalue">EDBusServer</span></a> *
e_user_prompter_server_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new instance of <a class="link" href="eds-EUserPrompterServer.html#EUserPrompterServer" title="struct EUserPrompterServer"><span class="type">EUserPrompterServer</span></a>.</p>
<div class="refsect3">
<a name="id-1.5.3.7.6.2.5"></a><h4>Returns</h4>
<p> a new instance of <a class="link" href="eds-EUserPrompterServer.html#EUserPrompterServer" title="struct EUserPrompterServer"><span class="type">EUserPrompterServer</span></a></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-response"></a><h3>e_user_prompter_server_response ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_user_prompter_server_response (<em class="parameter"><code><a class="link" href="eds-EUserPrompterServer.html#EUserPrompterServer" title="struct EUserPrompterServer"><span class="type">EUserPrompterServer</span></a> *server</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> *extension_values</code></em>);</pre>
<p>Finishes prompt initiated by a "prompt" signal or an extension prompt.
The <em class="parameter"><code>response</code></em>
 for non-extension prompts is a 0-based index of a button
used to close the prompt.</p>
<p>The <em class="parameter"><code>extension_values</code></em>
 is ignored for non-extension prompts.</p>
<div class="refsect3">
<a name="id-1.5.3.7.6.3.6"></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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EUserPrompterServer.html#EUserPrompterServer" title="struct EUserPrompterServer"><span class="type">EUserPrompterServer</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>Id of a prompt, which was responded</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>extension_values</p></td>
<td class="parameter_description"><p> For extension prompts can pass extra return values. </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>
<hr>
<div class="refsect2">
<a name="e-user-prompter-server-register"></a><h3>e_user_prompter_server_register ()</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_register (<em class="parameter"><code><a class="link" href="eds-EUserPrompterServer.html#EUserPrompterServer" title="struct EUserPrompterServer"><span class="type">EUserPrompterServer</span></a> *server</code></em>,
                                 <em class="parameter"><code><a class="link" href="eds-EExtension.html#EExtension" title="struct EExtension"><span class="type">EExtension</span></a> *extension</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>);</pre>
<p>Registers <em class="parameter"><code>extension</code></em>
 as a provider of <em class="parameter"><code>dialog_name</code></em>
 dialog. The names
are compared case sensitively and two extensions cannot provide
the same dialog. If the function succeeds, then it adds its own
reference on the <em class="parameter"><code>extension</code></em>
.</p>
<p>Extensions providing multiple dialogs call this function multiple
times, for each dialog name separately.</p>
<div class="refsect3">
<a name="id-1.5.3.7.6.4.6"></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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EUserPrompterServer.html#EUserPrompterServer" title="struct EUserPrompterServer"><span class="type">EUserPrompterServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<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> descendant</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, which the <em class="parameter"><code>extensions</code></em>
implement</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.3.7.6.4.7"></a><h4>Returns</h4>
<p> Whether properly registered <em class="parameter"><code>extension</code></em>
</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>
</div>
<div class="refsect1">
<a name="eds-EUserPrompterServer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="E-USER-PROMPTER-SERVER-OBJECT-PATH:CAPS"></a><h3>E_USER_PROMPTER_SERVER_OBJECT_PATH</h3>
<pre class="programlisting">#define             E_USER_PROMPTER_SERVER_OBJECT_PATH</pre>
<p>D-Bus object path of the user prompter.</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="EUserPrompterServer"></a><h3>struct EUserPrompterServer</h3>
<pre class="programlisting">struct EUserPrompterServer {
	EDBusServer parent;
	EUserPrompterServerPrivate *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="EUserPrompterServerClass"></a><h3>struct EUserPrompterServerClass</h3>
<pre class="programlisting">struct EUserPrompterServerClass {
	EDBusServerClass parent_class;

	/* signals */
	void		(*prompt)		(EUserPrompterServer *server,
						 gint id,
						 const gchar *type,
						 const gchar *title,
						 const gchar *primary_text,
						 const gchar *secondary_text,
						 gboolean use_markup,
						 const GSList *button_captions);
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.