logo top
Main Page   Widgets   Namespaces   Book  

Gtk::Statusbar Class Reference
[Widgets]

Inheritance diagram for Gtk::Statusbar:

List of all members.


Detailed Description

Text status indicator This widget is used to display status information.

Messages are pushed and poped onto a message stack. When text is pushed it replaces the old contents. The old text is restored when popped.

It derives from Gtk::HBox so that additional information can be added easily.

The Statusbar widget looks like this:

statusbar1.png

Public Member Functions

guint get_context_id (const Glib::ustring& context_description)
 Returns: an integer id.
bool get_has_resize_grip () const
 Returns: true if the statusbar has a resize grip.
const GtkStatusbar* gobj () const
 Provides access to the underlying C GtkObject.
GtkStatusbar* gobj ()
 Provides access to the underlying C GtkObject.
void pop (guint context_id=0)
 Removes the first message in the Gtk::StatusBar's stack with the given context id.
Glib::PropertyProxy_ReadOnly
<bool> 
property_has_resize_grip () const
 Whether the statusbar has a grip for resizing the toplevel.
Glib::PropertyProxy<bool> property_has_resize_grip ()
 Whether the statusbar has a grip for resizing the toplevel.
guint push (const Glib::ustring& text, guint context_id=0)
void remove_message (guint message_id, guint context_id=0)
void set_has_resize_grip (bool setting=true)
 Sets whether the statusbar has a resize grip.
Glib::SignalProxy2< void,
guint, const Glib::ustring& > 
signal_text_popped ()
Glib::SignalProxy2< void,
guint, const Glib::ustring& > 
signal_text_pushed ()
 Statusbar ()
virtual ~Statusbar ()

Protected Member Functions

virtual void on_text_popped (guint context_id, const Glib::ustring& text)
virtual void on_text_pushed (guint context_id, const Glib::ustring& text)

Related Functions

(Note that these are not member functions.)

Gtk::Statusbarwrap (GtkStatusbar* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Constructor & Destructor Documentation

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

Gtk::Statusbar::Statusbar (  ) 


Member Function Documentation

guint Gtk::Statusbar::get_context_id ( const Glib::ustring context_description  ) 

Returns: an integer id.

Parameters:
context_description Textual description of what context the new message is being used in.
Returns:
An integer id.

bool Gtk::Statusbar::get_has_resize_grip (  )  const

Returns: true if the statusbar has a resize grip.

Returns:
true if the statusbar has a resize grip.

const GtkStatusbar* Gtk::Statusbar::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::HBox.

GtkStatusbar* Gtk::Statusbar::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::HBox.

virtual void Gtk::Statusbar::on_text_popped ( guint  context_id,
const Glib::ustring text 
) [protected, virtual]

virtual void Gtk::Statusbar::on_text_pushed ( guint  context_id,
const Glib::ustring text 
) [protected, virtual]

void Gtk::Statusbar::pop ( guint  context_id = 0  ) 

Removes the first message in the Gtk::StatusBar's stack with the given context id.

Note that this may not change the displayed message, if the message at the top of the stack has a different context id.

Parameters:
context_id A context identifier.

Glib::PropertyProxy_ReadOnly<bool> Gtk::Statusbar::property_has_resize_grip (  )  const

Whether the statusbar has a grip for resizing the toplevel.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::Statusbar::property_has_resize_grip (  ) 

Whether the statusbar has a grip for resizing the toplevel.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

guint Gtk::Statusbar::push ( const Glib::ustring text,
guint  context_id = 0 
)

void Gtk::Statusbar::remove_message ( guint  message_id,
guint  context_id = 0 
)

void Gtk::Statusbar::set_has_resize_grip ( bool  setting = true  ) 

Sets whether the statusbar has a resize grip.

true by default.

Parameters:
setting true to have a resize grip.

Glib::SignalProxy2< void,guint,const Glib::ustring& > Gtk::Statusbar::signal_text_popped (  ) 

Prototype:
void on_my_text_popped(guint context_id, const Glib::ustring& text)

Glib::SignalProxy2< void,guint,const Glib::ustring& > Gtk::Statusbar::signal_text_pushed (  ) 

Prototype:
void on_my_text_pushed(guint context_id, const Glib::ustring& text)


Friends And Related Function Documentation

Gtk::Statusbar* wrap ( GtkStatusbar *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

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.5.6 © 1997-2001