GNOME UI Library Reference Manual | |||
---|---|---|---|
<<< Previous Page | Home | Up | Next Page >>> |
enum GnomeUIInfoType; enum GnomeUIInfoConfigurableTypes; enum GnomeUIPixmapType; typedef GnomeUIInfo; #define GNOMEUIINFO_KEY_UIDATA #define GNOMEUIINFO_KEY_UIBDATA #define GNOMEUIINFO_END #define GNOMEUIINFO_SEPARATOR #define GNOMEUIINFO_ITEM (label, tooltip, callback, xpm_data) #define GNOMEUIINFO_ITEM_STOCK (label, tooltip, callback, stock_id) #define GNOMEUIINFO_ITEM_NONE (label, tooltip, callback) #define GNOMEUIINFO_ITEM_DATA (label, tooltip, callback, user_data, xpm_data) #define GNOMEUIINFO_TOGGLEITEM (label, tooltip, callback, xpm_data) #define GNOMEUIINFO_TOGGLEITEM_DATA (label, tooltip, callback, user_data, xpm_data) #define GNOMEUIINFO_HELP (app_name) #define GNOMEUIINFO_SUBTREE (label, tree) #define GNOMEUIINFO_SUBTREE_HINT (label, hint, tree) #define GNOMEUIINFO_SUBTREE_STOCK (label, tree, stock_id) #define GNOMEUIINFO_INCLUDE (tree) #define GNOMEUIINFO_RADIOLIST (list) #define GNOMEUIINFO_RADIOITEM (label, tooltip, callback, xpm_data) #define GNOMEUIINFO_RADIOITEM_DATA (label, tooltip, callback, user_data, xpm_data) #define GNOMEUIINFO_MENU_NEW_ITEM (label, tip, cb, data) #define GNOMEUIINFO_MENU_NEW_SUBTREE (tree) #define GNOMEUIINFO_MENU_OPEN_ITEM (cb, data) #define GNOMEUIINFO_MENU_SAVE_ITEM (cb, data) #define GNOMEUIINFO_MENU_SAVE_AS_ITEM (cb, data) #define GNOMEUIINFO_MENU_REVERT_ITEM (cb, data) #define GNOMEUIINFO_MENU_PRINT_ITEM (cb, data) #define GNOMEUIINFO_MENU_PRINT_SETUP_ITEM(cb, data) #define GNOMEUIINFO_MENU_CLOSE_ITEM (cb, data) #define GNOMEUIINFO_MENU_EXIT_ITEM (cb, data) #define GNOMEUIINFO_MENU_CUT_ITEM (cb, data) #define GNOMEUIINFO_MENU_COPY_ITEM (cb, data) #define GNOMEUIINFO_MENU_PASTE_ITEM (cb, data) #define GNOMEUIINFO_MENU_SELECT_ALL_ITEM(cb, data) #define GNOMEUIINFO_MENU_CLEAR_ITEM (cb, data) #define GNOMEUIINFO_MENU_UNDO_ITEM (cb, data) #define GNOMEUIINFO_MENU_REDO_ITEM (cb, data) #define GNOMEUIINFO_MENU_FIND_ITEM (cb, data) #define GNOMEUIINFO_MENU_FIND_AGAIN_ITEM(cb, data) #define GNOMEUIINFO_MENU_REPLACE_ITEM (cb, data) #define GNOMEUIINFO_MENU_PROPERTIES_ITEM(cb, data) #define GNOMEUIINFO_MENU_PREFERENCES_ITEM(cb, data) #define GNOMEUIINFO_MENU_NEW_WINDOW_ITEM(cb, data) #define GNOMEUIINFO_MENU_CLOSE_WINDOW_ITEM(cb, data) #define GNOMEUIINFO_MENU_ABOUT_ITEM (cb, data) #define GNOMEUIINFO_MENU_NEW_GAME_ITEM (cb, data) #define GNOMEUIINFO_MENU_PAUSE_GAME_ITEM(cb, data) #define GNOMEUIINFO_MENU_RESTART_GAME_ITEM(cb, data) #define GNOMEUIINFO_MENU_UNDO_MOVE_ITEM (cb, data) #define GNOMEUIINFO_MENU_REDO_MOVE_ITEM (cb, data) #define GNOMEUIINFO_MENU_HINT_ITEM (cb, data) #define GNOMEUIINFO_MENU_SCORES_ITEM (cb, data) #define GNOMEUIINFO_MENU_END_GAME_ITEM (cb, data) const gchar* gnome_app_helper_gettext (const gchar *string); #define D_ (x) #define L_ (x) #define GNOMEUIINFO_MENU_FILE_TREE (tree) #define GNOMEUIINFO_MENU_EDIT_TREE (tree) #define GNOMEUIINFO_MENU_VIEW_TREE (tree) #define GNOMEUIINFO_MENU_SETTINGS_TREE (tree) #define GNOMEUIINFO_MENU_FILES_TREE (tree) #define GNOMEUIINFO_MENU_WINDOWS_TREE (tree) #define GNOMEUIINFO_MENU_HELP_TREE (tree) #define GNOMEUIINFO_MENU_GAME_TREE (tree) #define GNOME_MENU_FILE_STRING #define GNOME_MENU_FILE_PATH #define GNOME_MENU_EDIT_STRING #define GNOME_MENU_EDIT_PATH #define GNOME_MENU_VIEW_STRING #define GNOME_MENU_VIEW_PATH #define GNOME_MENU_SETTINGS_STRING #define GNOME_MENU_SETTINGS_PATH #define GNOME_MENU_NEW_STRING #define GNOME_MENU_NEW_PATH #define GNOME_MENU_FILES_STRING #define GNOME_MENU_FILES_PATH #define GNOME_MENU_WINDOWS_STRING #define GNOME_MENU_WINDOWS_PATH struct GnomeUIBuilderData; void (*GnomeUISignalConnectFunc) (GnomeUIInfo *uiinfo, const char *signal_name, GnomeUIBuilderData *uibdata); void gnome_accelerators_sync (void); void gnome_app_fill_menu (GtkMenuShell *menu_shell, GnomeUIInfo *uiinfo, GtkAccelGroup *accel_group, gboolean uline_accels, gint pos); void gnome_app_fill_menu_with_data (GtkMenuShell *menu_shell, GnomeUIInfo *uiinfo, GtkAccelGroup *accel_group, gboolean uline_accels, gint pos, gpointer user_data); void gnome_app_fill_menu_custom (GtkMenuShell *menu_shell, GnomeUIInfo *uiinfo, GnomeUIBuilderData *uibdata, GtkAccelGroup *accel_group, gboolean uline_accels, gint pos); void gnome_app_ui_configure_configurable (GnomeUIInfo *uiinfo); void gnome_app_create_menus (GnomeApp *app, GnomeUIInfo *uiinfo); void gnome_app_create_menus_interp (GnomeApp *app, GnomeUIInfo *uiinfo, GtkCallbackMarshal relay_func, gpointer data, GtkDestroyNotify destroy_func); void gnome_app_create_menus_with_data (GnomeApp *app, GnomeUIInfo *uiinfo, gpointer user_data); void gnome_app_create_menus_custom (GnomeApp *app, GnomeUIInfo *uiinfo, GnomeUIBuilderData *uibdata); void gnome_app_fill_toolbar (GtkToolbar *toolbar, GnomeUIInfo *uiinfo, GtkAccelGroup *accel_group); void gnome_app_fill_toolbar_with_data (GtkToolbar *toolbar, GnomeUIInfo *uiinfo, GtkAccelGroup *accel_group, gpointer user_data); void gnome_app_fill_toolbar_custom (GtkToolbar *toolbar, GnomeUIInfo *uiinfo, GnomeUIBuilderData *uibdata, GtkAccelGroup *accel_group); void gnome_app_create_toolbar (GnomeApp *app, GnomeUIInfo *uiinfo); void gnome_app_create_toolbar_interp (GnomeApp *app, GnomeUIInfo *uiinfo, GtkCallbackMarshal relay_func, gpointer data, GtkDestroyNotify destroy_func); void gnome_app_create_toolbar_with_data (GnomeApp *app, GnomeUIInfo *uiinfo, gpointer user_data); void gnome_app_create_toolbar_custom (GnomeApp *app, GnomeUIInfo *uiinfo, GnomeUIBuilderData *uibdata); GtkWidget* gnome_app_find_menu_pos (GtkWidget *parent, const gchar *path, gint *pos); void gnome_app_remove_menus (GnomeApp *app, const gchar *path, gint items); void gnome_app_remove_menu_range (GnomeApp *app, const gchar *path, gint start, gint items); void gnome_app_insert_menus_custom (GnomeApp *app, const gchar *path, GnomeUIInfo *menuinfo, GnomeUIBuilderData *uibdata); void gnome_app_insert_menus (GnomeApp *app, const gchar *path, GnomeUIInfo *menuinfo); void gnome_app_insert_menus_with_data (GnomeApp *app, const gchar *path, GnomeUIInfo *menuinfo, gpointer data); void gnome_app_insert_menus_interp (GnomeApp *app, const gchar *path, GnomeUIInfo *menuinfo, GtkCallbackMarshal relay_func, gpointer data, GtkDestroyNotify destroy_func); void gnome_app_install_appbar_menu_hints (GnomeAppBar *appbar, GnomeUIInfo *uiinfo); void gnome_app_install_statusbar_menu_hints (GtkStatusbar *bar, GnomeUIInfo *uiinfo); void gnome_app_install_menu_hints (GnomeApp *app, GnomeUIInfo *uinfo); void gnome_app_setup_toolbar (GtkToolbar *toolbar, BonoboDockItem *dock_item); |
typedef enum { 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. */ /* 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. */ 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 gnome-libs catalog */ GNOME_APP_UI_INCLUDE /* almost like SUBTREE, but inserts items into the current menu/whatever. instead of making a submenu */ } GnomeUIInfoType; |
typedef enum { /* 0 */ GNOME_APP_CONFIGURABLE_ITEM_NEW, GNOME_APP_CONFIGURABLE_ITEM_OPEN, GNOME_APP_CONFIGURABLE_ITEM_SAVE, GNOME_APP_CONFIGURABLE_ITEM_SAVE_AS, GNOME_APP_CONFIGURABLE_ITEM_REVERT, GNOME_APP_CONFIGURABLE_ITEM_PRINT, GNOME_APP_CONFIGURABLE_ITEM_PRINT_SETUP, GNOME_APP_CONFIGURABLE_ITEM_CLOSE, GNOME_APP_CONFIGURABLE_ITEM_QUIT, GNOME_APP_CONFIGURABLE_ITEM_CUT, /* 10 */ GNOME_APP_CONFIGURABLE_ITEM_COPY, GNOME_APP_CONFIGURABLE_ITEM_PASTE, GNOME_APP_CONFIGURABLE_ITEM_CLEAR, GNOME_APP_CONFIGURABLE_ITEM_UNDO, GNOME_APP_CONFIGURABLE_ITEM_REDO, GNOME_APP_CONFIGURABLE_ITEM_FIND, GNOME_APP_CONFIGURABLE_ITEM_FIND_AGAIN, GNOME_APP_CONFIGURABLE_ITEM_REPLACE, GNOME_APP_CONFIGURABLE_ITEM_PROPERTIES, GNOME_APP_CONFIGURABLE_ITEM_PREFERENCES, /* 20 */ GNOME_APP_CONFIGURABLE_ITEM_ABOUT, GNOME_APP_CONFIGURABLE_ITEM_SELECT_ALL, GNOME_APP_CONFIGURABLE_ITEM_NEW_WINDOW, GNOME_APP_CONFIGURABLE_ITEM_CLOSE_WINDOW, GNOME_APP_CONFIGURABLE_ITEM_NEW_GAME, GNOME_APP_CONFIGURABLE_ITEM_PAUSE_GAME, GNOME_APP_CONFIGURABLE_ITEM_RESTART_GAME, GNOME_APP_CONFIGURABLE_ITEM_UNDO_MOVE, GNOME_APP_CONFIGURABLE_ITEM_REDO_MOVE, GNOME_APP_CONFIGURABLE_ITEM_HINT, /* 30 */ GNOME_APP_CONFIGURABLE_ITEM_SCORES, GNOME_APP_CONFIGURABLE_ITEM_END_GAME } GnomeUIInfoConfigurableTypes; |
typedef enum { 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 */ } GnomeUIPixmapType; |
typedef struct { GnomeUIInfoType type; /* Type of item */ gchar const *label; /* String to use in the label */ gchar const *hint; /* For toolbar items, the tooltip. For menu items, the status bar message */ gpointer moreinfo; /* For an item, toggleitem, or radioitem, this is a pointer to the function to call when the item is activated. For a subtree, a pointer to another array of GnomeUIInfo structures. For a radioitem lead entry, a pointer to an array of GnomeUIInfo structures for the radio item group. For a help item, specifies the help node to load (i.e. the application's identifier) or NULL for the main program's name. For builder data, points to the GnomeUIBuilderData structure for the following items */ gpointer user_data; /* Data pointer to pass to callbacks */ gpointer unused_data; /* Reserved for future expansion, should be NULL */ GnomeUIPixmapType pixmap_type; /* Type of pixmap for the item */ gconstpointer pixmap_info; /* Pointer to the pixmap information: * * For GNOME_APP_PIXMAP_STOCK, a * pointer to the stock icon name. * * For GNOME_APP_PIXMAP_DATA, a * pointer to the inline xpm data. * * For GNOME_APP_PIXMAP_FILENAME, a * pointer to the filename string. */ guint accelerator_key; /* Accelerator key, or 0 for none */ GdkModifierType ac_mods; /* Mask of modifier keys for the accelerator */ GtkWidget *widget; /* Filled in by gnome_app_create*, you can use this to tweak the widgets once they have been created */ } GnomeUIInfo; |
#define GNOMEUIINFO_TOGGLEITEM_DATA(label, tooltip, callback, user_data, xpm_data) |
#define GNOMEUIINFO_RADIOITEM_DATA(label, tooltip, callback, user_data, xpm_data) |
#define GNOMEUIINFO_MENU_EXIT_ITEM(cb, data) GNOMEUIINFO_MENU_QUIT_ITEM(cb, data) |
struct GnomeUIBuilderData { GnomeUISignalConnectFunc connect_func; /* Function that connects to the item's signals */ gpointer data; /* User data pointer */ gboolean is_interp; /* Should use * g_signal_connect_closure_by_id * or normal g_signal_connect? */ GtkCallbackMarshal relay_func; /* Marshaller function for language bindings */ GtkDestroyNotify destroy_func; /* Destroy notification function for language bindings */ }; |
void (*GnomeUISignalConnectFunc) (GnomeUIInfo *uiinfo, const char *signal_name, GnomeUIBuilderData *uibdata); |
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 info, inserting them from the item no. 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. The uline_accels argument determines whether underline accelerators will be featured from the menu item labels.
void gnome_app_fill_menu_with_data (GtkMenuShell *menu_shell, GnomeUIInfo *uiinfo, GtkAccelGroup *accel_group, gboolean uline_accels, gint pos, gpointer user_data); |
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 info, inserting them from item no. pos on and using the specified builder data -- this is intended for language bindings. 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. The uline_accels argument determines whether underline accelerators will be featured from the menu item labels.
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.
void gnome_app_create_menus (GnomeApp *app, GnomeUIInfo *uiinfo); |
Constructs a menu bar and attaches it to the specified application window.
void gnome_app_create_menus_interp (GnomeApp *app, GnomeUIInfo *uiinfo, GtkCallbackMarshal relay_func, gpointer data, GtkDestroyNotify destroy_func); |
void gnome_app_create_menus_with_data (GnomeApp *app, GnomeUIInfo *uiinfo, gpointer user_data); |
void gnome_app_create_menus_custom (GnomeApp *app, GnomeUIInfo *uiinfo, GnomeUIBuilderData *uibdata); |
void gnome_app_fill_toolbar (GtkToolbar *toolbar, GnomeUIInfo *uiinfo, GtkAccelGroup *accel_group); |
void gnome_app_fill_toolbar_with_data (GtkToolbar *toolbar, GnomeUIInfo *uiinfo, GtkAccelGroup *accel_group, gpointer user_data); |
void gnome_app_fill_toolbar_custom (GtkToolbar *toolbar, GnomeUIInfo *uiinfo, GnomeUIBuilderData *uibdata, GtkAccelGroup *accel_group); |
void gnome_app_create_toolbar (GnomeApp *app, GnomeUIInfo *uiinfo); |
Constructs a toolbar and attaches it to the specified application window.
void gnome_app_create_toolbar_interp (GnomeApp *app, GnomeUIInfo *uiinfo, GtkCallbackMarshal relay_func, gpointer data, GtkDestroyNotify destroy_func); |
Constructs a toolbar and attaches it to the specified application window -- this version is intended for language bindings.
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.
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.
GtkWidget* gnome_app_find_menu_pos (GtkWidget *parent, const gchar *path, gint *pos); |
finds menu item described by path starting in the GtkMenuShell top and returns its parent GtkMenuShell and the position after this item in pos: gtk_menu_shell_insert(p, w, pos) would then insert widget w in GtkMenuShell p right after the menu item described by path.
void gnome_app_remove_menus (GnomeApp *app, const gchar *path, gint items); |
removes num items from the existing app's menu structure beginning with item described by path
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 the number specified by start - very useful for adding and removing Recent document items in the File menu.
void gnome_app_insert_menus_custom (GnomeApp *app, const gchar *path, GnomeUIInfo *menuinfo, GnomeUIBuilderData *uibdata); |
inserts menus described by uiinfo in existing app's menu structure right after the item described by path.
void gnome_app_insert_menus (GnomeApp *app, const gchar *path, GnomeUIInfo *menuinfo); |
void gnome_app_insert_menus_with_data (GnomeApp *app, const gchar *path, GnomeUIInfo *menuinfo, gpointer data); |
void gnome_app_insert_menus_interp (GnomeApp *app, const gchar *path, GnomeUIInfo *menuinfo, GtkCallbackMarshal relay_func, gpointer data, GtkDestroyNotify destroy_func); |
void gnome_app_install_appbar_menu_hints (GnomeAppBar *appbar, GnomeUIInfo *uiinfo); |
Install menu hints for the given GNOME app bar object.
void gnome_app_install_statusbar_menu_hints (GtkStatusbar *bar, GnomeUIInfo *uiinfo); |
Install menu hints for the given status bar.
void gnome_app_install_menu_hints (GnomeApp *app, GnomeUIInfo *uinfo); |
Set menu hints for the GNOME app object's attached status bar.