SWAMIGUI_STATUSBAR_GLOBAL_MAXLEN

#define SWAMIGUI_STATUSBAR_GLOBAL_MAXLEN 24

SwamiguiStatusbar

typedef struct _SwamiguiStatusbar SwamiguiStatusbar;

SwamiguiStatusbarCloseFunc ()

gboolean            (*SwamiguiStatusbarCloseFunc)       (SwamiguiStatusbar *statusbar,
                                                         GtkWidget *widg);

Callback function prototype which gets called when a close button on a progress status bar item gets activated.

enum SwamiguiStatusbarPos

typedef enum
{
  SWAMIGUI_STATUSBAR_POS_LEFT,
  SWAMIGUI_STATUSBAR_POS_RIGHT
} SwamiguiStatusbarPos;

enum SwamiguiStatusbarTimeout

typedef enum
{
  SWAMIGUI_STATUSBAR_TIMEOUT_DEFAULT = -1,  /* uses "default-timeout" property */
  SWAMIGUI_STATUSBAR_TIMEOUT_FOREVER = 0    /* don't timeout */
} SwamiguiStatusbarTimeout;

swamigui_statusbar_new ()

GtkWidget *         swamigui_statusbar_new              (void);

Create a new status bar widget.

swamigui_statusbar_add ()

guint               swamigui_statusbar_add              (SwamiguiStatusbar *statusbar,
                                                         const char *group,
                                                         int timeout,
                                                         guint pos,
                                                         GtkWidget *widg);

Add a widget to a status bar. The widg is usually created with one of the helper functions, such as swamigui_statusbar_msg_label_new() or swamigui_statusbar_msg_progress_new(), although an arbitrary widget can be added.

swamigui_statusbar_remove ()

void                swamigui_statusbar_remove           (SwamiguiStatusbar *statusbar,
                                                         guint id,
                                                         const char *group);

Remove a message by id or group.

swamigui_statusbar_printf ()

void                swamigui_statusbar_printf           (SwamiguiStatusbar *statusbar,
                                                         const char *format,
                                                         ...);

A convenience function to display a message label to a statusbar with the "default-timeout" property value for the timeout, no group and positioned left. This is commonly used to display an operation that was performed.

swamigui_statusbar_msg_label_new ()

GtkWidget *         swamigui_statusbar_msg_label_new    (const char *label,
                                                         guint maxlen);

A helper function to create a label widget for use in a statusbar. Doesn't do a whole lot beyond just creating a regular GtkLabel and setting its max length.

swamigui_statusbar_msg_progress_new ()

GtkWidget *         swamigui_statusbar_msg_progress_new (const char *label,
                                                         SwamiguiStatusbarCloseFunc close);

A helper function to create a progress status bar item.

swamigui_statusbar_msg_set_timeout ()

void                swamigui_statusbar_msg_set_timeout  (SwamiguiStatusbar *statusbar,
                                                         guint id,
                                                         const char *group,
                                                         int timeout);

Modify the timeout of an existing message in the statusbar. Message is selected by id or group.

swamigui_statusbar_msg_set_label ()

void                swamigui_statusbar_msg_set_label    (SwamiguiStatusbar *statusbar,
                                                         guint id,
                                                         const char *group,
                                                         const char *label);

Modify the label of an existing message in the statusbar. Message is selected by id or group. This function should only be used for GtkLabel widget status items or those created with swamigui_statusbar_msg_label_new() and swamigui_statusbar_msg_progress_new().

swamigui_statusbar_msg_set_progress ()

void                swamigui_statusbar_msg_set_progress (SwamiguiStatusbar *statusbar,
                                                         guint id,
                                                         const char *group,
                                                         double val);

Modify the progress indicator of an existing message in the statusbar. Message is selected by id or group. This function should only be used for widget status items created with swamigui_statusbar_msg_progress_new().

The "default-timeout" property

  "default-timeout"          gint                  : Read / Write

Default timeout in milliseconds.

Allowed values: >= 0

Default value: 4000