Class Index Cross Index Namespace Index

Class Gtk::Statusbar

Text status indicator
Contained in: Gtk
Derived from: Gtk::HBox
Derived by: none

#include <gtk--/statusbar.h>


public function member index:

Statusbar();
guint get_context_id(const nstring& context_description) const;
GtkStatusbar* gtkobj();
const GtkStatusbar* gtkobj() const;
static bool isA(Object* object);
MsgList& messages();
const MsgList& messages() const;
iterator messages_begin();
iterator messages_end();
void pop(guint context_id);
guint push(guint context_id, const nstring& text);
void remove_message(guint context_id, guint message_id);
signal void text_popped(guint, const gchar*);
signal void text_pushed(guint, const gchar*);
virtual ~Statusbar();
 

protected function member index:

virtual void text_popped_impl(guint p0, const gchar* p1);
virtual void text_pushed_impl(guint p0, const gchar* p1);
 

Description:

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 message list can be accessed through the messages() list.


Function Member Descriptions:

Gtk::Statusbar::get_context_id - Returns a new context identifier, given a description of the actual context.

guint get_context_id(const nstring& context_description) const;
context_description: Textual description of what context the new message is being used in.

Returns: An integer id.



Gtk::Statusbar::gtkobj - Returns the underlaying gtk+ object.

GtkStatusbar* gtkobj();

Gtk::Statusbar::isA - Returns true if object is this type.

static bool isA(Object* object);

Gtk::Statusbar::pop - Removes the message at the top of a GtkStatusBar's stack.

void pop(guint context_id);
context_id: A context identifier.


Gtk::Statusbar::push - Pushes a new message onto a statusbar's stack.

guint push(guint context_id, const nstring& text);
context_id: The message's context id, as returned by get_context_id.

text: The message to add to the statusbar.

Returns: The message's new message id for use with .



Gtk::Statusbar::remove_message - Forces the removal of a message from a statusbar's stack. The exact context_id and message_id must be specified.

void remove_message(guint context_id, guint message_id);
context_id: A context identifier.

message_id: A message identifier, as returned by push.



Gtk::Statusbar::text_popped - Is emitted whenever a new message is popped off a statusbar's stack.

signal void text_popped(guint, const gchar*);
virtual void text_popped_impl(guint p0, const gchar* p1);

Gtk::Statusbar::text_pushed - Is emitted whenever a new message gets pushed onto a statusbar's stack.

signal void text_pushed(guint, const gchar*);
virtual void text_pushed_impl(guint p0, const gchar* p1);