Reference Manual
Inti Logo
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

Inti::Gtk::Statusbar Class Reference

A GtkStatusbar C++ wrapper class. More...

#include <inti/gtk/statusbar.h>

Inheritance diagram for Inti::Gtk::Statusbar:

Inti::Gtk::HBox Inti::Gtk::Box Inti::Gtk::Container Inti::Gtk::Widget Inti::Gtk::Object Inti::Atk::Implementor Inti::G::Object Inti::G::TypeInterface Inti::G::TypeInstance Inti::MemoryHandler Inti::G::TypeInstance Inti::ReferencedBase Inti::ReferencedBase List of all members.

Public Member Functions

Constructors
Accessors
Methods
Signal Proxies

Protected Member Functions

Constructors
Signal Handlers

Detailed Description

A GtkStatusbar C++ wrapper class.

A Statusbar is usually placed along the bottom of an application's main Gtk::Window. 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.

Statusbars 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 get_context_id(), 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. Messages are added to the bar's stack with push(). The message at the top of the stack can be removed using pop(). A message can be removed from anywhere in the stack if it's message_id was recorded at the time it was added. This is done using remove().


Constructor & Destructor Documentation

Inti::Gtk::Statusbar::Statusbar GtkStatusbar *  statusbar,
bool  reference = false
[explicit, protected]
 

Construct a new Statusbar from an existing GtkStatusbar.

Parameters:
statusbar A pointer to a GtkStatusbar.
reference Set false if the initial reference count is floating, set true if it's not.

The statusbar can be a newly created GtkStatusbar or an existing GtkStatusbar(see G::Object::Object).


Member Function Documentation

unsigned int Inti::Gtk::Statusbar::get_context_id const String context_description  )  const
 

Returns a new context identifier, given a description of the actual context.

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

virtual void Inti::Gtk::Statusbar::on_text_popped unsigned int  context_id,
const String text
[protected, virtual]
 

Called whenever a new message is popped off a statusbar's stack.

Parameters:
context_id The context id of the relevant message.
text The message that was just popped.

virtual void Inti::Gtk::Statusbar::on_text_pushed unsigned int  context_id,
const String text
[protected, virtual]
 

Called whenever a new message gets pushed onto a statusbar's stack.

Parameters:
context_id The context id of the relevant message.
text The message that was pushed.

void Inti::Gtk::Statusbar::pop unsigned int  context_id = 0  ) 
 

Removes the message at the top of the statusbar's stack.

Parameters:
context_id A context identifier.

unsigned int Inti::Gtk::Statusbar::push const String text,
unsigned int  context_id = 0
 

Pushes a new message onto a statusbar's stack.

Parameters:
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 remove().

void Inti::Gtk::Statusbar::remove unsigned int  message_id,
unsigned int  context_id = 0
 

Forces the removal of a message from the statusbar's stack.

Parameters:
context_id A context identifier.
message_id A message identifier, as returned by push()

The exact context_id and message_id must be specified.

void Inti::Gtk::Statusbar::set_has_resize_grip bool  setting  ) 
 

Sets whether the statusbar has a resize grip; true by default.

Parameters:
setting true to have a resize grip.


The documentation for this class was generated from the following file: Main Page - Footer


Generated on Sun Sep 14 20:08:18 2003 for Inti by doxygen 1.3.2 written by Dimitri van Heesch, © 1997-2002