gtk.statusbar

Module for [Statusbar] class

class Statusbar StatusbarGidBuilder StatusbarGidBuilderImpl

Types 3

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.Statusbar.getContextId], 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.Statusbar.new_].

Messages are added to the bar’s stack with [gtk.statusbar.Statusbar.push].

The message at the top of the stack can be removed using [gtk.statusbar.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.Statusbar.remove].

CSS node

GtkStatusbar has a single CSS node with name statusbar.

Methods

GType _getGType()

GType _gType() @property

Statusbar self()Returns `this`, for use in `with` statements.

StatusbarGidBuilder builder()Get builder for [gtk.statusbar.Statusbar] Returns: New builder object

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.

gtk.box.Box getMessageArea()Retrieves the box containing the label widget. Returns: a #GtkBox

void pop(uint contextId)Removes the first message in the #GtkStatusbar’s stack with the given context id.

uint push(uint contextId, string text)Pushes a new message onto a statusbar’s stack.

void remove(uint contextId, uint messageId)Forces the removal of a message from a statusbar’s stack. The exact contextid and messageid must be specified.

void removeAll(uint contextId)Forces the removal of all messages from a statusbar's stack with the exact context_id.

gulong connectTextPopped(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  uint)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  string)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  gtk.statusbar.Statusbar)))
   &&  Parameters!T.length <  4)

Connect to `TextPopped` signal.

gulong connectTextPushed(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  uint)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  string)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  gtk.statusbar.Statusbar)))
   &&  Parameters!T.length <  4)

Connect to `TextPushed` signal.

Constructors

this(void * ptr, Flag!"Take" take)

this()Creates a new #GtkStatusbar ready for messages. Returns: the new #GtkStatusbar

classStatusbarGidBuilderImpl(T) : gtk.box.BoxGidBuilderImpl!T

classStatusbarGidBuilder : StatusbarGidBuilderImpl!StatusbarGidBuilder

Fluent builder for [gtk.statusbar.Statusbar]

Methods

Statusbar build()