Statusbar

Description A GtkStatusbar is usually placed along the bottom of an application's main GtkWindow. 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. Status bars in GTK+ 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 gtk_statusbar_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. One could say that a statusbar maintains one stack of messages for display purposes, but allows multiple message producers to maintain sub-stacks of the messages they produced (via context ids). Status bars are created using gtk_statusbar_new(). Messages are added to the bar's stack with gtk_statusbar_push(). The message at the top of the stack can be removed using gtk_statusbar_pop(). A message can be removed from anywhere in the stack if its message_id was recorded at the time it was added. This is done using gtk_statusbar_remove().

class Statusbar : HBox {

protected

GtkStatusbar* gtkStatusbar;

GtkStatusbar* getStatusbarStruct();

void* getStruct();

this(GtkStatusbar* gtkStatusbar);

void setStruct(GObject* obj);

int[string] connectedSignals;

void delegate(guint, string, Statusbar)[] onTextPoppedListeners;

void addOnTextPopped(void delegate(guint, string, Statusbar) dlg, ConnectFlags connectFlags);

static void callBackTextPopped(GtkStatusbar* statusbarStruct, guint contextId, gchar* text, Statusbar _statusbar);

void delegate(guint, string, Statusbar)[] onTextPushedListeners;

void addOnTextPushed(void delegate(guint, string, Statusbar) dlg, ConnectFlags connectFlags);

static void callBackTextPushed(GtkStatusbar* statusbarStruct, guint contextId, gchar* text, Statusbar _statusbar);

this();

uint getContextId(string contextDescription);

uint push(uint contextId, string text);

void pop(uint contextId);

void remove(uint contextId, uint messageId);

void removeAll(uint contextId);

void setHasResizeGrip(int setting);

int getHasResizeGrip();

Widget getMessageArea();

}

Constructors

this this(GtkStatusbar* gtkStatusbar): Sets our main struct and passes it to the parent class
this this(): Creates a new GtkStatusbar ready for messages.

Members

Functions

addOnTextPopped void addOnTextPopped(void delegate(guint, string, Statusbar) dlg, ConnectFlags connectFlags): Is emitted whenever a new message is popped off a statusbar's stack.
addOnTextPushed void addOnTextPushed(void delegate(guint, string, Statusbar) dlg, ConnectFlags connectFlags): Is emitted whenever a new message gets pushed onto a statusbar's stack.
getContextId uint getContextId(string contextDescription): Returns a new context identifier, given a description of the actual context. Note that the description is not shown in the UI.
getHasResizeGrip int getHasResizeGrip(): Returns whether the statusbar has a resize grip.
getMessageArea Widget getMessageArea(): Retrieves the box containing the label widget. Since 2.20
getStatusbarStruct GtkStatusbar* getStatusbarStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getStruct void* getStruct(): the main Gtk struct as a void*
pop void pop(uint contextId): Removes the first message in the GtkStatusBar'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.
push uint push(uint contextId, string text): Pushes a new message onto a statusbar's stack.
remove void remove(uint contextId, uint messageId): Forces the removal of a message from a statusbar's stack. The exact context_id and message_id must be specified.
removeAll void removeAll(uint contextId): Forces the removal of all messages from a statusbar's stack with the exact context_id. Since 2.22
setHasResizeGrip void setHasResizeGrip(int setting): Sets whether the statusbar has a resize grip. TRUE by default.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

callBackTextPopped void callBackTextPopped(GtkStatusbar* statusbarStruct, guint contextId, gchar* text, Statusbar _statusbar): Undocumented in source. Be warned that the author may not have intended to support it.
callBackTextPushed void callBackTextPushed(GtkStatusbar* statusbarStruct, guint contextId, gchar* text, Statusbar _statusbar): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals int[string] connectedSignals;
gtkStatusbar GtkStatusbar* gtkStatusbar;: the main Gtk struct
onTextPoppedListeners void delegate(guint, string, Statusbar)[] onTextPoppedListeners;: Undocumented in source.
onTextPushedListeners void delegate(guint, string, Statusbar)[] onTextPushedListeners;: Undocumented in source.

Inherited Members

From HBox

gtkHBox GtkHBox* gtkHBox;: the main Gtk struct
getHBoxStruct GtkHBox* getHBoxStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.