GtkActionGroup             package:RGtk2             R Documentation

_G_t_k_A_c_t_i_o_n_G_r_o_u_p

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

     A group of actions

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

     'gtkActionGroupNew(name = NULL)'
      'gtkActionGroupGetName(object)'
      'gtkActionGroupGetSensitive(object)'
      'gtkActionGroupSetSensitive(object, sensitive)'
      'gtkActionGroupGetVisible(object)'
      'gtkActionGroupSetVisible(object, visible)'
      'gtkActionGroupGetAction(object, action.name)'
      'gtkActionGroupListActions(object)'
      'gtkActionGroupAddAction(object, action)'
      'gtkActionGroupAddActionWithAccel(object, action, accelerator =
     NULL)'
      'gtkActionGroupRemoveAction(object, action)'
      'gtkActionGroupAddActions(object, entries, user.data = NULL)'
      'gtkActionGroupAddActionsFull(object, entries, user.data = NULL)'
      'gtkActionGroupAddToggleActions(object, entries, user.data =
     NULL)'
      'gtkActionGroupAddToggleActionsFull(object, entries, user.data =
     NULL)'
      'gtkActionGroupAddRadioActions(object, entries, value, on.change
     = NULL, user.data = NULL)'
      'gtkActionGroupAddRadioActionsFull(object, entries, value,
     on.change = NULL, user.data = NULL)'
      'gtkActionGroupSetTranslateFunc(object, func, data = NULL)'
      'gtkActionGroupSetTranslationDomain(object, domain)'
      'gtkActionGroupTranslateString(object, string)'
      'gtkActionGroup(name = NULL)'

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

     GObject
        +----GtkActionGroup 

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

     GtkActionGroup implements 'GtkBuildable'.

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

     Actions are organised into groups.  An action group is essentially
     a map from names to 'GtkAction' objects.

     All actions that would make sense to use in a particular context
     should be in a single group.  Multiple action groups may be used
     for a particular user interface.  In fact, it is expected that
     most nontrivial  applications will make use of multiple groups. 
     For example, in an application that can edit multiple documents,
     one group holding global actions  (e.g. quit, about, new), and one
     group per document holding actions that  act on that document (eg.
     save, cut/copy/paste, etc).  Each window's menus  would be
     constructed from a combination of two action groups.

     Accelerators are handled by the GTK+ accelerator map. All actions
     are assigned an  accelerator path (which normally has the form 
     '<Actions>/')  and a shortcut is associated with this accelerator
     path. All menuitems and  toolitems take on this accelerator path.
     The GTK+ accelerator map code makes  sure that the correct
     shortcut is displayed next to the menu item.

_G_t_k_A_c_t_i_o_n_G_r_o_u_p _a_s _G_t_k_B_u_i_l_d_a_b_l_e:

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

     Note that it is probably more common to define actions and action
     groups in the code, since they are directly related to what the
     code can do.

     The GtkActionGroup implementation of the GtkBuildable interface
     supports a  custom <accelerator> element, which has attributes
     named key and modifiers and allows to specify accelerators. This
     is similar to the  <accelerator> element of GtkWidget, the main
     difference is that  it doesn't allow you to specify a signal.

     _A   'GtkDialog'   UI definition fragment._ <object
     class="GtkActionGroup" id="actiongroup">
       <child>
           <object class="GtkAction" id="About">
               <property name="name">About</property>
               <property name="stock_id">gtk-about</property>
               <signal handler="about_activate" name="activate"/>
           </object>
           <accelerator key="F1" modifiers="GDK_CONTROL_MASK |
     GDK_SHIFT_MASK"/>
       </child>
     </object>


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


     '_G_t_k_A_c_t_i_o_n_G_r_o_u_p' The 'GtkActionGroup' struct contains only private
           members and should not be accessed directly.


     '_G_t_k_A_c_t_i_o_n_E_n_t_r_y' 'GtkActionEntry' structs are used with 
          'gtkActionGroupAddActions' to construct actions.
          *'GtkActionEntry' is a transparent-type.*

          '_n_a_m_e' [character] The name of the action.

          '_s_t_o_c_k__i_d' [character] The stock id for the action, or the
               name of an icon from the icon  theme.

          '_l_a_b_e_l' [character] The label for the action. This field
               should typically be marked for  translation, see
               'gtkActionGroupSetTranslationDomain'. If 'label' is
               'NULL', the label of the stock item with id 'stock.id'
               is used.

          '_a_c_c_e_l_e_r_a_t_o_r' [character] The accelerator for the action, in
               the format understood by  'gtkAcceleratorParse'.

          '_t_o_o_l_t_i_p' [character] The tooltip for the action. This field
               should typically be marked  for translation, see
               'gtkActionGroupSetTranslationDomain'.

          '_c_a_l_l_b_a_c_k' [GCallback] The function to call when the action
               is activated.


     '_G_t_k_T_o_g_g_l_e_A_c_t_i_o_n_E_n_t_r_y' 'GtkToggleActionEntry' structs are used
          with  'gtkActionGroupAddToggleActions' to construct toggle
          actions. *'GtkToggleActionEntry' is a transparent-type.*

          '_n_a_m_e' [character] The name of the action.

          '_s_t_o_c_k__i_d' [character] The stock id for the action, or the
               name of an icon from the icon  theme.

          '_l_a_b_e_l' [character] The label for the action. This field
               should typically be marked for  translation, see
               'gtkActionGroupSetTranslationDomain'.

          '_a_c_c_e_l_e_r_a_t_o_r' [character] The accelerator for the action, in
               the format understood by  'gtkAcceleratorParse'.

          '_t_o_o_l_t_i_p' [character] The tooltip for the action. This field
               should typically be marked  for translation, see
               'gtkActionGroupSetTranslationDomain'.

          '_c_a_l_l_b_a_c_k' [GCallback] The function to call when the action
               is activated.

          '_i_s__a_c_t_i_v_e' [logical] The initial state of the toggle action.


     '_G_t_k_R_a_d_i_o_A_c_t_i_o_n_E_n_t_r_y' 'GtkRadioActionEntry' structs are used with 
          'gtkActionGroupAddRadioActions' to construct groups of radio
          actions. *'GtkRadioActionEntry' is a transparent-type.*

          '_n_a_m_e' [character] The name of the action.

          '_s_t_o_c_k__i_d' [character] The stock id for the action, or the
               name of an icon from the icon  theme.

          '_l_a_b_e_l' [character] The label for the action. This field
               should typically be marked for  translation, see
               'gtkActionGroupSetTranslationDomain'.

          '_a_c_c_e_l_e_r_a_t_o_r' [character] The accelerator for the action, in
               the format understood by  'gtkAcceleratorParse'.

          '_t_o_o_l_t_i_p' [character] The tooltip for the action. This field
               should typically be marked for  translation, see
               'gtkActionGroupSetTranslationDomain'.

          '_v_a_l_u_e' [integer] The value to set on the radio action. See
               'gtkRadioActionGetCurrentValue'.


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

     'gtkActionGroup' is the equivalent of 'gtkActionGroupNew'.

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


     '_c_o_n_n_e_c_t-_p_r_o_x_y(_a_c_t_i_o_n._g_r_o_u_p, _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. Note that the proxy may have been
          connected  to a different action before.

          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. 'GtkUIManager' proxies the signal
          and provides global notification  just before any action is
          connected to a proxy, which is probably more convenient to
          use.  

          Since  2.4

          '_a_c_t_i_o_n._g_r_o_u_p' ['GtkActionGroup']  the group

          '_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(_a_c_t_i_o_n._g_r_o_u_p, _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.  'GtkUIManager' proxies
          the signal and provides global notification  just before any
          action is connected to a proxy, which is probably more
          convenient to use.  

          Since  2.4

          '_a_c_t_i_o_n._g_r_o_u_p' ['GtkActionGroup']  the group

          '_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(_a_c_t_i_o_n._g_r_o_u_p, _a_c_t_i_o_n, _u_s_e_r._d_a_t_a)' The post_activate
          signal is emitted just after the 'action' in the
          'action.group' is activated

          This is intended for 'GtkUIManager' to proxy the signal and
          provide global notification just after any action is
          activated.  

          Since  2.4

          '_a_c_t_i_o_n._g_r_o_u_p' ['GtkActionGroup']  the group

          '_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(_a_c_t_i_o_n._g_r_o_u_p, _a_c_t_i_o_n, _u_s_e_r._d_a_t_a)' The pre_activate
          signal is emitted just before the 'action' in the
          'action.group' is activated

          This is intended for 'GtkUIManager' to proxy the signal and
          provide global notification just before any action is
          activated.  

          Since  2.4

          '_a_c_t_i_o_n._g_r_o_u_p' ['GtkActionGroup']  the group

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


     '_n_a_m_e' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e / _C_o_n_s_t_r_u_c_t _O_n_l_y] A name for the
          action group.  Default value: NULL


     '_s_e_n_s_i_t_i_v_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the action group is
          enabled.  Default value: TRUE


     '_v_i_s_i_b_l_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the action group is
          visible.  Default value: TRUE


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

