GtkStatusbar              package:RGtk2              R Documentation

_G_t_k_S_t_a_t_u_s_b_a_r

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

     Report messages of minor importance to the user

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

     'gtkStatusbarNew(show = TRUE)'
      'gtkStatusbarGetContextId(object, context.description)'
      'gtkStatusbarPush(object, context.id, text)'
      'gtkStatusbarPop(object, context.id)'
      'gtkStatusbarRemove(object, context.id, message.id)'
      'gtkStatusbarSetHasResizeGrip(object, setting)'
      'gtkStatusbarGetHasResizeGrip(object)'
      'gtkStatusbar(show = TRUE)'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkContainer
                                +----GtkBox
                                      +----GtkHBox
                                            +----GtkStatusbar 

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

     GtkStatusbar implements AtkImplementorIface and  'GtkBuildable'.

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

     A 'GtkStatusbar' is usually placed along the bottom of an
     application's main 'GtkWindow'. It may provide a regular
     commentary of the application's status (as is usually the case in
     a web browser, for example), or may be used to simply output a
     message when the status changes, (when an upload is complete in an
     FTP client, for example).  It may also have a resize grip (a
     triangular area in the lower right corner)  which can be clicked
     on to resize the window containing the statusbar.

     Status bars in GTK+ maintain a stack of messages. The message at
     the top of the each bar's stack is the one that will currently be
     displayed.

     Any messages added to a statusbar's stack must specify a _context 
     id_ that is used to uniquely identify the source of a message. 
     This context id can be generated by 'gtkStatusbarGetContextId',
     given a  message and the statusbar that it will be added to. Note
     that messages are  stored in a stack, and when choosing which
     message to display, the stack  structure is adhered to, regardless
     of the context identifier of a message.

     One could say that a statusbar maintains one stack of messages for
     display purposes, but allows multiple message producers to
     maintain sub-stacks of the messages they produced (via context
     ids).

     Status bars are created using 'gtkStatusbarNew'.

     Messages are added to the bar's stack with 'gtkStatusbarPush'.

     The message at the top of the stack can be removed using
     'gtkStatusbarPop'.  A message can be removed from anywhere in the
     stack if its message_id was  recorded at the time it was added.
     This is done using 'gtkStatusbarRemove'.

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


     '_G_t_k_S_t_a_t_u_s_b_a_r' Contains private data that should be modified with
          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:

     'gtkStatusbar' is the equivalent of 'gtkStatusbarNew'.

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


     '_t_e_x_t-_p_o_p_p_e_d(_s_t_a_t_u_s_b_a_r, _c_o_n_t_e_x_t._i_d, _t_e_x_t, _u_s_e_r._d_a_t_a)' Is emitted
          whenever a new message is popped off a statusbar's stack.  

          '_s_t_a_t_u_s_b_a_r' ['GtkStatusbar']  the object which received the
               signal.

          '_c_o_n_t_e_x_t._i_d' [numeric]  the context id of the relevant
               message/statusbar.

          '_t_e_x_t' [character]  the message that was just popped.

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


     '_t_e_x_t-_p_u_s_h_e_d(_s_t_a_t_u_s_b_a_r, _c_o_n_t_e_x_t._i_d, _t_e_x_t, _u_s_e_r._d_a_t_a)' Is emitted
          whenever a new message gets pushed onto a statusbar's stack.  

          '_s_t_a_t_u_s_b_a_r' ['GtkStatusbar']  the object which received the
               signal.

          '_c_o_n_t_e_x_t._i_d' [numeric]  the context id of the relevant
               message/statusbar.

          '_t_e_x_t' [character]  the message that was pushed.

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


     '_h_a_s-_r_e_s_i_z_e-_g_r_i_p' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether the statusbar
          has a grip for resizing the toplevel window.  

          Default value: TRUE  Since  2.4


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


     '_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
          statusbar text.  Default value: GTK_SHADOW_IN


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

