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
|
<refentry id="GnomeMDI">
<refmeta>
<refentrytitle role="top_of_page">GnomeMDI</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GnomeMDI</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <libgnomeui/libgnomeui.h>
enum <link linkend="GnomeMDIMode">GnomeMDIMode</link>;
<link linkend="GnomeMDI-struct">GnomeMDI</link>;
<link linkend="GtkObject">GtkObject</link>* <link linkend="gnome-mdi-new">gnome_mdi_new</link> (const <link linkend="gchar">gchar</link> *appname,
const <link linkend="gchar">gchar</link> *title);
<link linkend="void">void</link> <link linkend="gnome-mdi-set-mode">gnome_mdi_set_mode</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIMode">GnomeMDIMode</link> mode);
<link linkend="void">void</link> <link linkend="gnome-mdi-set-menubar-template">gnome_mdi_set_menubar_template</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeUIInfo">GnomeUIInfo</link> *menu_tmpl);
<link linkend="void">void</link> <link linkend="gnome-mdi-set-toolbar-template">gnome_mdi_set_toolbar_template</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeUIInfo">GnomeUIInfo</link> *tbar_tmpl);
<link linkend="void">void</link> <link linkend="gnome-mdi-set-child-menu-path">gnome_mdi_set_child_menu_path</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
const <link linkend="gchar">gchar</link> *path);
<link linkend="void">void</link> <link linkend="gnome-mdi-set-child-list-path">gnome_mdi_set_child_list_path</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
const <link linkend="gchar">gchar</link> *path);
<link linkend="gint">gint</link> <link linkend="gnome-mdi-add-view">gnome_mdi_add_view</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIChild">GnomeMDIChild</link> *child);
<link linkend="gint">gint</link> <link linkend="gnome-mdi-add-toplevel-view">gnome_mdi_add_toplevel_view</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIChild">GnomeMDIChild</link> *child);
<link linkend="gint">gint</link> <link linkend="gnome-mdi-remove-view">gnome_mdi_remove_view</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GtkWidget">GtkWidget</link> *view,
<link linkend="gint">gint</link> force);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-mdi-get-active-view">gnome_mdi_get_active_view</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi);
<link linkend="void">void</link> <link linkend="gnome-mdi-set-active-view">gnome_mdi_set_active_view</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GtkWidget">GtkWidget</link> *view);
<link linkend="gint">gint</link> <link linkend="gnome-mdi-add-child">gnome_mdi_add_child</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIChild">GnomeMDIChild</link> *child);
<link linkend="gint">gint</link> <link linkend="gnome-mdi-remove-child">gnome_mdi_remove_child</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIChild">GnomeMDIChild</link> *child,
<link linkend="gint">gint</link> force);
<link linkend="gint">gint</link> <link linkend="gnome-mdi-remove-all">gnome_mdi_remove_all</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="gint">gint</link> force);
<link linkend="void">void</link> <link linkend="gnome-mdi-open-toplevel">gnome_mdi_open_toplevel</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi);
<link linkend="void">void</link> <link linkend="gnome-mdi-update-child">gnome_mdi_update_child</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIChild">GnomeMDIChild</link> *child);
<link linkend="GnomeMDIChild">GnomeMDIChild</link>* <link linkend="gnome-mdi-get-active-child">gnome_mdi_get_active_child</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi);
<link linkend="GnomeMDIChild">GnomeMDIChild</link>* <link linkend="gnome-mdi-find-child">gnome_mdi_find_child</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
const <link linkend="gchar">gchar</link> *name);
<link linkend="GnomeApp">GnomeApp</link>* <link linkend="gnome-mdi-get-active-window">gnome_mdi_get_active_window</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi);
<link linkend="void">void</link> <link linkend="gnome-mdi-register">gnome_mdi_register</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GtkObject">GtkObject</link> *object);
<link linkend="void">void</link> <link linkend="gnome-mdi-unregister">gnome_mdi_unregister</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GtkObject">GtkObject</link> *object);
<link linkend="GnomeApp">GnomeApp</link>* <link linkend="gnome-mdi-get-app-from-view">gnome_mdi_get_app_from_view</link> (<link linkend="GtkWidget">GtkWidget</link> *view);
<link linkend="GnomeMDIChild">GnomeMDIChild</link>* <link linkend="gnome-mdi-get-child-from-view">gnome_mdi_get_child_from_view</link> (<link linkend="GtkWidget">GtkWidget</link> *view);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-mdi-get-view-from-window">gnome_mdi_get_view_from_window</link> (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeApp">GnomeApp</link> *app);
<link linkend="GnomeUIInfo">GnomeUIInfo</link>* <link linkend="gnome-mdi-get-menubar-info">gnome_mdi_get_menubar_info</link> (<link linkend="GnomeApp">GnomeApp</link> *app);
<link linkend="GnomeUIInfo">GnomeUIInfo</link>* <link linkend="gnome-mdi-get-toolbar-info">gnome_mdi_get_toolbar_info</link> (<link linkend="GnomeApp">GnomeApp</link> *app);
<link linkend="GnomeUIInfo">GnomeUIInfo</link>* <link linkend="gnome-mdi-get-child-menu-info">gnome_mdi_get_child_menu_info</link> (<link linkend="GnomeApp">GnomeApp</link> *app);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----GnomeMDI
</synopsis>
</refsect1>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="GnomeMDI-add-child">add-child</link>" : Run Last
"<link linkend="GnomeMDI-add-view">add-view</link>" : Run Last
"<link linkend="GnomeMDI-app-created">app-created</link>" : Run Last
"<link linkend="GnomeMDI-child-changed">child-changed</link>" : Run Last
"<link linkend="GnomeMDI-remove-child">remove-child</link>" : Run Last
"<link linkend="GnomeMDI-remove-view">remove-view</link>" : Run Last
"<link linkend="GnomeMDI-view-changed">view-changed</link>" : Run Last
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GnomeMDIMode" role="enum" condition="deprecated:"/>enum GnomeMDIMode</title>
<indexterm role="deprecated"><primary>GnomeMDIMode</primary></indexterm><programlisting>typedef enum {
GNOME_MDI_NOTEBOOK,
GNOME_MDI_TOPLEVEL,
GNOME_MDI_MODAL,
GNOME_MDI_DEFAULT_MODE = 42
} GnomeMDIMode;
</programlisting>
<warning><para><literal>GnomeMDIMode</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GnomeMDI-struct" role="struct"/>GnomeMDI</title>
<indexterm role="deprecated"><primary>GnomeMDI</primary></indexterm><programlisting>typedef struct _GnomeMDI GnomeMDI;</programlisting>
<warning><para><literal>GnomeMDI</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-new" role="function" condition="deprecated:"/>gnome_mdi_new ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_new</primary></indexterm><programlisting><link linkend="GtkObject">GtkObject</link>* gnome_mdi_new (const <link linkend="gchar">gchar</link> *appname,
const <link linkend="gchar">gchar</link> *title);</programlisting>
<warning><para><literal>gnome_mdi_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Creates a new MDI object. <parameter>appname</parameter> and <parameter>title</parameter> are used for
MDI's calling <link linkend="gnome-app-new"><function>gnome_app_new()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>appname</parameter> :</term>
<listitem><simpara> Application name as used in filenames and paths.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>title</parameter> :</term>
<listitem><simpara> Title of the application windows.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
A pointer to a new GnomeMDI object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-set-mode" role="function" condition="deprecated:"/>gnome_mdi_set_mode ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_set_mode</primary></indexterm><programlisting><link linkend="void">void</link> gnome_mdi_set_mode (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIMode">GnomeMDIMode</link> mode);</programlisting>
<warning><para><literal>gnome_mdi_set_mode</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the MDI mode to mode. Possible values are <link linkend="GNOME-MDI-TOPLEVEL:CAPS"><literal>GNOME_MDI_TOPLEVEL</literal></link>,
<link linkend="GNOME-MDI-NOTEBOOK:CAPS"><literal>GNOME_MDI_NOTEBOOK</literal></link>, <link linkend="GNOME-MDI-MODAL:CAPS"><literal>GNOME_MDI_MODAL</literal></link> and <link linkend="GNOME-MDI-DEFAULT:CAPS"><literal>GNOME_MDI_DEFAULT</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mode</parameter> :</term>
<listitem><simpara> New mode.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-set-menubar-template" role="function" condition="deprecated:"/>gnome_mdi_set_menubar_template ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_set_menubar_template</primary></indexterm><programlisting><link linkend="void">void</link> gnome_mdi_set_menubar_template (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeUIInfo">GnomeUIInfo</link> *menu_tmpl);</programlisting>
<warning><para><literal>gnome_mdi_set_menubar_template</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This function sets the template for menus that appear in each toplevel
window to menu_template. For each new toplevel window created by the MDI,
this structure is copied, the menus are created with
<link linkend="gnome-app-create-menus-with-data"><function>gnome_app_create_menus_with_data()</function></link> function with mdi as the callback
user data. Finally, the pointer to the copy is assigned to the new
toplevel window (a GnomeApp widget) and can be obtained by calling
&gnome_mdi_get_menubar_info.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>menu_tmpl</parameter> :</term>
<listitem><simpara> A GnomeUIInfo array describing the menu.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-set-toolbar-template" role="function" condition="deprecated:"/>gnome_mdi_set_toolbar_template ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_set_toolbar_template</primary></indexterm><programlisting><link linkend="void">void</link> gnome_mdi_set_toolbar_template (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeUIInfo">GnomeUIInfo</link> *tbar_tmpl);</programlisting>
<warning><para><literal>gnome_mdi_set_toolbar_template</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This function sets the template for toolbar that appears in each toplevel
window to toolbar_template. For each new toplevel window created by the MDI,
this structure is copied, the toolbar is created with
<link linkend="gnome-app-create-toolbar-with-data"><function>gnome_app_create_toolbar_with_data()</function></link> function with mdi as the callback
user data. Finally, the pointer to the copy is assigned to the new toplevel
window (a GnomeApp widget) and can be retrieved with a call to
&gnome_mdi_get_toolbar_info.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tbar_tmpl</parameter> :</term>
<listitem><simpara> A GnomeUIInfo array describing the toolbar.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-set-child-menu-path" role="function" condition="deprecated:"/>gnome_mdi_set_child_menu_path ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_set_child_menu_path</primary></indexterm><programlisting><link linkend="void">void</link> gnome_mdi_set_child_menu_path (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
const <link linkend="gchar">gchar</link> *path);</programlisting>
<warning><para><literal>gnome_mdi_set_child_menu_path</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the desired position of child-specific menus (which are added to and
removed from the main menus as views of different children are activated).
See gnome_app_find_menu_pos for details on menu paths.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter> :</term>
<listitem><simpara> A menu path where the child menus should be inserted.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-set-child-list-path" role="function" condition="deprecated:"/>gnome_mdi_set_child_list_path ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_set_child_list_path</primary></indexterm><programlisting><link linkend="void">void</link> gnome_mdi_set_child_list_path (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
const <link linkend="gchar">gchar</link> *path);</programlisting>
<warning><para><literal>gnome_mdi_set_child_list_path</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the position for insertion of menu items used to activate the MDI
children that were added to the MDI. See gnome_app_find_menu_pos for
details on menu paths. If the path is not set or set to <link linkend="NULL:CAPS"><literal>NULL</literal></link>, these menu
items aren't going to be inserted in the MDI menu structure. Note that if
you want all menu items to be inserted in their own submenu, you have to
create that submenu (and leave it empty, of course).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter> :</term>
<listitem><simpara> A menu path where the child list menu should be inserted
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-add-view" role="function" condition="deprecated:"/>gnome_mdi_add_view ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_add_view</primary></indexterm><programlisting><link linkend="gint">gint</link> gnome_mdi_add_view (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIChild">GnomeMDIChild</link> *child);</programlisting>
<warning><para><literal>gnome_mdi_add_view</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Creates a new view of the child and adds it to the MDI. GnomeMDIChild
<parameter>child</parameter> has to be added to the MDI with a call to gnome_mdi_add_child
before its views are added to the MDI.
An "add_view" signal is emitted to the MDI after the view has been
created, but before it is shown and added to the MDI, with a pointer to
the created view as its parameter. The view is added to the MDI only if
the signal handler (if it exists) returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. If the handler returns
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link>, the created view is destroyed and not added to the MDI.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>child</parameter> :</term>
<listitem><simpara> A pointer to a child.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if adding the view succeeded and <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-add-toplevel-view" role="function" condition="deprecated:"/>gnome_mdi_add_toplevel_view ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_add_toplevel_view</primary></indexterm><programlisting><link linkend="gint">gint</link> gnome_mdi_add_toplevel_view (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIChild">GnomeMDIChild</link> *child);</programlisting>
<warning><para><literal>gnome_mdi_add_toplevel_view</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Creates a new view of the child and adds it to the MDI; it behaves the
same way as gnome_mdi_add_view in <link linkend="GNOME-MDI-MODAL:CAPS"><literal>GNOME_MDI_MODAL</literal></link> and <link linkend="GNOME-MDI-TOPLEVEL:CAPS"><literal>GNOME_MDI_TOPLEVEL</literal></link>
modes, but in <link linkend="GNOME-MDI-NOTEBOOK:CAPS"><literal>GNOME_MDI_NOTEBOOK</literal></link> mode, the view is added in a new
toplevel window unless the active one has no views in it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>child</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDIChild object to be added to the MDI.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if adding the view succeeded and <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-remove-view" role="function" condition="deprecated:"/>gnome_mdi_remove_view ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_remove_view</primary></indexterm><programlisting><link linkend="gint">gint</link> gnome_mdi_remove_view (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GtkWidget">GtkWidget</link> *view,
<link linkend="gint">gint</link> force);</programlisting>
<warning><para><literal>gnome_mdi_remove_view</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Removes a view from an MDI.
A "remove_view" signal is emitted to the MDI before actually removing
view. The view is removed only if the signal handler (if it exists and
the <parameter>force</parameter> is set to <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>) returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>view</parameter> :</term>
<listitem><simpara> View to remove.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>force</parameter> :</term>
<listitem><simpara> If TRUE, the "remove_view" signal is not emitted.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the view was removed and <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-get-active-view" role="function" condition="deprecated:"/>gnome_mdi_get_active_view ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_get_active_view</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_mdi_get_active_view (<link linkend="GnomeMDI">GnomeMDI</link> *mdi);</programlisting>
<warning><para><literal>gnome_mdi_get_active_view</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Returns a pointer to the active view (the one with the focus).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
A pointer to a GtkWidget *.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-set-active-view" role="function" condition="deprecated:"/>gnome_mdi_set_active_view ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_set_active_view</primary></indexterm><programlisting><link linkend="void">void</link> gnome_mdi_set_active_view (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GtkWidget">GtkWidget</link> *view);</programlisting>
<warning><para><literal>gnome_mdi_set_active_view</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the active view to <parameter>view</parameter>. It also raises the window containing it
and gives it focus.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to an MDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>view</parameter> :</term>
<listitem><simpara> A pointer to the view that is to become the active one.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-add-child" role="function" condition="deprecated:"/>gnome_mdi_add_child ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_add_child</primary></indexterm><programlisting><link linkend="gint">gint</link> gnome_mdi_add_child (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIChild">GnomeMDIChild</link> *child);</programlisting>
<warning><para><literal>gnome_mdi_add_child</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Adds a new child to the MDI. No views are added: this has to be done with
a call to gnome_mdi_add_view.
First an "add_child" signal is emitted to the MDI with a pointer to the
child as its parameter. The child is added to the MDI only if the signal
handler (if it exists) returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. If the handler returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>, the
child is not added to the MDI.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>child</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDIChild to add to the MDI.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the child was added successfully and <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-remove-child" role="function" condition="deprecated:"/>gnome_mdi_remove_child ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_remove_child</primary></indexterm><programlisting><link linkend="gint">gint</link> gnome_mdi_remove_child (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIChild">GnomeMDIChild</link> *child,
<link linkend="gint">gint</link> force);</programlisting>
<warning><para><literal>gnome_mdi_remove_child</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Removes a child and all of its views from the MDI.
A "remove_child" signal is emitted to the MDI with <parameter>child</parameter> as its parameter
before actually removing the child. The child is removed only if the signal
handler (if it exists and the <parameter>force</parameter> is set to <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>) returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>child</parameter> :</term>
<listitem><simpara> Child to remove.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>force</parameter> :</term>
<listitem><simpara> If TRUE, the "remove_child" signal is not emitted
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the removal was successful and <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-remove-all" role="function" condition="deprecated:"/>gnome_mdi_remove_all ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_remove_all</primary></indexterm><programlisting><link linkend="gint">gint</link> gnome_mdi_remove_all (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="gint">gint</link> force);</programlisting>
<warning><para><literal>gnome_mdi_remove_all</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Removes all children and all views from the MDI.
A "remove_child" signal is emitted to the MDI for each child before
actually trying to remove any. If signal handlers for all children (if
they exist and the <parameter>force</parameter> is set to <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>) return <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, all children
and their views are removed and none otherwise.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>force</parameter> :</term>
<listitem><simpara> If TRUE, the "remove_child" signal is not emitted
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
<link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the removal was successful and <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-open-toplevel" role="function" condition="deprecated:"/>gnome_mdi_open_toplevel ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_open_toplevel</primary></indexterm><programlisting><link linkend="void">void</link> gnome_mdi_open_toplevel (<link linkend="GnomeMDI">GnomeMDI</link> *mdi);</programlisting>
<warning><para><literal>gnome_mdi_open_toplevel</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Opens a new toplevel window (unless in <link linkend="GNOME-MDI-MODAL:CAPS"><literal>GNOME_MDI_MODAL</literal></link> mode and a
toplevel window is already open). This is usually used only for opening
the initial window on startup (just before calling <link linkend="gtkmain"><function>gtkmain()</function></link>) if no
windows were open because a session was restored or children were added
because of command line args).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-update-child" role="function" condition="deprecated:"/>gnome_mdi_update_child ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_update_child</primary></indexterm><programlisting><link linkend="void">void</link> gnome_mdi_update_child (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIChild">GnomeMDIChild</link> *child);</programlisting>
<warning><para><literal>gnome_mdi_update_child</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Updates all notebook labels of <parameter>child</parameter>'s views and their window titles
after its name changes. It is not required if <link linkend="gnome-mdi-child-set-name"><function>gnome_mdi_child_set_name()</function></link>
is used for setting the child's name.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>child</parameter> :</term>
<listitem><simpara> Child to update.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-get-active-child" role="function" condition="deprecated:"/>gnome_mdi_get_active_child ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_get_active_child</primary></indexterm><programlisting><link linkend="GnomeMDIChild">GnomeMDIChild</link>* gnome_mdi_get_active_child (<link linkend="GnomeMDI">GnomeMDI</link> *mdi);</programlisting>
<warning><para><literal>gnome_mdi_get_active_child</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Returns a pointer to the active GnomeMDIChild object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
A pointer to the active GnomeMDIChild object. <link linkend="NULL:CAPS"><literal>NULL</literal></link>, if there is none.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-find-child" role="function" condition="deprecated:"/>gnome_mdi_find_child ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_find_child</primary></indexterm><programlisting><link linkend="GnomeMDIChild">GnomeMDIChild</link>* gnome_mdi_find_child (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
const <link linkend="gchar">gchar</link> *name);</programlisting>
<warning><para><literal>gnome_mdi_find_child</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Finds a child named <parameter>name</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> A string with a name of the child to find.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
A pointer to the GnomeMDIChild object if the child was found and NULL
otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-get-active-window" role="function" condition="deprecated:"/>gnome_mdi_get_active_window ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_get_active_window</primary></indexterm><programlisting><link linkend="GnomeApp">GnomeApp</link>* gnome_mdi_get_active_window (<link linkend="GnomeMDI">GnomeMDI</link> *mdi);</programlisting>
<warning><para><literal>gnome_mdi_get_active_window</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Returns a pointer to the toplevel window containing the active view.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
A pointer to a GnomeApp that has the focus.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-register" role="function" condition="deprecated:"/>gnome_mdi_register ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_register</primary></indexterm><programlisting><link linkend="void">void</link> gnome_mdi_register (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GtkObject">GtkObject</link> *object);</programlisting>
<warning><para><literal>gnome_mdi_register</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Registers GtkObject <parameter>object</parameter> with MDI.
This is mostly intended for applications that open other windows besides
those opened by the MDI and want to continue to run even when no MDI
windows exist (an example of this would be GIMP's window with tools, if
the pictures were MDI children). As long as there is an object registered
with the MDI, the MDI will not destroy itself when the last of its windows
is closed. If no objects are registered, closing the last MDI window
results in MDI being destroyed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> Object to register.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-unregister" role="function" condition="deprecated:"/>gnome_mdi_unregister ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_unregister</primary></indexterm><programlisting><link linkend="void">void</link> gnome_mdi_unregister (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GtkObject">GtkObject</link> *object);</programlisting>
<warning><para><literal>gnome_mdi_unregister</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Removes GtkObject <parameter>object</parameter> from the list of registered objects.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara> Object to unregister.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-get-app-from-view" role="function" condition="deprecated:"/>gnome_mdi_get_app_from_view ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_get_app_from_view</primary></indexterm><programlisting><link linkend="GnomeApp">GnomeApp</link>* gnome_mdi_get_app_from_view (<link linkend="GtkWidget">GtkWidget</link> *view);</programlisting>
<warning><para><literal>gnome_mdi_get_app_from_view</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Returns the toplevel window for this view.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>view</parameter> :</term>
<listitem><simpara> A pointer to a GtkWidget.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
A pointer to the GnomeApp containg the specified view.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-get-child-from-view" role="function" condition="deprecated:"/>gnome_mdi_get_child_from_view ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_get_child_from_view</primary></indexterm><programlisting><link linkend="GnomeMDIChild">GnomeMDIChild</link>* gnome_mdi_get_child_from_view (<link linkend="GtkWidget">GtkWidget</link> *view);</programlisting>
<warning><para><literal>gnome_mdi_get_child_from_view</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Returns a child that <parameter>view</parameter> is a view of.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>view</parameter> :</term>
<listitem><simpara> A pointer to a GtkWidget.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
A pointer to the GnomeMDIChild the view belongs to.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-get-view-from-window" role="function" condition="deprecated:"/>gnome_mdi_get_view_from_window ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_get_view_from_window</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_mdi_get_view_from_window (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeApp">GnomeApp</link> *app);</programlisting>
<warning><para><literal>gnome_mdi_get_view_from_window</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Returns the pointer to the view in the MDI toplevel window <parameter>app</parameter>.
If the mode is set to <link linkend="GNOME-MDI-NOTEBOOK:CAPS"><literal>GNOME_MDI_NOTEBOOK</literal></link>, the view in the current
page is returned.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara> A pointer to a GnomeMDI object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A pointer to a GnomeApp widget.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
A pointer to a view.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-get-menubar-info" role="function" condition="deprecated:"/>gnome_mdi_get_menubar_info ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_get_menubar_info</primary></indexterm><programlisting><link linkend="GnomeUIInfo">GnomeUIInfo</link>* gnome_mdi_get_menubar_info (<link linkend="GnomeApp">GnomeApp</link> *app);</programlisting>
<warning><para><literal>gnome_mdi_get_menubar_info</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A pointer to a GnomeApp widget created by the MDI.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
A GnomeUIInfo array used for menubar in <parameter>app</parameter> if the menubar has been created with a template.
<link linkend="NULL:CAPS"><literal>NULL</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-get-toolbar-info" role="function" condition="deprecated:"/>gnome_mdi_get_toolbar_info ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_get_toolbar_info</primary></indexterm><programlisting><link linkend="GnomeUIInfo">GnomeUIInfo</link>* gnome_mdi_get_toolbar_info (<link linkend="GnomeApp">GnomeApp</link> *app);</programlisting>
<warning><para><literal>gnome_mdi_get_toolbar_info</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A pointer to a GnomeApp widget created by the MDI.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
A GnomeUIInfo array used for toolbar in <parameter>app</parameter> if the toolbar has been created with a template.
<link linkend="NULL:CAPS"><literal>NULL</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-mdi-get-child-menu-info" role="function" condition="deprecated:"/>gnome_mdi_get_child_menu_info ()</title>
<indexterm role="deprecated"><primary>gnome_mdi_get_child_menu_info</primary></indexterm><programlisting><link linkend="GnomeUIInfo">GnomeUIInfo</link>* gnome_mdi_get_child_menu_info (<link linkend="GnomeApp">GnomeApp</link> *app);</programlisting>
<warning><para><literal>gnome_mdi_get_child_menu_info</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app</parameter> :</term>
<listitem><simpara> A pointer to a GnomeApp widget created by the MDI.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
A GnomeUIInfo array used for child's menus in <parameter>app</parameter> if they have been created with a template.
<link linkend="NULL:CAPS"><literal>NULL</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="GnomeMDI-add-child"/>The <literal>"add-child"</literal> signal</title>
<indexterm><primary>GnomeMDI::add-child</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIChild">GnomeMDIChild</link> *arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="GnomeMDI-add-view"/>The <literal>"add-view"</literal> signal</title>
<indexterm><primary>GnomeMDI::add-view</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="GnomeMDI-app-created"/>The <literal>"app-created"</literal> signal</title>
<indexterm><primary>GnomeMDI::app-created</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeApp">GnomeApp</link> *arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="GnomeMDI-child-changed"/>The <literal>"child-changed"</literal> signal</title>
<indexterm><primary>GnomeMDI::child-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIChild">GnomeMDIChild</link> *arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="GnomeMDI-remove-child"/>The <literal>"remove-child"</literal> signal</title>
<indexterm><primary>GnomeMDI::remove-child</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GnomeMDIChild">GnomeMDIChild</link> *arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="GnomeMDI-remove-view"/>The <literal>"remove-view"</literal> signal</title>
<indexterm><primary>GnomeMDI::remove-view</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="GnomeMDI-view-changed"/>The <literal>"view-changed"</literal> signal</title>
<indexterm><primary>GnomeMDI::view-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GnomeMDI">GnomeMDI</link> *mdi,
<link linkend="GtkWidget">GtkWidget</link> *widget,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>mdi</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>widget</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|