+/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
+
+ menu.h for the Openbox window manager
+ Copyright (c) 2003-2007 Dana Jansens
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ See the COPYING file for a copy of the GNU General Public License.
+*/
+
#ifndef __menu_h
#define __menu_h
#include "action.h"
#include "window.h"
-#include "render/render.h"
#include "geom.h"
+#include "render/render.h"
+#include "parser/parse.h"
#include <glib.h>
struct _ObClient;
+struct _ObMenuFrame;
+struct _ObMenuEntryFrame;
-typedef struct _ObMenu ObMenu;
+typedef struct _ObMenu ObMenu;
typedef struct _ObMenuEntry ObMenuEntry;
-
-typedef void(*menu_controller_show)(ObMenu *self, int x, int y,
- struct _ObClient *);
-typedef void(*menu_controller_update)(ObMenu *self);
-typedef void(*menu_controller_mouseover)(ObMenuEntry *self, gboolean enter);
-
-extern GHashTable *menu_hash;
-extern GSList *menu_visible;
+typedef struct _ObNormalMenuEntry ObNormalMenuEntry;
+typedef struct _ObSubmenuMenuEntry ObSubmenuMenuEntry;
+typedef struct _ObSeparatorMenuEntry ObSeparatorMenuEntry;
+
+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,
+ struct _ObMenuFrame *frame,
+ struct _ObClient *client,
+ guint state, 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
{
- ObWindow obwin;
-
- gchar *label;
+ /* Name of the menu. Used in the showmenu action. */
gchar *name;
-
+ /* Displayed title */
+ gchar *title;
+ /*! 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 key should be shown in menu entries even when it
+ is the first character in the string */
+ gboolean show_all_shortcuts;
+
+ /* Command to execute to rebuild the menu */
+ gchar *execute;
+
+ /* ObMenuEntry list */
GList *entries;
- gboolean shown;
- gboolean invalid;
-
- ObMenu *parent;
-
- ObMenu *open_submenu;
-
- /* place a menu on screen */
- menu_controller_show show;
- void (*hide)( /* some bummu */);
-
- /* render a menu */
- menu_controller_update update;
- menu_controller_mouseover mouseover;
- void (*selected)( /* some bummu */);
-
-
- /* render stuff */
- struct _ObClient *client;
- Window frame;
- Window title;
- RrAppearance *a_title;
- gint title_min_w, title_h;
- Window items;
- RrAppearance *a_items;
- gint bullet_w;
- gint item_h;
- Point location;
- Size size;
- guint xin_area; /* index of the xinerama head/area */
-
- /* plugin stuff */
- char *plugin;
- void *plugin_data;
+ /* plugin data */
+ gpointer data;
+
+ ObMenuShowFunc show_func;
+ ObMenuHideFunc hide_func;
+ ObMenuUpdateFunc update_func;
+ ObMenuExecuteFunc execute_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
{
- OB_MENU_ENTRY_RENDER_TYPE_NONE,
- OB_MENU_ENTRY_RENDER_TYPE_SUBMENU,
- OB_MENU_ENTRY_RENDER_TYPE_BOOLEAN,
- OB_MENU_ENTRY_RENDER_TYPE_SEPARATOR,
- OB_MENU_ENTRY_RENDER_TYPE_OTHER /* XXX what is this? */
-} ObMenuEntryRenderType;
+ OB_MENU_ENTRY_TYPE_NORMAL,
+ OB_MENU_ENTRY_TYPE_SUBMENU,
+ OB_MENU_ENTRY_TYPE_SEPARATOR
+} ObMenuEntryType;
-struct _ObMenuEntry
-{
- char *label;
- ObMenu *parent;
+struct _ObNormalMenuEntry {
+ gchar *label;
+ /*! The shortcut key that would be used to activate this menu entry */
+ gunichar shortcut;
+ /*! The shortcut's position in the string */
+ guint shortcut_position;
- Action *action;
-
- ObMenuEntryRenderType render_type;
- gboolean hilite;
+ /* state */
gboolean enabled;
- gboolean boolean_value;
- ObMenu *submenu;
+ /* List of ObActions */
+ GSList *actions;
+
+ /* Icon shit */
+ gint icon_width;
+ gint icon_height;
+ gint icon_alpha;
+ RrPixel32 *icon_data;
+
+ /* Mask icon */
+ RrPixmapMask *mask;
+ RrColor *mask_normal_color;
+ RrColor *mask_selected_color;
+ RrColor *mask_disabled_color;
+ RrColor *mask_disabled_selected_color;
+
+ gpointer data;
+};
- /* render stuff */
- Window item;
- RrAppearance *a_item;
- RrAppearance *a_disabled;
- RrAppearance *a_hilite;
- gint y;
- gint min_w;
+struct _ObSubmenuMenuEntry {
+ gchar *name;
+ ObMenu *submenu;
+ guint show_from;
};
-void menu_startup();
-void menu_shutdown();
+struct _ObSeparatorMenuEntry {
+ gchar *label;
+};
-#define menu_new(l, n, p) \
- menu_new_full(l, n, p, NULL, NULL)
+struct _ObMenuEntry
+{
+ guint ref;
-ObMenu *menu_new_full(char *label, char *name, ObMenu *parent,
- menu_controller_show show, menu_controller_update update);
-void menu_free(char *name);
+ ObMenuEntryType type;
+ ObMenu *menu;
-void menu_show(char *name, int x, int y, struct _ObClient *client);
-void menu_show_full(ObMenu *menu, int x, int y, struct _ObClient *client);
+ gint id;
-void menu_hide(ObMenu *self);
+ union u {
+ ObNormalMenuEntry normal;
+ ObSubmenuMenuEntry submenu;
+ ObSeparatorMenuEntry separator;
+ } data;
+};
-void menu_clear(ObMenu *self);
+void menu_startup(gboolean reconfig);
+void menu_shutdown(gboolean reconfig);
-ObMenuEntry *menu_entry_new_full(char *label, Action *action,
- ObMenuEntryRenderType render_type,
- gpointer submenu);
+void menu_entry_ref(ObMenuEntry *self);
+void menu_entry_unref(ObMenuEntry *self);
-#define menu_entry_new(label, action) \
-menu_entry_new_full(label, action, OB_MENU_ENTRY_RENDER_TYPE_NONE, NULL)
+/*! @param allow_shortcut this should be false when the label is coming from
+ outside data like window or desktop titles */
+ObMenu* menu_new(const gchar *name, const gchar *title,
+ gboolean allow_shortcut_selection, gpointer data);
+void menu_free(ObMenu *menu);
-#define menu_entry_new_separator(label) \
-menu_entry_new_full(label, NULL, OB_MENU_ENTRY_RENDER_TYPE_SEPARATOR, NULL)
+/*! 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();
-#define menu_entry_new_submenu(label, submenu) \
-menu_entry_new_full(label, NULL, OB_MENU_ENTRY_RENDER_TYPE_SUBMENU, submenu)
+void menu_show_all_shortcuts(ObMenu *self, gboolean show);
-#define menu_entry_new_boolean(label, action) \
-menu_entry_new_full(label, action, OB_MENU_ENTRY_RENDER_TYPE_BOOLEAN, NULL)
+void menu_show(gchar *name, gint x, gint y, gboolean mouse,
+ struct _ObClient *client);
+gboolean menu_hide_delay_reached();
-void menu_entry_free(ObMenuEntry *entry);
+void menu_set_show_func(ObMenu *menu, ObMenuShowFunc func);
+void menu_set_hide_func(ObMenu *menu, ObMenuHideFunc func);
+void menu_set_update_func(ObMenu *menu, ObMenuUpdateFunc func);
+void menu_set_execute_func(ObMenu *menu, ObMenuExecuteFunc func);
+void menu_set_destroy_func(ObMenu *menu, ObMenuDestroyFunc func);
+void menu_set_place_func(ObMenu *menu, ObMenuPlaceFunc func);
-void menu_entry_set_submenu(ObMenuEntry *entry, ObMenu *submenu);
+/* functions for building menus */
+/*! @param allow_shortcut this should be false when the label is coming from
+ outside data like window or desktop titles */
+ObMenuEntry* menu_add_normal(ObMenu *menu, gint id, const gchar *label,
+ GSList *actions, gboolean allow_shortcut);
+ObMenuEntry* menu_add_submenu(ObMenu *menu, gint id, const gchar *submenu);
+ObMenuEntry* menu_add_separator(ObMenu *menu, gint id, const gchar *label);
-void menu_add_entry(ObMenu *menu, ObMenuEntry *entry);
+void menu_clear_entries(ObMenu *menu);
+void menu_entry_remove(ObMenuEntry *self);
-ObMenuEntry *menu_find_entry(ObMenu *menu, Window win);
-ObMenuEntry *menu_find_entry_by_pos(ObMenu *menu, int x, int y);
+void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
+ gboolean allow_shortcut);
-void menu_entry_render(ObMenuEntry *self);
+ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id);
-void menu_entry_fire(ObMenuEntry *self);
+/* fills in the submenus, for use when a menu is being shown */
+void menu_find_submenus(ObMenu *self);
-void menu_render(ObMenu *self);
-void menu_render_full(ObMenu *self);
+ObMenuEntry* menu_get_more(ObMenu *menu, guint show_from);
-void menu_control_mouseover(ObMenuEntry *entry, gboolean enter);
#endif
projects / mikachu / openbox.git / blobdiff