GtkToolItem              package:RGtk2              R Documentation

_G_t_k_T_o_o_l_I_t_e_m

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

     The base class of widgets that can be added to GtkToolbar

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

     'gtkToolItemNew(show = TRUE)'
      'gtkToolItemSetHomogeneous(object, homogeneous)'
      'gtkToolItemGetHomogeneous(object)'
      'gtkToolItemSetExpand(object, expand)'
      'gtkToolItemGetExpand(object)'
      'gtkToolItemSetTooltip(object, tooltips, tip.text = NULL,
     tip.private = NULL)'
      'gtkToolItemSetTooltip(object, tooltips, tip.text = NULL,
     tip.private = NULL)'
      'gtkToolItemSetTooltipText(object, text)'
      'gtkToolItemSetTooltipMarkup(object, markup)'
      'gtkToolItemSetUseDragWindow(object, use.drag.window)'
      'gtkToolItemGetUseDragWindow(object)'
      'gtkToolItemSetVisibleHorizontal(object, visible.horizontal)'
      'gtkToolItemGetVisibleHorizontal(object)'
      'gtkToolItemSetVisibleVertical(object, visible.vertical)'
      'gtkToolItemGetVisibleVertical(object)'
      'gtkToolItemSetIsImportant(object, is.important)'
      'gtkToolItemGetIsImportant(object)'
      'gtkToolItemGetIconSize(object)'
      'gtkToolItemGetOrientation(object)'
      'gtkToolItemGetToolbarStyle(object)'
      'gtkToolItemGetReliefStyle(object)'
      'gtkToolItemRetrieveProxyMenuItem(object)'
      'gtkToolItemGetProxyMenuItem(object, menu.item.id)'
      'gtkToolItemSetProxyMenuItem(object, menu.item.id, menu.item =
     NULL)'
      'gtkToolItemRebuildMenu(object)'
      'gtkToolItem(show = TRUE)'

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

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

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

     GtkToolItem implements AtkImplementorIface and  'GtkBuildable'.

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

     'GtkToolItem's are widgets that can appear on a toolbar. To create
     a toolbar item that contain something else than a button, use
     'gtkToolItemNew'. Use 'gtkContainerAdd' to add a child widget to
     the tool item.

     For toolbar items that contain buttons, see the 'GtkToolButton',
     'GtkToggleToolButton' and 'GtkRadioToolButton' classes.
     'GtkToolbar'

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


     '_G_t_k_T_o_o_l_I_t_e_m' The GtkToolItem struct contains only private data.
          It should only be accessed through the functions described
          below.


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

     'gtkToolItem' is the equivalent of 'gtkToolItemNew'.

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


     '_c_r_e_a_t_e-_m_e_n_u-_p_r_o_x_y(_t_o_o_l._i_t_e_m, _u_s_e_r._d_a_t_a)' This signal is emitted
          when the toolbar needs information from 'tool.item' about
          whether the item should appear in the toolbar overflow menu.
          In response the tool item should either

             * 

             * 

             *  .in -3

                The toolbar may cache the result of this signal. When
                the tool item changes how it will respond to this
                signal it must call 'gtkToolItemRebuildMenu' to
                invalidate the cache and ensure that the toolbar
                rebuilds its overflow menu.  

             '_t_o_o_l._i_t_e_m' ['GtkToolItem']  the object the signal was
                  emitted on

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


        '_s_e_t-_t_o_o_l_t_i_p(_t_o_o_l._i_t_e_m, _t_o_o_l_t_i_p_s, _t_i_p._t_e_x_t, _t_i_p._p_r_i_v_a_t_e, _u_s_e_r._d_a_t_a)' 
             This signal is emitted when the toolitem's tooltip
             changes. Application developers can use
             'gtkToolItemSetTooltip' to set the item's tooltip.  

             '_t_o_o_l._i_t_e_m' ['GtkToolItem']  the object the signal was
                  emitted on

             '_t_o_o_l_t_i_p_s' ['GtkTooltips']  the 'GtkTooltips'

             '_t_i_p._t_e_x_t' [character]  the tooltip text

             '_t_i_p._p_r_i_v_a_t_e' [character]  the tooltip private text

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


        '_t_o_o_l_b_a_r-_r_e_c_o_n_f_i_g_u_r_e_d(_t_o_o_l._i_t_e_m, _u_s_e_r._d_a_t_a)' This signal is
             emitted when some property of the toolbar that the item is
             a child of changes. For custom subclasses of
             'GtkToolItem', the default handler of this signal use the
             functions

                * 

                * 

                * 

                *  .in -3

                   to find out what the toolbar should look like and
                   change themselves accordingly.  

                '_t_o_o_l._i_t_e_m' ['GtkToolItem']  the object the signal was
                     emitted on

                '_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_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 toolbar item
          is considered important. When TRUE, toolbar buttons show text
          in GTK_TOOLBAR_BOTH_HORIZ mode.  Default value: FALSE


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

