1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 menuframe.h for the Openbox window manager
4 Copyright (c) 2006 Mikael Magnusson
5 Copyright (c) 2003-2007 Dana Jansens
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 See the COPYING file for a copy of the GNU General Public License.
20 #ifndef ob__menuframe_h
21 #define ob__menuframe_h
25 #include "obrender/render.h"
33 typedef struct _ObMenuFrame ObMenuFrame
;
34 typedef struct _ObMenuEntryFrame ObMenuEntryFrame
;
36 extern GList
*menu_frame_visible
;
40 /* stuff to be an ObWindow */
46 /* The client that the visual instance of the menu is associated with for
48 struct _ObClient
*client
;
51 ObMenuEntryFrame
*parent_entry
;
53 ObMenuEntryFrame
*child_entry
;
56 ObMenuEntryFrame
*selected
;
58 /* show entries from the menu starting at this index */
61 /* If the submenus are being drawn to the right or the left */
62 gboolean direction_right
;
64 /* On-screen area (including borders!) */
67 gint inner_w
; /* inside the borders */
68 gint item_h
; /* height of all normal items */
69 gint text_x
; /* offset at which the text appears in the items */
70 gint text_w
; /* width of the text area in the items */
71 gint text_h
; /* height of the items */
73 gint monitor
; /* monitor on which to show the menu in xinerama */
75 /* We make a copy of this for each menu, so that we don't have to re-render
76 the background of the entire menu each time we render an item inside it.
78 RrAppearance
*a_items
;
80 gboolean got_press
; /* don't allow a KeyRelease event to run things in the
81 menu until it has seen a KeyPress. this is to
82 avoid having the keybinding used to show the menu
83 end up running something inside the menu */
84 guint press_keycode
; /* the KeyCode that was used in the last KeyPress */
85 gboolean press_doexec
; /* if the upcoming KeyRelease should be used to
86 execute the menu item that was selected by the
90 struct _ObMenuEntryFrame
92 struct _ObMenuEntry
*entry
;
106 extern GHashTable
*menu_frame_map
;
108 void menu_frame_startup(gboolean reconfig
);
109 void menu_frame_shutdown(gboolean reconfig
);
111 ObMenuFrame
* menu_frame_new(struct _ObMenu
*menu
,
113 struct _ObClient
*client
);
114 void menu_frame_free(ObMenuFrame
*self
);
116 void menu_frame_move(ObMenuFrame
*self
, gint x
, gint y
);
117 void menu_frame_move_on_screen(ObMenuFrame
*self
, gint x
, gint y
,
120 gboolean
menu_frame_show_topmenu(ObMenuFrame
*self
, gint x
, gint y
,
122 gboolean
menu_frame_show_submenu(ObMenuFrame
*self
, ObMenuFrame
*parent
,
123 ObMenuEntryFrame
*parent_entry
);
125 void menu_frame_hide_all(void);
126 void menu_frame_hide_all_client(struct _ObClient
*client
);
128 void menu_frame_render(ObMenuFrame
*self
);
130 void menu_frame_select(ObMenuFrame
*self
, ObMenuEntryFrame
*entry
,
132 void menu_frame_select_previous(ObMenuFrame
*self
);
133 void menu_frame_select_next(ObMenuFrame
*self
);
134 void menu_frame_select_first(ObMenuFrame
*self
);
135 void menu_frame_select_last(ObMenuFrame
*self
);
137 ObMenuFrame
* menu_frame_under(gint x
, gint y
);
138 ObMenuEntryFrame
* menu_entry_frame_under(gint x
, gint y
);
140 void menu_entry_frame_show_submenu(ObMenuEntryFrame
*self
);
142 void menu_entry_frame_execute(ObMenuEntryFrame
*self
, guint state
);