Fix bug #4877 (Some harmless code quirks involving booleans)
[dana/openbox.git] / openbox / menu.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    menu.h for the Openbox window manager
4    Copyright (c) 2003-2007   Dana Jansens
5
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.
10
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.
15
16    See the COPYING file for a copy of the GNU General Public License.
17 */
18
19 #ifndef __menu_h
20 #define __menu_h
21
22 #include "window.h"
23 #include "geom.h"
24 #include "obrender/render.h"
25
26 #include <glib.h>
27
28 struct _ObClient;
29 struct _ObMenuFrame;
30 struct _ObMenuEntryFrame;
31
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;
37
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,
41                                      gpointer data);
42 typedef void (*ObMenuExecuteFunc)(struct _ObMenuEntry *entry,
43                                   struct _ObMenuFrame *frame,
44                                   struct _ObClient *client,
45                                   guint state, gpointer data);
46 typedef void (*ObMenuCleanupFunc)(struct _ObMenu *menu, gpointer data);
47 typedef void (*ObMenuDestroyFunc)(struct _ObMenu *menu, gpointer data);
48 /*! @param x is the mouse x coordinate. on return it should be the x coordinate
49              for the menu
50     @param y is the mouse y coordinate. on return it should be the y coordinate
51              for the menu
52 */
53 typedef void (*ObMenuPlaceFunc)(struct _ObMenuFrame *frame, gint *x, gint *y,
54                                 gboolean mouse, gpointer data);
55
56 struct _ObMenu
57 {
58     /* Name of the menu. Used in the showmenu action. */
59     gchar *name;
60     /* Displayed title */
61     gchar *title;
62     /*! The shortcut key that would be used to activate this menu if it was
63       displayed as a submenu */
64     gunichar shortcut;
65     /*! The shortcut's position in the string */
66     guint shortcut_position;
67     /*! If the shortcut was specified by & and should always be drawn */
68     gboolean shortcut_always_show;
69
70     /*! If the shortcut key should be shown in menu entries even when it
71       is the first character in the string */
72     gboolean show_all_shortcuts;
73
74     /* Command to execute to rebuild the menu */
75     gchar *execute;
76
77     /* ObMenuEntry list */
78     GList *entries;
79
80     /* plugin data */
81     gpointer data;
82
83     ObMenuShowFunc show_func;
84     ObMenuHideFunc hide_func;
85     ObMenuUpdateFunc update_func;
86     ObMenuExecuteFunc execute_func;
87     ObMenuCleanupFunc cleanup_func;
88     ObMenuDestroyFunc destroy_func;
89     ObMenuPlaceFunc place_func;
90
91     /* Pipe-menu parent, we get destroyed when it is destroyed */
92     ObMenu *pipe_creator;
93
94     /* The menu used as the destination for the "More..." entry for this menu*/
95     ObMenu *more_menu;
96 };
97
98 typedef enum
99 {
100     OB_MENU_ENTRY_TYPE_NORMAL,
101     OB_MENU_ENTRY_TYPE_SUBMENU,
102     OB_MENU_ENTRY_TYPE_SEPARATOR
103 } ObMenuEntryType;
104
105 struct _ObNormalMenuEntry {
106     gchar *label;
107     /*! The shortcut key that would be used to activate this menu entry */
108     gunichar shortcut;
109     /*! The shortcut's position in the string */
110     guint shortcut_position;
111     /*! If the shortcut was specified by & and should always be drawn */
112     gboolean shortcut_always_show;
113
114     /* state */
115     gboolean enabled;
116
117     /* List of ObActions */
118     GSList *actions;
119
120     /* Icon stuff.  If you set this, make sure you RrImageRef() it too. */
121     RrImage *icon;
122     gint     icon_alpha;
123
124     /* Mask icon */
125     RrPixmapMask *mask;
126     RrColor *mask_normal_color;
127     RrColor *mask_selected_color;
128     RrColor *mask_disabled_color;
129     RrColor *mask_disabled_selected_color;
130
131     gpointer data;
132 };
133
134 struct _ObSubmenuMenuEntry {
135     gchar *name;
136     ObMenu *submenu;
137     guint show_from;
138 };
139
140 struct _ObSeparatorMenuEntry {
141     gchar *label;
142 };
143
144 struct _ObMenuEntry
145 {
146     guint ref;
147
148     ObMenuEntryType type;
149     ObMenu *menu;
150
151     gint id;
152
153     union u {
154         ObNormalMenuEntry normal;
155         ObSubmenuMenuEntry submenu;
156         ObSeparatorMenuEntry separator;
157     } data;
158 };
159
160 void menu_startup(gboolean reconfig);
161 void menu_shutdown(gboolean reconfig);
162
163 void menu_entry_ref(ObMenuEntry *self);
164 void menu_entry_unref(ObMenuEntry *self);
165
166 ObMenu* menu_new(const gchar *name, const gchar *title,
167                  gboolean allow_shortcut_selection, gpointer data);
168 void menu_free(ObMenu *menu);
169
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(void);
174
175 void menu_show_all_shortcuts(ObMenu *self, gboolean show);
176
177 void menu_show(gchar *name, gint x, gint y, gboolean mouse,
178                struct _ObClient *client);
179 gboolean menu_hide_delay_reached(void);
180
181 /*! The show function is called right after a menu is shown */
182 void menu_set_show_func(ObMenu *menu, ObMenuShowFunc func);
183 /*! The hide function is called right before a menu is hidden */
184 void menu_set_hide_func(ObMenu *menu, ObMenuHideFunc func);
185 /*! The update function is called when the menu should refresh its
186   contents, generally right before it is shown */
187 void menu_set_update_func(ObMenu *menu, ObMenuUpdateFunc func);
188 /*! The execute function is called when a user chooses to execute an
189   entry in the menu */
190 void menu_set_execute_func(ObMenu *menu, ObMenuExecuteFunc func);
191 /*! The cleanup function is called after a menu is hidden, allowing it
192   to be cleaned up between uses */
193 void menu_set_cleanup_func(ObMenu *menu, ObMenuCleanupFunc func);
194 /*! The destroy function is called when the menu is being destroyed
195   permanently */
196 void menu_set_destroy_func(ObMenu *menu, ObMenuDestroyFunc func);
197 /*! The place function is called when the menu is being shown and allows
198   the menu to choose its initial position */
199 void menu_set_place_func(ObMenu *menu, ObMenuPlaceFunc func);
200
201 /* functions for building menus */
202 /*! @param allow_shortcut this should be false when the label is coming from
203            outside data like window or desktop titles */
204 ObMenuEntry* menu_add_normal(ObMenu *menu, gint id, const gchar *label,
205                              GSList *actions, gboolean allow_shortcut);
206 ObMenuEntry* menu_add_submenu(ObMenu *menu, gint id, const gchar *submenu);
207 ObMenuEntry* menu_add_separator(ObMenu *menu, gint id, const gchar *label);
208
209 void menu_clear_entries(ObMenu *menu);
210 void menu_entry_remove(ObMenuEntry *self);
211
212 void menu_entry_set_label(ObMenuEntry *self, const gchar *label,
213                           gboolean allow_shortcut);
214
215 ObMenuEntry* menu_find_entry_id(ObMenu *self, gint id);
216
217 /* fills in the submenus, for use when a menu is being shown */
218 void menu_find_submenus(ObMenu *self);
219
220 ObMenuEntry* menu_get_more(ObMenu *menu, guint show_from);
221
222 #endif