GtkAction               package:RGtk2               R Documentation

_G_t_k_A_c_t_i_o_n

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

     An action which can be triggered by a menu or toolbar item

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

     'gtkActionNew(name = NULL, label = NULL, tooltip = NULL, stock.id
     = NULL)'
      'gtkActionGetName(object)'
      'gtkActionIsSensitive(object)'
      'gtkActionGetSensitive(object)'
      'gtkActionSetSensitive(object, sensitive)'
      'gtkActionIsVisible(object)'
      'gtkActionGetVisible(object)'
      'gtkActionSetVisible(object, visible)'
      'gtkActionActivate(object)'
      'gtkActionCreateIcon(object, icon.size)'
      'gtkActionCreateMenuItem(object)'
      'gtkActionCreateToolItem(object)'
      'gtkActionCreateMenu(object)'
      'gtkActionConnectProxy(object, proxy)'
      'gtkActionDisconnectProxy(object, proxy)'
      'gtkActionGetProxies(object)'
      'gtkActionConnectAccelerator(object)'
      'gtkActionDisconnectAccelerator(object)'
      'gtkActionBlockActivateFrom(object, proxy)'
      'gtkActionUnblockActivateFrom(object, proxy)'
      'gtkActionGetAccelPath(object)'
      'gtkActionSetAccelPath(object, accel.path)'
      'gtkActionGetAccelClosure(object)'
      'gtkActionSetAccelGroup(object, accel.group)'
      'gtkAction(name = NULL, label = NULL, tooltip = NULL, stock.id =
     NULL)'

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

     GObject
        +----GtkAction
              +----GtkToggleAction
              +----GtkRecentAction 

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

     GtkAction implements 'GtkBuildable'.

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

     Actions represent operations that the user can be perform, along
     with some information how it should be presented in the interface.
     Each action  provides methods to create icons, menu items and
     toolbar items representing  itself.

     As well as the callback that is called when the action gets
     activated, the  following also gets associated with the action:

        *  a name (not translated, for path lookup)

        *  a label (translated, for display)

        *  an accelerator

        *  whether label indicates a stock id

        *  a tooltip (optional, translated)

        *  a toolbar label (optional, shorter than label)

     The action will also have some state information:

        *  visible (shown/hidden)

        *  sensitive (enabled/disabled)

     Apart from regular actions, there are 'GtkToggleAction', which can
     be toggled between two states and 'GtkRadioAction', of which only
     one in a group  can be in the "active" state. Other actions can be
     implemented as 'GtkAction'  subclasses.

     Each action can have one or more proxy menu item, toolbar button
     or other proxy widgets.  Proxies mirror the state of the action
     (text label, tooltip, icon, visible, sensitive, etc), and should
     change when the action's state changes. When the proxy is
     activated, it should activate its action.

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


     '_G_t_k_A_c_t_i_o_n' The 'GtkAction' 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:

     'gtkAction' is the equivalent of 'gtkActionNew'.

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


     '_a_c_t_i_v_a_t_e(_a_c_t_i_o_n, _u_s_e_r._d_a_t_a)' The "activate" signal is emitted
          when the action is activated.  

          Since  2.4

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

          '_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_c_t_i_o_n-_g_r_o_u_p' ['_G_t_k_A_c_t_i_o_n_G_r_o_u_p' : _R_e_a_d / _W_r_i_t_e] The
          GtkActionGroup this GtkAction is associated with, or NULL
          (for internal use).


     '_h_i_d_e-_i_f-_e_m_p_t_y' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] When TRUE, empty menu
          proxies for this action are hidden.  Default value: TRUE


     '_i_c_o_n-_n_a_m_e' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The name of the icon from
          the icon theme.  Note that the stock icon is preferred, if
          the ::stock-id property holds the id of an existing stock
          icon.  

          Default value: NULL  Since  2.10


     '_i_s-_i_m_p_o_r_t_a_n_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the action is
          considered important. When TRUE, toolitem proxies for this
          action show text in GTK_TOOLBAR_BOTH_HORIZ mode.  Default
          value: FALSE


     '_l_a_b_e_l' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The label used for menu items
          and buttons that activate this action. If the label is
          'NULL', GTK+ uses the stock  label specified via the stock-id
          property.  

          Default value: NULL


     '_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 unique name
          for the action.  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 is
          enabled.  Default value: TRUE


     '_s_h_o_r_t-_l_a_b_e_l' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] A shorter label that may
          be used on toolbar buttons.  Default value: NULL


     '_s_t_o_c_k-_i_d' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The stock icon displayed in
          widgets representing this action.  Default value: NULL


     '_t_o_o_l_t_i_p' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] A tooltip for this action. 
          Default value: NULL


     '_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 is visible. 
          Default value: TRUE


     '_v_i_s_i_b_l_e-_h_o_r_i_z_o_n_t_a_l' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the toolbar
          item is visible when the toolbar is in a horizontal
          orientation.  Default value: TRUE


     '_v_i_s_i_b_l_e-_o_v_e_r_f_l_o_w_n' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] When 'TRUE', toolitem
          proxies for this action are represented in the  toolbar
          overflow menu.  

          Default value: TRUE  Since  2.6


     '_v_i_s_i_b_l_e-_v_e_r_t_i_c_a_l' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the toolbar
          item is visible when the toolbar is in a vertical
          orientation.  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/GtkAction.html>

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

     'GtkActionGroup' 'GtkUIManager'

