Next: , Previous: spin-button, Up: Widgets

6.2.86 statusbar

— Class: statusbar

Superclass: h-box atk-implementor-iface buildable orientable

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.

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. Context ids may be specified by context descriptions (as string) or by numeric identifiers obtained by statusbar-context-id. 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 description 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 descriptions).

Messages are added to the bar's stack with statusbar-push.

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



— Method: statusbar-context-id
     (statusbar-context-id statusbar context-description) => context-id

Returns a context identifier, given a description of the actual context. Note that the description is not shown in the UI.

context-description is a string - textual description of what context the new message is being used in

— Method: statusbar-push
     (statusbar-push statusbar context text) => message-id

Pushes a new message onto a statusbar's stack.

context: a string (context description) or a number obtained by statusbar-context-id

text: the message to add to the statusbar

message-id: a message id that can be used with statusbar-remove.

— Method: statusbar-pop
     (statusbar-pop statusbar context)

Removes the first message in the statusbar's stack with the given context.

Note that this may not change the displayed message, if the message at the top of the stack has a different context.

context: a string (context description) or a number obtained by statusbar-context-id

— Method: statusbar-remove
     (statusbar-remove statusbar context message-id)

Forces the removal of a message from a statusbar's stack. The exact context and message-id must be specified.

context: a string (context description) or a number obtained by statusbar-context-id

message-id: a message identifier returned by statusbar-push