GtkStatusbar — Report messages of minor importance to the user
GtkWidget * | gtk_statusbar_new () |
guint | gtk_statusbar_get_context_id () |
guint | gtk_statusbar_push () |
void | gtk_statusbar_pop () |
void | gtk_statusbar_remove () |
void | gtk_statusbar_remove_all () |
const char * | gtk_statusbar_get_message () |
void | text-popped | Run Last |
void | text-pushed | Run Last |
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkStatusbar
GtkStatusbar implements GtkAccessible, GtkBuildable and GtkConstraintTarget.
#include <gtk/gtk.h>
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_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 gtk_statusbar_new()
.
Messages are added to the bar’s stack with gtk_statusbar_push()
.
The message at the top of the stack can be removed using gtk_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_remove()
.
GtkStatusbar has a single CSS node with name statusbar.
GtkWidget *
gtk_statusbar_new (void
);
Creates a new GtkStatusbar ready for messages.
the new GtkStatusbar
guint gtk_statusbar_get_context_id (GtkStatusbar *statusbar
,const char *context_description
);
Returns a new context identifier, given a description of the actual context. Note that the description is not shown in the UI.
statusbar | ||
context_description | textual description of what context the new message is being used in |
an integer id
guint gtk_statusbar_push (GtkStatusbar *statusbar
,guint context_id
,const char *text
);
Pushes a new message onto a statusbar’s stack.
statusbar | ||
context_id | the message’s context id, as returned by | |
text | the message to add to the statusbar |
a message id that can be used with gtk_statusbar_remove()
.
void gtk_statusbar_pop (GtkStatusbar *statusbar
,guint context_id
);
Removes the first message in the GtkStatusbar’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.
statusbar | ||
context_id | a context identifier |
void gtk_statusbar_remove (GtkStatusbar *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.
statusbar | ||
context_id | a context identifier | |
message_id | a message identifier, as returned by |
void gtk_statusbar_remove_all (GtkStatusbar *statusbar
,guint context_id
);
Forces the removal of all messages from a statusbar's stack with the exact context_id
.
statusbar | ||
context_id | a context identifier |
const char *
gtk_statusbar_get_message (GtkStatusbar *statusbar
);
Retrieves the contents of the label in GtkStatusbar.
statusbar |
the contents of the statusbar.
[transfer none]
typedef struct _GtkStatusbar GtkStatusbar;
“text-popped”
signalvoid user_function (GtkStatusbar *statusbar, guint context_id, char *text, gpointer user_data)
Is emitted whenever a new message is popped off a statusbar's stack.
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
“text-pushed”
signalvoid user_function (GtkStatusbar *statusbar, guint context_id, char *text, gpointer user_data)
Is emitted whenever a new message gets pushed onto a statusbar's stack.
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
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk4/4.0/GtkStatusbar.html