diff options
author | Matthias Clasen <mclasen@redhat.com> | 2010-06-08 19:44:56 -0400 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2010-06-08 19:48:15 -0400 |
commit | e17b9f282fb6cfb413de598350e273a68031994b (patch) | |
tree | b71e1591805451a8f03961755b4d3ed2d81f124c /gtk/gtkstatusbar.c | |
parent | 814701993030bb1280d0eb354ab52fec1becdfc7 (diff) | |
download | gtk+-e17b9f282fb6cfb413de598350e273a68031994b.tar.gz |
Get rid of templates that gtk-doc touches during distcheck
In an attempt to make distcheck not touch any files under source
control.
Diffstat (limited to 'gtk/gtkstatusbar.c')
-rw-r--r-- | gtk/gtkstatusbar.c | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/gtk/gtkstatusbar.c b/gtk/gtkstatusbar.c index 81d28d02c8..2556c149dd 100644 --- a/gtk/gtkstatusbar.c +++ b/gtk/gtkstatusbar.c @@ -36,6 +36,44 @@ #include "gtkbuildable.h" #include "gtkalias.h" +/** + * SECTION:gtkstatusbar + * @title: GtkStatusbar + * @short_description: Report messages of minor importance to the user + * + * 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). + * 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 + * <emphasis>context id</emphasis> 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(). + */ typedef struct _GtkStatusbarMsg GtkStatusbarMsg; struct _GtkStatusbarMsg |