GI.Gtk.Objects.Statusbar

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

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 statusbarGetContextId, 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 statusbarNew.

Messages are added to the bar’s stack with statusbarPush.

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

CSS node

GtkStatusbar has a single CSS node with name statusbar.

Exported types

newtype Statusbar

Memory-managed wrapper type.

Constructors

Statusbar (ManagedPtr Statusbar)

Instances

GObject Statusbar

Defined in GI.Gtk.Objects.Statusbar

Methods

gobjectType :: Statusbar -> IO GType

IsImplementorIface Statusbar

Defined in GI.Gtk.Objects.Statusbar

IsObject Statusbar

Defined in GI.Gtk.Objects.Statusbar

IsBuildable Statusbar

Defined in GI.Gtk.Objects.Statusbar

IsOrientable Statusbar

Defined in GI.Gtk.Objects.Statusbar

IsBox Statusbar

Defined in GI.Gtk.Objects.Statusbar

IsContainer Statusbar

Defined in GI.Gtk.Objects.Statusbar

IsWidget Statusbar

Defined in GI.Gtk.Objects.Statusbar

IsStatusbar Statusbar

Defined in GI.Gtk.Objects.Statusbar

class GObject o => IsStatusbar o

Type class for types which can be safely cast to Statusbar, for instance with toStatusbar.

Instances

(GObject a, (UnknownAncestorError Statusbar a :: Constraint)) => IsStatusbar a

Defined in GI.Gtk.Objects.Statusbar

IsStatusbar Statusbar

Defined in GI.Gtk.Objects.Statusbar

toStatusbar :: (MonadIO m, IsStatusbar o) => o -> m Statusbar

Cast to Statusbar, for types for which this is known to be safe. For general casts, use castTo.

noStatusbar :: Maybe Statusbar

A convenience alias for Nothing :: Maybe Statusbar.

Methods

getContextId

statusbarGetContextId

Arguments

:: (HasCallStack, MonadIO m, IsStatusbar a)

=> a

statusbar: a Statusbar

-> Text

contextDescription: textual description of what context the new message is being used in

-> m Word32

Returns: an integer id

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

getMessageArea

statusbarGetMessageArea

Arguments

:: (HasCallStack, MonadIO m, IsStatusbar a)

=> a

statusbar: a Statusbar

-> m Box

Returns: a Box

Retrieves the box containing the label widget.

Since: 2.20

new

statusbarNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Statusbar

Returns: the new Statusbar

Creates a new Statusbar ready for messages.

pop

statusbarPop

Arguments

:: (HasCallStack, MonadIO m, IsStatusbar a)

=> a

statusbar: a Statusbar

-> Word32

contextId: a context identifier

-> m ()

Removes the first message in the Statusbar’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

statusbarPush

Arguments

:: (HasCallStack, MonadIO m, IsStatusbar a)

=> a

statusbar: a Statusbar

-> Word32

contextId: the message’s context id, as returned by statusbarGetContextId

-> Text

text: the message to add to the statusbar

-> m Word32

Returns: a message id that can be used with statusbarRemove.

Pushes a new message onto a statusbar’s stack.

remove

statusbarRemove

Arguments

:: (HasCallStack, MonadIO m, IsStatusbar a)

=> a

statusbar: a Statusbar

-> Word32

contextId: a context identifier

-> Word32

messageId: a message identifier, as returned by statusbarPush

-> m ()

Forces the removal of a message from a statusbar’s stack. The exact contextId and messageId must be specified.

removeAll

statusbarRemoveAll

Arguments

:: (HasCallStack, MonadIO m, IsStatusbar a)

=> a

statusbar: a Statusbar

-> Word32

contextId: a context identifier

-> m ()

Forces the removal of all messages from a statusbar's stack with the exact contextId.

Since: 2.22

Signals

textPopped

type C_StatusbarTextPoppedCallback = Ptr () -> Word32 -> CString -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type StatusbarTextPoppedCallback

Arguments

 = Word32

contextId: the context id of the relevant message/statusbar

-> Text

text: the message that was just popped

-> IO ()

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

afterStatusbarTextPopped :: (IsStatusbar a, MonadIO m) => a -> StatusbarTextPoppedCallback -> m SignalHandlerId

Connect a signal handler for the “text-popped” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after statusbar #textPopped callback

genClosure_StatusbarTextPopped :: StatusbarTextPoppedCallback -> IO Closure

Wrap the callback into a Closure.

mk_StatusbarTextPoppedCallback :: C_StatusbarTextPoppedCallback -> IO (FunPtr C_StatusbarTextPoppedCallback)

Generate a function pointer callable from C code, from a C_StatusbarTextPoppedCallback.

noStatusbarTextPoppedCallback :: Maybe StatusbarTextPoppedCallback

A convenience synonym for Nothing :: Maybe StatusbarTextPoppedCallback.

onStatusbarTextPopped :: (IsStatusbar a, MonadIO m) => a -> StatusbarTextPoppedCallback -> m SignalHandlerId

Connect a signal handler for the “text-popped” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on statusbar #textPopped callback

wrap_StatusbarTextPoppedCallback :: StatusbarTextPoppedCallback -> C_StatusbarTextPoppedCallback

Wrap a StatusbarTextPoppedCallback into a C_StatusbarTextPoppedCallback.

textPushed

type C_StatusbarTextPushedCallback = Ptr () -> Word32 -> CString -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type StatusbarTextPushedCallback

Arguments

 = Word32

contextId: the context id of the relevant message/statusbar

-> Text

text: the message that was pushed

-> IO ()

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

afterStatusbarTextPushed :: (IsStatusbar a, MonadIO m) => a -> StatusbarTextPushedCallback -> m SignalHandlerId

Connect a signal handler for the “text-pushed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after statusbar #textPushed callback

genClosure_StatusbarTextPushed :: StatusbarTextPushedCallback -> IO Closure

Wrap the callback into a Closure.

mk_StatusbarTextPushedCallback :: C_StatusbarTextPushedCallback -> IO (FunPtr C_StatusbarTextPushedCallback)

Generate a function pointer callable from C code, from a C_StatusbarTextPushedCallback.

noStatusbarTextPushedCallback :: Maybe StatusbarTextPushedCallback

A convenience synonym for Nothing :: Maybe StatusbarTextPushedCallback.

onStatusbarTextPushed :: (IsStatusbar a, MonadIO m) => a -> StatusbarTextPushedCallback -> m SignalHandlerId

Connect a signal handler for the “text-pushed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on statusbar #textPushed callback

wrap_StatusbarTextPushedCallback :: StatusbarTextPushedCallback -> C_StatusbarTextPushedCallback

Wrap a StatusbarTextPushedCallback into a C_StatusbarTextPushedCallback.