mate-ui-init

mate-ui-init — Parameters (and deprecated functions) for initializing libmateui applications.

Synopsis

#include <libmateui/libmateui.h>

#define             LIBMATEUI_MODULE
#define             LIBMATEUI_PARAM_CRASH_DIALOG
#define             LIBMATEUI_PARAM_DISPLAY
#define             LIBMATEUI_PARAM_DEFAULT_ICON
int                 mate_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             mate_init                          (app_id,
                                                         app_version,
                                                         argc,
                                                         argv)
const MateModuleInfo *  mate_gtk_module_info_get      (void);

Description

The initialization functions in this module are deprecated in favour of calls to mate_program_init() in the libmate library.

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

Details

LIBMATEUI_MODULE

#define LIBMATEUI_MODULE libmateui_module_info_get()

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


LIBMATEUI_PARAM_CRASH_DIALOG

#define LIBMATEUI_PARAM_CRASH_DIALOG "show-crash-dialog"

If set to TRUE, the standard MATE 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 MATE_DISABLE_CRASH_DIALOG environment variable or passing --disable-crash-dialog on the command line.


LIBMATEUI_PARAM_DISPLAY

#define LIBMATEUI_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.


LIBMATEUI_PARAM_DEFAULT_ICON

#define LIBMATEUI_PARAM_DEFAULT_ICON "default-icon"

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


mate_init_with_popt_table ()

int                 mate_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

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

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

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

Deprecated, use mate_program_init with the LIBMATEUI_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)

mate_init()

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

Warning

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

This is identical to a call to mate_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).

mate_gtk_module_info_get ()

const MateModuleInfo *  mate_gtk_module_info_get      (void);

Returns :