/usr/share/gtk-doc/html/libgda-4.0/GdauiBasicForm.html is in libgda-4.0-doc 4.2.8-2build1.
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 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdauiBasicForm</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GNOME Data Access 4 manual">
<link rel="up" href="ch21.html" title="User interface API reference">
<link rel="prev" href="GdauiDataProxy.html" title="GdauiDataProxy">
<link rel="next" href="GdauiForm.html" title="GdauiForm">
<meta name="generator" content="GTK-Doc V1.17 (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="GdauiDataProxy.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch21.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">GNOME Data Access 4 manual</th>
<td><a accesskey="n" href="GdauiForm.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdauiBasicForm.synopsis" class="shortcut">Top</a>
|
<a href="#GdauiBasicForm.description" class="shortcut">Description</a>
|
<a href="#GdauiBasicForm.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GdauiBasicForm.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GdauiBasicForm.properties" class="shortcut">Properties</a>
|
<a href="#GdauiBasicForm.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GdauiBasicForm"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdauiBasicForm.top_of_page"></a>GdauiBasicForm</span></h2>
<p>GdauiBasicForm — Form widget mapping the values contained in a <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a></p>
</td>
<td valign="top" align="right"><img src="vi-basic-form.png"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GdauiBasicForm.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="GdauiBasicForm.html#GdauiBasicForm-struct" title="struct GdauiBasicForm">GdauiBasicForm</a>;
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-new" title="gdaui_basic_form_new ()">gdaui_basic_form_new</a> (<em class="parameter"><code><a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> *data_set</code></em>);
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-new-in-dialog" title="gdaui_basic_form_new_in_dialog ()">gdaui_basic_form_new_in_dialog</a> (<em class="parameter"><code><a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> *data_set</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *header</code></em>);
<a class="link" href="GdaSet.html" title="GdaSet"><span class="returnvalue">GdaSet</span></a> * <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-get-data-set" title="gdaui_basic_form_get_data_set ()">gdaui_basic_form_get_data_set</a> (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-is-valid" title="gdaui_basic_form_is_valid ()">gdaui_basic_form_is_valid</a> (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-has-changed" title="gdaui_basic_form_has_changed ()">gdaui_basic_form_has_changed</a> (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-reset" title="gdaui_basic_form_reset ()">gdaui_basic_form_reset</a> (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-set-as-reference" title="gdaui_basic_form_set_as_reference ()">gdaui_basic_form_set_as_reference</a> (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-entry-set-visible" title="gdaui_basic_form_entry_set_visible ()">gdaui_basic_form_entry_set_visible</a> (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> *holder</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-entry-grab-focus" title="gdaui_basic_form_entry_grab_focus ()">gdaui_basic_form_entry_grab_focus</a> (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> *holder</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-entry-set-editable" title="gdaui_basic_form_entry_set_editable ()">gdaui_basic_form_entry_set_editable</a> (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> *holder</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> editable</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-set-entries-to-default" title="gdaui_basic_form_set_entries_to_default ()">gdaui_basic_form_set_entries_to_default</a>
(<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>);
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-get-entry-widget" title="gdaui_basic_form_get_entry_widget ()">gdaui_basic_form_get_entry_widget</a> (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> *holder</code></em>);
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-get-label-widget" title="gdaui_basic_form_get_label_widget ()">gdaui_basic_form_get_label_widget</a> (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> *holder</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-set-layout-from-file" title="gdaui_basic_form_set_layout_from_file ()">gdaui_basic_form_set_layout_from_file</a>
(<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file_name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *form_name</code></em>);
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-get-place-holder" title="gdaui_basic_form_get_place_holder ()">gdaui_basic_form_get_place_holder</a> (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *placeholder_id</code></em>);
enum <a class="link" href="GdauiBasicForm.html#GdauiBasicFormPart" title="enum GdauiBasicFormPart">GdauiBasicFormPart</a>;
<span class="returnvalue">void</span> <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-add-to-size-group" title="gdaui_basic_form_add_to_size_group ()">gdaui_basic_form_add_to_size_group</a> (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkSizeGroup.html"><span class="type">GtkSizeGroup</span></a> *size_group</code></em>,
<em class="parameter"><code><a class="link" href="GdauiBasicForm.html#GdauiBasicFormPart" title="enum GdauiBasicFormPart"><span class="type">GdauiBasicFormPart</span></a> part</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-remove-from-size-group" title="gdaui_basic_form_remove_from_size_group ()">gdaui_basic_form_remove_from_size_group</a>
(<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkSizeGroup.html"><span class="type">GtkSizeGroup</span></a> *size_group</code></em>,
<em class="parameter"><code><a class="link" href="GdauiBasicForm.html#GdauiBasicFormPart" title="enum GdauiBasicFormPart"><span class="type">GdauiBasicFormPart</span></a> part</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GdauiBasicForm.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkObject.html">GtkObject</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html">GtkWidget</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkContainer.html">GtkContainer</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkBox.html">GtkBox</a>
+----<a href="http://library.gnome.org/devel/gtk3/GtkVBox.html">GtkVBox</a>
+----GdauiBasicForm
+----<a class="link" href="GdauiRawForm.html" title="GdauiRawForm">GdauiRawForm</a>
</pre>
</div>
<div class="refsect1">
<a name="GdauiBasicForm.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdauiBasicForm implements
AtkImplementorIface, <a href="http://library.gnome.org/devel/gtk3/GtkBuildable.html">GtkBuildable</a> and <a href="http://library.gnome.org/devel/gtk3/gtk-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="GdauiBasicForm.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GdauiBasicForm.html#GdauiBasicForm--can-expand-v" title='The "can-expand-v" property'>can-expand-v</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read
"<a class="link" href="GdauiBasicForm.html#GdauiBasicForm--entries-auto-default" title='The "entries-auto-default" property'>entries-auto-default</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a class="link" href="GdauiBasicForm.html#GdauiBasicForm--headers-sensitive" title='The "headers-sensitive" property'>headers-sensitive</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a class="link" href="GdauiBasicForm.html#GdauiBasicForm--paramlist" title='The "paramlist" property'>paramlist</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Read / Write
"<a class="link" href="GdauiBasicForm.html#GdauiBasicForm--show-actions" title='The "show-actions" property'>show-actions</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
"<a class="link" href="GdauiBasicForm.html#GdauiBasicForm--xml-layout" title='The "xml-layout" property'>xml-layout</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Write
</pre>
</div>
<div class="refsect1">
<a name="GdauiBasicForm.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GdauiBasicForm.html#GdauiBasicForm-activated" title='The "activated" signal'>activated</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
"<a class="link" href="GdauiBasicForm.html#GdauiBasicForm-holder-changed" title='The "holder-changed" signal'>holder-changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
"<a class="link" href="GdauiBasicForm.html#GdauiBasicForm-layout-changed" title='The "layout-changed" signal'>layout-changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
"<a class="link" href="GdauiBasicForm.html#GdauiBasicForm-populate-popup" title='The "populate-popup" signal'>populate-popup</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GdauiBasicForm.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget is a form containing an entry for each <a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> object
contained in a <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> (specified when the form is created). A typical usage is when the
user is requested to enter a value which will be used in a statement (without any error checking for clarity):
</p>
<pre class="programlisting">
GdaStatement *stmt;
GdaSet *params;
stmt = gda_sql_parser_parse_string (parser, "SELECT * FROM customers where name LIKE #name::string", NULL, NULL);
gda_statement_get_parameters (stmt, &params, NULL);
GtkWidget *form;
gint result;
form = gdaui_basic_form_new_in_dialog (params, NULL, "Customer search", "Enter Customer search expression");
result = gtk_dialog_run (GTK_DIALOG (form));
gtk_widget_destroy (form);
if (result == GTK_RESPONSE_ACCEPT) {
/* execute statement */
GdaDataModel *model;
model = gda_connection_statement_execute_select (cnc, stmt, params, NULL);
[...]
}
g_object_unref (params);
g_object_unref (stmt);
</pre>
<p>
</p>
<p>
The default layout within a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> is a vertical column: all the data entry widgets are aligned
in a single column. This behaviour can be changed using the <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-set-layout-from-file" title="gdaui_basic_form_set_layout_from_file ()"><code class="function">gdaui_basic_form_set_layout_from_file()</code></a> method or
setting the <a class="link" href="GdauiBasicForm.html#GdauiBasicForm--xml-layout" title='The "xml-layout" property'>xml-layout</a> property.
</p>
<div class="refsect2">
<a name="GdauiBasicFormXMLLayout"></a><h3>XML Layout Definitions</h3>
<p>
The <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> class parses textual descriptions of XML layout which
which can be described by the following DTD.
</p>
<p>
</p>
<pre class="programlisting">
<!ELEMENT gdaui_layouts (gdaui_form | gdaui_grid)>
<!ELEMENT gdaui_form (gdaui_section | gdaui_column | gdaui_notebook)*>
<!ATTLIST gdaui_form
name CDATA #REQUIRED
container (columns|rows|hpaned|vpaned) #IMPLIED>
<!ELEMENT gdaui_section (gdaui_section | gdaui_column | gdaui_notebook)*>
<!ATTLIST gdaui_section
title CDATA #IMPLIED >
<!ELEMENT gdaui_notebook (gdaui_section | gdaui_column | gdaui_notebook)*>
<!ELEMENT gdaui_column (gdaui_entry | gdaui_placeholder)*>
<!ELEMENT gdaui_entry EMPTY>
<!ATTLIST gdaui_entry
name CDATA #REQUIRED
editable (true|false) #IMPLIED
label CDATA #IMPLIED
plugin CDATA #IMPLIED>
<!ELEMENT gdaui_placeholder EMPTY>
<!ATTLIST gdaui_placeholder
id CDATA #REQUIRED
label CDATA #IMPLIED>
</pre>
<p>
</p>
<div class="example">
<a name="id882688"></a><p class="title"><b>Example 1. A GdauiBasicForm layout example</b></p>
<div class="example-contents"><pre class="programlisting">
<?xml version="1.0" encoding="UTF-8"?>
<gdaui_layouts>
<gdaui_form name="customers" container="hpaned">
<gdaui_section title="Summary">
<gdaui_column>
<gdaui_entry name="id" editable="no"/>
<gdaui_entry name="name"/>
<gdaui_entry name="comments" plugin="text"/>
<gdaui_entry name="total_orders" label="Total ordered" plugin="number:NB_DECIMALS=2;CURRENCY=€"/>
</gdaui_column>
</gdaui_section>
<gdaui_section title="Photo">
<gdaui_column>
<gdaui_entry name="photo" plugin="picture"/>
</gdaui_column>
</gdaui_section>
</gdaui_form>
</gdaui_layouts>
</pre></div>
</div>
<br class="example-break">
</div>
</div>
<div class="refsect1">
<a name="GdauiBasicForm.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdauiBasicForm-struct"></a><h3>struct GdauiBasicForm</h3>
<pre class="programlisting">struct GdauiBasicForm;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-new"></a><h3>gdaui_basic_form_new ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gdaui_basic_form_new (<em class="parameter"><code><a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> *data_set</code></em>);</pre>
<p>
Creates a new <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget using all the <a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> objects provided in <em class="parameter"><code>data_set</code></em>.
</p>
<p>
The global layout is rendered using a table (a <a href="http://library.gnome.org/devel/gtk3/GtkTable.html"><span class="type">GtkTable</span></a>), and an entry is created for each
node of <em class="parameter"><code>data_set</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_set</code></em> :</span></p></td>
<td>a <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> structure</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new widget. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-new-in-dialog"></a><h3>gdaui_basic_form_new_in_dialog ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gdaui_basic_form_new_in_dialog (<em class="parameter"><code><a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> *data_set</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *header</code></em>);</pre>
<p>
Creates a new <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget in the same way as <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-new" title="gdaui_basic_form_new ()"><code class="function">gdaui_basic_form_new()</code></a>
and puts it into a <a href="http://library.gnome.org/devel/gtk3/GtkDialog.html"><span class="type">GtkDialog</span></a> widget. The returned dialog has the "Ok" and "Cancel" buttons
which respectively return GTK_RESPONSE_ACCEPT and GTK_RESPONSE_REJECT.
</p>
<p>
The <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget is attached to the dialog using the user property
"form".
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_set</code></em> :</span></p></td>
<td>a <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
<td>the parent window for the new dialog, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td>the title of the dialog window, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
<td>a helper text displayed at the top of the dialog, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <a href="http://library.gnome.org/devel/gtk3/GtkDialog.html"><span class="type">GtkDialog</span></a> widget. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-get-data-set"></a><h3>gdaui_basic_form_get_data_set ()</h3>
<pre class="programlisting"><a class="link" href="GdaSet.html" title="GdaSet"><span class="returnvalue">GdaSet</span></a> * gdaui_basic_form_get_data_set (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>);</pre>
<p>
Get a pointer to the <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> object which
is modified by <em class="parameter"><code>form</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to the <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a>. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-is-valid"></a><h3>gdaui_basic_form_is_valid ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gdaui_basic_form_is_valid (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>);</pre>
<p>
Tells if the form can be used as-is (if all the parameters do have some valid values)
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the form is valid</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-has-changed"></a><h3>gdaui_basic_form_has_changed ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gdaui_basic_form_has_changed (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>);</pre>
<p>
Tells if the form has had at least on entry changed since <em class="parameter"><code>form</code></em> was created or
<a class="link" href="GdauiBasicForm.html#gdaui-basic-form-set-as-reference" title="gdaui_basic_form_set_as_reference ()"><code class="function">gdaui_basic_form_set_as_reference()</code></a> has been called.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if one entry has changed at least</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-reset"></a><h3>gdaui_basic_form_reset ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdaui_basic_form_reset (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>);</pre>
<p>
Resets all the entries in the form to their
original values
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget</td>
</tr></tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-set-as-reference"></a><h3>gdaui_basic_form_set_as_reference ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdaui_basic_form_set_as_reference (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>);</pre>
<p>
Tells <em class="parameter"><code>form</code></em> that the current values in the different entries are
to be considered as the original values for all the entries; the immediate
consequence is that any sub-sequent call to <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-has-changed" title="gdaui_basic_form_has_changed ()"><code class="function">gdaui_basic_form_has_changed()</code></a>
will return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> (of course until any entry is changed).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget</td>
</tr></tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-entry-set-visible"></a><h3>gdaui_basic_form_entry_set_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdaui_basic_form_entry_set_visible (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> *holder</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show</code></em>);</pre>
<p>
Shows or hides the <a class="link" href="GdauiDataEntry.html" title="GdauiDataEntry"><span class="type">GdauiDataEntry</span></a> in <em class="parameter"><code>form</code></em> which corresponds to the
<em class="parameter"><code>param</code></em> parameter
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>show</code></em> :</span></p></td>
<td>set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to show the data entry, and to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to hide it</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-entry-grab-focus"></a><h3>gdaui_basic_form_entry_grab_focus ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdaui_basic_form_entry_grab_focus (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> *holder</code></em>);</pre>
<p>
Makes the data entry corresponding to <em class="parameter"><code>param</code></em> grab the focus for the window it's in
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget</td>
</tr></tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-entry-set-editable"></a><h3>gdaui_basic_form_entry_set_editable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdaui_basic_form_entry_set_editable (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> *holder</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> editable</code></em>);</pre>
<p>
Sets the <a class="link" href="GdauiDataEntry.html" title="GdauiDataEntry"><span class="type">GdauiDataEntry</span></a> in <em class="parameter"><code>form</code></em> which corresponds to the
<em class="parameter"><code>holder</code></em> parameter editable or not. If <em class="parameter"><code>holder</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then all the parameters
are concerned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>holder</code></em> :</span></p></td>
<td>a <a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> object; or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>editable</code></em> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if corresponding data entry must be editable</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-set-entries-to-default"></a><h3>gdaui_basic_form_set_entries_to_default ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdaui_basic_form_set_entries_to_default
(<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>);</pre>
<p>
For each entry in the form, sets it to a default value if it is possible to do so.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget</td>
</tr></tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-get-entry-widget"></a><h3>gdaui_basic_form_get_entry_widget ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gdaui_basic_form_get_entry_widget (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> *holder</code></em>);</pre>
<p>
Get the <a class="link" href="GdauiDataEntry.html" title="GdauiDataEntry"><span class="type">GdauiDataEntry</span></a> in <em class="parameter"><code>form</code></em> which corresponds to the param parameter.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the requested widget, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not found. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-get-label-widget"></a><h3>gdaui_basic_form_get_label_widget ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gdaui_basic_form_get_label_widget (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> *holder</code></em>);</pre>
<p>
Get the label in <em class="parameter"><code>form</code></em> which corresponds to the param parameter.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the requested widget, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not found. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-set-layout-from-file"></a><h3>gdaui_basic_form_set_layout_from_file ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdaui_basic_form_set_layout_from_file
(<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file_name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *form_name</code></em>);</pre>
<p>
Sets a form layout according an XML description contained in <em class="parameter"><code>file_name</code></em>, for the form identified
by the <em class="parameter"><code>form_name</code></em> name (as an XML layout file can contain the descriptions of several forms and grids).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_name</code></em> :</span></p></td>
<td>XML file name to use</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>form_name</code></em> :</span></p></td>
<td>the name of the form to use, in <em class="parameter"><code>file_name</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-get-place-holder"></a><h3>gdaui_basic_form_get_place_holder ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gdaui_basic_form_get_place_holder (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *placeholder_id</code></em>);</pre>
<p>
Retreives a pointer to a place holder widget. This feature is only available if a specific
layout has been defined for <em class="parameter"><code>form</code></em> using <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-set-layout-from-file" title="gdaui_basic_form_set_layout_from_file ()"><code class="function">gdaui_basic_form_set_layout_from_file()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>placeholder_id</code></em> :</span></p></td>
<td>the name of the requested place holder</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to the requested place holder, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not found. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="GdauiBasicFormPart"></a><h3>enum GdauiBasicFormPart</h3>
<pre class="programlisting">typedef enum {
GDAUI_BASIC_FORM_LABELS,
GDAUI_BASIC_FORM_ENTRIES
} GdauiBasicFormPart;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-add-to-size-group"></a><h3>gdaui_basic_form_add_to_size_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdaui_basic_form_add_to_size_group (<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkSizeGroup.html"><span class="type">GtkSizeGroup</span></a> *size_group</code></em>,
<em class="parameter"><code><a class="link" href="GdauiBasicForm.html#GdauiBasicFormPart" title="enum GdauiBasicFormPart"><span class="type">GdauiBasicFormPart</span></a> part</code></em>);</pre>
<p>
Add <em class="parameter"><code>form</code></em>'s widgets specified by <em class="parameter"><code>part</code></em> to <em class="parameter"><code>size_group</code></em>
(the widgets can then be removed using <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-remove-from-size-group" title="gdaui_basic_form_remove_from_size_group ()"><code class="function">gdaui_basic_form_remove_from_size_group()</code></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size_group</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gtk3/GtkSizeGroup.html"><span class="type">GtkSizeGroup</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
<td>specifies which widgets in <em class="parameter"><code>form</code></em> are concerned</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdaui-basic-form-remove-from-size-group"></a><h3>gdaui_basic_form_remove_from_size_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdaui_basic_form_remove_from_size_group
(<em class="parameter"><code><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gtk3/GtkSizeGroup.html"><span class="type">GtkSizeGroup</span></a> *size_group</code></em>,
<em class="parameter"><code><a class="link" href="GdauiBasicForm.html#GdauiBasicFormPart" title="enum GdauiBasicFormPart"><span class="type">GdauiBasicFormPart</span></a> part</code></em>);</pre>
<p>
Removes <em class="parameter"><code>form</code></em>'s widgets specified by <em class="parameter"><code>part</code></em> from <em class="parameter"><code>size_group</code></em>
(the widgets must have been added using <a class="link" href="GdauiBasicForm.html#gdaui-basic-form-add-to-size-group" title="gdaui_basic_form_add_to_size_group ()"><code class="function">gdaui_basic_form_add_to_size_group()</code></a>).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td>a <a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size_group</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gtk3/GtkSizeGroup.html"><span class="type">GtkSizeGroup</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
<td>specifies which widgets in <em class="parameter"><code>form</code></em> are concerned</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2</p>
</div>
</div>
<div class="refsect1">
<a name="GdauiBasicForm.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdauiBasicForm--can-expand-v"></a><h3>The <code class="literal">"can-expand-v"</code> property</h3>
<pre class="programlisting"> "can-expand-v" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
<p></p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GdauiBasicForm--entries-auto-default"></a><h3>The <code class="literal">"entries-auto-default"</code> property</h3>
<pre class="programlisting"> "entries-auto-default" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p></p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GdauiBasicForm--headers-sensitive"></a><h3>The <code class="literal">"headers-sensitive"</code> property</h3>
<pre class="programlisting"> "headers-sensitive" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p></p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GdauiBasicForm--paramlist"></a><h3>The <code class="literal">"paramlist"</code> property</h3>
<pre class="programlisting"> "paramlist" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Read / Write</pre>
<p></p>
</div>
<hr>
<div class="refsect2">
<a name="GdauiBasicForm--show-actions"></a><h3>The <code class="literal">"show-actions"</code> property</h3>
<pre class="programlisting"> "show-actions" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p></p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GdauiBasicForm--xml-layout"></a><h3>The <code class="literal">"xml-layout"</code> property</h3>
<pre class="programlisting"> "xml-layout" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> : Write</pre>
<p></p>
</div>
</div>
<div class="refsect1">
<a name="GdauiBasicForm.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GdauiBasicForm-activated"></a><h3>The <code class="literal">"activated"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
Emitted when the use has activated any of the <span class="type">GdaDataEntry</span> widget
in <em class="parameter"><code>form</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GdauiBasicForm-holder-changed"></a><h3>The <code class="literal">"holder-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form,
<a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> *param,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> is_user_modif,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
Emitted when a GdaHolder changed in <em class="parameter"><code>form</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>param</code></em> :</span></p></td>
<td>the <a class="link" href="GdaHolder.html" title="GdaHolder"><span class="type">GdaHolder</span></a> that changed</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>is_user_modif</code></em> :</span></p></td>
<td>TRUE if the modification has been initiated by a user modification</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GdauiBasicForm-layout-changed"></a><h3>The <code class="literal">"layout-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
Emitted when the form's layout changes
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GdauiBasicForm-populate-popup"></a><h3>The <code class="literal">"populate-popup"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a> *form,
<a href="http://library.gnome.org/devel/gtk3/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
Connect this signal and modify the popup menu.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>form</code></em> :</span></p></td>
<td><a class="link" href="GdauiBasicForm.html" title="GdauiBasicForm"><span class="type">GdauiBasicForm</span></a></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gtk3/GtkMenu.html"><span class="type">GtkMenu</span></a> to modify</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 4.2.4</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|