Description
A GnomeAppBar widget sits (usually) at the bottom of an application window and
contains a progress bar (for indicating time consuming tasks and their
completion status) and/or a status bar for sending short one-line message to
the user. It is also possible (in theory) for the user to edit the contents of
the status bar, should the application developer choose to allow that, however
note that this is not really working in the present
implementation, so developers are recommended to avoid using interactive status
bars and use proper editable widgets instead.
Details
GNOME_APPBAR_HAS_STATUS()
#define GNOME_APPBAR_HAS_STATUS(appbar) (gnome_appbar_get_status(GNOME_APPBAR(appbar)) != NULL) |
Whether or not the application bar contains a status box.
GNOME_APPBAR_HAS_PROGRESS()
#define GNOME_APPBAR_HAS_PROGRESS(appbar) (gnome_appbar_get_progress(GNOME_APPBAR(appbar)) != NULL) |
Whether or not the application bar contains a status box.
GNOME_APPBAR_INTERACTIVE()
#define GNOME_APPBAR_INTERACTIVE(ab) ((ab) ? (ab)->interactive : FALSE) |
Whether or not the user can edit the text in the statusbar portion of a
GnomeAppBar instance.
struct GnomeAppBar
This widget contains the status bar and progress bar (if they are requested).
After creating a GnomeAppBar widget (via gnome_appbar_new(), for example), it
can then be passed to gnome_app_set_statusbar() to add it to the main
application window.
gnome_appbar_new ()
GtkWidget* gnome_appbar_new (gboolean has_progress,
gboolean has_status,
GnomePreferencesType interactivity); |
Create a new GNOME application status bar. If has_progress is
TRUE, a small progress bar widget will be created, and placed on the
left side of the appbar. If has_status is TRUE, a status bar,
possibly an editable one, is created.
The interactivity parameter determines whether the appbar is an interactive
"minibuffer" or just a status bar. If it is set to
GNOME_PREFERENCES_NEVER, it is never interactive. If it is set to
GNOME_PREFERENCES_USER we respect user preferences from
ui-properties. If it's GNOME_PREFERENCES_ALWAYS we are interactive
whether the user likes it or not. Basically, if your app supports
both interactive and not (for example, if you use the
gnome-app-util interfaces), you should use
GNOME_PREFERENCES_USER. Otherwise, use the setting you
support. Please note that "interactive" mode is not functional now;
GtkEntry is inadequate and so a custom widget will be written
eventually.
gnome_appbar_get_status ()
GtkWidget* gnome_appbar_get_status (GnomeAppBar *appbar); |
Retrieves the statusbar widget.
gnome_appbar_set_default ()
void gnome_appbar_set_default (GnomeAppBar *appbar,
const gchar *default_status); |
What to show when showing nothing else is on the stack; defaults to the
empty string.
gnome_appbar_push ()
void gnome_appbar_push (GnomeAppBar *appbar,
const gchar *status); |
Push a new status message onto the status bar stack and display it.
gnome_appbar_pop ()
Remove current status message, and display previous status
message, if any. It is fine to call this with an empty stack.
gnome_appbar_clear_stack ()
Remove all status messages from appbar, and display default status
message (if present).
gnome_appbar_set_progress_percentage ()
void gnome_appbar_set_progress_percentage
(GnomeAppBar *appbar,
gfloat percentage); |
Sets progress bar to percentage.
gnome_appbar_get_progress ()
GtkProgressBar* gnome_appbar_get_progress (GnomeAppBar *appbar); |
Retrieves the progress bar widget for further manipulation.
gnome_appbar_refresh ()
Refresh the status message bar by redrawing the item on the top of the
stack, or the default value if the stack is empty.. Useful to force the
message from a previous call to gnome_appbar_set_status() to disappear.
gnome_appbar_set_prompt ()
void gnome_appbar_set_prompt (GnomeAppBar *appbar,
const gchar *prompt,
gboolean modal); |
Put a prompt in the appbar and wait for a response. When the
user responds or cancels, a 'user_response' signal is emitted.
gnome_appbar_clear_prompt ()
Remove any prompt from the status message bar.
gnome_appbar_get_response ()
gchar* gnome_appbar_get_response (GnomeAppBar *appbar); |
Get the response to the prompt, if any.