GnomeAppBar

Name

GnomeAppBar -- 

Synopsis



#define     GNOME_APPBAR_HAS_STATUS         (appbar)
#define     GNOME_APPBAR_HAS_PROGRESS       (appbar)
struct      GnomeAppBarPrivate;
struct      GnomeAppBarMsg;
#define     GNOME_APPBAR_INTERACTIVE        (ab)
GtkWidget*  gnome_appbar_new                (gboolean has_progress,
                                             gboolean has_status,
                                             GnomePreferencesType interactivity);
void        gnome_appbar_set_status         (GnomeAppBar *appbar,
                                             const gchar *status);
GtkWidget*  gnome_appbar_get_status         (GnomeAppBar *appbar);
void        gnome_appbar_set_default        (GnomeAppBar *appbar,
                                             const gchar *default_status);
void        gnome_appbar_push               (GnomeAppBar *appbar,
                                             const gchar *status);
void        gnome_appbar_pop                (GnomeAppBar *appbar);
void        gnome_appbar_clear_stack        (GnomeAppBar *appbar);
void        gnome_appbar_set_progress_percentage
                                            (GnomeAppBar *appbar,
                                             gfloat percentage);
GtkProgressBar* gnome_appbar_get_progress   (GnomeAppBar *appbar);
void        gnome_appbar_refresh            (GnomeAppBar *appbar);
void        gnome_appbar_set_prompt         (GnomeAppBar *appbar,
                                             const gchar *prompt,
                                             gboolean modal);
void        gnome_appbar_clear_prompt       (GnomeAppBar *appbar);
gchar*      gnome_appbar_get_response       (GnomeAppBar *appbar);

Object Hierarchy


  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkContainer
                     +----GtkBox
                           +----GtkHBox
                                 +----GnomeAppBar

Properties


  "has-progress"         gboolean             : Read / Write / Construct
  "has-status"           gboolean             : Read / Write / Construct
  "interactivity"        GnomePreferencesType : Read / Write / Construct

Signal Prototypes


"clear-prompt"
            void        user_function      (GnomeAppBar *appbar,
                                            gpointer user_data);
"user-response"
            void        user_function      (GnomeAppBar *appbar,
                                            gpointer user_data);

Description

Details

GNOME_APPBAR_HAS_STATUS()

#define GNOME_APPBAR_HAS_STATUS(appbar) (gnome_appbar_get_status(GNOME_APPBAR(appbar)) != NULL)


GNOME_APPBAR_HAS_PROGRESS()

#define GNOME_APPBAR_HAS_PROGRESS(appbar) (gnome_appbar_get_progress(GNOME_APPBAR(appbar)) != NULL)


struct GnomeAppBarPrivate

struct GnomeAppBarPrivate;


struct GnomeAppBarMsg

struct GnomeAppBarMsg;


GNOME_APPBAR_INTERACTIVE()

#define GNOME_APPBAR_INTERACTIVE(ab) ((ab) ? (ab)->interactive : FALSE)


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.

interactivity 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_set_status ()

void        gnome_appbar_set_status         (GnomeAppBar *appbar,
                                             const gchar *status);

Sets the status label without changing widget state; next set or push will destroy this permanently.


gnome_appbar_get_status ()

GtkWidget*  gnome_appbar_get_status         (GnomeAppBar *appbar);

Returns 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; defaults to nothing.


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

void        gnome_appbar_pop                (GnomeAppBar *appbar);

Remove current status message, and display previous status message, if any. It is OK to call this with an empty stack.


gnome_appbar_clear_stack ()

void        gnome_appbar_clear_stack        (GnomeAppBar *appbar);

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);


gnome_appbar_get_progress ()

GtkProgressBar* gnome_appbar_get_progress   (GnomeAppBar *appbar);

Returns &GtkProgressBar widget pointer, so that the progress bar may be manipulated further.


gnome_appbar_refresh ()

void        gnome_appbar_refresh            (GnomeAppBar *appbar);

Reflect the current state of stack/default. Useful to force a 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 ()

void        gnome_appbar_clear_prompt       (GnomeAppBar *appbar);

Remove any prompt.


gnome_appbar_get_response ()

gchar*      gnome_appbar_get_response       (GnomeAppBar *appbar);

Get the response to the prompt, if any. Result must be g_free'd.

Properties

"has-progress" (gboolean : Read / Write / Construct)

Create a progress widget.

"has-status" (gboolean : Read / Write / Construct)

Create a status widget.

"interactivity" (GnomePreferencesType : Read / Write / Construct)

Level of user activity required.

Signals

The "clear-prompt" signal

void        user_function                  (GnomeAppBar *appbar,
                                            gpointer user_data);


The "user-response" signal

void        user_function                  (GnomeAppBar *appbar,
                                            gpointer user_data);