logo top
Main Page   Widgets   Namespaces   Book  

Gtk::StatusIcon Class Reference

Inheritance diagram for Gtk::StatusIcon:

Inheritance graph
[legend]
List of all members.

Detailed Description

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 StatusIcon 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 StatusIcon, 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 is_embedded().

On X11, the implementation follows the freedesktop.org "System Tray" specification. Implementations of the "tray" side of this specification can be found e.g. in the GNOME and KDE panel applications.

Since gtkmm 2.10:


Public Member Functions

bool get_blinking () const
Glib::ustring get_icon_name () const
Glib::RefPtr<const Gdk::Pixbufget_pixbuf () const
Glib::RefPtr<Gdk::Pixbufget_pixbuf ()
int get_size () const
StockID get_stock () const
ImageType get_storage_type () const
bool get_visible () const
const GtkStatusIcon* gobj () const
 Provides access to the underlying C GObject.
GtkStatusIcon* gobj ()
 Provides access to the underlying C GObject.
GtkStatusIcon* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool is_embedded () const
void set (const Glib::ustring& icon_name)
void set (const StockID& stock_id)
void set (const Glib::RefPtr<Gdk::Pixbuf>& pixbuf)
void set_blinking (bool blinking=true)
void set_from_file (const Glib::ustring& filename)
void set_tooltip (const Glib::ustring& tooltip_text)
void set_visible (bool visible=true)
virtual ~StatusIcon ()

Static Public Member Functions

static Glib::RefPtr<StatusIconcreate (const Glib::ustring& icon_name)
static Glib::RefPtr<StatusIconcreate (const StockID& stock_id)
static Glib::RefPtr<StatusIconcreate (const Glib::RefPtr<Gdk::Pixbuf>& pixbuf)
 Creates a new Gtk::StatusIcon object.
static Glib::RefPtr<StatusIconcreate_from_file (const std::string& filename)
 Creates a status icon displaying the file filename.

Protected Member Functions

 StatusIcon (const Glib::ustring& icon_name)
 StatusIcon (const StockID& stock)
 StatusIcon (const Glib::RefPtr<Gdk::Pixbuf>& pixbuf)
 StatusIcon ()

Related Functions

(Note that these are not member functions.)

Glib::RefPtr<Gtk::StatusIconwrap (GtkStatusIcon* object, bool take_copy=false)


Constructor & Destructor Documentation

virtual Gtk::StatusIcon::~StatusIcon (  )  [virtual]
 

Gtk::StatusIcon::StatusIcon (  )  [protected]
 

Gtk::StatusIcon::StatusIcon ( const Glib::RefPtr<Gdk::Pixbuf>&  pixbuf  )  [explicit, protected]
 

Gtk::StatusIcon::StatusIcon ( const StockID stock  )  [explicit, protected]
 

Gtk::StatusIcon::StatusIcon ( const Glib::ustring icon_name  )  [explicit, protected]
 


Member Function Documentation

static Glib::RefPtr<StatusIcon> Gtk::StatusIcon::create ( const Glib::ustring icon_name  )  [static]
 

static Glib::RefPtr<StatusIcon> Gtk::StatusIcon::create ( const StockID stock_id  )  [static]
 

static Glib::RefPtr<StatusIcon> Gtk::StatusIcon::create ( const Glib::RefPtr<Gdk::Pixbuf>&  pixbuf  )  [static]
 

Creates a new Gtk::StatusIcon object.

Returns:
A Glib::RefPtr<> to a newly created Gtk::StatusIcon object.

static Glib::RefPtr<StatusIcon> Gtk::StatusIcon::create_from_file ( const std::string&  filename  )  [static]
 

Creates a status icon displaying the file filename.

The image will be scaled down to fit in the available space in the notification area, if necessary.

Parameters:
filename A filename.
Returns:
A new StatusIcon
Since gtkmm 2.10:

bool Gtk::StatusIcon::get_blinking (  )  const
 

Glib::ustring Gtk::StatusIcon::get_icon_name (  )  const
 

Glib::RefPtr<const Gdk::Pixbuf> Gtk::StatusIcon::get_pixbuf (  )  const
 

Glib::RefPtr<Gdk::Pixbuf> Gtk::StatusIcon::get_pixbuf (  ) 
 

int Gtk::StatusIcon::get_size (  )  const
 

StockID Gtk::StatusIcon::get_stock (  )  const
 

ImageType Gtk::StatusIcon::get_storage_type (  )  const
 

bool Gtk::StatusIcon::get_visible (  )  const
 

const GtkStatusIcon* Gtk::StatusIcon::gobj (  )  const [inline]
 

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GtkStatusIcon* Gtk::StatusIcon::gobj (  )  [inline]
 

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GtkStatusIcon* Gtk::StatusIcon::gobj_copy (  ) 
 

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

bool Gtk::StatusIcon::is_embedded (  )  const
 

void Gtk::StatusIcon::set ( const Glib::ustring icon_name  ) 
 

void Gtk::StatusIcon::set ( const StockID stock_id  ) 
 

void Gtk::StatusIcon::set ( const Glib::RefPtr<Gdk::Pixbuf>&  pixbuf  ) 
 

void Gtk::StatusIcon::set_blinking ( bool  blinking = true  ) 
 

void Gtk::StatusIcon::set_from_file ( const Glib::ustring filename  ) 
 

void Gtk::StatusIcon::set_tooltip ( const Glib::ustring tooltip_text  ) 
 

void Gtk::StatusIcon::set_visible ( bool  visible = true  ) 
 


Friends And Related Function Documentation

Glib::RefPtr<Gtk::StatusIcon> wrap ( GtkStatusIcon*  object,
bool  take_copy = false
[related]
 

Parameters:
object The C instance
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:
Generated for gtkmm 2.4 by Doxygen 1.4.6 © 1997-2001