GtkStatusIcon             package:RGtk2             R Documentation

_G_t_k_S_t_a_t_u_s_I_c_o_n

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

     Display an icon in the system tray

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

     'gtkStatusIconNew()'
      'gtkStatusIconNewFromPixbuf(pixbuf)'
      'gtkStatusIconNewFromFile(filename)'
      'gtkStatusIconNewFromStock(stock.id)'
      'gtkStatusIconNewFromIconName(icon.name)'
      'gtkStatusIconSetFromPixbuf(object, pixbuf)'
      'gtkStatusIconSetFromFile(object, filename)'
      'gtkStatusIconSetFromStock(object, stock.id)'
      'gtkStatusIconSetFromIconName(object, icon.name)'
      'gtkStatusIconGetStorageType(object)'
      'gtkStatusIconGetPixbuf(object)'
      'gtkStatusIconGetStock(object)'
      'gtkStatusIconGetIconName(object)'
      'gtkStatusIconGetSize(object)'
      'gtkStatusIconSetScreen(object, screen)'
      'gtkStatusIconGetScreen(object)'
      'gtkStatusIconSetTooltip(object, tooltip.text)'
      'gtkStatusIconSetVisible(object, visible)'
      'gtkStatusIconGetVisible(object)'
      'gtkStatusIconSetBlinking(object, blinking)'
      'gtkStatusIconGetBlinking(object)'
      'gtkStatusIconIsEmbedded(object)'
      'gtkStatusIconPositionMenu(menu, user.data)'
      'gtkStatusIconGetGeometry(object)'
      'gtkStatusIcon()'

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

     GObject
        +----GtkStatusIcon 

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

     The "system tray" or notification area is normally used for
     transient icons  that indicate some special state. For example, a
     system tray icon might  appear to tell the user that they have new
     mail, or have an incoming instant  message, or something along
     those lines. The basic idea is that creating an  icon in the
     notification area is less annoying than popping up a dialog. 

     A 'GtkStatusIcon' object can be used to display an icon in a
     "system tray". The icon can have a tooltip, and the user can
     interact with it by activating it or popping up a context menu.
     Critical information should not solely be displayed in a
     'GtkStatusIcon', since it may not be visible (e.g. when the user
     doesn't have a notification area on his panel). This can be
     checked with 'gtkStatusIconIsEmbedded'.

     On X11, the implementation follows the freedesktop.org "System
     Tray"  specification (<URL:
     http://www.freedesktop.org/wiki/Standards/systemtray-spec>).
     Implementations of the "tray" side of this specification can be
     found e.g. in the GNOME and KDE panel applications.

     Note that a GtkStatusIcon is _not_ a widget, but just a 'GObject'.
     Making it a widget would be impractical, since the system tray on
     Win32 doesn't allow to embed arbitrary widgets.

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


     '_G_t_k_S_t_a_t_u_s_I_c_o_n' _undocumented _


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

     'gtkStatusIcon' is the equivalent of 'gtkStatusIconNew'.

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


     '_a_c_t_i_v_a_t_e(_s_t_a_t_u_s._i_c_o_n, _u_s_e_r._d_a_t_a)' Gets emitted when the user
          activates the status icon.  If and how status icons can
          activated is platform-dependent.  

          Since  2.10

          '_s_t_a_t_u_s._i_c_o_n' ['GtkStatusIcon']  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.


     '_p_o_p_u_p-_m_e_n_u(_s_t_a_t_u_s._i_c_o_n, _b_u_t_t_o_n, _a_c_t_i_v_a_t_e._t_i_m_e, _u_s_e_r._d_a_t_a)' Gets
          emitted when the user brings up the context menu of the
          status icon. Whether status icons can have context  menus and
          how these are activated is platform-dependent.

          The 'button' and 'activate.timeout' parameters should be 
          passed as the last to arguments to 'gtkMenuPopup'.  

          Since  2.10

          '_s_t_a_t_u_s._i_c_o_n' ['GtkStatusIcon']  the object which received
               the signal

          '_b_u_t_t_o_n' [numeric]  the button that was pressed, or 0 if the 
               signal is not emitted in response to a button press
               event

          '_a_c_t_i_v_a_t_e._t_i_m_e' [numeric]  the timestamp of the event that
               triggered the signal emission

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


     '_s_i_z_e-_c_h_a_n_g_e_d(_s_t_a_t_u_s._i_c_o_n, _s_i_z_e, _u_s_e_r._d_a_t_a)' Gets emitted when the
          size available for the image changes, e.g. because the
          notification area got resized.  

          Since  2.10

          '_s_t_a_t_u_s._i_c_o_n' ['GtkStatusIcon']  the object which received
               the signal

          '_s_i_z_e' [integer]  the new size

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

          _Returns:_ [logical] 'TRUE' if the icon was updated for the
          new size. Otherwise, GTK+ will scale the icon as necessary.


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


     '_b_l_i_n_k_i_n_g' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether or not the status icon
          is blinking.  Default value: FALSE


     '_e_m_b_e_d_d_e_d' [_l_o_g_i_c_a_l : _R_e_a_d] 'TRUE' if the statusicon is embedded
          in a notification area.  

          Default value: FALSE  Since  2.12


     '_f_i_l_e' [_c_h_a_r_a_c_t_e_r : _W_r_i_t_e] Filename to load and display.  Default
          value: NULL


     '_i_c_o_n-_n_a_m_e' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] The name of the icon from
          the icon theme.  Default value: NULL


     '_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] The orientation of the
          tray in which the statusicon  is embedded.  

          Default value: GTK_ORIENTATION_HORIZONTAL  Since  2.12


     '_p_i_x_b_u_f' ['_G_d_k_P_i_x_b_u_f' : _R_e_a_d / _W_r_i_t_e] A GdkPixbuf to display.


     '_s_c_r_e_e_n' ['_G_d_k_S_c_r_e_e_n' : _R_e_a_d / _W_r_i_t_e] The screen where this status
          icon will be displayed.


     '_s_i_z_e' [_i_n_t_e_g_e_r : _R_e_a_d] The size of the icon.  Allowed values: >=
          0  Default value: 0


     '_s_t_o_c_k' [_c_h_a_r_a_c_t_e_r : _R_e_a_d / _W_r_i_t_e] Stock ID for a stock image to
          display.  Default value: NULL


     '_s_t_o_r_a_g_e-_t_y_p_e' ['_G_t_k_I_m_a_g_e_T_y_p_e' : _R_e_a_d] The representation being
          used for image data.  Default value: GTK_IMAGE_EMPTY


     '_v_i_s_i_b_l_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether or not the status icon
          is visible.  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/GtkStatusIcon.html>

