/usr/include/gtkmm-2.4/gtkmm/uimanager.h is in libgtkmm-2.4-dev 1:2.24.5-2.
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 | // -*- c++ -*-
// Generated by gmmproc 2.45.3 -- DO NOT MODIFY!
#ifndef _GTKMM_UIMANAGER_H
#define _GTKMM_UIMANAGER_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* $Id: uimanager.hg,v 1.17 2006/05/11 11:40:24 murrayc Exp $ */
/* Copyright (C) 2003 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <gtkmm/widget.h>
#include <gtkmm/action.h>
#include <gtkmm/actiongroup.h>
#include <gtkmm/uimanager.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkUIManager GtkUIManager;
typedef struct _GtkUIManagerClass GtkUIManagerClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{ class UIManager_Class; } // namespace Gtk
#endif //DOXYGEN_SHOULD_SKIP_THIS
namespace Gtk
{
/** @addtogroup gtkmmEnums gtkmm Enums and Flags */
/**
*
* @ingroup gtkmmEnums
* @par Bitwise operators:
* <tt>%UIManagerItemType operator|(UIManagerItemType, UIManagerItemType)</tt><br>
* <tt>%UIManagerItemType operator&(UIManagerItemType, UIManagerItemType)</tt><br>
* <tt>%UIManagerItemType operator^(UIManagerItemType, UIManagerItemType)</tt><br>
* <tt>%UIManagerItemType operator~(UIManagerItemType)</tt><br>
* <tt>%UIManagerItemType& operator|=(UIManagerItemType&, UIManagerItemType)</tt><br>
* <tt>%UIManagerItemType& operator&=(UIManagerItemType&, UIManagerItemType)</tt><br>
* <tt>%UIManagerItemType& operator^=(UIManagerItemType&, UIManagerItemType)</tt><br>
*/
enum UIManagerItemType
{
UI_MANAGER_AUTO = 0,
UI_MANAGER_MENUBAR = 1 << 0,
UI_MANAGER_MENU = 1 << 1,
UI_MANAGER_TOOLBAR = 1 << 2,
UI_MANAGER_PLACEHOLDER = 1 << 3,
UI_MANAGER_POPUP = 1 << 4,
UI_MANAGER_MENUITEM = 1 << 5,
UI_MANAGER_TOOLITEM = 1 << 6,
UI_MANAGER_SEPARATOR = 1 << 7,
UI_MANAGER_ACCELERATOR = 1 << 8,
UI_MANAGER_POPUP_WITH_ACCELS = 1 << 9
};
/** @ingroup gtkmmEnums */
inline UIManagerItemType operator|(UIManagerItemType lhs, UIManagerItemType rhs)
{ return static_cast<UIManagerItemType>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup gtkmmEnums */
inline UIManagerItemType operator&(UIManagerItemType lhs, UIManagerItemType rhs)
{ return static_cast<UIManagerItemType>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup gtkmmEnums */
inline UIManagerItemType operator^(UIManagerItemType lhs, UIManagerItemType rhs)
{ return static_cast<UIManagerItemType>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup gtkmmEnums */
inline UIManagerItemType operator~(UIManagerItemType flags)
{ return static_cast<UIManagerItemType>(~static_cast<unsigned>(flags)); }
/** @ingroup gtkmmEnums */
inline UIManagerItemType& operator|=(UIManagerItemType& lhs, UIManagerItemType rhs)
{ return (lhs = static_cast<UIManagerItemType>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup gtkmmEnums */
inline UIManagerItemType& operator&=(UIManagerItemType& lhs, UIManagerItemType rhs)
{ return (lhs = static_cast<UIManagerItemType>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup gtkmmEnums */
inline UIManagerItemType& operator^=(UIManagerItemType& lhs, UIManagerItemType rhs)
{ return (lhs = static_cast<UIManagerItemType>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
} // namespace Gtk
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gtk::UIManagerItemType> : public Glib::Value_Flags<Gtk::UIManagerItemType>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gtk
{
/** Constructing menus and toolbars from an XML description.
*
* A Gtk::UIManager constructs a user interface (menus and toolbars) from one or more UI definitions,
* which reference actions from one or more action groups.
*
* \par UI Definitions
*
* The UI definitions are specified in an XML format which can be roughly described by the following DTD.
* \code
* <!ELEMENT ui (menubar|toolbar|popup|accelerator)* >
* <!ELEMENT menubar (menuitem|separator|placeholder|menu)* >
* <!ELEMENT menu (menuitem|separator|placeholder|menu)* >
* <!ELEMENT popup (menuitem|separator|placeholder|menu)* >
* <!ELEMENT toolbar (toolitem|separator|placeholder)* >
* <!ELEMENT placeholder (menuitem|toolitem|separator|placeholder|menu)* >
* <!ELEMENT menuitem EMPTY >
* <!ELEMENT toolitem (menu?) >
* <!ELEMENT separator EMPTY >
* <!ELEMENT accelerator EMPTY >
* <!ATTLIST menubar name #IMPLIED
* action #IMPLIED >
* <!ATTLIST toolbar name #IMPLIED
* action #IMPLIED >
* <!ATTLIST popup name #IMPLIED
* action #IMPLIED >
* <!ATTLIST placeholder name #IMPLIED
* action #IMPLIED >
* <!ATTLIST separator name #IMPLIED
* action #IMPLIED
* expand (true|false) #IMPLIED >
* <!ATTLIST menu name #IMPLIED
* action #REQUIRED
* position (top|bot) #IMPLIED >
* <!ATTLIST menuitem name #IMPLIED
* action #REQUIRED
* position (top|bot) #IMPLIED >
* <!ATTLIST toolitem name #IMPLIED
* action #REQUIRED
* position (top|bot) #IMPLIED >
* <!ATTLIST accelerator name #IMPLIED
* action #REQUIRED >
* \endcode
*
* There are some additional restrictions beyond those specified in the DTD, e.g.
* every toolitem must have a toolbar in its anchestry and every menuitem must have a +
* menubar or popup in its anchestry. Since a GMarkup parser is used to parse the UI description,
* it must not only be valid XML, but valid GMarkup.
*
* If a name is not specified, it defaults to the action. If an action is not specified either,
* the element name is used. The name and action attributes must not contain '/' characters after
* parsing (since that would mess up path lookup) and must be usable as XML attributes when
* enclosed in doublequotes, thus they must not '"' characters or references to the " entity.
*
* \par Example: UI Definition
* \code
* <ui>
* <menubar>
* <menu name="FileMenu" action="FileMenuAction">
* <menuitem name="New" action="New2Action" />
* <placeholder name="FileMenuAdditions" />
* </menu>
* <menu name="JustifyMenu" action="JustifyMenuAction">
* <menuitem name="Left" action="justify-left"/>
* <menuitem name="Centre" action="justify-center"/>
* <menuitem name="Right" action="justify-right"/>
* <menuitem name="Fill" action="justify-fill"/>
* </menu>
* </menubar>
* <toolbar action="toolbar1">
* <placeholder name="JustifyToolItems">
* <separator/>
* <toolitem name="Left" action="justify-left"/>
* <toolitem name="Centre" action="justify-center"/>
* <toolitem name="Right" action="justify-right"/>
* <toolitem name="Fill" action="justify-fill"/>
* <separator/>
* </placeholder>
* </toolbar>
* </ui>
* \endcode
*
* The constructed widget hierarchy is very similar to the element tree of the XML,
* with the exception that placeholders are merged into their parents. The correspondence
* of XML elements to widgets should be almost obvious:
* - menubar a Gtk::MenuBar
* - toolbar a Gtk::Toolbar
* - popup a toplevel Gtk::Menu
* - menu a Gtk::Menu attached to a menuitem
* - menuitem a Gtk::MenuItem subclass, the exact type depends on the action
* - toolitem a Gtk::ToolItem subclass, the exact type depends on the action.
* Note that toolitem elements may contain a menu element, but only if their
* associated action specifies a Gtk::MenuToolButton as proxy.
* - separator a Gtk::SeparatorMenuItem or Gtk::SeparatorToolItem
* - accelerator a keyboard accelerator
*
* The "position" attribute determines where a constructed widget is positioned wrt.
* to its siblings in the partially constructed tree. If it is "top", the widget is
* prepended, otherwise it is appended.
*
* \par UI Merging
*
* The most remarkable feature of Gtk::UIManager is that it can overlay a set of menuitems
* and toolitems over another one, and demerge them later.
*
* Merging is done based on the names of the XML elements. Each element is identified by
* a path which consists of the names of its anchestors, separated by slashes. For example,
* the menuitem named "Left" in the example above has the path /ui/menubar/JustifyMenu/Left
* and the toolitem with the same name has path /ui/toolbar1/JustifyToolItems/Left.
*
* \par Accelerators
*
* Every action has an accelerator path. Accelerators are installed together with menuitem
* proxies, but they can also be explicitly added with <accelerator> elements in the
* UI definition. This makes it possible to have accelerators for actions even
* if they have no visible proxies.
*
* \par Smart Separators
*
* The separators created by Gtk::UIManager are "smart", i.e. they do not show up in
* the UI unless they end up between two visible menu or tool items. Separators which are
* located at the very beginning or end of the menu or toolbar containing them, or multiple
* separators next to each other, are hidden. This is a useful feature, since the merging
* of UI elements from multiple sources can make it hard or impossible to determine in
* advance whether a separator will end up in such an unfortunate position.
*
* For separators in toolbars, you can set expand="true" to turn them from a small,
* visible separator to an expanding, invisible one. Toolitems following an expanding
* separator are effectively right-aligned.
*
* \par Empty Menus
*
* Submenus pose similar problems to separators inconnection with merging. It is impossible
* to know in advance whether they will end up empty after merging. Gtk::UIManager offers
* two ways to treat empty submenus:
*
* - make them disappear by hiding the menu item they're attached to
* - add an insensitive "Empty" item
*
* The behaviour is chosen based on the "hide_if_empty" property of the action to which the submenu is associated.
*
* @newin{2,4}
*/
class UIManager : public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef UIManager CppObjectType;
typedef UIManager_Class CppClassType;
typedef GtkUIManager BaseObjectType;
typedef GtkUIManagerClass BaseClassType;
private: friend class UIManager_Class;
static CppClassType uimanager_class_;
private:
// noncopyable
UIManager(const UIManager&);
UIManager& operator=(const UIManager&);
protected:
explicit UIManager(const Glib::ConstructParams& construct_params);
explicit UIManager(GtkUIManager* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~UIManager();
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GtkUIManager* gobj() { return reinterpret_cast<GtkUIManager*>(gobject_); }
///Provides access to the underlying C GObject.
const GtkUIManager* gobj() const { return reinterpret_cast<GtkUIManager*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GtkUIManager* gobj_copy();
private:
protected:
UIManager();
public:
static Glib::RefPtr<UIManager> create();
/** Sets the "add_tearoffs" property, which controls whether menus
* generated by this Gtk::UIManager will have tearoff menu items.
*
* Note that this only affects regular menus. Generated popup
* menus never have tearoff menu items.
*
* @newin{2,4}
*
* @param add_tearoffs Whether tearoff menu items are added.
*/
void set_add_tearoffs(bool add_tearoffs = true);
/** Returns whether menus generated by this Gtk::UIManager
* will have tearoff menu items.
*
* @newin{2,4}
*
* @return Whether tearoff menu items are added.
*/
bool get_add_tearoffs() const;
/** Inserts an action group into the list of action groups associated
* with @a self. Actions in earlier groups hide actions with the same
* name in later groups.
*
* @newin{2,4}
*
* @param action_group The action group to be inserted.
* @param pos The position at which the group will be inserted.
*/
void insert_action_group(const Glib::RefPtr<ActionGroup>& action_group, int pos = 0);
/** Removes an action group from the list of action groups associated
* with @a self.
*
* @newin{2,4}
*
* @param action_group The action group to be removed.
*/
void remove_action_group(const Glib::RefPtr<ActionGroup>& action_group);
/** Returns the list of action groups associated with @a self.
*
* @newin{2,4}
*
* @return A List of
* action groups. The list is owned by GTK+
* and should not be modified.
*/
Glib::ListHandle< Glib::RefPtr<ActionGroup> > get_action_groups();
/** Returns the list of action groups associated with @a self.
*
* @newin{2,4}
*
* @return A List of
* action groups. The list is owned by GTK+
* and should not be modified.
*/
Glib::ListHandle< Glib::RefPtr<const ActionGroup> > get_action_groups() const;
/** Returns the Gtk::AccelGroup associated with @a self.
*
* @newin{2,4}
*
* @return The Gtk::AccelGroup.
*/
Glib::RefPtr<AccelGroup> get_accel_group();
/** Returns the Gtk::AccelGroup associated with @a self.
*
* @newin{2,4}
*
* @return The Gtk::AccelGroup.
*/
Glib::RefPtr<const AccelGroup> get_accel_group() const;
/** Looks up a widget by following a path.
* The path consists of the names specified in the XML description of the UI.
* separated by '/'. Elements which don't have a name or action attribute in
* the XML (e.g. <popup>) can be addressed by their XML element name
* (e.g. "popup"). The root element ("/ui") can be omitted in the path.
*
* Note that the widget found by following a path that ends in a <menu>
* element is the menuitem to which the menu is attached, not the menu itself.
*
* Also note that the widgets constructed by a ui manager are not tied to
* the lifecycle of the ui manager. If you add the widgets returned by this
* function to some container or explicitly ref them, they will survive the
* destruction of the ui manager.
*
* @newin{2,4}
*
* @param path A path.
* @return The widget found by following the path, or <tt>0</tt> if no widget
* was found.
*/
Widget* get_widget(const Glib::ustring& path);
/** Looks up a widget by following a path.
* The path consists of the names specified in the XML description of the UI.
* separated by '/'. Elements which don't have a name or action attribute in
* the XML (e.g. <popup>) can be addressed by their XML element name
* (e.g. "popup"). The root element ("/ui") can be omitted in the path.
*
* Note that the widget found by following a path that ends in a <menu>
* element is the menuitem to which the menu is attached, not the menu itself.
*
* Also note that the widgets constructed by a ui manager are not tied to
* the lifecycle of the ui manager. If you add the widgets returned by this
* function to some container or explicitly ref them, they will survive the
* destruction of the ui manager.
*
* @newin{2,4}
*
* @param path A path.
* @return The widget found by following the path, or <tt>0</tt> if no widget
* was found.
*/
const Widget* get_widget(const Glib::ustring& path) const;
/** Obtains a list of all toplevel widgets of the requested types.
*
* @newin{2,4}
*
* @param types Specifies the types of toplevel widgets to include. Allowed
* types are Gtk::UI_MANAGER_MENUBAR, Gtk::UI_MANAGER_TOOLBAR and
* Gtk::UI_MANAGER_POPUP.
* @return A newly-allocated SList of
* all toplevel widgets of the requested types. Free the returned list with Glib::slist_free().
*/
Glib::SListHandle<Widget*> get_toplevels(UIManagerItemType types);
/** Obtains a list of all toplevel widgets of the requested types.
*
* @newin{2,4}
*
* @param types Specifies the types of toplevel widgets to include. Allowed
* types are Gtk::UI_MANAGER_MENUBAR, Gtk::UI_MANAGER_TOOLBAR and
* Gtk::UI_MANAGER_POPUP.
* @return A newly-allocated SList of
* all toplevel widgets of the requested types. Free the returned list with Glib::slist_free().
*/
Glib::SListHandle<const Widget*> get_toplevels(UIManagerItemType types) const;
/** Looks up an action by following a path. See gtk_ui_manager_get_widget()
* for more information about paths.
*
* @newin{2,4}
*
* @param path A path.
* @return The action whose proxy widget is found by following the path,
* or <tt>0</tt> if no widget was found.
*/
Glib::RefPtr<Action> get_action(const Glib::ustring& path);
/** Looks up an action by following a path. See gtk_ui_manager_get_widget()
* for more information about paths.
*
* @newin{2,4}
*
* @param path A path.
* @return The action whose proxy widget is found by following the path,
* or <tt>0</tt> if no widget was found.
*/
Glib::RefPtr<const Action> get_action(const Glib::ustring& path) const;
typedef guint ui_merge_id;
/** Parses a string containing a UI definition and
* merges it with the current contents. An enclosing <ui>
* element is added if it is missing.
*
* @param buffer the string to parse
* @result The merge id for the merged UI. The merge id can be used to unmerge the UI with remove_ui(). If an error occurred, the return value is 0.
* @throws exception
* @newin{2,4}
*/
ui_merge_id add_ui_from_string(const Glib::ustring& buffer);
/** Parses a file containing a UI definition and
* merges it with the current contents of @a self.
*
* @newin{2,4}
*
* @param filename The name of the file to parse.
* @return The merge id for the merged UI. The merge id can be used
* to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred,
* the return value is 0.
*/
ui_merge_id add_ui_from_file(const Glib::ustring& filename);
//TODO: Is top=true a good default?
/** Adds a UI element to the current contents of @a self.
*
* If @a type is Gtk::UI_MANAGER_AUTO, GTK+ inserts a menuitem, toolitem or
* separator if such an element can be inserted at the place determined by
* @a path. Otherwise @a type must indicate an element that can be inserted at
* the place determined by @a path.
*
* @a see add_ui_separator().
*
* @newin{2,4}
*
* @param merge_id The merge id for the merged UI, see gtk_ui_manager_new_merge_id().
* @param path A path.
* @param name The name for the added UI element.
* @param action The name of the action to be proxied, if this is not a separator.
* @param type The type of UI element to add.
* @param top If <tt>true</tt>, the UI element is added before its siblings, otherwise it
* is added after its siblings.
*/
void add_ui(ui_merge_id merge_id, const Glib::ustring& path, const Glib::ustring& name, const Glib::ustring& action, UIManagerItemType type = Gtk::UI_MANAGER_AUTO, bool top = true);
/** Adds a separator UI element to the current contents.
*
* If @a type is Gtk::UI_MANAGER_AUTO, GTK+ inserts a menuitem, toolitem or
* separator if such an element can be inserted at the place determined by
* @a path . Otherwise @a type must indicate an element that can be inserted at
* the place determined by @a path.
*
* @see add_ui().
*
* @newin{2,4}
* @param merge_id The merge id for the merged UI, see gtk_ui_manager_new_merge_id().
* @param path A path.
* @param name The name for the added UI element.
* @param type The type of UI element to add.
* @param top If <tt>true</tt>, the UI element is added before its siblings, otherwise it
* is added after its siblings.
*/
void add_ui_separator(ui_merge_id merge_id, const Glib::ustring& path, const Glib::ustring& name = "", UIManagerItemType type = Gtk::UI_MANAGER_AUTO, bool top = true);
/** Unmerges the part of @a self<!-- -->s content identified by @a merge_id.
*
* @newin{2,4}
*
* @param merge_id A merge id as returned by gtk_ui_manager_add_ui_from_string().
*/
void remove_ui(ui_merge_id merge_id);
/** Creates a UI definition of the merged UI.
*
* @newin{2,4}
*
* @return A newly allocated string containing an XML representation of
* the merged UI.
*/
Glib::ustring get_ui() const;
/** Makes sure that all pending updates to the UI have been completed.
*
* This may occasionally be necessary, since Gtk::UIManager updates the
* UI in an idle function. A typical example where this function is
* useful is to enforce that the menubar and toolbar have been added to
* the main window before showing it:
*
* [C example ellipted]
*
* @newin{2,4}
*/
void ensure_update();
/** Returns an unused merge id, suitable for use with
* gtk_ui_manager_add_ui().
*
* @newin{2,4}
*
* @return An unused merge id.
*/
ui_merge_id new_merge_id();
/** The add_widget signal is emitted for each generated menubar and toolbar.
* It is not emitted for generated popup menus, which can be obtained by
* get_widget().
*
* @param widget the added widget
*
* @par Slot Prototype:
* <tt>void on_my_%add_widget(Widget* widget)</tt>
*
*/
Glib::SignalProxy1< void,Widget* > signal_add_widget();
/** The "actions-changed" signal is emitted whenever the set of actions
* changes.
*
* @par Slot Prototype:
* <tt>void on_my_%actions_changed()</tt>
*
*/
Glib::SignalProxy0< void > signal_actions_changed();
/** The connect_proxy signal is emitted after connecting a proxy to
* an action in the group.
*
* This is intended for simple customizations for which a custom action
* class would be too clumsy, e.g. showing tooltips for menuitems in the
* statusbar.
*
* @param action the action
* @param widget the proxy
*
* @par Slot Prototype:
* <tt>void on_my_%connect_proxy(const Glib::RefPtr<Action>& action, Widget* widget)</tt>
*
*/
Glib::SignalProxy2< void,const Glib::RefPtr<Action>&,Widget* > signal_connect_proxy();
/** The disconnect_proxy signal is emitted after disconnecting a proxy
* from an action in the group.
*
* @param action the action
* @param widget the proxy
*
* @par Slot Prototype:
* <tt>void on_my_%disconnect_proxy(const Glib::RefPtr<Action>& action, Widget* widget)</tt>
*
*/
Glib::SignalProxy2< void,const Glib::RefPtr<Action>&,Widget* > signal_disconnect_proxy();
/** The pre_activate signal is emitted just before the @a action
* is activated.
*
* This is intended for applications to get notification
* just before any action is activated.
*
* @param action the action
*
* @par Slot Prototype:
* <tt>void on_my_%pre_activate(const Glib::RefPtr<Action>& action)</tt>
*
*/
Glib::SignalProxy1< void,const Glib::RefPtr<Action>& > signal_pre_activate();
/** The post_activate signal is emitted just after the @a action
* is activated.
*
* This is intended for applications to get notification
* just after any action is activated.
*
* @param action the action
*
* @par Slot Prototype:
* <tt>void on_my_%post_activate(const Glib::RefPtr<Action>& action)</tt>
*
*/
Glib::SignalProxy1< void,const Glib::RefPtr<Action>& > signal_post_activate();
/** Whether tearoff menu items should be added to menus.
*
* @return A PropertyProxy that allows you to get or set the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy< bool > property_add_tearoffs() ;
/** Whether tearoff menu items should be added to menus.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< bool > property_add_tearoffs() const;
/** An XML string describing the merged UI.
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_ui() const;
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
/// This is a default handler for the signal signal_add_widget().
virtual void on_add_widget(Widget* widget);
/// This is a default handler for the signal signal_actions_changed().
virtual void on_actions_changed();
};
} // namespace Gtk
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gtk::UIManager
*/
Glib::RefPtr<Gtk::UIManager> wrap(GtkUIManager* object, bool take_copy = false);
}
#endif /* _GTKMM_UIMANAGER_H */
|