Statusbar

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).

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().

CSS node

GtkStatusbar has a single CSS node with name statusbar.

class Statusbar : Box {

protected

GtkStatusbar* gtkStatusbar;

GtkStatusbar* getStatusbarStruct(bool transferOwnership);

void* getStruct();

this(GtkStatusbar* gtkStatusbar, bool ownedRef);

Box getMessageArea();

static GType getType();

this();

uint getContextId(string contextDescription);

void pop(uint contextId);

uint push(uint contextId, string text);

void remove(uint contextId, uint messageId);

void removeAll(uint contextId);

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

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

}

Constructors

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

Members

Functions

addOnTextPopped gulong addOnTextPopped(void delegate(uint, string, Statusbar) dlg, ConnectFlags connectFlags): Is emitted whenever a new message is popped off a statusbar's stack.
addOnTextPushed gulong addOnTextPushed(void delegate(uint, 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.
getMessageArea Box getMessageArea(): Retrieves the box containing the label widget. Since 2.20
getStatusbarStruct GtkStatusbar* getStatusbarStruct(bool transferOwnership): Get the main Gtk struct
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.
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.

Static functions

getType GType getType()

Variables

gtkStatusbar GtkStatusbar* gtkStatusbar;: the main Gtk struct

Inherited Members

From Box

gtkBox GtkBox* gtkBox;: the main Gtk struct
getBoxStruct GtkBox* getBoxStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
__anonymous mixin OrientableT!(GtkBox): Undocumented in source.
getType GType getType()
getBaselinePosition GtkBaselinePosition getBaselinePosition(): Gets the value set by gtk_box_set_baseline_position().
getCenterWidget Widget getCenterWidget(): Retrieves the center widget of the box.
getHomogeneous bool getHomogeneous(): Returns whether the box is homogeneous (all children are the same size). See gtk_box_set_homogeneous().
getSpacing int getSpacing(): Gets the value set by gtk_box_set_spacing().
packEnd void packEnd(Widget child, bool expand, bool fill, uint padding): Adds @child to @box, packed with reference to the end of @box. The @child is packed after (away from end of) any other child packed with reference to the end of @box.
packStart void packStart(Widget child, bool expand, bool fill, uint padding): Adds @child to @box, packed with reference to the start of @box. The @child is packed after any other child packed with reference to the start of @box.
queryChildPacking void queryChildPacking(Widget child, bool expand, bool fill, uint padding, GtkPackType packType): Obtains information about how @child is packed into @box.
reorderChild void reorderChild(Widget child, int position): Moves @child to a new @position in the list of @box children. The list contains widgets packed #GTK_PACK_START as well as widgets packed #GTK_PACK_END, in the order that these widgets were added to @box.
setBaselinePosition void setBaselinePosition(GtkBaselinePosition position): Sets the baseline position of a box. This affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then @position is used to allocate the baseline wrt the extra space available.
setCenterWidget void setCenterWidget(Widget widget): Sets a center widget; that is a child widget that will be centered with respect to the full width of the box, even if the children at either side take up different amounts of space.
setChildPacking void setChildPacking(Widget child, bool expand, bool fill, uint padding, GtkPackType packType): Sets the way @child is packed into @box.
setHomogeneous void setHomogeneous(bool homogeneous): Sets the #GtkBox:homogeneous property of @box, controlling whether or not all children of @box are given equal space in the box.
setSpacing void setSpacing(int spacing): Sets the #GtkBox:spacing property of @box, which is the number of pixels to place between children of @box.