GtkToolButton             package:RGtk2             R Documentation

_G_t_k_T_o_o_l_B_u_t_t_o_n

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

     A GtkToolItem subclass that displays buttons

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

     'gtkToolButtonNew(icon.widget = NULL, label = NULL, show = TRUE)'
      'gtkToolButtonNewFromStock(stock.id)'
      'gtkToolButtonSetLabel(object, label = NULL)'
      'gtkToolButtonGetLabel(object)'
      'gtkToolButtonSetUseUnderline(object, use.underline)'
      'gtkToolButtonGetUseUnderline(object)'
      'gtkToolButtonSetStockId(object, stock.id = NULL)'
      'gtkToolButtonGetStockId(object)'
      'gtkToolButtonSetIconName(object, icon.name)'
      'gtkToolButtonGetIconName(object)'
      'gtkToolButtonSetIconWidget(object, icon.widget = NULL)'
      'gtkToolButtonGetIconWidget(object)'
      'gtkToolButtonSetLabelWidget(object, label.widget = NULL)'
      'gtkToolButtonGetLabelWidget(object)'
      'gtkToolButton(icon.widget = NULL, label = NULL, show = TRUE)'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkContainer
                                +----GtkBin
                                      +----GtkToolItem
                                            +----GtkToolButton

     +----GtkMenuToolButton

     +----GtkToggleToolButton 

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

     GtkToolButton implements AtkImplementorIface and  'GtkBuildable'.

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

     'GtkToolButton's are 'GtkToolItems' containing buttons.

     Use 'gtkToolButtonNew' to create a new 'GtkToolButton'. Use
     'gtkToolButtonNewWithStock()' to create a 'GtkToolButton'
     containing a stock item.

     The label of a 'GtkToolButton' is determined by the properties
     "label_widget", "label", and "stock_id". If "label_widget" is
     non-'NULL', then that widget is used as the label. Otherwise, if
     "label" is non-'NULL', that string is used as the label.
     Otherwise, if "stock_id" is non-'NULL', the label is determined by
     the stock item. Otherwise, the button does not have a label.

     The icon of a 'GtkToolButton' is determined by the properties
     "icon_widget" and "stock_id". If "icon_widget" is non-'NULL', then
     that widget is used as the icon. Otherwise, if "stock_id" is
     non-'NULL', the icon is determined by the stock item. Otherwise,
     the button does not have a label.

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


     '_G_t_k_T_o_o_l_B_u_t_t_o_n' The 'GtkToolButton' struct contains only private.
          It should only be accessed with the function described below.


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

     'gtkToolButton' is the equivalent of 'gtkToolButtonNew'.

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


     '_c_l_i_c_k_e_d(_t_o_o_l_b_u_t_t_o_n, _u_s_e_r._d_a_t_a)' This signal is emitted when the
          tool button is clicked with the mouse or activated with the
          keyboard.  

          '_t_o_o_l_b_u_t_t_o_n' ['GtkToolButton']  the object that emitted 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:


     '_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 themed icon
          displayed on the item. This property only has an effect if
          not overridden by "label",  "icon_widget" or "stock_id"
          properties.  

          Default value: NULL  Since  2.8 


     '_i_c_o_n-_w_i_d_g_e_t' ['_G_t_k_W_i_d_g_e_t' : _R_e_a_d / _W_r_i_t_e] Icon widget to display
          in the item.


     '_l_a_b_e_l' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] Text to show in the item. 
          Default value: NULL


     '_l_a_b_e_l-_w_i_d_g_e_t' ['_G_t_k_W_i_d_g_e_t' : _R_e_a_d / _W_r_i_t_e] Widget to use as the
          item label.


     '_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 on
          the item.  Default value: NULL


     '_u_s_e-_u_n_d_e_r_l_i_n_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] If set, an underline in
          the label property indicates that the next character should
          be used for the mnemonic accelerator key in the overflow
          menu.  Default value: FALSE


_S_t_y_l_e _P_r_o_p_e_r_t_i_e_s:


     '_i_c_o_n-_s_p_a_c_i_n_g' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] Spacing in pixels between
          the icon and label.  Allowed values: >= 0  Default value: 0


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

