struct _ObMenuFrame *frame,
struct _ObClient *client,
guint state, gpointer data);
+typedef void (*ObMenuCleanupFunc)(struct _ObMenu *menu, gpointer data);
typedef void (*ObMenuDestroyFunc)(struct _ObMenu *menu, gpointer data);
/*! @param x is the mouse x coordinate. on return it should be the x coordinate
for the menu
gchar *name;
/* Displayed title */
gchar *title;
+ gchar *collate_key;
/*! The shortcut key that would be used to activate this menu if it was
displayed as a submenu */
gunichar shortcut;
ObMenuHideFunc hide_func;
ObMenuUpdateFunc update_func;
ObMenuExecuteFunc execute_func;
+ ObMenuCleanupFunc cleanup_func;
ObMenuDestroyFunc destroy_func;
ObMenuPlaceFunc place_func;
} ObMenuEntryType;
struct _ObNormalMenuEntry {
+ /* Icon stuff. If you set this, make sure you RrImageRef() it too. */
+ RrImage *icon;
+ gint icon_alpha;
+
gchar *label;
+ gchar *collate_key;
/*! The shortcut key that would be used to activate this menu entry */
gunichar shortcut;
/*! The shortcut's position in the string */
/* List of ObActions */
GSList *actions;
- /* Icon stuff. If you set this, make sure you RrImageRef() it too. */
- RrImage *icon;
- gint icon_alpha;
-
/* Mask icon */
RrPixmapMask *mask;
RrColor *mask_normal_color;
};
struct _ObSubmenuMenuEntry {
+ /* Icon stuff. If you set this, make sure you RrImageRef() it too. */
+ RrImage *icon;
+ gint icon_alpha;
+
gchar *name;
ObMenu *submenu;
+
guint show_from;
};
struct _ObClient *client);
gboolean menu_hide_delay_reached(void);
+/*! The show function is called right after a menu is shown */
void menu_set_show_func(ObMenu *menu, ObMenuShowFunc func);
+/*! The hide function is called right before a menu is hidden */
void menu_set_hide_func(ObMenu *menu, ObMenuHideFunc func);
+/*! The update function is called when the menu should refresh its
+ contents, generally right before it is shown */
void menu_set_update_func(ObMenu *menu, ObMenuUpdateFunc func);
+/*! The execute function is called when a user chooses to execute an
+ entry in the menu */
void menu_set_execute_func(ObMenu *menu, ObMenuExecuteFunc func);
+/*! The cleanup function is called after a menu is hidden, allowing it
+ to be cleaned up between uses */
+void menu_set_cleanup_func(ObMenu *menu, ObMenuCleanupFunc func);
+/*! The destroy function is called when the menu is being destroyed
+ permanently */
void menu_set_destroy_func(ObMenu *menu, ObMenuDestroyFunc func);
+/*! The place function is called when the menu is being shown and allows
+ the menu to choose its initial position */
void menu_set_place_func(ObMenu *menu, ObMenuPlaceFunc func);
/* functions for building menus */
ObMenuEntry* menu_add_submenu(ObMenu *menu, gint id, const gchar *submenu);
ObMenuEntry* menu_add_separator(ObMenu *menu, gint id, const gchar *label);
-void menu_clear_entries(ObMenu *menu);
+/*! This sorts groups of menu entries between consecutive separators */
+void menu_sort_entries(ObMenu *self);
+
+void menu_clear_entries(ObMenu *self);
void menu_entry_remove(ObMenuEntry *self);
void menu_entry_set_label(ObMenuEntry *self, const gchar *label,