/usr/share/gtk-doc/html/evolution-util/EConfig.html is in evolution-dev 3.10.4-0ubuntu1.
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 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EConfig</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution Utilities Reference Manual">
<link rel="up" href="ch14.html" title="Plugins (Legacy)">
<link rel="prev" href="evolution-util-EPluginUI.html" title="EPluginUI">
<link rel="next" href="EEvent.html" title="EEvent">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="evolution-util-EPluginUI.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch14.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution Utilities Reference Manual</th>
<td><a accesskey="n" href="EEvent.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EConfig.synopsis" class="shortcut">Top</a>
|
<a href="#EConfig.description" class="shortcut">Description</a>
|
<a href="#EConfig.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EConfig.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="EConfig"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EConfig.top_of_page"></a>EConfig</span></h2>
<p>EConfig</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EConfig.synopsis"></a><h2>Synopsis</h2>
<a name="EConfigHook"></a><pre class="synopsis">struct <a class="link" href="EConfig.html#EConfig-struct" title="struct EConfig">EConfig</a>;
enum <a class="link" href="EConfig.html#e-config-t" title="enum e_config_t">e_config_t</a>;
struct <a class="link" href="EConfig.html#EConfigItem" title="struct EConfigItem">EConfigItem</a>;
<a class="link" href="EConfig.html#EConfigFactory" title="EConfigFactory">EConfigFactory</a>;
struct <a class="link" href="EConfig.html#EConfigTarget" title="struct EConfigTarget">EConfigTarget</a>;
<span class="returnvalue">void</span> (<a class="link" href="EConfig.html#EConfigFactoryFunc" title="EConfigFactoryFunc ()">*EConfigFactoryFunc</a>) (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">gboolean</span> (<a class="link" href="EConfig.html#EConfigCheckFunc" title="EConfigCheckFunc ()">*EConfigCheckFunc</a>) (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pageid</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="EConfig.html#EConfigItemsFunc" title="EConfigItemsFunc ()">*EConfigItemsFunc</a>) (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><span class="type">GSList</span> *items</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">GtkWidget</span> (<a class="link" href="EConfig.html#EConfigItemFactoryFunc" title="EConfigItemFactoryFunc ()">*EConfigItemFactoryFunc</a>) (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigItem" title="struct EConfigItem"><span class="type">EConfigItem</span></a> *item</code></em>,
<em class="parameter"><code><span class="type">GtkWidget</span> *parent</code></em>,
<em class="parameter"><code><span class="type">GtkWidget</span> *old</code></em>,
<em class="parameter"><code><span class="type">gint</span> position</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<a class="link" href="EConfig.html#EConfigFactory" title="EConfigFactory"><span class="returnvalue">EConfigFactory</span></a> * <a class="link" href="EConfig.html#e-config-class-add-factory" title="e_config_class_add_factory ()">e_config_class_add_factory</a> (<em class="parameter"><code><span class="type">EConfigClass</span> *klass</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigFactoryFunc" title="EConfigFactoryFunc ()"><span class="type">EConfigFactoryFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<a class="link" href="EConfig.html" title="EConfig"><span class="returnvalue">EConfig</span></a> * <a class="link" href="EConfig.html#e-config-construct" title="e_config_construct ()">e_config_construct</a> (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EConfig.html#e-config-add-items" title="e_config_add_items ()">e_config_add_items</a> (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><span class="type">GSList</span> *items</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigItemsFunc" title="EConfigItemsFunc ()"><span class="type">EConfigItemsFunc</span></a> freefunc</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EConfig.html#e-config-add-page-check" title="e_config_add_page_check ()">e_config_add_page_check</a> (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pageid</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigCheckFunc" title="EConfigCheckFunc ()"><span class="type">EConfigCheckFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EConfig.html#e-config-set-target" title="e_config_set_target ()">e_config_set_target</a> (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigTarget" title="struct EConfigTarget"><span class="type">EConfigTarget</span></a> *target</code></em>);
<span class="returnvalue">GtkWidget</span> * <a class="link" href="EConfig.html#e-config-create-widget" title="e_config_create_widget ()">e_config_create_widget</a> (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>);
enum <a class="link" href="EConfig.html#e-config-target-change-t" title="enum e_config_target_change_t">e_config_target_change_t</a>;
<span class="returnvalue">void</span> <a class="link" href="EConfig.html#e-config-target-changed" title="e_config_target_changed ()">e_config_target_changed</a> (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#e-config-target-change-t" title="enum e_config_target_change_t"><span class="type">e_config_target_change_t</span></a> how</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="EConfig.html#e-config-page-check" title="e_config_page_check ()">e_config_page_check</a> (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pageid</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EConfig.html#e-config-abort" title="e_config_abort ()">e_config_abort</a> (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EConfig.html#e-config-commit" title="e_config_commit ()">e_config_commit</a> (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>);
<span class="returnvalue">gpointer</span> <a class="link" href="EConfig.html#e-config-target-new" title="e_config_target_new ()">e_config_target_new</a> (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><span class="type">gint</span> type</code></em>,
<em class="parameter"><code><span class="type">gsize</span> size</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EConfig.html#e-config-target-free" title="e_config_target_free ()">e_config_target_free</a> (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> target</code></em>);
struct <a class="link" href="EConfig.html#EConfigHookGroup" title="struct EConfigHookGroup">EConfigHookGroup</a>;
struct <a class="link" href="EConfig.html#EConfigHook-struct" title="struct EConfigHook">EConfigHook</a>;
typedef <a class="link" href="EConfig.html#EConfigHookTargetMap" title="EConfigHookTargetMap">EConfigHookTargetMap</a>;
typedef <a class="link" href="EConfig.html#EConfigHookTargetMask" title="EConfigHookTargetMask">EConfigHookTargetMask</a>;
struct <a class="link" href="EConfig.html#EConfigHookItemFactoryData" title="struct EConfigHookItemFactoryData">EConfigHookItemFactoryData</a>;
struct <a class="link" href="EConfig.html#EConfigHookPageCheckData" title="struct EConfigHookPageCheckData">EConfigHookPageCheckData</a>;
<span class="returnvalue">void</span> (<a class="link" href="EConfig.html#EConfigHookFunc" title="EConfigHookFunc ()">*EConfigHookFunc</a>) (<em class="parameter"><code><a class="link" href="EPlugin.html" title="EPlugin"><span class="type">EPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigTarget" title="struct EConfigTarget"><span class="type">EConfigTarget</span></a> *target</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="EConfig.html#EConfigHookItemFactoryFunc" title="EConfigHookItemFactoryFunc ()">*EConfigHookItemFactoryFunc</a>) (<em class="parameter"><code><a class="link" href="EPlugin.html" title="EPlugin"><span class="type">EPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigHookItemFactoryData" title="struct EConfigHookItemFactoryData"><span class="type">EConfigHookItemFactoryData</span></a> *data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EConfig.html#e-config-hook-class-add-target-map" title="e_config_hook_class_add_target_map ()">e_config_hook_class_add_target_map</a> (<em class="parameter"><code><span class="type">EConfigHookClass</span> *hook_class</code></em>,
<em class="parameter"><code>const <a class="link" href="EConfig.html#EConfigHookTargetMap" title="EConfigHookTargetMap"><span class="type">EConfigHookTargetMap</span></a> *map</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EConfig.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----EConfig
</pre>
<pre class="synopsis">
GObject
+----<a class="link" href="EPlugin.html#EPluginHook">EPluginHook</a>
+----EConfigHook
</pre>
</div>
<div class="refsect1">
<a name="EConfig.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="EConfig.html#EConfig-abort" title='The "abort" signal'>abort</a>" : <code class="literal">Run Last</code>
"<a class="link" href="EConfig.html#EConfig-commit" title='The "commit" signal'>commit</a>" : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="EConfig.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EConfig.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EConfig-struct"></a><h3>struct EConfig</h3>
<pre class="programlisting">struct EConfig;</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-config-t"></a><h3>enum e_config_t</h3>
<pre class="programlisting">enum e_config_t {
/* use one and only one of these for any given config-window id */
E_CONFIG_BOOK,
E_CONFIG_PAGE,
E_CONFIG_SECTION,
E_CONFIG_SECTION_TABLE,
E_CONFIG_ITEM,
E_CONFIG_ITEM_TABLE /* only allowed in table sections */
};
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="E-CONFIG-BOOK:CAPS"></a><span class="term"><code class="literal">E_CONFIG_BOOK</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="E-CONFIG-PAGE:CAPS"></a><span class="term"><code class="literal">E_CONFIG_PAGE</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="E-CONFIG-SECTION:CAPS"></a><span class="term"><code class="literal">E_CONFIG_SECTION</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="E-CONFIG-SECTION-TABLE:CAPS"></a><span class="term"><code class="literal">E_CONFIG_SECTION_TABLE</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="E-CONFIG-ITEM:CAPS"></a><span class="term"><code class="literal">E_CONFIG_ITEM</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="E-CONFIG-ITEM-TABLE:CAPS"></a><span class="term"><code class="literal">E_CONFIG_ITEM_TABLE</code></span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="EConfigItem"></a><h3>struct EConfigItem</h3>
<pre class="programlisting">struct EConfigItem {
enum _e_config_t type;
gchar *path; /* absolute path, must sort
* ascii-lexographically into the right spot */
gchar *label;
EConfigItemFactoryFunc factory;
gpointer user_data;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfigFactory"></a><h3>EConfigFactory</h3>
<pre class="programlisting">typedef struct _EConfigFactory EConfigFactory;</pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfigTarget"></a><h3>struct EConfigTarget</h3>
<pre class="programlisting">struct EConfigTarget {
struct _EConfig *config;
GtkWidget *widget; /* used if you need a parent toplevel, if available */
guint32 type;
/* implementation fields follow, depends on window type */
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfigFactoryFunc"></a><h3>EConfigFactoryFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*EConfigFactoryFunc) (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfigCheckFunc"></a><h3>EConfigCheckFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> (*EConfigCheckFunc) (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pageid</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfigItemsFunc"></a><h3>EConfigItemsFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*EConfigItemsFunc) (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><span class="type">GSList</span> *items</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfigItemFactoryFunc"></a><h3>EConfigItemFactoryFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> (*EConfigItemFactoryFunc) (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigItem" title="struct EConfigItem"><span class="type">EConfigItem</span></a> *item</code></em>,
<em class="parameter"><code><span class="type">GtkWidget</span> *parent</code></em>,
<em class="parameter"><code><span class="type">GtkWidget</span> *old</code></em>,
<em class="parameter"><code><span class="type">gint</span> position</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-config-class-add-factory"></a><h3>e_config_class_add_factory ()</h3>
<pre class="programlisting"><a class="link" href="EConfig.html#EConfigFactory" title="EConfigFactory"><span class="returnvalue">EConfigFactory</span></a> * e_config_class_add_factory (<em class="parameter"><code><span class="type">EConfigClass</span> *klass</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigFactoryFunc" title="EConfigFactoryFunc ()"><span class="type">EConfigFactoryFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
Add a config factory which will be called to <code class="function">add_items()</code> any
extra items's if wants to, to the current Config window.
</p>
<p>
TODO: Make the id a pattern?
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td>
<td>Implementing class pointer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>The name of the configuration window you're interested in.
This may be NULL to be called for all windows.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>An EConfigFactoryFunc to call when the window <em class="parameter"><code>id</code></em> is being created.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>Callback data.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A handle to the factory.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-config-construct"></a><h3>e_config_construct ()</h3>
<pre class="programlisting"><a class="link" href="EConfig.html" title="EConfig"><span class="returnvalue">EConfig</span></a> * e_config_construct (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *id</code></em>);</pre>
<p>
Used by implementing classes to initialise base parameters.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>The instance to initialise.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>The name of the configuration window this manager drives.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<em class="parameter"><code>config</code></em> is returned.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-config-add-items"></a><h3>e_config_add_items ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_config_add_items (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><span class="type">GSList</span> *items</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigItemsFunc" title="EConfigItemsFunc ()"><span class="type">EConfigItemsFunc</span></a> freefunc</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
Add new EConfigItems to the configuration window. Nothing will be
done with them until the widget is built.
</p>
<p>
TODO: perhaps commit and abort should just be signals.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>An initialised implementing instance of EConfig.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>items</code></em> :</span></p></td>
<td>A list of EConfigItem's to add to the configuration manager.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>freefunc</code></em> :</span></p></td>
<td>If supplied, called to free the item list (and/or items)
once they are no longer needed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Data for the callback methods.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-config-add-page-check"></a><h3>e_config_add_page_check ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_config_add_page_check (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pageid</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigCheckFunc" title="EConfigCheckFunc ()"><span class="type">EConfigCheckFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
Add a page-checking function callback. It will be called to validate the
data in the given page or pages. If <em class="parameter"><code>pageid</code></em> is NULL then it will be called
to validate every page, or the whole configuration window.
</p>
<p>
In the latter case, the pageid in the callback will be either the
specific page being checked, or NULL when the whole config window
is being checked.
</p>
<p>
The page check function is used to validate input before allowing
the assistant to continue or the notebook to close.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>Initialised implemeting instance of EConfig.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pageid</code></em> :</span></p></td>
<td>pageid to check.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>checking callback.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>user-data for the callback.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-config-set-target"></a><h3>e_config_set_target ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_config_set_target (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigTarget" title="struct EConfigTarget"><span class="type">EConfigTarget</span></a> *target</code></em>);</pre>
<p>
Sets the target object for the config window. Generally the target
is set only once, and will supply its own "changed" signal which
can be used to drive the modal. This is a virtual method so that
the implementing class can connect to the changed signal and
initiate a <a class="link" href="EConfig.html#e-config-target-changed" title="e_config_target_changed ()"><code class="function">e_config_target_changed()</code></a> call where appropriate.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>An initialised EConfig.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
<td>A target allocated from <em class="parameter"><code>config</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-config-create-widget"></a><h3>e_config_create_widget ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * e_config_create_widget (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>);</pre>
<p>
Create the <span class="type">GtkNotebook</span> described by <em class="parameter"><code>config</code></em>.
</p>
<p>
This object will be self-driving, but will not close itself once
complete.
</p>
<p>
Unless reffed otherwise, the management object <em class="parameter"><code>config</code></em> will be
finalized when the widget is.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>An initialised EConfig object.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The widget, also available in <em class="parameter"><code>config.widget</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-config-target-change-t"></a><h3>enum e_config_target_change_t</h3>
<pre class="programlisting">enum e_config_target_change_t {
E_CONFIG_TARGET_CHANGED_STATE,
E_CONFIG_TARGET_CHANGED_REBUILD
};
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="E-CONFIG-TARGET-CHANGED-STATE:CAPS"></a><span class="term"><code class="literal">E_CONFIG_TARGET_CHANGED_STATE</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="E-CONFIG-TARGET-CHANGED-REBUILD:CAPS"></a><span class="term"><code class="literal">E_CONFIG_TARGET_CHANGED_REBUILD</code></span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-config-target-changed"></a><h3>e_config_target_changed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_config_target_changed (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#e-config-target-change-t" title="enum e_config_target_change_t"><span class="type">e_config_target_change_t</span></a> how</code></em>);</pre>
<p>
Indicate that the target has changed. This may be called by the
self-aware target itself, or by the driving code. If <em class="parameter"><code>how</code></em> is
<a class="link" href="EConfig.html#E-CONFIG-TARGET-CHANGED-REBUILD:CAPS"><code class="literal">E_CONFIG_TARGET_CHANGED_REBUILD</code></a>, then the entire configuration
widget may be recreated based on the changed target.
</p>
<p>
This is used to sensitise Assistant next/back buttons and the Apply
button for the Notebook mode.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>an <a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>how</code></em> :</span></p></td>
<td>an enum value indicating how the target has changed</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-config-page-check"></a><h3>e_config_page_check ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_config_page_check (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pageid</code></em>);</pre>
<p>
Check that a given page is complete. If <em class="parameter"><code>pageid</code></em> is NULL, then check
the whole config. No check is made that the page actually exists.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>an <a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pageid</code></em> :</span></p></td>
<td>the path of the page item</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>FALSE if the data is inconsistent/incomplete.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-config-abort"></a><h3>e_config_abort ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_config_abort (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>);</pre>
<p>
Signify that the stateful configuration changes must be discarded
to all listeners. This is used by self-driven assistant or notebook, or
may be used by code using the widget directly.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>an <a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-config-commit"></a><h3>e_config_commit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_config_commit (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>);</pre>
<p>
Signify that the stateful configuration changes should be saved.
This is used by the self-driven assistant or notebook, or may be used
by code driving the widget directly.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>an <a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-config-target-new"></a><h3>e_config_target_new ()</h3>
<pre class="programlisting"><span class="returnvalue">gpointer</span> e_config_target_new (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><span class="type">gint</span> type</code></em>,
<em class="parameter"><code><span class="type">gsize</span> size</code></em>);</pre>
<p>
Allocate a new config target suitable for this class. Implementing
classes will define the actual content of the target.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>an <a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>type, up to implementor</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>size of object to allocate</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-config-target-free"></a><h3>e_config_target_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_config_target_free (<em class="parameter"><code><a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *config</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> target</code></em>);</pre>
<p>
Free a target. The implementing class can override this method to
free custom targets.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td>
<td>an <a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
<td>the target to free</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="EConfigHookGroup"></a><h3>struct EConfigHookGroup</h3>
<pre class="programlisting">struct EConfigHookGroup {
struct _EConfigHook *hook; /* parent pointer */
gchar *id; /* target menu id for these config items */
gint target_type; /* target type of this group */
GSList *items; /* items to add to group */
gchar *check; /* validate handler, if set */
gchar *commit; /* commit handler, if set */
gchar *abort; /* abort handler, if set */
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfigHook-struct"></a><h3>struct EConfigHook</h3>
<pre class="programlisting">struct EConfigHook;</pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfigHookTargetMap"></a><h3>EConfigHookTargetMap</h3>
<pre class="programlisting">typedef struct _EPluginHookTargetMap EConfigHookTargetMap;
</pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfigHookTargetMask"></a><h3>EConfigHookTargetMask</h3>
<pre class="programlisting">typedef struct _EPluginHookTargetKey EConfigHookTargetMask;
</pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfigHookItemFactoryData"></a><h3>struct EConfigHookItemFactoryData</h3>
<pre class="programlisting">struct EConfigHookItemFactoryData {
EConfig *config;
EConfigItem *item;
EConfigTarget *target;
GtkWidget *parent;
GtkWidget *old;
gint position;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfigHookPageCheckData"></a><h3>struct EConfigHookPageCheckData</h3>
<pre class="programlisting">struct EConfigHookPageCheckData {
EConfig *config;
EConfigTarget *target;
const gchar *pageid;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfigHookFunc"></a><h3>EConfigHookFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*EConfigHookFunc) (<em class="parameter"><code><a class="link" href="EPlugin.html" title="EPlugin"><span class="type">EPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigTarget" title="struct EConfigTarget"><span class="type">EConfigTarget</span></a> *target</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfigHookItemFactoryFunc"></a><h3>EConfigHookItemFactoryFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*EConfigHookItemFactoryFunc) (<em class="parameter"><code><a class="link" href="EPlugin.html" title="EPlugin"><span class="type">EPlugin</span></a> *plugin</code></em>,
<em class="parameter"><code><a class="link" href="EConfig.html#EConfigHookItemFactoryData" title="struct EConfigHookItemFactoryData"><span class="type">EConfigHookItemFactoryData</span></a> *data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-config-hook-class-add-target-map"></a><h3>e_config_hook_class_add_target_map ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_config_hook_class_add_target_map (<em class="parameter"><code><span class="type">EConfigHookClass</span> *hook_class</code></em>,
<em class="parameter"><code>const <a class="link" href="EConfig.html#EConfigHookTargetMap" title="EConfigHookTargetMap"><span class="type">EConfigHookTargetMap</span></a> *map</code></em>);</pre>
<p>
<em class="parameter"><code>hook_class</code></em>: The dervied <a class="link" href="EConfig.html#EConfigHook"><span class="type">EConfigHook</span></a> class.
<em class="parameter"><code>map</code></em>: A map used to describe a single EConfigTarget type for this class.
</p>
<p>
Add a targe tmap to a concrete derived class of EConfig. The
target map enumates the target types available for the implenting
class.
</p>
</div>
</div>
<div class="refsect1">
<a name="EConfig.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="EConfig-abort"></a><h3>The <code class="literal">"abort"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *econfig,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
</div>
<hr>
<div class="refsect2">
<a name="EConfig-commit"></a><h3>The <code class="literal">"commit"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EConfig.html" title="EConfig"><span class="type">EConfig</span></a> *econfig,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|