Gnome User Interface Library Reference Manual
PrevNext

gnome-app-util

Name

gnome-app-util — one line description goes here.

Synopsis

#include <gnome.h>


GtkWidget*  gnome_app_message               (GnomeApp *app,
                                             const gchar *message);
void        gnome_app_flash                 (GnomeApp *app,
                                             const gchar *flash);
GtkWidget*  gnome_app_error                 (GnomeApp *app,
                                             const gchar *error);
GtkWidget*  gnome_app_warning               (GnomeApp *app,
                                             const gchar *warning);
GtkWidget*  gnome_app_question              (GnomeApp *app,
                                             const gchar *question,
                                             GnomeReplyCallback callback,
                                             gpointer data);
GtkWidget*  gnome_app_question_modal        (GnomeApp *app,
                                             const gchar *question,
                                             GnomeReplyCallback callback,
                                             gpointer data);
GtkWidget*  gnome_app_ok_cancel             (GnomeApp *app,
                                             const gchar *message,
                                             GnomeReplyCallback callback,
                                             gpointer data);
GtkWidget*  gnome_app_ok_cancel_modal       (GnomeApp *app,
                                             const gchar *message,
                                             GnomeReplyCallback callback,
                                             gpointer data);
GtkWidget*  gnome_app_request_string        (GnomeApp *app,
                                             const gchar *prompt,
                                             GnomeStringCallback callback,
                                             gpointer data);
GtkWidget*  gnome_app_request_password      (GnomeApp *app,
                                             const gchar *prompt,
                                             GnomeStringCallback callback,
                                             gpointer data);
gdouble     (*GnomeAppProgressFunc)         (gpointer data);
void        (*GnomeAppProgressCancelFunc)   (gpointer data);
typedef     GnomeAppProgressKey
GnomeAppProgressKey gnome_app_progress_timeout
                                            (GnomeApp *app,
                                             const gchar *description,
                                             guint32 interval,
                                             GnomeAppProgressFunc percentage_cb,
                                             GnomeAppProgressCancelFunc cancel_cb,
                                             gpointer data);
GnomeAppProgressKey gnome_app_progress_manual
                                            (GnomeApp *app,
                                             const gchar *description,
                                             GnomeAppProgressCancelFunc cancel_cb,
                                             gpointer data);
void        gnome_app_set_progress          (GnomeAppProgressKey key,
                                             gdouble percent);
void        gnome_app_progress_done         (GnomeAppProgressKey key);

Description

Details

gnome_app_message()

GtkWidget*  gnome_app_message               (GnomeApp *app,
                                             const gchar *message);

A simple message, in an OK dialog or the status bar. Requires confirmation from the user before it goes away.

app : Pointer to GNOME app objectmessage : Text of message to be displayedReturns :Pointer to dialog widget, or NULL if error or message in status bar.

gnome_app_flash()

void        gnome_app_flash                 (GnomeApp *app,
                                             const gchar *flash);

Flash the message in the statusbar for a few moments; if no statusbar, do nothing (?). For trivial little status messages, e.g. "Auto saving..."

app : Pointer to GNOME app objectflash : Text of message to be flashed

gnome_app_error()

GtkWidget*  gnome_app_error                 (GnomeApp *app,
                                             const gchar *error);

An important fatal error; if it appears in the statusbar, it might gdk_beep() and require acknowledgement.

app : Pointer to GNOME app objecterror : Text of error message to be displayedReturns :Pointer to dialog widget, or NULL if error or message in status bar.

gnome_app_warning()

GtkWidget*  gnome_app_warning               (GnomeApp *app,
                                             const gchar *warning);

A not-so-important error, but still marked better than a flash

app : Pointer to GNOME app objectwarning : Text of warning message to be displayedReturns :Pointer to dialog widget, or NULL if error or message in status bar.

gnome_app_question()

GtkWidget*  gnome_app_question              (GnomeApp *app,
                                             const gchar *question,
                                             GnomeReplyCallback callback,
                                             gpointer data);

Ask a yes or no question, and call the callback when it's answered.

app : Pointer to GNOME app objectquestion : Text of question to be displayedcallback : data : Returns :Pointer to dialog widget, or NULL if error or message in status bar.

gnome_app_question_modal()

GtkWidget*  gnome_app_question_modal        (GnomeApp *app,
                                             const gchar *question,
                                             GnomeReplyCallback callback,
                                             gpointer data);

Ask a yes or no question, and call the callback when it's answered.

app : Pointer to GNOME app objectquestion : Text of question to be displayedcallback : data : Returns :Pointer to dialog widget, or NULL if error or message in status bar.

gnome_app_ok_cancel()

GtkWidget*  gnome_app_ok_cancel             (GnomeApp *app,
                                             const gchar *message,
                                             GnomeReplyCallback callback,
                                             gpointer data);

app : Pointer to GNOME app objectmessage : Text of message to be displayedcallback : data : Returns :Pointer to dialog widget, or NULL if error or message in status bar.

gnome_app_ok_cancel_modal()

GtkWidget*  gnome_app_ok_cancel_modal       (GnomeApp *app,
                                             const gchar *message,
                                             GnomeReplyCallback callback,
                                             gpointer data);

app : Pointer to GNOME app objectmessage : Text of message to be displayedcallback : data : Returns :Pointer to dialog widget, or NULL if error or message in status bar.

gnome_app_request_string()

GtkWidget*  gnome_app_request_string        (GnomeApp *app,
                                             const gchar *prompt,
                                             GnomeStringCallback callback,
                                             gpointer data);

app : Pointer to GNOME app objectprompt : Text of prompt to be displayedcallback : data : Returns :Pointer to dialog widget, or NULL if error or message in status bar.

gnome_app_request_password()

GtkWidget*  gnome_app_request_password      (GnomeApp *app,
                                             const gchar *prompt,
                                             GnomeStringCallback callback,
                                             gpointer data);

app : Pointer to GNOME app objectprompt : Text of prompt to be displayedcallback : data : Returns :Pointer to dialog widget, or NULL if error or message in status bar.

GnomeAppProgressFunc()

gdouble     (*GnomeAppProgressFunc)         (gpointer data);

data : Returns : 

GnomeAppProgressCancelFunc()

void        (*GnomeAppProgressCancelFunc)   (gpointer data);

data : 

GnomeAppProgressKey

typedef gpointer GnomeAppProgressKey;

gnome_app_progress_timeout()

GnomeAppProgressKey gnome_app_progress_timeout
                                            (GnomeApp *app,
                                             const gchar *description,
                                             guint32 interval,
                                             GnomeAppProgressFunc percentage_cb,
                                             GnomeAppProgressCancelFunc cancel_cb,
                                             gpointer data);

app : description : interval : percentage_cb : cancel_cb : data : Returns : 

gnome_app_progress_manual()

GnomeAppProgressKey gnome_app_progress_manual
                                            (GnomeApp *app,
                                             const gchar *description,
                                             GnomeAppProgressCancelFunc cancel_cb,
                                             gpointer data);

app : description : cancel_cb : data : Returns : 

gnome_app_set_progress()

void        gnome_app_set_progress          (GnomeAppProgressKey key,
                                             gdouble percent);

key : percent : 

gnome_app_progress_done()

void        gnome_app_progress_done         (GnomeAppProgressKey key);

key : 

PrevHomeNext
gnome-app-helperUpgnome-canvas-util