GtkUIManager              package:RGtk2              R Documentation

_G_t_k_U_I_M_a_n_a_g_e_r

_D_e_s_c_r_i_p_t_i_o_n:

     Constructing menus and toolbars from an XML description

_M_e_t_h_o_d_s _a_n_d _F_u_n_c_t_i_o_n_s:

     'gtkUIManagerNew()'
      'gtkUIManagerSetAddTearoffs(object, add.tearoffs)'
      'gtkUIManagerGetAddTearoffs(object)'
      'gtkUIManagerInsertActionGroup(object, action.group, pos)'
      'gtkUIManagerRemoveActionGroup(object, action.group)'
      'gtkUIManagerGetActionGroups(object)'
      'gtkUIManagerGetAccelGroup(object)'
      'gtkUIManagerGetWidget(object, path)'
      'gtkUIManagerGetToplevels(object, types)'
      'gtkUIManagerGetAction(object, path)'
      'gtkUIManagerAddUiFromString(object, buffer, length = -1,
     .errwarn = TRUE)'
      'gtkUIManagerAddUiFromFile(object, filename, .errwarn = TRUE)'
      'gtkUIManagerNewMergeId(object)'
      'gtkUIManagerAddUi(object, merge.id, path, name, action = NULL,
     type, top)'
      'gtkUIManagerRemoveUi(object, merge.id)'
      'gtkUIManagerGetUi(object)'
      'gtkUIManagerEnsureUpdate(object)'
      'gtkUIManager()'

_H_i_e_r_a_r_c_h_y:

     GObject
        +----GtkUIManager 

_I_n_t_e_r_f_a_c_e_s:

     GtkUIManager implements 'GtkBuildable'.

_D_e_t_a_i_l_e_d _D_e_s_c_r_i_p_t_i_o_n:

     A 'GtkUIManager' constructs a user interface (menus and toolbars)
     from one or more UI definitions, which reference actions from one
     or more  action groups.

_U_I _D_e_f_i_n_i_t_i_o_n_s:

     The UI definitions are specified in an XML format which can be
     roughly described by the following DTD. 

     Do not confuse the GtkUIManager UI Definitions described here with
     the similarly named GtkBuilder UI  Definitions. 

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

     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 &quot; entity.

     _A UI definition_ <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>
      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: 

     _m_e_n_u_b_a_r a 'GtkMenuBar'

     _t_o_o_l_b_a_r a 'GtkToolbar'

     _p_o_p_u_p a toplevel 'GtkMenu'

     _m_e_n_u a 'GtkMenu' attached to a menuitem

     _m_e_n_u_i_t_e_m a 'GtkMenuItem' subclass, the exact type depends on the
          action

     _t_o_o_l_i_t_e_m a 'GtkToolItem' 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
          'GtkMenuToolButton' as proxy.

     _s_e_p_a_r_a_t_o_r a 'GtkSeparatorMenuItem' or 'GtkSeparatorToolItem'

     _a_c_c_e_l_e_r_a_t_o_r 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.

_U_I _M_e_r_g_i_n_g:

     The most remarkable feature of 'GtkUIManager' 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'.

_A_c_c_e_l_e_r_a_t_o_r_s:

     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.

_S_m_a_r_t _S_e_p_a_r_a_t_o_r_s:

     The separators created by 'GtkUIManager' 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.

_E_m_p_t_y _M_e_n_u_s:

     Submenus pose similar problems to separators inconnection with
     merging. It is  impossible to know in advance whether they will
     end up empty after merging.  'GtkUIManager' 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.

_G_t_k_U_I_M_a_n_a_g_e_r _a_s _G_t_k_B_u_i_l_d_a_b_l_e:

     The GtkUIManager implementation of the GtkBuildable interface
     accepts GtkActionGroup objects as <child> elements in UI
     definitions.

     A GtkUIManager UI definition as described above can be embedded in
     an GtkUIManager <object> element in a GtkBuilder UI definition.

     The widgets that are constructed by a GtkUIManager can be embedded
     in other parts of the constructed user interface with the help of
     the "constructor" attribute. See the example below.

     _An embedded GtkUIManager UI definition_ <object
     class="GtkUIManager" id="uiman">
       <child>
         <object class="GtkActionGroup">
           <child>
             <object class="GtkAction" id="file">
               <property name="label">_File</property>
             </object>
           </child>
         </object>
       </child>
       <ui>
         <menubar name="menubar1">
           <menu action="file">
           </menu>
         </menubar>
       </ui>
     </object>
     <object class="GtkWindow" id="main-window">
       <child>
         <object class="GtkMenuBar" id="menubar1" constructor="uiman"/>
       </child>
     </object>


_S_t_r_u_c_t_u_r_e_s:


     '_G_t_k_U_I_M_a_n_a_g_e_r' The 'GtkUIManager' struct contains only private
          members and should not be accessed directly.


_C_o_n_v_e_n_i_e_n_t _C_o_n_s_t_r_u_c_t_i_o_n:

     'gtkUIManager' is the equivalent of 'gtkUIManagerNew'.

_E_n_u_m_s _a_n_d _F_l_a_g_s:


     '_G_t_k_U_I_M_a_n_a_g_e_r_I_t_e_m_T_y_p_e' These enumeration values are used by
          'gtkUIManagerAddUi' to determine what UI element to create.

          '_a_u_t_o' Pick the type of the UI element according to context.

          '_m_e_n_u_b_a_r' Create a menubar.

          '_m_e_n_u' Create a menu.

          '_t_o_o_l_b_a_r' Create a toolbar.

          '_p_l_a_c_e_h_o_l_d_e_r' Insert a placeholder.

          '_p_o_p_u_p' Create a popup menu.

          '_m_e_n_u_i_t_e_m' Create a menuitem.

          '_t_o_o_l_i_t_e_m' Create a toolitem.

          '_s_e_p_a_r_a_t_o_r' Create a separator.

          '_a_c_c_e_l_e_r_a_t_o_r' Install an accelerator.


_S_i_g_n_a_l_s:


     '_a_c_t_i_o_n_s-_c_h_a_n_g_e_d(_m_e_r_g_e, _u_s_e_r._d_a_t_a)' The "actions-changed" signal
          is emitted whenever the set of actions changes.  

          Since  2.4

          '_m_e_r_g_e' ['GtkUIManager']  a 'GtkUIManager'

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_a_d_d-_w_i_d_g_e_t(_m_e_r_g_e, _w_i_d_g_e_t, _u_s_e_r._d_a_t_a)' 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 
          'gtkUIManagerGetWidget'.  

          Since  2.4

          '_m_e_r_g_e' ['GtkUIManager']  a 'GtkUIManager'

          '_w_i_d_g_e_t' ['GtkWidget']  the added widget

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_c_o_n_n_e_c_t-_p_r_o_x_y(_u_i_m_a_n_a_g_e_r, _a_c_t_i_o_n, _p_r_o_x_y, _u_s_e_r._d_a_t_a)' 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.  

          Since  2.4

          '_u_i_m_a_n_a_g_e_r' ['GtkUIManager']  the ui manager

          '_a_c_t_i_o_n' ['GtkAction']  the action

          '_p_r_o_x_y' ['GtkWidget']  the proxy

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_d_i_s_c_o_n_n_e_c_t-_p_r_o_x_y(_u_i_m_a_n_a_g_e_r, _a_c_t_i_o_n, _p_r_o_x_y, _u_s_e_r._d_a_t_a)' The
          disconnect_proxy signal is emitted after disconnecting a
          proxy  from an action in the group.  

          Since  2.4

          '_u_i_m_a_n_a_g_e_r' ['GtkUIManager']  the ui manager

          '_a_c_t_i_o_n' ['GtkAction']  the action

          '_p_r_o_x_y' ['GtkWidget']  the proxy

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_p_o_s_t-_a_c_t_i_v_a_t_e(_u_i_m_a_n_a_g_e_r, _a_c_t_i_o_n, _u_s_e_r._d_a_t_a)' The post_activate
          signal is emitted just after the 'action' is activated.

          This is intended for applications to get notification just
          after any action is activated.  

          Since  2.4

          '_u_i_m_a_n_a_g_e_r' ['GtkUIManager']  the ui manager

          '_a_c_t_i_o_n' ['GtkAction']  the action

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_p_r_e-_a_c_t_i_v_a_t_e(_u_i_m_a_n_a_g_e_r, _a_c_t_i_o_n, _u_s_e_r._d_a_t_a)' The pre_activate
          signal is emitted just before the 'action' is activated.

          This is intended for applications to get notification just
          before any action is activated.  

          Since  2.4

          '_u_i_m_a_n_a_g_e_r' ['GtkUIManager']  the ui manager

          '_a_c_t_i_o_n' ['GtkAction']  the action

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


_P_r_o_p_e_r_t_i_e_s:


     '_a_d_d-_t_e_a_r_o_f_f_s' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] The "add-tearoffs"
          property controls whether generated menus  have tearoff menu
          items. 

          Note that this only affects regular menus. Generated popup 
          menus never have tearoff menu items.  

          Default value: FALSE  Since  2.4


     '_u_i' [_c_h_a_r_a_c_t_e_r : _R_e_a_d] An XML string describing the merged UI. 
          Default value: "<ui>\n</ui>\n"


_A_u_t_h_o_r(_s):

     Derived by RGtkGen from GTK+ documentation

_R_e_f_e_r_e_n_c_e_s:

     <URL:
     http://developer.gnome.org/doc/API/2.0/gtk/GtkUIManager.html>

_S_e_e _A_l_s_o:

     'GtkBuilder'

