GtkTipsQuery              package:RGtk2              R Documentation

_G_t_k_T_i_p_s_Q_u_e_r_y

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

     Displays help about widgets in the user interface

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

     'gtkTipsQueryNew(show = TRUE)'
      'gtkTipsQueryStartQuery(object)'
      'gtkTipsQueryStopQuery(object)'
      'gtkTipsQuerySetCaller(object, caller)'
      'gtkTipsQuerySetLabels(object, label.inactive, label.no.tip)'
      'gtkTipsQuery(show = TRUE)'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkMisc
                                +----GtkLabel
                                      +----GtkTipsQuery 

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

     GtkTipsQuery implements AtkImplementorIface and  'GtkBuildable'.

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

     The 'GtkTipsQuery' widget is a subclass of 'GtkLabel' which is
     used to display help about widgets in a user interface.

     A query is started with a call to 'gtkTipsQueryStartQuery',
     usually when some kind of 'Help' button is pressed. The
     'GtkTipsQuery' then grabs all events, stopping the user interface
     from functioning normally. Then as the user moves the mouse over
     the widgets, the 'GtkTipsQuery' displays each widget's tooltip
     text.

     By connecting to the "widget-entered" or "widget-selected"
     signals, it is possible to customize the 'GtkTipsQuery' to perform
     other actions when widgets are entered or selected. For example, a
     help browser could be opened with documentation on the widget
     selected.

     At some point a call to 'gtkTipsQueryStopQuery' must be made in
     order to stop the query and return the interface to its normal
     state. The 'gtkTipsQuerySetCaller' function can be used to specify
     a widget which the user can select to stop the query (often the
     same button used to start the query).

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


     '_G_t_k_T_i_p_s_Q_u_e_r_y' *WARNING: 'GtkTipsQuery' is deprecated and should
          not be used in newly-written code.* The 'GtkTipsQuery' struct
          contains private data only, and should be accessed using the
          functions below.


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

     'gtkTipsQuery' is the equivalent of 'gtkTipsQueryNew'.

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


     '_s_t_a_r_t-_q_u_e_r_y(_t_i_p_s_q_u_e_r_y, _u_s_e_r._d_a_t_a)' Emitted when the query is
          started.

          '_t_i_p_s_q_u_e_r_y' ['GtkTipsQuery'] 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.


     '_s_t_o_p-_q_u_e_r_y(_t_i_p_s_q_u_e_r_y, _u_s_e_r._d_a_t_a)' Emitted when the query is
          stopped.

          '_t_i_p_s_q_u_e_r_y' ['GtkTipsQuery'] 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.


     '_w_i_d_g_e_t-_e_n_t_e_r_e_d(_t_i_p_s_q_u_e_r_y, _w_i_d_g_e_t, _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)' 
          Emitted when a widget is entered by the pointer while the
          query is in effect.

          '_t_i_p_s_q_u_e_r_y' ['GtkTipsQuery'] the object which received the
               signal.

          '_w_i_d_g_e_t' ['GtkWidget'] the widget that was entered by the
               pointer.

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

          '_t_i_p._p_r_i_v_a_t_e' [character] the widget's private tooltip (see
               'gtkTooltipsSetTip').

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


     '_w_i_d_g_e_t-_s_e_l_e_c_t_e_d(_t_i_p_s_q_u_e_r_y, _w_i_d_g_e_t, _t_i_p._t_e_x_t, _t_i_p._p_r_i_v_a_t_e, _e_v_e_n_t, _u_s_e_r._d_a_t_a)' 
          Emitted when a widget is selected during a query.

          '_t_i_p_s_q_u_e_r_y' ['GtkTipsQuery'] the object which received the
               signal.

          '_w_i_d_g_e_t' ['GtkWidget'] the widget that was selected.

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

          '_t_i_p._p_r_i_v_a_t_e' [character] the widget's private tooltip (see
               'gtkTooltipsSetTip').

          '_e_v_e_n_t' ['GdkEventButton'] the button press or button release
               event.

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

          _Returns:_ [logical] 'TRUE' if the query should be stopped.


_P_r_o_p_e_r_t_i_e_s:


     '_c_a_l_l_e_r' ['_G_t_k_W_i_d_g_e_t' : _R_e_a_d / _W_r_i_t_e] The widget that starts the
          tips query, usually a button. If it is selected while the
          query is in effect the query is automatically stopped.


     '_e_m_i_t-_a_l_w_a_y_s' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] 'TRUE' if the
          widget-entered and widget-selected signals are emitted even
          when the widget has no tooltip set. Default value: FALSE


     '_l_a_b_e_l-_i_n_a_c_t_i_v_e' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The text to display in
          the 'GtkTipsQuery' widget when the query is not in effect.
          Default value: NULL


     '_l_a_b_e_l-_n_o-_t_i_p' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The text to display in
          the 'GtkTipsQuery' widget when the query is running and the
          widget that the pointer is over has no tooltip. Default
          value: NULL


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

