Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (inaki@blueleaf.cc)
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.Statusbar

Contents

Exported types
Methods
Signals
- textPopped
- textPushed

Description

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.

Synopsis

newtype Statusbar = Statusbar (ManagedPtr Statusbar)
class (GObject o, IsDescendantOf Statusbar o) => IsStatusbar o
toStatusbar :: (MonadIO m, IsStatusbar o) => o -> m Statusbar
noStatusbar :: Maybe Statusbar
statusbarGetContextId :: (HasCallStack, MonadIO m, IsStatusbar a) => a -> Text -> m Word32
statusbarGetMessageArea :: (HasCallStack, MonadIO m, IsStatusbar a) => a -> m Box
statusbarNew :: (HasCallStack, MonadIO m) => m Statusbar
statusbarPop :: (HasCallStack, MonadIO m, IsStatusbar a) => a -> Word32 -> m ()
statusbarPush :: (HasCallStack, MonadIO m, IsStatusbar a) => a -> Word32 -> Text -> m Word32
statusbarRemove :: (HasCallStack, MonadIO m, IsStatusbar a) => a -> Word32 -> Word32 -> m ()
statusbarRemoveAll :: (HasCallStack, MonadIO m, IsStatusbar a) => a -> Word32 -> m ()
type C_StatusbarTextPoppedCallback = Ptr () -> Word32 -> CString -> Ptr () -> IO ()
type StatusbarTextPoppedCallback = Word32 -> Text -> IO ()
afterStatusbarTextPopped :: (IsStatusbar a, MonadIO m) => a -> StatusbarTextPoppedCallback -> m SignalHandlerId
genClosure_StatusbarTextPopped :: MonadIO m => StatusbarTextPoppedCallback -> m (GClosure C_StatusbarTextPoppedCallback)
mk_StatusbarTextPoppedCallback :: C_StatusbarTextPoppedCallback -> IO (FunPtr C_StatusbarTextPoppedCallback)
noStatusbarTextPoppedCallback :: Maybe StatusbarTextPoppedCallback
onStatusbarTextPopped :: (IsStatusbar a, MonadIO m) => a -> StatusbarTextPoppedCallback -> m SignalHandlerId
wrap_StatusbarTextPoppedCallback :: StatusbarTextPoppedCallback -> C_StatusbarTextPoppedCallback
type C_StatusbarTextPushedCallback = Ptr () -> Word32 -> CString -> Ptr () -> IO ()
type StatusbarTextPushedCallback = Word32 -> Text -> IO ()
afterStatusbarTextPushed :: (IsStatusbar a, MonadIO m) => a -> StatusbarTextPushedCallback -> m SignalHandlerId
genClosure_StatusbarTextPushed :: MonadIO m => StatusbarTextPushedCallback -> m (GClosure C_StatusbarTextPushedCallback)
mk_StatusbarTextPushedCallback :: C_StatusbarTextPushedCallback -> IO (FunPtr C_StatusbarTextPushedCallback)
noStatusbarTextPushedCallback :: Maybe StatusbarTextPushedCallback
onStatusbarTextPushed :: (IsStatusbar a, MonadIO m) => a -> StatusbarTextPushedCallback -> m SignalHandlerId
wrap_StatusbarTextPushedCallback :: StatusbarTextPushedCallback -> C_StatusbarTextPushedCallback

Exported types

newtype Statusbar Source #

Memory-managed wrapper type.

Constructors

Statusbar (ManagedPtr Statusbar)

Instances

GObject Statusbar Source #
Instance details Defined in GI.Gtk.Objects.Statusbar Methods gobjectType :: IO GType #
HasParentTypes Statusbar Source #
Instance details Defined in GI.Gtk.Objects.Statusbar
type ParentTypes Statusbar Source #
Instance details Defined in GI.Gtk.Objects.Statusbar type ParentTypes Statusbar = Box ': (Container ': (Widget ': (Object ': (ImplementorIface ': (Buildable ': (Orientable ': ([] :: [Type])))))))

class (GObject o, IsDescendantOf Statusbar o) => IsStatusbar o Source #

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

Instances

(GObject o, IsDescendantOf Statusbar o) => IsStatusbar o Source #
Instance details Defined in GI.Gtk.Objects.Statusbar

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

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

noStatusbar :: Maybe Statusbar Source #

A convenience alias for Nothing :: Maybe Statusbar.

Methods

getContextId

statusbarGetContextId Source #

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 Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m Statusbar	Returns: the new `Statusbar`

Creates a new Statusbar ready for messages.

pop

statusbarPop Source #

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 Source #

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 Source #

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 Source #

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 () Source #

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

type StatusbarTextPoppedCallback Source #

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 Source #

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 :: MonadIO m => StatusbarTextPoppedCallback -> m (GClosure C_StatusbarTextPoppedCallback) Source #

Wrap the callback into a GClosure.

mk_StatusbarTextPoppedCallback :: C_StatusbarTextPoppedCallback -> IO (FunPtr C_StatusbarTextPoppedCallback) Source #

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

noStatusbarTextPoppedCallback :: Maybe StatusbarTextPoppedCallback Source #

A convenience synonym for Nothing :: Maybe StatusbarTextPoppedCallback.

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

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 Source #

Wrap a StatusbarTextPoppedCallback into a C_StatusbarTextPoppedCallback.

textPushed

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

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

type StatusbarTextPushedCallback Source #

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 Source #

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 :: MonadIO m => StatusbarTextPushedCallback -> m (GClosure C_StatusbarTextPushedCallback) Source #

Wrap the callback into a GClosure.

mk_StatusbarTextPushedCallback :: C_StatusbarTextPushedCallback -> IO (FunPtr C_StatusbarTextPushedCallback) Source #

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

noStatusbarTextPushedCallback :: Maybe StatusbarTextPushedCallback Source #

A convenience synonym for Nothing :: Maybe StatusbarTextPushedCallback.

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

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 Source #

Wrap a StatusbarTextPushedCallback into a C_StatusbarTextPushedCallback.