gnome-app-helper

gnome-app-helper

Functions

void (*GnomeUISignalConnectFunc) ()
void gnome_accelerators_sync ()
void gnome_app_fill_menu ()
void gnome_app_fill_menu_with_data ()
void gnome_app_fill_menu_custom ()
void gnome_app_ui_configure_configurable ()
void gnome_app_create_menus ()
void gnome_app_create_menus_interp ()
void gnome_app_create_menus_with_data ()
void gnome_app_create_menus_custom ()
void gnome_app_fill_toolbar ()
void gnome_app_fill_toolbar_with_data ()
void gnome_app_fill_toolbar_custom ()
void gnome_app_create_toolbar ()
void gnome_app_create_toolbar_interp ()
void gnome_app_create_toolbar_with_data ()
void gnome_app_create_toolbar_custom ()
GtkWidget * gnome_app_find_menu_pos ()
void gnome_app_remove_menus ()
void gnome_app_remove_menu_range ()
void gnome_app_insert_menus_custom ()
void gnome_app_insert_menus ()
void gnome_app_insert_menus_with_data ()
void gnome_app_insert_menus_interp ()
void gnome_app_install_appbar_menu_hints ()
void gnome_app_install_statusbar_menu_hints ()
void gnome_app_install_menu_hints ()
void gnome_app_setup_toolbar ()
#define GNOMEUIINFO_ITEM()
#define GNOMEUIINFO_ITEM_STOCK()
#define GNOMEUIINFO_ITEM_NONE()
#define GNOMEUIINFO_ITEM_DATA()
#define GNOMEUIINFO_TOGGLEITEM()
#define GNOMEUIINFO_TOGGLEITEM_DATA()
#define GNOMEUIINFO_HELP()
#define GNOMEUIINFO_SUBTREE()
#define GNOMEUIINFO_SUBTREE_HINT()
#define GNOMEUIINFO_SUBTREE_STOCK()
#define GNOMEUIINFO_INCLUDE()
#define GNOMEUIINFO_RADIOLIST()
#define GNOMEUIINFO_RADIOITEM()
#define GNOMEUIINFO_RADIOITEM_DATA()
#define GNOMEUIINFO_MENU_NEW_ITEM()
#define GNOMEUIINFO_MENU_NEW_SUBTREE()
#define GNOMEUIINFO_MENU_OPEN_ITEM()
#define GNOMEUIINFO_MENU_SAVE_ITEM()
#define GNOMEUIINFO_MENU_SAVE_AS_ITEM()
#define GNOMEUIINFO_MENU_REVERT_ITEM()
#define GNOMEUIINFO_MENU_PRINT_ITEM()
#define GNOMEUIINFO_MENU_PRINT_SETUP_ITEM()
#define GNOMEUIINFO_MENU_CLOSE_ITEM()
#define GNOMEUIINFO_MENU_EXIT_ITEM()
#define GNOMEUIINFO_MENU_QUIT_ITEM()
#define GNOMEUIINFO_MENU_CUT_ITEM()
#define GNOMEUIINFO_MENU_COPY_ITEM()
#define GNOMEUIINFO_MENU_PASTE_ITEM()
#define GNOMEUIINFO_MENU_SELECT_ALL_ITEM()
#define GNOMEUIINFO_MENU_CLEAR_ITEM()
#define GNOMEUIINFO_MENU_UNDO_ITEM()
#define GNOMEUIINFO_MENU_REDO_ITEM()
#define GNOMEUIINFO_MENU_FIND_ITEM()
#define GNOMEUIINFO_MENU_FIND_AGAIN_ITEM()
#define GNOMEUIINFO_MENU_REPLACE_ITEM()
#define GNOMEUIINFO_MENU_PROPERTIES_ITEM()
#define GNOMEUIINFO_MENU_PREFERENCES_ITEM()
#define GNOMEUIINFO_MENU_NEW_WINDOW_ITEM()
#define GNOMEUIINFO_MENU_CLOSE_WINDOW_ITEM()
#define GNOMEUIINFO_MENU_ABOUT_ITEM()
#define GNOMEUIINFO_MENU_NEW_GAME_ITEM()
#define GNOMEUIINFO_MENU_PAUSE_GAME_ITEM()
#define GNOMEUIINFO_MENU_RESTART_GAME_ITEM()
#define GNOMEUIINFO_MENU_UNDO_MOVE_ITEM()
#define GNOMEUIINFO_MENU_REDO_MOVE_ITEM()
#define GNOMEUIINFO_MENU_HINT_ITEM()
#define GNOMEUIINFO_MENU_SCORES_ITEM()
#define GNOMEUIINFO_MENU_END_GAME_ITEM()
#define GNOMEUIINFO_MENU_FILE_TREE()
#define GNOMEUIINFO_MENU_EDIT_TREE()
#define GNOMEUIINFO_MENU_VIEW_TREE()
#define GNOMEUIINFO_MENU_SETTINGS_TREE()
#define GNOMEUIINFO_MENU_FILES_TREE()
#define GNOMEUIINFO_MENU_WINDOWS_TREE()
#define GNOMEUIINFO_MENU_HELP_TREE()
#define GNOMEUIINFO_MENU_GAME_TREE()
const gchar * gnome_app_helper_gettext ()
#define L_()
#define D_()

Types and Values

Includes

#include <libgnomeui/libgnomeui.h>

Description

Functions

GnomeUISignalConnectFunc ()

void
(*GnomeUISignalConnectFunc) (GnomeUIInfo *uiinfo,
                             const char *signal_name,
                             GnomeUIBuilderData *uibdata);

gnome_accelerators_sync ()

void
gnome_accelerators_sync (void);

Flush the accelerator definitions into the application specific configuration file $HOME/.gnome2/accels/<app-id>.


gnome_app_fill_menu ()

void
gnome_app_fill_menu (GtkMenuShell *menu_shell,
                     GnomeUIInfo *uiinfo,
                     GtkAccelGroup *accel_group,
                     gboolean uline_accels,
                     gint pos);

Fills the specified menu_shell with items created from the specified uiinfo , inserting them from the item number pos on. The accel_ group will be used as the accel group for all newly created sub menus and serves as the global accel group for all menu item hotkeys. If it is passed as NULL, global hotkeys will be disabled.

Parameters

menu_shell

A GtkMenuShell instance (a menu bar).

 

uiinfo

A pointer to the first element in an array of GnomeUIInfo structures. The last element of the array should have a type of GNOME_APP_UI_ENDOFINFO.

 

accel_group

A GtkAccelGroup.

 

uline_accels

TRUE if underline accelerators will be drawn for the menu item labels.

 

pos

The position in the menu bar at which to start inserting items.

 

gnome_app_fill_menu_with_data ()

void
gnome_app_fill_menu_with_data (GtkMenuShell *menu_shell,
                               GnomeUIInfo *uiinfo,
                               GtkAccelGroup *accel_group,
                               gboolean uline_accels,
                               gint pos,
                               gpointer user_data);

This is the same as gnome_app_fill_menu(), except that all the user data pointers are filled with the value of user_data .

Parameters

menu_shell

A GtkMenuShell instance (a menu bar).

 

uiinfo

A pointer to the first element in an array of GnomeUIInfo structures. The last element of the array should have a type of GNOME_APP_UI_ENDOFINFO.

 

accel_group

A GtkAccelGroup.

 

uline_accels

TRUE if underline accelerators will be drawn for the menu item labels.

 

pos

The position in the menu bar at which to start inserting items.

 

user_data

Some application-specific data.

 

gnome_app_fill_menu_custom ()

void
gnome_app_fill_menu_custom (GtkMenuShell *menu_shell,
                            GnomeUIInfo *uiinfo,
                            GnomeUIBuilderData *uibdata,
                            GtkAccelGroup *accel_group,
                            gboolean uline_accels,
                            gint pos);

Fills the specified menu shell with items created from the specified uiinfo , inserting them from item number pos on and using the specified builder data (uibdata ) -- this is intended for language bindings.

The other parameters have the same meaning as in gnome_app_fill_menu().

Parameters

menu_shell

A GtkMenuShell instance (a menu bar).

 

uiinfo

A pointer to the first element in an array of GnomeUIInfo structures. The last element of the array should have a type of GNOME_APP_UI_ENDOFINFO.

 

uibdata

A GnomeUIInfoBuilderData instance.

 

accel_group

A GtkAccelGroup.

 

uline_accels

TRUE if underline accelerators will be drawn for the menu item labels.

 

pos

The position in the menu bar at which to start inserting items.

 

gnome_app_ui_configure_configurable ()

void
gnome_app_ui_configure_configurable (GnomeUIInfo *uiinfo);

Configure all user-configurable elements in the given UI info structure. This includes loading and setting previously-set options from GNOME config files.

Normally, gnome_app_create_menus() calls this function for the developer, but if something needs to be altered afterwards, this function can be called first. The main reason for this function being a public interface is so that it can be called from gnome_popup_menu_new(), which clears a copy of the pass in GnomeUIInfo structures.

Parameters

uiinfo

Pointer to GNOME UI menu/toolbar info

 

gnome_app_create_menus ()

void
gnome_app_create_menus (GnomeApp *app,
                        GnomeUIInfo *uiinfo);

Constructs a menu bar and attaches it to the specified application window.

Parameters

app

A GnomeApp instance representing the current application.

 

uiinfo

The first in an array GnomeUIInfo instances containing the menu data.

 

gnome_app_create_menus_interp ()

void
gnome_app_create_menus_interp (GnomeApp *app,
                               GnomeUIInfo *uiinfo,
                               GtkCallbackMarshal relay_func,
                               gpointer data,
                               GDestroyNotify destroy_func);

Identical to gnome_app_create_menus(), except that extra functions and data can be passed in for finer control of the destruction and marshalling.

Parameters

app

A GnomeApp instance, representing the current application.

 

uiinfo

The first item in an array of GnomeUIInfo structures describing the menu bar.

 

relay_func

A marshaller for the signal callbacks.

 

data

Application specific data passed to the signal callback functions.

 

destroy_func

The function to call when the menu bar is destroyed.

 

gnome_app_create_menus_with_data ()

void
gnome_app_create_menus_with_data (GnomeApp *app,
                                  GnomeUIInfo *uiinfo,
                                  gpointer user_data);

Identical to gnome_app_create_menus(), except that user_data is passed to all the callback functions when signals are emitted.

Parameters

app

A GnomeApp instance representing the current application.

 

uiinfo

The first in an array GnomeUIInfo instances containing the menu data.

 

user_data

Application-specific data that is passed to every callback function.

 

gnome_app_create_menus_custom ()

void
gnome_app_create_menus_custom (GnomeApp *app,
                               GnomeUIInfo *uiinfo,
                               GnomeUIBuilderData *uibdata);

Identical to gnome_app_create_menus(), except that uibdata is also specified for creating the signal handlers. Mostly for use by language bindings.

Parameters

app

A GnomeApp instance representing the current application.

 

uiinfo

The first in an array GnomeUIInfo instances containing the menu data.

 

uibdata

An appropriate GnomeUIBuilderData instance.

 

gnome_app_fill_toolbar ()

void
gnome_app_fill_toolbar (GtkToolbar *toolbar,
                        GnomeUIInfo *uiinfo,
                        GtkAccelGroup *accel_group);

Fills toolbar with buttons specified in uiinfo . If accel_group is not NULL, the items' accelrator keys are put into it.

Parameters

toolbar

A GtkToolbar instance.

 

uiinfo

An array of GnomeUIInfo structures containing the items for the toolbar.

 

accel_group

A GtkAccelGroup for holding the accelerator keys of the items (or NULL).

 

gnome_app_fill_toolbar_with_data ()

void
gnome_app_fill_toolbar_with_data (GtkToolbar *toolbar,
                                  GnomeUIInfo *uiinfo,
                                  GtkAccelGroup *accel_group,
                                  gpointer user_data);

The same as gnome_app_fill_toolbar(), except that the user data pointers in the signal handlers are set to user_data .

Parameters

toolbar

A GtkToolbar instance.

 

uiinfo

An array of GnomeUIInfo structures containing the items for the toolbar.

 

accel_group

A GtkAccelGroup for holding the accelerator keys of the items (or NULL).

 

user_data

Application specific data.

 

gnome_app_fill_toolbar_custom ()

void
gnome_app_fill_toolbar_custom (GtkToolbar *toolbar,
                               GnomeUIInfo *uiinfo,
                               GnomeUIBuilderData *uibdata,
                               GtkAccelGroup *accel_group);

The same as gnome_app_fill_toolbar(), except that the sepcified uibdata instance is used. This is mostly for the benefit of language bindings.

Parameters

toolbar

A GtkToolbar instance.

 

uiinfo

An array of GnomeUIInfo structures containing the items for the toolbar.

 

uibdata

The GnomeUIBuilderData data for the toolbar.

 

accel_group

A GtkAccelGroup for holding the accelerator keys of the items (or NULL).

 

gnome_app_create_toolbar ()

void
gnome_app_create_toolbar (GnomeApp *app,
                          GnomeUIInfo *uiinfo);

Constructs a toolbar and attaches it to the specified application window.

Parameters

app

A GnomeApp instance.

 

uiinfo

A GnomeUIInfo array specifying the contents of the toolbar.

 

gnome_app_create_toolbar_interp ()

void
gnome_app_create_toolbar_interp (GnomeApp *app,
                                 GnomeUIInfo *uiinfo,
                                 GtkCallbackMarshal relay_func,
                                 gpointer data,
                                 GDestroyNotify destroy_func);

Constructs a toolbar and attaches it to the specified application window -- this version is intended for language bindings.

Parameters

app

A GnomeApp instance.

 

uiinfo

A GnomeUIInfo array specifying the contents of the toolbar.

 

relay_func

Argument marshalling function.

 

data

Application specific data to pass to signal callbacks.

 

destroy_func

The function to call when the toolbar is destroyed.

 

gnome_app_create_toolbar_with_data ()

void
gnome_app_create_toolbar_with_data (GnomeApp *app,
                                    GnomeUIInfo *uiinfo,
                                    gpointer user_data);

Constructs a toolbar, sets all the user data pointers to user_data , and attaches it to app .

Parameters

app

A GnomeApp instance.

 

uiinfo

A GnomeUIInfo array specifying the contents of the toolbar.

 

user_data

Application specific data to be sent to each signal callback function.

 

gnome_app_create_toolbar_custom ()

void
gnome_app_create_toolbar_custom (GnomeApp *app,
                                 GnomeUIInfo *uiinfo,
                                 GnomeUIBuilderData *uibdata);

Constructs a toolbar and attaches it to the app window, using uibdata builder data -- intended for language bindings.

Parameters

app

A GnomeApp instance.

 

uiinfo

A GnomeUIInfo array specifying the contents of the toolbar.

 

uibdata

A GnomeUIBuilderData instance specifying the handlers to use for the toolbar.

 

gnome_app_find_menu_pos ()

GtkWidget *
gnome_app_find_menu_pos (GtkWidget *parent,
                         const gchar *path,
                         gint *pos);

Finds a menu item described by path starting in the GtkMenuShell top and returns its parent GtkMenuShell and the position after this item in pos . The meaning of pos is that a subsequent call to gtk_menu_shell_insert(p, w, pos) would then insert widget w in GtkMenuShell p right after the menu item described by path.

Parameters

parent

Root menu shell widget containing menu items to be searched.

 

path

Specifies the target menu item by menu path.

 

pos

Used to hold the returned menu items' position.

 

Returns

The parent menu shell of path .


gnome_app_remove_menus ()

void
gnome_app_remove_menus (GnomeApp *app,
                        const gchar *path,
                        gint items);

Removes items items from the existing app 's menu structure, beginning with item described by path .

The path argument should be in the form "File/.../.../Something". "" will insert the item as the first one in the menubar, "File/" will insert it as the first one in the File menu, "File/Settings" will insert it after the Setting item in the File menu use of "File/<Separator>" should be obvious. However, the use of "<Separator>" stops after the first separator.

Parameters

app

A GnomeApp instance.

 

path

A path to the menu item concerned.

 

items

The number of items to remove.

 

gnome_app_remove_menu_range ()

void
gnome_app_remove_menu_range (GnomeApp *app,
                             const gchar *path,
                             gint start,
                             gint items);

Same as the gnome_app_remove_menus(), except it removes the specified number of items from the existing app 's menu structure begining with item described by (path plus start ). This is very useful for adding and removing Recent document items in the File menu.

Parameters

app

A GnomeApp instance.

 

path

A path to the menu item concerned.

 

start

An offset beyond the start of path at which to begin removing.

 

items

The number of items to remove.

 

gnome_app_insert_menus_custom ()

void
gnome_app_insert_menus_custom (GnomeApp *app,
                               const gchar *path,
                               GnomeUIInfo *uiinfo,
                               GnomeUIBuilderData *uibdata);

Inserts menus described by uiinfo in existing app 's menu structure right after the item described by path . The uibdata parameter makes this, again, most useful for language bindings.

Parameters

app

A GnomeApp instance.

 

path

A path to the menu item concerned.

 

uiinfo

A GnomeUIInfo array describing the menus.

 

uibdata

A GnomeUIBuilderData instance describing the functions to attach as the menu's callbacks.

 

gnome_app_insert_menus ()

void
gnome_app_insert_menus (GnomeApp *app,
                        const gchar *path,
                        GnomeUIInfo *menuinfo);

Insert the menus given by menuinfo beginning at path into the pre-existing app .

Parameters

app

A GnomeApp instance.

 

path

A path to the menu item concerned.

 

menuinfo

A GnomeUIInfo array describing the menus.

 

gnome_app_insert_menus_with_data ()

void
gnome_app_insert_menus_with_data (GnomeApp *app,
                                  const gchar *path,
                                  GnomeUIInfo *menuinfo,
                                  gpointer data);

This is the same as gnome_app_insert_menus(), except that the specified data is passed to each signal callback.

Parameters

app

A GnomeApp instance.

 

path

A path to the menu item concerned.

 

menuinfo

A GnomeUIInfo array describing the menus.

 

data

Application specific data to send to each signal callback.

 

gnome_app_insert_menus_interp ()

void
gnome_app_insert_menus_interp (GnomeApp *app,
                               const gchar *path,
                               GnomeUIInfo *menuinfo,
                               GtkCallbackMarshal relay_func,
                               gpointer data,
                               GDestroyNotify destroy_func);

THe same as gnome_app_insert_menus(), except that the given functions are attached to each menu item. Mostly of use for language bindings.

Parameters

app

A GnomeApp instance.

 

path

A path to the menu item concerned.

 

menuinfo

A GnomeUIInfo array describing the menus.

 

relay_func

A custom marshallar for signal data.,

 

data

Application-specific data to send to each signal callback.

 

destroy_func

The function to call when the menu item is destroyed.

 

gnome_app_install_appbar_menu_hints ()

void
gnome_app_install_appbar_menu_hints (GnomeAppBar *appbar,
                                     GnomeUIInfo *uiinfo);

Install menu hints for the given appbar object. This function cannot just be called automatically, since it is impossible to reliably find the correct appbar .

Parameters

appbar

An existing GnomeAppBar instance.

 

uiinfo

A GnomeUIInfo array of a menu for which hints will be set.

 

gnome_app_install_statusbar_menu_hints ()

void
gnome_app_install_statusbar_menu_hints
                               (GtkStatusbar *bar,
                                GnomeUIInfo *uiinfo);

Install menu hints for the given status bar.

Parameters

bar

Pointer to GtkStatusbar instance.

 

uiinfo

GnomeUIInfo for the menu to be changed.

 

gnome_app_install_menu_hints ()

void
gnome_app_install_menu_hints (GnomeApp *app,
                              GnomeUIInfo *uiinfo);

Set menu hints for the app object's attached status bar.

Parameters

app

An existing GnomeAppBar instance.

 

uiinfo

A GnomeUIInfo array of a menu for which hints will be set.

 

gnome_app_setup_toolbar ()

void
gnome_app_setup_toolbar (GtkToolbar *toolbar,
                         BonoboDockItem *dock_item);

Sets up a toolbar to use GNOME user preferences.

Parameters

toolbar

Pointer to a GtkToolbar instance.

 

dock_item

Pointer to the BonoboDockItem the toolbar is inside, or NULL for none.

 

GNOMEUIINFO_ITEM()

#define             GNOMEUIINFO_ITEM(label, tooltip, callback, xpm_data)

GNOMEUIINFO_ITEM_STOCK()

#define             GNOMEUIINFO_ITEM_STOCK(label, tooltip, callback, stock_id)

GNOMEUIINFO_ITEM_NONE()

#define             GNOMEUIINFO_ITEM_NONE(label, tooltip, callback)

GNOMEUIINFO_ITEM_DATA()

#define             GNOMEUIINFO_ITEM_DATA(label, tooltip, callback, user_data, xpm_data)

GNOMEUIINFO_TOGGLEITEM()

#define             GNOMEUIINFO_TOGGLEITEM(label, tooltip, callback, xpm_data)

GNOMEUIINFO_TOGGLEITEM_DATA()

#define             GNOMEUIINFO_TOGGLEITEM_DATA(label, tooltip, callback, user_data, xpm_data)

GNOMEUIINFO_HELP()

#define             GNOMEUIINFO_HELP(app_name)

GNOMEUIINFO_SUBTREE()

#define             GNOMEUIINFO_SUBTREE(label, tree)

GNOMEUIINFO_SUBTREE_HINT()

#define             GNOMEUIINFO_SUBTREE_HINT(label, hint, tree)

GNOMEUIINFO_SUBTREE_STOCK()

#define             GNOMEUIINFO_SUBTREE_STOCK(label, tree, stock_id)

GNOMEUIINFO_INCLUDE()

#define             GNOMEUIINFO_INCLUDE(tree)

GNOMEUIINFO_RADIOLIST()

#define             GNOMEUIINFO_RADIOLIST(list)

GNOMEUIINFO_RADIOITEM()

#define             GNOMEUIINFO_RADIOITEM(label, tooltip, callback, xpm_data)

GNOMEUIINFO_RADIOITEM_DATA()

#define             GNOMEUIINFO_RADIOITEM_DATA(label, tooltip, callback, user_data, xpm_data)

GNOMEUIINFO_MENU_NEW_ITEM()

#define             GNOMEUIINFO_MENU_NEW_ITEM(label, tip, cb, data)

GNOMEUIINFO_MENU_NEW_SUBTREE()

#define             GNOMEUIINFO_MENU_NEW_SUBTREE(tree)

GNOMEUIINFO_MENU_OPEN_ITEM()

#define             GNOMEUIINFO_MENU_OPEN_ITEM(cb, data)

GNOMEUIINFO_MENU_SAVE_ITEM()

#define             GNOMEUIINFO_MENU_SAVE_ITEM(cb, data)

GNOMEUIINFO_MENU_SAVE_AS_ITEM()

#define             GNOMEUIINFO_MENU_SAVE_AS_ITEM(cb, data)

GNOMEUIINFO_MENU_REVERT_ITEM()

#define             GNOMEUIINFO_MENU_REVERT_ITEM(cb, data)

GNOMEUIINFO_MENU_PRINT_ITEM()

#define             GNOMEUIINFO_MENU_PRINT_ITEM(cb, data)

GNOMEUIINFO_MENU_PRINT_SETUP_ITEM()

#define             GNOMEUIINFO_MENU_PRINT_SETUP_ITEM(cb, data)

GNOMEUIINFO_MENU_CLOSE_ITEM()

#define             GNOMEUIINFO_MENU_CLOSE_ITEM(cb, data)

GNOMEUIINFO_MENU_EXIT_ITEM()

#define GNOMEUIINFO_MENU_EXIT_ITEM(cb, data) GNOMEUIINFO_MENU_QUIT_ITEM(cb, data)

GNOMEUIINFO_MENU_QUIT_ITEM()

#define             GNOMEUIINFO_MENU_QUIT_ITEM(cb, data)

GNOMEUIINFO_MENU_CUT_ITEM()

#define             GNOMEUIINFO_MENU_CUT_ITEM(cb, data)

GNOMEUIINFO_MENU_COPY_ITEM()

#define             GNOMEUIINFO_MENU_COPY_ITEM(cb, data)

GNOMEUIINFO_MENU_PASTE_ITEM()

#define             GNOMEUIINFO_MENU_PASTE_ITEM(cb, data)

GNOMEUIINFO_MENU_SELECT_ALL_ITEM()

#define             GNOMEUIINFO_MENU_SELECT_ALL_ITEM(cb, data)

GNOMEUIINFO_MENU_CLEAR_ITEM()

#define             GNOMEUIINFO_MENU_CLEAR_ITEM(cb, data)

GNOMEUIINFO_MENU_UNDO_ITEM()

#define             GNOMEUIINFO_MENU_UNDO_ITEM(cb, data)

GNOMEUIINFO_MENU_REDO_ITEM()

#define             GNOMEUIINFO_MENU_REDO_ITEM(cb, data)

GNOMEUIINFO_MENU_FIND_ITEM()

#define             GNOMEUIINFO_MENU_FIND_ITEM(cb, data)

GNOMEUIINFO_MENU_FIND_AGAIN_ITEM()

#define             GNOMEUIINFO_MENU_FIND_AGAIN_ITEM(cb, data)

GNOMEUIINFO_MENU_REPLACE_ITEM()

#define             GNOMEUIINFO_MENU_REPLACE_ITEM(cb, data)

GNOMEUIINFO_MENU_PROPERTIES_ITEM()

#define             GNOMEUIINFO_MENU_PROPERTIES_ITEM(cb, data)

GNOMEUIINFO_MENU_PREFERENCES_ITEM()

#define             GNOMEUIINFO_MENU_PREFERENCES_ITEM(cb, data)

GNOMEUIINFO_MENU_NEW_WINDOW_ITEM()

#define             GNOMEUIINFO_MENU_NEW_WINDOW_ITEM(cb, data)

GNOMEUIINFO_MENU_CLOSE_WINDOW_ITEM()

#define             GNOMEUIINFO_MENU_CLOSE_WINDOW_ITEM(cb, data)

GNOMEUIINFO_MENU_ABOUT_ITEM()

#define             GNOMEUIINFO_MENU_ABOUT_ITEM(cb, data)

GNOMEUIINFO_MENU_NEW_GAME_ITEM()

#define             GNOMEUIINFO_MENU_NEW_GAME_ITEM(cb, data)

GNOMEUIINFO_MENU_PAUSE_GAME_ITEM()

#define             GNOMEUIINFO_MENU_PAUSE_GAME_ITEM(cb, data)

GNOMEUIINFO_MENU_RESTART_GAME_ITEM()

#define             GNOMEUIINFO_MENU_RESTART_GAME_ITEM(cb, data)

GNOMEUIINFO_MENU_UNDO_MOVE_ITEM()

#define             GNOMEUIINFO_MENU_UNDO_MOVE_ITEM(cb, data)

GNOMEUIINFO_MENU_REDO_MOVE_ITEM()

#define             GNOMEUIINFO_MENU_REDO_MOVE_ITEM(cb, data)

GNOMEUIINFO_MENU_HINT_ITEM()

#define             GNOMEUIINFO_MENU_HINT_ITEM(cb, data)

GNOMEUIINFO_MENU_SCORES_ITEM()

#define             GNOMEUIINFO_MENU_SCORES_ITEM(cb, data)

GNOMEUIINFO_MENU_END_GAME_ITEM()

#define             GNOMEUIINFO_MENU_END_GAME_ITEM(cb, data)

GNOMEUIINFO_MENU_FILE_TREE()

#define             GNOMEUIINFO_MENU_FILE_TREE(tree)

GNOMEUIINFO_MENU_EDIT_TREE()

#define             GNOMEUIINFO_MENU_EDIT_TREE(tree)

GNOMEUIINFO_MENU_VIEW_TREE()

#define             GNOMEUIINFO_MENU_VIEW_TREE(tree)

GNOMEUIINFO_MENU_SETTINGS_TREE()

#define             GNOMEUIINFO_MENU_SETTINGS_TREE(tree)

GNOMEUIINFO_MENU_FILES_TREE()

#define             GNOMEUIINFO_MENU_FILES_TREE(tree)

GNOMEUIINFO_MENU_WINDOWS_TREE()

#define             GNOMEUIINFO_MENU_WINDOWS_TREE(tree)

GNOMEUIINFO_MENU_HELP_TREE()

#define             GNOMEUIINFO_MENU_HELP_TREE(tree)

GNOMEUIINFO_MENU_GAME_TREE()

#define             GNOMEUIINFO_MENU_GAME_TREE(tree)

gnome_app_helper_gettext ()

const gchar *
gnome_app_helper_gettext (const gchar *string);

L_()

#define L_(x) gnome_app_helper_gettext(x)

D_()

#define D_(x) dgettext (GETTEXT_PACKAGE, x)

Types and Values

enum GnomeUIInfoType

These values identify the item type that a particular GnomeUIInfo structure specifies.

One should be careful when using gnome_app_create_[custom|interp|with_data] functions with GnomeUIInfo arrays containing GNOME_APP_UI_BUILDER_DATA items, since their GnomeUIBuilderData structures completely override the ones generated or supplied by the above functions.

Members

GNOME_APP_UI_ENDOFINFO

No more items, use it at the end of an array.

 

GNOME_APP_UI_ITEM

Normal item, or radio item if it is inside a radioitems group.

 

GNOME_APP_UI_TOGGLEITEM

Toggle (check box) item.

 

GNOME_APP_UI_RADIOITEMS

Radio item group.

 

GNOME_APP_UI_SUBTREE

Item that defines a subtree/submenu.

 

GNOME_APP_UI_SEPARATOR

Separator line (menus) or blank space (toolbars).

 

GNOME_APP_UI_HELP

Create a list of help topics, used in the Help menu.

 

GNOME_APP_UI_BUILDER_DATA

Specifies the builder data for the following entries, see code for further info.

 

GNOME_APP_UI_ITEM_CONFIGURABLE

A configurable menu item.

 

GNOME_APP_UI_SUBTREE_STOCK

Item that defines a subtree/submenu, same as GNOME_APP_UI_SUBTREE, but the texts should be looked up in the libgnome catalog.

 

GNOME_APP_UI_INCLUDE

Almost like GNOME_APP_UI_SUBTREE , but inserts items into the current menu or whatever, instead of making a submenu.

 

enum GnomeUIInfoConfigurableTypes

A user can redefine the accelerator keys for each menu item (if the application supports this). This enum gives an identifier for each menu shortcut that can possible be redefined. If an application is not using one of these accelerators, then no shortcut redefinition is possible unless the application specifically implements it (moral: use standard menu items).

Members

GNOME_APP_CONFIGURABLE_ITEM_NEW

The "New" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_OPEN

The "Open" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_SAVE

The "Save" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_SAVE_AS

The "Save as..." menu.

 

GNOME_APP_CONFIGURABLE_ITEM_REVERT

The "Revert" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_PRINT

The "Print" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_PRINT_SETUP

The "Print setup..." menu.

 

GNOME_APP_CONFIGURABLE_ITEM_CLOSE

The "Close" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_QUIT

The "Quit" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_CUT

The "Cut" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_COPY

The "Copy" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_PASTE

The "Paste" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_CLEAR

The "Clear" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_UNDO

The "Undo" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_REDO

The "Redo" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_FIND

The "Find..." menu.

 

GNOME_APP_CONFIGURABLE_ITEM_FIND_AGAIN

The "Find again" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_REPLACE

The "Replace..." menu.

 

GNOME_APP_CONFIGURABLE_ITEM_PROPERTIES

The "Properties..." menu.

 

GNOME_APP_CONFIGURABLE_ITEM_PREFERENCES

The "Preferences..." menu.

 

GNOME_APP_CONFIGURABLE_ITEM_ABOUT

The "About..." menu.

 

GNOME_APP_CONFIGURABLE_ITEM_SELECT_ALL

The "Select all" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_NEW_WINDOW

The "New window" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_CLOSE_WINDOW

The "Close window" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_NEW_GAME

The "New game" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_PAUSE_GAME

The "Pause game" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_RESTART_GAME

The "Restart game" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_UNDO_MOVE

The "Undo move" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_REDO_MOVE

The "Redo move" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_HINT

The "Hint" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_SCORES

The "Scores..." menu.

 

GNOME_APP_CONFIGURABLE_ITEM_END_GAME

The "End game" menu.

 

GNOME_APP_CONFIGURABLE_ITEM_EXIT

#define GNOME_APP_CONFIGURABLE_ITEM_EXIT GNOME_APP_CONFIGURABLE_ITEM_QUIT

enum GnomeUIPixmapType

These values identify the type of pixmap used in an item.

Members

GNOME_APP_PIXMAP_NONE

No pixmap specified.

 

GNOME_APP_PIXMAP_STOCK

Use a stock pixmap (GnomeStock).

 

GNOME_APP_PIXMAP_DATA

Use a pixmap from inline xpm data.

 

GNOME_APP_PIXMAP_FILENAME

Use a pixmap from the specified filename.

 

GnomeUIInfo

typedef struct {
	GnomeUIInfoType type;		/* Type of item */
	gchar const *label;		/* String to use in item's label */
	gchar const *hint;		/* Tooltip for toolbar items, status 
					   bar message for menu items. */
	gpointer moreinfo;		/* Extra information; depends on the
					   type. */
	gpointer user_data;		/* User data sent to the callback. */
	gpointer unused_data;		/* Should be NULL (reserved). */
	GnomeUIPixmapType pixmap_type; /* Type of pixmap for this item. */
	gconstpointer pixmap_info; /* Pointer to pixmap information. */
	guint accelerator_key;		/* Accelerator key, or 0 for none. */
	GdkModifierType ac_mods; /* Mask of modifier keys for the 
					   accelerator. */
	GtkWidget *widget;		/* Filled in by the gnome_app_create* 
					   functions. */
} GnomeUIInfo;

struct GnomeUIBuilderData

struct GnomeUIBuilderData {
	GnomeUISignalConnectFunc connect_func;
	gpointer data;
	gboolean is_interp;
	GtkCallbackMarshal relay_func;
	GDestroyNotify destroy_func;
};

This structure defines how the relevant menu items are to have their signals connected. This includes the activations signals, as well as the destroy notifications. The affected menu items are either the items following aA GNOME_APP_UI_BUILDER_DATA item in an array of GnomeUIInfo structures or all of the menu items that are connected as a result of a call to gnome_app_create_menu_custom() and similar functions.

Members

GnomeUISignalConnectFunc connect_func;

Function that connects to the item's signals.

 

gpointer data;

User data pointer for the signal callback.

 

gboolean is_interp;

If TRUE, the signal should be connected with g_signal_connect_closure_by_id(), otherwise, g_signal_connect() is used.

 

GtkCallbackMarshal relay_func;

Marshaller function for language bindings.

 

GDestroyNotify destroy_func;

Destroy notification function for language bindings.

 

GNOMEUIINFO_KEY_UIDATA

#define GNOMEUIINFO_KEY_UIDATA		"uidata"

GNOMEUIINFO_KEY_UIBDATA

#define GNOMEUIINFO_KEY_UIBDATA		"uibdata"

GNOMEUIINFO_END

#define             GNOMEUIINFO_END

GNOMEUIINFO_SEPARATOR

#define             GNOMEUIINFO_SEPARATOR

GNOME_MENU_FILE_STRING

#define GNOME_MENU_FILE_STRING D_("_File")

GNOME_MENU_FILE_PATH

#define GNOME_MENU_FILE_PATH D_("_File/")

GNOME_MENU_EDIT_STRING

#define GNOME_MENU_EDIT_STRING D_("_Edit")

GNOME_MENU_EDIT_PATH

#define GNOME_MENU_EDIT_PATH D_("_Edit/")

GNOME_MENU_VIEW_STRING

#define GNOME_MENU_VIEW_STRING D_("_View")

GNOME_MENU_VIEW_PATH

#define GNOME_MENU_VIEW_PATH D_("_View/")

GNOME_MENU_SETTINGS_STRING

#define GNOME_MENU_SETTINGS_STRING D_("_Settings")

GNOME_MENU_SETTINGS_PATH

#define GNOME_MENU_SETTINGS_PATH D_("_Settings/")

GNOME_MENU_NEW_STRING

#define GNOME_MENU_NEW_STRING D_("_New")

GNOME_MENU_NEW_PATH

#define GNOME_MENU_NEW_PATH D_("_New/")

GNOME_MENU_FILES_STRING

#define GNOME_MENU_FILES_STRING D_("Fi_les")

GNOME_MENU_FILES_PATH

#define GNOME_MENU_FILES_PATH D_("Fi_les/")

GNOME_MENU_WINDOWS_STRING

#define GNOME_MENU_WINDOWS_STRING D_("_Windows")

GNOME_MENU_WINDOWS_PATH

#define GNOME_MENU_WINDOWS_PATH D_("_Windows/")