GtkButton               package:RGtk2               R Documentation

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

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

     A widget that creates a signal when clicked on

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

     'gtkButtonNew(show = TRUE)'
      'gtkButtonNewWithLabel(label, show = TRUE)'
      'gtkButtonNewWithMnemonic(label, show = TRUE)'
      'gtkButtonNewFromStock(stock.id, show = TRUE)'
      'gtkButtonPressed(object)'
      'gtkButtonReleased(object)'
      'gtkButtonClicked(object)'
      'gtkButtonEnter(object)'
      'gtkButtonLeave(object)'
      'gtkButtonSetRelief(object, newstyle)'
      'gtkButtonGetRelief(object)'
      'gtkButtonGetLabel(object)'
      'gtkButtonSetLabel(object, label)'
      'gtkButtonGetUseStock(object)'
      'gtkButtonSetUseStock(object, use.stock)'
      'gtkButtonGetUseUnderline(object)'
      'gtkButtonSetUseUnderline(object, use.underline)'
      'gtkButtonSetFocusOnClick(object, focus.on.click)'
      'gtkButtonGetFocusOnClick(object)'
      'gtkButtonSetAlignment(object, xalign, yalign)'
      'gtkButtonGetAlignment(object)'
      'gtkButtonSetImage(object, image)'
      'gtkButtonGetImage(object)'
      'gtkButton(label, stock.id, show = TRUE)'

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

     GObject
        +----GtkObject
              +----GtkWidget
                    +----GtkContainer
                          +----GtkBin
                                +----GtkButton
                                      +----GtkToggleButton
                                      +----GtkColorButton
                                      +----GtkFontButton
                                      +----GtkOptionMenu 

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

     GtkButton implements AtkImplementorIface.

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

     The 'GtkButton' widget is generally used to attach a function to
     that is called when the button is pressed.  The various signals
     and how to use them are outlined below.

     The 'GtkButton' widget can hold any valid child widget.  That is
     it can hold most any other standard 'GtkWidget'.  The most
     commonly used child is the 'GtkLabel'.

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

     '_G_t_k_B_u_t_t_o_n' This should not be accessed directly.  Use the
          accessor functions below.

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

     'gtkButton' is the result of collapsing the constructors of
     'GtkButton' ('gtkButtonNew', 'gtkButtonNewWithLabel',
     'gtkButtonNewFromStock', 'gtkButtonNewWithMnemonic') and accepts a
     subset of its arguments matching the required arguments of one of
     its delegate constructors.

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

     '_a_c_t_i_v_a_t_e(_w_i_d_g_e_t, _u_s_e_r._d_a_t_a)' The "activate" signal on GtkButton
          is an action signal and emitting it causes the button to
          animate press then release.  Applications should never
          connect to this signal, but use the "clicked" signal.  

          '_w_i_d_g_e_t' ['GtkButton']  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_l_i_c_k_e_d(_b_u_t_t_o_n, _u_s_e_r._d_a_t_a)' Emitted when the button has been
          activated (pressed and released).   Emitted when a button
          clicked on by the mouse and the cursor stays on the button. 
          If the cursor is not on the button when the mouse button is
          released, the signal is not emitted.

          '_b_u_t_t_o_n' ['GtkButton']  the object that received the signal

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


     '_e_n_t_e_r(_b_u_t_t_o_n, _u_s_e_r._d_a_t_a)' Emitted when the pointer enters the
          button.

          'Deprecated': Use the GtkWidget::enter-notify-event signal.  
          Emitted when the mouse cursor enters the region of the
          button.

          '_b_u_t_t_o_n' ['GtkButton']  the object that received the signal

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


     '_l_e_a_v_e(_b_u_t_t_o_n, _u_s_e_r._d_a_t_a)' Emitted when the pointer leaves the
          button.

          'Deprecated': Use the GtkWidget::leave-notify-event signal.  
          Emitted when the mouse cursor leaves the region of the
          button.

          '_b_u_t_t_o_n' ['GtkButton']  the object that received the signal

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


     '_p_r_e_s_s_e_d(_b_u_t_t_o_n, _u_s_e_r._d_a_t_a)' Emitted when the button is pressed.

          'Deprecated': Use the GtkWidget::button-press-event signal.  
          Emitted when the button is initially pressed.

          '_b_u_t_t_o_n' ['GtkButton']  the object that received the signal

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


     '_r_e_l_e_a_s_e_d(_b_u_t_t_o_n, _u_s_e_r._d_a_t_a)' Emitted when the button is released.

          'Deprecated': Use the GtkWidget::button-release-event signal.
            Emitted when a button which is pressed is released, no
          matter where the mouse cursor is.

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

     '_f_o_c_u_s-_o_n-_c_l_i_c_k' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the button grabs
          focus when it is clicked with the mouse.  Default value: TRUE


     '_i_m_a_g_e' ['_G_t_k_W_i_d_g_e_t' : _R_e_a_d / _W_r_i_t_e] Child widget to appear next
          to the button text.


     '_l_a_b_e_l' [_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] Text of the label
          widget inside the button, if the button contains a label
          widget.  Default value: NULL


     '_r_e_l_i_e_f' ['_G_t_k_R_e_l_i_e_f_S_t_y_l_e' : _R_e_a_d / _W_r_i_t_e] The border relief
          style.  Default value: GTK_RELIEF_NORMAL


     '_u_s_e-_s_t_o_c_k' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e / _C_o_n_s_t_r_u_c_t] If set, the label
          is used to pick a stock item instead of being displayed. 
          Default value: FALSE


     '_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 / _C_o_n_s_t_r_u_c_t] If set, an
          underline in the text indicates the next character should be
          used for the mnemonic accelerator key.  Default value: FALSE


     '_x_a_l_i_g_n' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] If the child of the button is a
          'GtkMisc' or 'GtkAlignment', this property  can be used to
          control it's horizontal alignment. 0.0 is left aligned,  1.0
          is right aligned.  

          Allowed values: [0,1]  Default value: 0.5  Since  2.4


     '_y_a_l_i_g_n' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] If the child of the button is a
          'GtkMisc' or 'GtkAlignment', this property  can be used to
          control it's vertical alignment. 0.0 is top aligned,  1.0 is
          bottom aligned.  

          Allowed values: [0,1]  Default value: 0.5  Since  2.4


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

     '_c_h_i_l_d-_d_i_s_p_l_a_c_e_m_e_n_t-_x' [_i_n_t_e_g_e_r : _R_e_a_d] How far in the x direction
          to move the child when the button is depressed.  Default
          value: 0


     '_c_h_i_l_d-_d_i_s_p_l_a_c_e_m_e_n_t-_y' [_i_n_t_e_g_e_r : _R_e_a_d] How far in the y direction
          to move the child when the button is depressed.  Default
          value: 0


     '_d_e_f_a_u_l_t-_b_o_r_d_e_r' ['_G_t_k_B_o_r_d_e_r' : _R_e_a_d] Extra space to add for
          CAN_DEFAULT buttons.


     '_d_e_f_a_u_l_t-_o_u_t_s_i_d_e-_b_o_r_d_e_r' ['_G_t_k_B_o_r_d_e_r' : _R_e_a_d] Extra space to add
          for CAN_DEFAULT buttons that is always drawn outside the
          border.


     '_d_i_s_p_l_a_c_e-_f_o_c_u_s' [_l_o_g_i_c_a_l : _R_e_a_d] Whether the
          child_displacement_x/child_displacement_y properties should
          also  affect the focus rectangle.  

          Default value: FALSE  Since  2.6


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

