gnome-ui-init

## gnome-ui-init gnome-ui-init — Parameters (and deprecated functions) for initializing libgnomeui applications. |

## Synopsis

    #include <libgnomeui/libgnomeui.h>

    #define             LIBGNOMEUI_MODULE
    #define             LIBGNOMEUI_PARAM_CRASH_DIALOG
    #define             LIBGNOMEUI_PARAM_DISPLAY
    #define             LIBGNOMEUI_PARAM_DEFAULT_ICON
    int                 gnome_init_with_popt_table          (const char *app_id,
                                                             const char *app_version,
                                                             int argc,
                                                             char **argv,
                                                             const struct poptOption *options,
                                                             int flags,
                                                             poptContext *return_ctx);
    #define             gnome_init                          (app_id,
                                                             app_version,
                                                             argc,
                                                             argv)
    const GnomeModuleInfo *  gnome_gtk_module_info_get      (void);

## Description

The initialization functions in this module are deprecated in favour of calls to `gnome_program_init()` in the libgnome library.

However, this module does provide some extra parameters on top of those already defined in libgnome that can be passed to the `gnome_program_init()` call. These should enable libgnomeui applications to control their appearance precisely.

## Details

### LIBGNOMEUI_MODULE

    #define LIBGNOMEUI_MODULE libgnomeui_module_info_get()

A module containing all the information required to initialize libgnomeui and its dependents. This should be passed to the `gnome_program_init()` call by applications using libgnomeui.

### LIBGNOMEUI_PARAM_CRASH_DIALOG

    #define LIBGNOMEUI_PARAM_CRASH_DIALOG "show-crash-dialog"

If set to `TRUE`, the standard GNOME crash dialog will appear (offering the user a chance to automatically file a bug report) should the application crash while running. Application authors will almost never want to change the default value of this parameter (`FALSE`). The user may change it however by setting the `GNOME_DISABLE_CRASH_DIALOG` environment variable or passing `--disable-crash-dialog` on the command line.

### LIBGNOMEUI_PARAM_DISPLAY

    #define LIBGNOMEUI_PARAM_DISPLAY "display"

Initially set to the value of the `DISPLAY` environment variable or the `--display` value passed on the command line, this parameter determines which X display the application will start on.

### LIBGNOMEUI_PARAM_DEFAULT_ICON

    #define LIBGNOMEUI_PARAM_DEFAULT_ICON "default-icon"

Set to the full path of the application's default icon. This can only be set by the application.

### gnome_init_with_popt_table ()

    int                 gnome_init_with_popt_table          (const char *app_id,
                                                             const char *app_version,
                                                             int argc,
                                                             char **argv,
                                                             const struct poptOption *options,
                                                             int flags,
                                                             poptContext *return_ctx);

### Warning

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

Initializes the application. This sets up all of the GNOME internals and prepares them (imlib, gdk, session-management, triggers, sound, user preferences).

Unlike gnome_init, with gnome_init_with_popt_table you can provide a table of popt options (popt is the command line argument parsing library).

Deprecated, use gnome_program_init with the LIBGNOMEUI_MODULE.

`app_id` : | Application id.
`app_version` : | Application version.
`argc` : | argument count (for example argc as received by main)
`argv` : | argument vector (for example argv as received by main)
`options` : | poptOption table with options to parse
`flags` : | popt flags.
`return_ctx` : | if non-NULL, the popt context is returned here.
Returns : | 0 (always)

### gnome_init()

    #define             gnome_init(app_id,app_version,argc,argv)

### Warning

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

This is identical to a call to gnome_init_with_popt_table with `NULL` passed in as the poptOption table.

`app_id` : | Application id.
`app_version` : | Application version.
`argc` : | Argument count (for example, argc as received by the main function).
`argv` : | Argument vector (for example, argv as received by the main function).

### gnome_gtk_module_info_get ()

    const GnomeModuleInfo *  gnome_gtk_module_info_get      (void);