CtkStatusbar

CtkStatusbar — Report messages of minor importance to the user

Functions

CtkWidget * ctk_statusbar_new ()
guint ctk_statusbar_get_context_id ()
guint ctk_statusbar_push ()
void ctk_statusbar_pop ()
void ctk_statusbar_remove ()
void ctk_statusbar_remove_all ()
CtkWidget * ctk_statusbar_get_message_area ()

Signals

void text-popped Run Last
void text-pushed Run Last

Types and Values

struct CtkStatusbar

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── CtkWidget
            ╰── CtkContainer
                ╰── CtkBox
                    ╰── CtkStatusbar

Implemented Interfaces

CtkStatusbar implements AtkImplementorIface, CtkBuildable and CtkOrientable.

Includes

#include <ctk/ctk.h>

Description

A CtkStatusbar is usually placed along the bottom of an application's main CtkWindow. 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 CTK+ 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 ctk_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 ctk_statusbar_new().

Messages are added to the bar’s stack with ctk_statusbar_push().

The message at the top of the stack can be removed using ctk_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 ctk_statusbar_remove().

CSS node

CtkStatusbar has a single CSS node with name statusbar.

Functions

ctk_statusbar_new ()

CtkWidget *
ctk_statusbar_new (void);

Creates a new CtkStatusbar ready for messages.

Returns

the new CtkStatusbar

ctk_statusbar_get_context_id ()

guint
ctk_statusbar_get_context_id (CtkStatusbar *statusbar,
                              const gchar *context_description);

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

Parameters

statusbar

a CtkStatusbar

  

context_description

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

  

Returns

an integer id

ctk_statusbar_push ()

guint
ctk_statusbar_push (CtkStatusbar *statusbar,
                    guint context_id,
                    const gchar *text);

Pushes a new message onto a statusbar’s stack.

Parameters

statusbar

a CtkStatusbar

  

context_id

the message’s context id, as returned by ctk_statusbar_get_context_id()

  

text

the message to add to the statusbar

  

Returns

a message id that can be used with ctk_statusbar_remove().

ctk_statusbar_pop ()

void
ctk_statusbar_pop (CtkStatusbar *statusbar,
                   guint context_id);

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

Parameters

statusbar

a CtkStatusbar

  

context_id

a context identifier

  

ctk_statusbar_remove ()

void
ctk_statusbar_remove (CtkStatusbar *statusbar,
                      guint context_id,
                      guint message_id);

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

Parameters

statusbar

a CtkStatusbar

  

context_id

a context identifier

  

message_id

a message identifier, as returned by ctk_statusbar_push()

  

ctk_statusbar_remove_all ()

void
ctk_statusbar_remove_all (CtkStatusbar *statusbar,
                          guint context_id);

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

Parameters

statusbar

a CtkStatusbar

  

context_id

a context identifier

  

Since: 2.22

ctk_statusbar_get_message_area ()

CtkWidget *
ctk_statusbar_get_message_area (CtkStatusbar *statusbar);

Retrieves the box containing the label widget.

Parameters

statusbar

a CtkStatusbar

  

Returns

a CtkBox.

[type Ctk.Box][transfer none]

Since: 2.20

Types and Values

struct CtkStatusbar

struct CtkStatusbar;

Signal Details

The “text-popped” signal

void
user_function (CtkStatusbar *statusbar,
               guint         context_id,
               char         *text,
               gpointer      user_data)

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

Parameters

statusbar

the object which received the signal

  

context_id

the context id of the relevant message/statusbar

  

text

the message that was just popped

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

The “text-pushed” signal

void
user_function (CtkStatusbar *statusbar,
               guint         context_id,
               char         *text,
               gpointer      user_data)

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

Parameters

statusbar

the object which received the signal

  

context_id

the context id of the relevant message/statusbar

  

text

the message that was pushed

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

Generated by GTK-Doc V1.36.1