1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 menu.h for the Openbox window manager
4 Copyright (c) 2003-2007 Dana Jansens
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 See the COPYING file for a copy of the GNU General Public License.
24 #include "render/render.h"
30 struct _ObMenuEntryFrame;
32 typedef struct _ObMenu ObMenu;
33 typedef struct _ObMenuEntry ObMenuEntry;
34 typedef struct _ObNormalMenuEntry ObNormalMenuEntry;
35 typedef struct _ObSubmenuMenuEntry ObSubmenuMenuEntry;
36 typedef struct _ObSeparatorMenuEntry ObSeparatorMenuEntry;
38 typedef void (*ObMenuShowFunc)(struct _ObMenuFrame *frame, gpointer data);
39 typedef void (*ObMenuHideFunc)(struct _ObMenuFrame *frame, gpointer data);
40 typedef gboolean (*ObMenuUpdateFunc)(struct _ObMenuFrame *frame,
42 typedef void (*ObMenuExecuteFunc)(struct _ObMenuEntry *entry,
43 struct _ObMenuFrame *frame,
44 struct _ObClient *client,
45 guint state, gpointer data);
46 typedef void (*ObMenuDestroyFunc)(struct _ObMenu *menu, gpointer data);
47 /*! @param x is the mouse x coordinate. on return it should be the x coordinate
49 @param y is the mouse y coordinate. on return it should be the y coordinate
52 typedef void (*ObMenuPlaceFunc)(struct _ObMenuFrame *frame, gint *x, gint *y,
53 gboolean mouse, gpointer data);
57 /* Name of the menu. Used in the showmenu action. */
61 /*! The shortcut key that would be used to activate this menu if it was
62 displayed as a submenu */
64 /*! The shortcut's position in the string */
65 guint shortcut_position;
66 /*! If the shortcut was specified by & and should always be drawn */
67 gboolean shortcut_always_show;
69 /*! If the shortcut key should be shown in menu entries even when it
70 is the first character in the string */
71 gboolean show_all_shortcuts;
73 /* Command to execute to rebuild the menu */
76 /* ObMenuEntry list */
82 ObMenuShowFunc show_func;
83 ObMenuHideFunc hide_func;
84 ObMenuUpdateFunc update_func;
85 ObMenuExecuteFunc execute_func;
86 ObMenuDestroyFunc destroy_func;
87 ObMenuPlaceFunc place_func;
89 /* Pipe-menu parent, we get destroyed when it is destroyed */
92 /* The menu used as the destination for the "More..." entry for this menu*/
98 OB_MENU_ENTRY_TYPE_NORMAL,
99 OB_MENU_ENTRY_TYPE_SUBMENU,
100 OB_MENU_ENTRY_TYPE_SEPARATOR
103 struct _ObNormalMenuEntry {
105 /*! The shortcut key that would be used to activate this menu entry */
107 /*! The shortcut's position in the string */
108 guint shortcut_position;
109 /*! If the shortcut was specified by & and should always be drawn */
110 gboolean shortcut_always_show;
115 /* List of ObActions */
122 RrPixel32 *icon_data;
126 RrColor *mask_normal_color;
127 RrColor *mask_selected_color;
128 RrColor *mask_disabled_color;
129 RrColor *mask_disabled_selected_color;
134 struct _ObSubmenuMenuEntry {
140 struct _ObSeparatorMenuEntry {
148 ObMenuEntryType type;
154 ObNormalMenuEntry normal;
155 ObSubmenuMenuEntry submenu;
156 ObSeparatorMenuEntry separator;
160 void menu_startup(gboolean reconfig);
161 void menu_shutdown(gboolean reconfig);
163 void menu_entry_ref(ObMenuEntry *self);
164 void menu_entry_unref(ObMenuEntry *self);
166 ObMenu* menu_new(const gchar *name, const gchar *title,
167 gboolean allow_shortcut_selection, gpointer data);
168 void menu_free(ObMenu *menu);
170 /*! Repopulate a pipe-menu by running its command */
171 void menu_pipe_execute(ObMenu *self);
172 /*! Clear a pipe-menu's entries */
173 void menu_clear_pipe_caches();
175 void menu_show_all_shortcuts(ObMenu *self, gboolean show);
177 void menu_show(gchar *name, gint x, gint y, gboolean mouse,
178 struct _ObClient *client);
179 gboolean menu_hide_delay_reached();
181 void menu_set_show_func(ObMenu *menu, ObMenuShowFunc func);
182 void menu_set_hide_func(ObMenu *menu, ObMenuHideFunc func);
183 void menu_set_update_func(ObMenu *menu, ObMenuUpdateFunc func);
184 void menu_set_execute_func(ObMenu *menu, ObMenuExecuteFunc func);
185 void menu_set_destroy_func(ObMenu *menu, ObMenuDestroyFunc func);
186 void menu_set_place_func(ObMenu *menu, ObMenuPlaceFunc func);
188 /* functions for building menus */
189 /*! @param allow_shortcut this should be false when the label is coming from
190 outside data like window or desktop titles */
191 ObMenuEntry* menu_add_normal(ObMenu *menu, gint id, const gchar *label,
192 GSList *actions, gboolean allow_shortcut);
193 ObMenuEntry* menu_add_submenu(ObMenu *menu, gint id, const gchar *submenu);
194 ObMenuEntry* menu_add_separator(ObMenu *menu, gint id, const gchar *label);
196 void menu_clear_entries(ObMenu *menu);
197 void menu_entry_remove(ObMenuEntry *self);
199 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
200 gboolean allow_shortcut);
202 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id);
204 /* fills in the submenus, for use when a menu is being shown */
205 void menu_find_submenus(ObMenu *self);
207 ObMenuEntry* menu_get_more(ObMenu *menu, guint show_from);