GtkMenuShell              package:RGtk2              R Documentation

_G_t_k_M_e_n_u_S_h_e_l_l

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

     A base class for menu objects

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

     'gtkMenuShellAppend(object, child)'
      'gtkMenuShellPrepend(object, child)'
      'gtkMenuShellInsert(object, child, position)'
      'gtkMenuShellDeactivate(object)'
      'gtkMenuShellSelectItem(object, menu.item)'
      'gtkMenuShellSelectFirst(object, search.sensitive)'
      'gtkMenuShellDeselect(object)'
      'gtkMenuShellActivateItem(object, menu.item, force.deactivate)'
      'gtkMenuShellCancel(object)'
      'gtkMenuShellSetTakeFocus(object, take.focus)'
      'gtkMenuShellGetTakeFocus(object)'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkContainer
                                +----GtkMenuShell
                                      +----GtkMenuBar
                                      +----GtkMenu 

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

     GtkMenuShell implements AtkImplementorIface and  'GtkBuildable'.

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

     A 'GtkMenuShell' is the abstract base class used to derive the 
     'GtkMenu' and 'GtkMenuBar' subclasses.  

     A 'GtkMenuShell' is a container of 'GtkMenuItem' objects arranged
     in a  list which can be navigated, selected, and activated by the
     user to perform application functions.  A 'GtkMenuItem' can have a
     submenu associated with it, allowing for nested hierarchical
     menus.

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


     '_G_t_k_M_e_n_u_S_h_e_l_l' The 'GtkMenuShell' struct contains the following
          fields. (These fields should be considered read-only. They
          should never be set by an application.)

            'list'   *children;  The list of   'GtkMenuItem'   objects contained by this   'GtkMenuShell'  .


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


     '_G_t_k_M_e_n_u_D_i_r_e_c_t_i_o_n_T_y_p_e' An enumeration representing directional
          movements within a menu.

            GTK_MENU_DIR_PARENT  To the parent menu shell.
            GTK_MENU_DIR_CHILD   To the submenu, if any, associated with the item.
            GTK_MENU_DIR_NEXT    To the next menu item.
            GTK_MENU_DIR_PREV    To the previous menu item.


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


     '_a_c_t_i_v_a_t_e-_c_u_r_r_e_n_t(_m_e_n_u_s_h_e_l_l, _f_o_r_c_e._h_i_d_e, _u_s_e_r._d_a_t_a)' An action
          signal that activates the current menu item within the menu
          shell.

          '_m_e_n_u_s_h_e_l_l' ['GtkMenuShell'] the object which received the
               signal.

          '_f_o_r_c_e._h_i_d_e' [logical] if TRUE, hide the menu after
               activating the menu item.

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


     '_c_a_n_c_e_l(_m_e_n_u_s_h_e_l_l, _u_s_e_r._d_a_t_a)' An action signal which cancels the
          selection within the menu shell. Causes the
          GtkMenuShell::selection-done signal to be emitted.

          '_m_e_n_u_s_h_e_l_l' ['GtkMenuShell'] the object which received the
               signal.

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


     '_c_y_c_l_e-_f_o_c_u_s(_m_e_n_u_s_h_e_l_l, _a_r_g_1, _u_s_e_r._d_a_t_a)' _undocumented _

          '_m_e_n_u_s_h_e_l_l' ['GtkMenuShell'] the object which received the
               signal.

          '_a_r_g_1' ['GtkDirectionType'] 

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


     '_d_e_a_c_t_i_v_a_t_e(_m_e_n_u_s_h_e_l_l, _u_s_e_r._d_a_t_a)' This signal is emitted when a
          menu shell is deactivated.

          '_m_e_n_u_s_h_e_l_l' ['GtkMenuShell'] the object which received the
               signal.

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


     '_m_o_v_e-_c_u_r_r_e_n_t(_m_e_n_u_s_h_e_l_l, _d_i_r_e_c_t_i_o_n, _u_s_e_r._d_a_t_a)' An action signal
          which moves the current menu item in the direction  specified
          by 'direction'.

          '_m_e_n_u_s_h_e_l_l' ['GtkMenuShell'] the object which received the
               signal.

          '_d_i_r_e_c_t_i_o_n' ['GtkMenuDirectionType'] the direction to move.

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


     '_m_o_v_e-_s_e_l_e_c_t_e_d(_m_e_n_u._s_h_e_l_l, _d_i_s_t_a_n_c_e, _u_s_e_r._d_a_t_a)' The
          ::move-selected signal is emitted to move the selection to
          another item.  

          Since  2.12

          '_m_e_n_u._s_h_e_l_l' ['GtkMenuShell']  the object on which the signal
               is emitted

          '_d_i_s_t_a_n_c_e' [integer]  +1 to move to the next item, -1 to move
               to the previous

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

          _Returns:_ [logical] 'TRUE' to stop the signal emission,
          'FALSE' to continue


     '_s_e_l_e_c_t_i_o_n-_d_o_n_e(_m_e_n_u_s_h_e_l_l, _u_s_e_r._d_a_t_a)' This signal is emitted when
          a selection has been completed within a menu shell.

          '_m_e_n_u_s_h_e_l_l' ['GtkMenuShell'] the object which received the
               signal.

          '_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:


     '_t_a_k_e-_f_o_c_u_s' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] A boolean that determines
          whether the menu and its submenus grab the keyboard focus.
          See 'gtkMenuShellSetTakeFocus' and
          'gtkMenuShellGetTakeFocus'.  

          Default value: TRUE  Since  2.8


_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/GtkMenuShell.html>

