GtkToolbar               package:RGtk2               R Documentation

_G_t_k_T_o_o_l_b_a_r

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

     Create bars of buttons and other widgets

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

     'gtkToolbarNew(show = TRUE)'
      'gtkToolbarInsert(object, item, pos)'
      'gtkToolbarGetItemIndex(object, item)'
      'gtkToolbarGetNItems(object)'
      'gtkToolbarGetNthItem(object, n)'
      'gtkToolbarGetDropIndex(object, x, y)'
      'gtkToolbarSetDropHighlightItem(object, tool.item = NULL, index)'
      'gtkToolbarSetShowArrow(object, show.arrow)'
      'gtkToolbarSetOrientation(object, orientation)'
      'gtkToolbarSetTooltips(object, enable)'
      'gtkToolbarUnsetIconSize(object)'
      'gtkToolbarGetShowArrow(object)'
      'gtkToolbarGetOrientation(object)'
      'gtkToolbarGetStyle(object)'
      'gtkToolbarGetIconSize(object)'
      'gtkToolbarGetTooltips(object)'
      'gtkToolbarGetReliefStyle(object)'
      'gtkToolbarAppendItem(object, text, tooltip.text,
     tooltip.private.text, icon, callback, user.data = NULL)'
      'gtkToolbarPrependItem(object, text, tooltip.text,
     tooltip.private.text, icon, callback, user.data)'
      'gtkToolbarInsertItem(object, text, tooltip.text,
     tooltip.private.text, icon, callback, user.data, position)'
      'gtkToolbarAppendSpace(object)'
      'gtkToolbarPrependSpace(object)'
      'gtkToolbarInsertSpace(object, position)'
      'gtkToolbarAppendElement(object, type, widget, text,
     tooltip.text, tooltip.private.text, icon, callback, user.data =
     NULL)'
      'gtkToolbarPrependElement(object, type, widget, text,
     tooltip.text, tooltip.private.text, icon, callback, user.data =
     NULL)'
      'gtkToolbarInsertElement(object, type, widget, text,
     tooltip.text, tooltip.private.text, icon, callback, user.data =
     NULL, position)'
      'gtkToolbarAppendWidget(object, widget, tooltip.text = NULL,
     tooltip.private.text = NULL)'
      'gtkToolbarPrependWidget(object, widget, tooltip.text = NULL,
     tooltip.private.text = NULL)'
      'gtkToolbarInsertWidget(object, widget, tooltip.text = NULL,
     tooltip.private.text = NULL, position)'
      'gtkToolbarSetStyle(object, style)'
      'gtkToolbarInsertStock(object, stock.id, tooltip.text,
     tooltip.private.text, callback, user.data, position)'
      'gtkToolbarSetIconSize(object, icon.size)'
      'gtkToolbarRemoveSpace(object, position)'
      'gtkToolbarUnsetStyle(object)'
      'gtkToolbar(show = TRUE)'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkContainer
                                +----GtkToolbar 

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

     GtkToolbar implements AtkImplementorIface and  'GtkBuildable'.

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

     A toolbar is created with a call to 'gtkToolbarNew'.

     A toolbar can contain instances of a subclass of 'GtkToolItem'. To
     add a 'GtkToolItem' to the a toolbar, use 'gtkToolbarInsert'. To
     remove an item from the toolbar use 'gtkContainerRemove'. To add a
     button to the toolbar, add an instance of 'GtkToolButton'.

     Toolbar items can be visually grouped by adding instances of
     'GtkSeparatorToolItem' to the toolbar. If a 'GtkSeparatorToolItem'
     has the "expand" property set to 'TRUE' and the "draw" property
     set to 'FALSE' the effect is to force all following items to the
     end of the toolbar.

     Creating a context menu for the toolbar can be done by connecting
     to the '"popup-context-menu"' signal.

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


     '_G_t_k_T_o_o_l_b_a_r' The 'GtkToolbar' struct only contains private data
          and should only be accessed through 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:

     'gtkToolbar' is the equivalent of 'gtkToolbarNew'.

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


     '_G_t_k_T_o_o_l_b_a_r_C_h_i_l_d_T_y_p_e' *WARNING: 'GtkToolbarChildType' is
          deprecated and should not be used in newly-written code.*
          'GtkToolbarChildType' is used to set the type of new elements
          that are added  to a 'GtkToolbar'.

          '_s_p_a_c_e' a space in the style of the toolbar's
               'GtkToolbarSpaceStyle'.

          '_b_u_t_t_o_n' a 'GtkButton'.

          '_t_o_g_g_l_e_b_u_t_t_o_n' a 'GtkToggleButton'.

          '_r_a_d_i_o_b_u_t_t_o_n' a 'GtkRadioButton'.

          '_w_i_d_g_e_t' a standard 'GtkWidget'.


     '_G_t_k_T_o_o_l_b_a_r_S_p_a_c_e_S_t_y_l_e' _undocumented _

          '_e_m_p_t_y' _undocumented _

          '_l_i_n_e' _undocumented _


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


     '_f_o_c_u_s-_h_o_m_e-_o_r-_e_n_d(_t_o_o_l_b_a_r, _f_o_c_u_s._h_o_m_e, _u_s_e_r._d_a_t_a)' A keybinding
          signal used internally by GTK+. This signal can't be used in
          application code  

          '_t_o_o_l_b_a_r' ['GtkToolbar']  the 'GtkToolbar' which emitted the
               signal

          '_f_o_c_u_s._h_o_m_e' [logical] 'TRUE' if the first item should be
               focused

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

          _Returns:_ [logical] 'TRUE' if the signal was handled,
          'FALSE' if not


     '_o_r_i_e_n_t_a_t_i_o_n-_c_h_a_n_g_e_d(_t_o_o_l_b_a_r, _o_r_i_e_n_t_a_t_i_o_n, _u_s_e_r._d_a_t_a)' Emitted
          when the orientation of the toolbar changes.  

          '_t_o_o_l_b_a_r' ['GtkToolbar']  the object which emitted the signal

          '_o_r_i_e_n_t_a_t_i_o_n' ['GtkOrientation']  the new 'GtkOrientation' of
               the toolbar

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


     '_p_o_p_u_p-_c_o_n_t_e_x_t-_m_e_n_u(_t_o_o_l_b_a_r, _x, _y, _b_u_t_t_o_n, _u_s_e_r._d_a_t_a)' Emitted
          when the user right-clicks the toolbar or uses the keybinding
          to display a popup menu.

          Application developers should handle this signal if they want
          to display a context menu on the toolbar. The context-menu
          should appear at the coordinates given by 'x' and 'y'. The
          mouse button number is given by the 'button' parameter. If
          the menu was popped up using the keybaord, 'button' is -1.  

          '_t_o_o_l_b_a_r' ['GtkToolbar']  the 'GtkToolbar' which emitted the
               signal

          '_x' [integer]  the x coordinate of the point where the menu
               should appear

          '_y' [integer]  the y coordinate of the point where the menu
               should appear

          '_b_u_t_t_o_n' [integer]  the mouse button the user pressed, or -1

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

          _Returns:_ [logical]  return 'TRUE' if the signal was
          handled, 'FALSE' if not


     '_s_t_y_l_e-_c_h_a_n_g_e_d(_t_o_o_l_b_a_r, _s_t_y_l_e, _u_s_e_r._d_a_t_a)' Emitted when the style
          of the toolbar changes.  

          '_t_o_o_l_b_a_r' ['GtkToolbar']  The 'GtkToolbar' which emitted the
               signal

          '_s_t_y_l_e' ['GtkToolbarStyle']  the new 'GtkToolbarStyle' of the
               toolbar

          '_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-_s_i_z_e' ['_G_t_k_I_c_o_n_S_i_z_e' : _R_e_a_d / _W_r_i_t_e] The size of the icons
          in a toolbar is normally determined by the toolbar-icon-size
          setting. When this property is set, it  overrides the
          setting. 

          This should only be used for special-purpose toolbars, normal
          application toolbars should respect the user preferences for
          the size of icons.  

          Default value: GTK_ICON_SIZE_LARGE_TOOLBAR  Since  2.10


     '_i_c_o_n-_s_i_z_e-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Is 'TRUE' if the
          icon-size property has been set.  

          Default value: FALSE  Since  2.10


     '_o_r_i_e_n_t_a_t_i_o_n' ['_G_t_k_O_r_i_e_n_t_a_t_i_o_n' : _R_e_a_d / _W_r_i_t_e] The orientation of
          the toolbar.  Default value: GTK_ORIENTATION_HORIZONTAL


     '_s_h_o_w-_a_r_r_o_w' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] If an arrow should be shown
          if the toolbar doesn't fit.  Default value: TRUE


     '_t_o_o_l_b_a_r-_s_t_y_l_e' ['_G_t_k_T_o_o_l_b_a_r_S_t_y_l_e' : _R_e_a_d / _W_r_i_t_e] How to draw the
          toolbar.  Default value: GTK_TOOLBAR_BOTH


     '_t_o_o_l_t_i_p_s' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] If the tooltips of the toolbar
          should be active or not.  

          Default value: TRUE  Since  2.8


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


     '_b_u_t_t_o_n-_r_e_l_i_e_f' ['_G_t_k_R_e_l_i_e_f_S_t_y_l_e' : _R_e_a_d] Type of bevel around
          toolbar buttons.  Default value: GTK_RELIEF_NONE


     '_i_n_t_e_r_n_a_l-_p_a_d_d_i_n_g' [_i_n_t_e_g_e_r : _R_e_a_d] Amount of border space between
          the toolbar shadow and the buttons.  Allowed values: >= 0 
          Default value: 0


     '_m_a_x-_c_h_i_l_d-_e_x_p_a_n_d' [_i_n_t_e_g_e_r : _R_e_a_d] Maximum amount of space an
          expandable item will be given.  Allowed values: >= 0  Default
          value: 2147483647


     '_s_h_a_d_o_w-_t_y_p_e' ['_G_t_k_S_h_a_d_o_w_T_y_p_e' : _R_e_a_d] Style of bevel around the
          toolbar.  Default value: GTK_SHADOW_OUT


     '_s_p_a_c_e-_s_i_z_e' [_i_n_t_e_g_e_r : _R_e_a_d] Size of spacers.  Allowed values: >=
          0  Default value: 12


     '_s_p_a_c_e-_s_t_y_l_e' ['_G_t_k_T_o_o_l_b_a_r_S_p_a_c_e_S_t_y_l_e' : _R_e_a_d] Whether spacers are
          vertical lines or just blank.  Default value:
          GTK_TOOLBAR_SPACE_LINE


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

