~ubuntu-branches/ubuntu/quantal/gtkmm3.0/quantal

#include <glibmm/ustring.h>

#include <sigc++/sigc++.h>

 

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Lesser General Public

#include <gtkmm/widget.h>

#include <gtkmm/action.h>

#include <gtkmm/actiongroup.h>

 

#ifndef DOXYGEN_SHOULD_SKIP_THIS

typedef struct _GtkUIManager GtkUIManager;

{ class UIManager_Class; } // namespace Gtk

namespace Gtk

{

/** @addtogroup gtkmmEnums gtkmm Enums and Flags */

 

/**

 * <!ELEMENT toolitem     (menu?) >

 * <!ELEMENT separator    EMPTY >

 * <!ELEMENT accelerator  EMPTY >

 *                      action                #IMPLIED >

 * <!ATTLIST placeholder  name                  #IMPLIED

 *                       action                #IMPLIED >

 *                       action                #REQUIRED >

 * \endcode

 *

 * every toolitem must have a toolbar in its anchestry and every menuitem must have a +

 * 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,

 * enclosed in doublequotes, thus they must not '"' characters or references to the &quot; entity.

 *

 * \par Example: UI Definition

 * </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:

 * - 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

 * associated action specifies a Gtk::MenuToolButton as proxy.

 * - separator  a Gtk::SeparatorMenuItem or Gtk::SeparatorToolItem

 * - accelerator        a keyboard accelerator

 *

 * \par UI Merging

 *

 * 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

 * and the toolitem with the same name has path /ui/toolbar1/JustifyToolItems/Left.

 *

 * \par Accelerators

 *

 * if they have no visible proxies.

 * \par Smart Separators

 *

 * 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,

 * separator are effectively right-aligned.

 *

 * \par Empty Menus

 *

 * two ways to treat empty submenus:

 *

 * - make them disappear by hiding the menu item they're attached to

   * and should not be modified.

   */

  std::vector< Glib::RefPtr<const ActionGroup> > get_action_groups() const;

  

  /** Returns the Gtk::AccelGroup associated with @a manager.

   * 

   * all toplevel widgets of the requested types.  Free the returned list with Glib::slist_free().

   */

  std::vector<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.

  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 &lt;ui&gt;

   * element is added if it is missing.

   * @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);

  

  

   * 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 manager<!-- -->s content identified by @a merge_id.

   *