/usr/share/gtk-doc/html/eds/eds-EUserPrompter.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 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 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EUserPrompter: 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-SQLite-vfs.html" title="SQLite vfs">
<link rel="next" href="eds-EUserPrompterServer.html" title="EUserPrompterServer">
<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-EUserPrompter.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-SQLite-vfs.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="eds-EUserPrompterServer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-EUserPrompter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-EUserPrompter.top_of_page"></a>EUserPrompter</span></h2>
<p>EUserPrompter — Manages user prompts over DBus</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-EUserPrompter.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-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="returnvalue">EUserPrompter</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EUserPrompter.html#e-user-prompter-new" title="e_user_prompter_new ()">e_user_prompter_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-EUserPrompter.html#e-user-prompter-prompt" title="e_user_prompter_prompt ()">e_user_prompter_prompt</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#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EUserPrompter.html#e-user-prompter-prompt-finish" title="e_user_prompter_prompt_finish ()">e_user_prompter_prompt_finish</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#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EUserPrompter.html#e-user-prompter-prompt-sync" title="e_user_prompter_prompt_sync ()">e_user_prompter_prompt_sync</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-EUserPrompter.html#e-user-prompter-extension-prompt" title="e_user_prompter_extension_prompt ()">e_user_prompter_extension_prompt</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#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EUserPrompter.html#e-user-prompter-extension-prompt-finish" title="e_user_prompter_extension_prompt_finish ()">e_user_prompter_extension_prompt_finish</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#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EUserPrompter.html#e-user-prompter-extension-prompt-sync" title="e_user_prompter_extension_prompt_sync ()">e_user_prompter_extension_prompt_sync</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EUserPrompter.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-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter">EUserPrompter</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-EUserPrompter.html#EUserPrompterClass" title="struct EUserPrompterClass">EUserPrompterClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EUserPrompter.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libebackend/libebackend.h>
</pre>
</div>
<div class="refsect1">
<a name="eds-EUserPrompter.description"></a><h2>Description</h2>
<p>Use this to initiate a user prompt from an <a class="link" href="eds-EBackend.html#EBackend" title="struct EBackend"><span class="type">EBackend</span></a> descendant.</p>
</div>
<div class="refsect1">
<a name="eds-EUserPrompter.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-user-prompter-new"></a><h3>e_user_prompter_new ()</h3>
<pre class="programlisting"><a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="returnvalue">EUserPrompter</span></a> *
e_user_prompter_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new instance of <a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</span></a>.</p>
<div class="refsect3">
<a name="id-1.5.3.6.7.2.5"></a><h4>Returns</h4>
<p> a new instance of <a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</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-prompt"></a><h3>e_user_prompter_prompt ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_user_prompter_prompt (<em class="parameter"><code><a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</span></a> *prompter</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> *type</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> *title</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> *primary_text</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> *secondary_text</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> use_markup</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *button_captions</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Asynchronously prompt a user for a decision.</p>
<p>The <em class="parameter"><code>type</code></em>
can be one of "info", "warning", "question" or "error", to include
an icon in the message prompt; anything else results in no icon in the message.</p>
<p>If <em class="parameter"><code>button_captions</code></em>
is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or empty list, then only one button is shown in
the prompt, a "Dismiss" button.</p>
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
will be called. You can then
call <a class="link" href="eds-EUserPrompter.html#e-user-prompter-prompt-finish" title="e_user_prompter_prompt_finish ()"><code class="function">e_user_prompter_prompt_finish()</code></a> to get the result of the operation.</p>
<div class="refsect3">
<a name="id-1.5.3.6.7.3.8"></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>prompter</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p> type of the prompt; can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p> window title of the prompt; can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>primary_text</p></td>
<td class="parameter_description"><p> primary text of the prompt; can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>secondary_text</p></td>
<td class="parameter_description"><p> secondary text of the prompt; can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>use_markup</p></td>
<td class="parameter_description"><p>whether both texts are with markup</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>button_captions</p></td>
<td class="parameter_description"><p> captions of buttons to use in the message; can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request
is satisfied. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p> data to pass to the callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</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-prompt-finish"></a><h3>e_user_prompter_prompt_finish ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
e_user_prompter_prompt_finish (<em class="parameter"><code><a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</span></a> *prompter</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Finishes the operation started with <a class="link" href="eds-EUserPrompter.html#e-user-prompter-prompt" title="e_user_prompter_prompt ()"><code class="function">e_user_prompter_prompt()</code></a>.</p>
<p>If an error occurred, the function sets <em class="parameter"><code>error</code></em>
and returns -1.</p>
<div class="refsect3">
<a name="id-1.5.3.6.7.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>prompter</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.3.6.7.4.7"></a><h4>Returns</h4>
<p> 0-based index of a button being used by a user as a response,
corresponding to 'button_captions' from <a class="link" href="eds-EUserPrompter.html#e-user-prompter-prompt" title="e_user_prompter_prompt ()"><code class="function">e_user_prompter_prompt()</code></a> call.</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-prompt-sync"></a><h3>e_user_prompter_prompt_sync ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
e_user_prompter_prompt_sync (<em class="parameter"><code><a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</span></a> *prompter</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> *type</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> *title</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> *primary_text</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> *secondary_text</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> use_markup</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *button_captions</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Prompts a user for a decision.</p>
<p>The <em class="parameter"><code>type</code></em>
can be one of "info", "warning", "question" or "error", to include
an icon in the message prompt; anything else results in no icon in the message.</p>
<p>If <em class="parameter"><code>button_captions</code></em>
is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or empty list, then only one button is shown in
the prompt, a "Dismiss" button.</p>
<p>If an error occurred, the function sets <em class="parameter"><code>error</code></em>
and returns -1.</p>
<div class="refsect3">
<a name="id-1.5.3.6.7.5.8"></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>prompter</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p> type of the prompt; can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p> window title of the prompt; can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>primary_text</p></td>
<td class="parameter_description"><p> primary text of the prompt; can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>secondary_text</p></td>
<td class="parameter_description"><p> secondary text of the prompt; can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>use_markup</p></td>
<td class="parameter_description"><p>whether both texts are with markup</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>button_captions</p></td>
<td class="parameter_description"><p> captions of buttons to use in the message; can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.3.6.7.5.9"></a><h4>Returns</h4>
<p> 0-based index of a button being used by a user as a response,
corresponding to <em class="parameter"><code>button_captions</code></em>
list.</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-extension-prompt"></a><h3>e_user_prompter_extension_prompt ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_user_prompter_extension_prompt (<em class="parameter"><code><a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</span></a> *prompter</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> *in_parameters</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Asynchronously prompt a user for a decision on an extension-provided dialog.
The caller usually provides an extension for <a class="link" href="eds-EUserPrompterServer.html#EUserPrompterServer" title="struct EUserPrompterServer"><span class="type">EUserPrompterServer</span></a>, a descendant
of <a class="link" href="eds-EUserPrompterServerExtension.html#EUserPrompterServerExtension" title="struct EUserPrompterServerExtension"><span class="type">EUserPrompterServerExtension</span></a>, which registers itself as a dialog provider.
The extension defines <em class="parameter"><code>dialog_name</code></em>
, same as meaning of <em class="parameter"><code>in_parameters</code></em>
;
only the extension and the caller know about meaning of these.</p>
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
will be called. You can then
call <a class="link" href="eds-EUserPrompter.html#e-user-prompter-extension-prompt-finish" title="e_user_prompter_extension_prompt_finish ()"><code class="function">e_user_prompter_extension_prompt_finish()</code></a> to get the result of the operation.
If there is no extension providing given dialog name, the operation finishes with
a G_IO_ERROR, G_IO_ERROR_NOT_FOUND <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>.</p>
<div class="refsect3">
<a name="id-1.5.3.6.7.6.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>prompter</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</span></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 invoke</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_parameters</p></td>
<td class="parameter_description"><p> optional parameters to pass to extension; can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request
is satisfied. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p> data to pass to the callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</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-extension-prompt-finish"></a><h3>e_user_prompter_extension_prompt_finish ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
e_user_prompter_extension_prompt_finish
(<em class="parameter"><code><a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</span></a> *prompter</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a class="link" href="eds-Main-Utility-Toolbox.html#ENamedParameters" title="ENamedParameters"><span class="type">ENamedParameters</span></a> *out_values</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Finishes the operation started with <a class="link" href="eds-EUserPrompter.html#e-user-prompter-extension-prompt" title="e_user_prompter_extension_prompt ()"><code class="function">e_user_prompter_extension_prompt()</code></a>.
Caller can provide <em class="parameter"><code>out_values</code></em>
to get additional values provided by the extension.
In case the caller is not interested in additional values, it can pass <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>out_values</code></em>
.
The <em class="parameter"><code>out_values</code></em>
will be cleared first, then any values will be added there.
Only the caller and the extension know about meaning of the result code and
additional values.</p>
<p>If an error occurred, the function sets <em class="parameter"><code>error</code></em>
and returns -1. If there is
no extension providing given dialog name, the operation finishes with
a G_IO_ERROR, G_IO_ERROR_NOT_FOUND <em class="parameter"><code>error</code></em>
.</p>
<div class="refsect3">
<a name="id-1.5.3.6.7.7.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>prompter</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html"><span class="type">GAsyncResult</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_values</p></td>
<td class="parameter_description"><p> Where to store values from the extension, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.3.6.7.7.7"></a><h4>Returns</h4>
<p> Result code of the prompt, as defined by the extension, or -1 on error.</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-extension-prompt-sync"></a><h3>e_user_prompter_extension_prompt_sync ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
e_user_prompter_extension_prompt_sync (<em class="parameter"><code><a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</span></a> *prompter</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> *in_parameters</code></em>,
<em class="parameter"><code><a class="link" href="eds-Main-Utility-Toolbox.html#ENamedParameters" title="ENamedParameters"><span class="type">ENamedParameters</span></a> *out_values</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Synchronously prompt a user for a decision on an extension-provided dialog.
The caller usually provides an extension for <a class="link" href="eds-EUserPrompterServer.html#EUserPrompterServer" title="struct EUserPrompterServer"><span class="type">EUserPrompterServer</span></a>, a descendant
of <a class="link" href="eds-EUserPrompterServerExtension.html#EUserPrompterServerExtension" title="struct EUserPrompterServerExtension"><span class="type">EUserPrompterServerExtension</span></a>, which registers itself as a dialog provider.
The extension defines <em class="parameter"><code>dialog_name</code></em>
, same as meaning of <em class="parameter"><code>in_parameters</code></em>
;
only the extension and the caller know about meaning of these.</p>
<p>Caller can provide <em class="parameter"><code>out_values</code></em>
to get additional values provided by the extension.
In case the caller is not interested in additional values, it can pass <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>out_values</code></em>
.
The <em class="parameter"><code>out_values</code></em>
will be cleared first, then any values will be added there.
Only the caller and the extension know about meaning of the result code and
additional values.</p>
<p>If an error occurred, the function sets <em class="parameter"><code>error</code></em>
and returns -1. If there is
no extension providing given dialog name, the operation finishes with
a G_IO_ERROR, G_IO_ERROR_NOT_FOUND <em class="parameter"><code>error</code></em>
.</p>
<div class="refsect3">
<a name="id-1.5.3.6.7.8.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>prompter</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-EUserPrompter.html#EUserPrompter" title="struct EUserPrompter"><span class="type">EUserPrompter</span></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 invoke</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_parameters</p></td>
<td class="parameter_description"><p> optional parameters to pass to extension; can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>out_values</p></td>
<td class="parameter_description"><p> Where to store values from the extension, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.3.6.7.8.8"></a><h4>Returns</h4>
<p> Result code of the prompt, as defined by the extension, or -1 on error.</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-EUserPrompter.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EUserPrompter"></a><h3>struct EUserPrompter</h3>
<pre class="programlisting">struct EUserPrompter {
GObject parent;
EUserPrompterPrivate *priv;
};
</pre>
<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="EUserPrompterClass"></a><h3>struct EUserPrompterClass</h3>
<pre class="programlisting">struct EUserPrompterClass {
GObjectClass parent;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|