## gnome-app-util

gnome-app-util

## Synopsis

    #include <libgnomeui/libgnomeui.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);

### Warning

`gnome_app_message` is deprecated and should not be used in newly-written code.

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 object
`message` : | Text of message to be displayed
Returns : | 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);

### Warning

`gnome_app_flash` is deprecated and should not be used in newly-written code.

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 object
`flash` : | Text of message to be flashed

### gnome_app_error ()

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

### Warning

`gnome_app_error` is deprecated and should not be used in newly-written code.

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

`app` : | Pointer to GNOME app object
`error` : | Text of error message to be displayed
Returns : | 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);

### Warning

`gnome_app_warning` is deprecated and should not be used in newly-written code.

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

`app` : | Pointer to GNOME app object
`warning` : | Text of warning message to be displayed
Returns : | 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);

### Warning

`gnome_app_question` is deprecated and should not be used in newly-written code.

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

`app` : | Pointer to GNOME app object
`question` : | Text of question to be displayed
`callback` : |
`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);

### Warning

`gnome_app_question_modal` is deprecated and should not be used in newly-written code.

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

`app` : | Pointer to GNOME app object
`question` : | Text of question to be displayed
`callback` : |
`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);

### Warning

`gnome_app_ok_cancel` is deprecated and should not be used in newly-written code.

`app` : | Pointer to GNOME app object
`message` : | Text of message to be displayed
`callback` : |
`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);

### Warning

`gnome_app_ok_cancel_modal` is deprecated and should not be used in newly-written code.

`app` : | Pointer to GNOME app object
`message` : | Text of message to be displayed
`callback` : |
`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);

### Warning

`gnome_app_request_string` is deprecated and should not be used in newly-written code.

`app` : | Pointer to GNOME app object
`prompt` : | Text of prompt to be displayed
`callback` : |
`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);

### Warning

`gnome_app_request_password` is deprecated and should not be used in newly-written code.

`app` : | Pointer to GNOME app object
`prompt` : | Text of prompt to be displayed
`callback` : |
`data` : |
Returns : | Pointer to dialog widget, or `NULL` if error or message in status bar.

### GnomeAppProgressFunc ()

    gdouble             (*GnomeAppProgressFunc)             (gpointer data);

### Warning

`GnomeAppProgressFunc` is deprecated and should not be used in newly-written code.

`data` : |
Returns : |

### GnomeAppProgressCancelFunc ()

    void                (*GnomeAppProgressCancelFunc)       (gpointer data);

### Warning

`GnomeAppProgressCancelFunc` is deprecated and should not be used in newly-written code.

`data` : |

### GnomeAppProgressKey

    typedef gpointer GnomeAppProgressKey;

### Warning

`GnomeAppProgressKey` is deprecated and should not be used in newly-written code.

### gnome_app_progress_timeout ()

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

### Warning

`gnome_app_progress_timeout` is deprecated and should not be used in newly-written code.

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

### Warning

`gnome_app_progress_manual` is deprecated and should not be used in newly-written code.

`app` : |
`description` : |
`cancel_cb` : |
`data` : |
Returns : |

### gnome_app_set_progress ()

    void                gnome_app_set_progress              (GnomeAppProgressKey key,
                                                             gdouble percent);

### Warning

`gnome_app_set_progress` is deprecated and should not be used in newly-written code.

`key` : |
`percent` : |

### gnome_app_progress_done ()

    void                gnome_app_progress_done             (GnomeAppProgressKey key);

### Warning

`gnome_app_progress_done` is deprecated and should not be used in newly-written code.

`key` : |