#ifndef __menu_h
#define __menu_h
-#include "action.h"
#include "window.h"
#include "geom.h"
-#include "render/render.h"
-#include "parser/parse.h"
+#include "obrender/render.h"
#include <glib.h>
typedef struct _ObSubmenuMenuEntry ObSubmenuMenuEntry;
typedef struct _ObSeparatorMenuEntry ObSeparatorMenuEntry;
-typedef void (*ObMenuUpdateFunc)(struct _ObMenuFrame *frame, gpointer data);
+typedef void (*ObMenuShowFunc)(struct _ObMenuFrame *frame, gpointer data);
+typedef void (*ObMenuHideFunc)(struct _ObMenuFrame *frame, gpointer data);
+typedef gboolean (*ObMenuUpdateFunc)(struct _ObMenuFrame *frame,
+ gpointer data);
typedef void (*ObMenuExecuteFunc)(struct _ObMenuEntry *entry,
- guint state, gpointer data, Time time);
+ 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
+ @param y is the mouse y coordinate. on return it should be the y coordinate
+ for the menu
+*/
+typedef void (*ObMenuPlaceFunc)(struct _ObMenuFrame *frame, gint *x, gint *y,
+ gboolean mouse, gpointer data);
struct _ObMenu
{
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;
/*! The shortcut's position in the string */
guint shortcut_position;
+ /*! If the shortcut was specified by & and should always be drawn */
+ gboolean shortcut_always_show;
/*! If the shortcut key should be shown in menu entries even when it
is the first character in the string */
/* plugin data */
gpointer data;
+ ObMenuShowFunc show_func;
+ ObMenuHideFunc hide_func;
ObMenuUpdateFunc update_func;
ObMenuExecuteFunc execute_func;
+ ObMenuCleanupFunc cleanup_func;
ObMenuDestroyFunc destroy_func;
+ ObMenuPlaceFunc place_func;
/* Pipe-menu parent, we get destroyed when it is destroyed */
ObMenu *pipe_creator;
+
+ /* The menu used as the destination for the "More..." entry for this menu*/
+ ObMenu *more_menu;
};
typedef enum
} 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 */
guint shortcut_position;
+ /*! If the shortcut was specified by & and should always be drawn */
+ gboolean shortcut_always_show;
/* state */
gboolean enabled;
/* List of ObActions */
GSList *actions;
- /* Icon shit */
- gint icon_width;
- gint icon_height;
- RrPixel32 *icon_data;
-
/* Mask icon */
RrPixmapMask *mask;
RrColor *mask_normal_color;
- RrColor *mask_disabled_color;
RrColor *mask_selected_color;
+ RrColor *mask_disabled_color;
+ RrColor *mask_disabled_selected_color;
+
+ gpointer data;
};
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 _ObSeparatorMenuEntry {
struct _ObMenuEntry
{
+ guint ref;
+
ObMenuEntryType type;
ObMenu *menu;
void menu_startup(gboolean reconfig);
void menu_shutdown(gboolean reconfig);
-/*! @param allow_shortcut this should be false when the label is coming from
- outside data like window or desktop titles */
+void menu_entry_ref(ObMenuEntry *self);
+void menu_entry_unref(ObMenuEntry *self);
+
ObMenu* menu_new(const gchar *name, const gchar *title,
- gboolean allow_shortcut, gpointer data);
+ gboolean allow_shortcut_selection, gpointer data);
void menu_free(ObMenu *menu);
-/* Repopulate a pipe-menu by running its command */
+/*! Repopulate a pipe-menu by running its command */
void menu_pipe_execute(ObMenu *self);
+/*! Clear a pipe-menu's entries */
+void menu_clear_pipe_caches(void);
void menu_show_all_shortcuts(ObMenu *self, gboolean show);
-void menu_show(gchar *name, gint x, gint y, struct _ObClient *client);
-
+void menu_show(gchar *name, const GravityPoint *pos, gint monitor,
+ gboolean mouse, gboolean user_positioned,
+ struct _ObClient *client);
+gboolean menu_hide_delay_reached(void);
+void menu_hide_delay_reset(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 */
/*! @param allow_shortcut this should be false when the label is coming from
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,
/* fills in the submenus, for use when a menu is being shown */
void menu_find_submenus(ObMenu *self);
+ObMenuEntry* menu_get_more(ObMenu *menu, guint show_from);
+
#endif
projects / dana / openbox.git / blobdiff