merge in r6153-6154 from the 3.4 branch
[dana/openbox.git] / openbox / menuframe.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    menuframe.h for the Openbox window manager
4    Copyright (c) 2006        Mikael Magnusson
5    Copyright (c) 2003-2007   Dana Jansens
6
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.
11
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.
16
17    See the COPYING file for a copy of the GNU General Public License.
18 */
19
20 #ifndef ob__menuframe_h
21 #define ob__menuframe_h
22
23 #include "geom.h"
24 #include "window.h"
25 #include "render/render.h"
26
27 #include <glib.h>
28
29 struct _ObClient;
30 struct _ObMenu;
31 struct _ObMenuEntry;
32
33 typedef struct _ObMenuFrame ObMenuFrame;
34 typedef struct _ObMenuEntryFrame ObMenuEntryFrame;
35
36 extern GList *menu_frame_visible;
37
38 struct _ObMenuFrame
39 {
40     /* stuff to be an ObWindow */
41     Window_InternalType type;
42     Window window;
43
44     struct _ObMenu *menu;
45
46     /* The client that the visual instance of the menu is associated with for
47        its actions */
48     struct _ObClient *client;
49
50     ObMenuFrame *parent;
51     ObMenuEntryFrame *parent_entry;
52     ObMenuFrame *child;
53
54     GList *entries;
55     ObMenuEntryFrame *selected;
56
57     /* show entries from the menu starting at this index */
58     guint show_from;
59
60     /* If the submenus are being drawn to the right or the left */
61     gboolean direction_right;
62
63     /* On-screen area (including borders!) */
64     Rect area;
65     Strut item_margin;
66     gint inner_w; /* inside the borders */
67     gint item_h;  /* height of all normal items */
68     gint text_x;  /* offset at which the text appears in the items */
69     gint text_w;  /* width of the text area in the items */
70     gint text_h;  /* height of the items */
71
72     gint monitor; /* monitor on which to show the menu in xinerama */
73
74     RrAppearance *a_title;
75     RrAppearance *a_items;
76 };
77
78 struct _ObMenuEntryFrame
79 {
80     /* if this is true then it doesn't have an entry to point to */
81     gboolean more;
82
83     struct _ObMenuEntry *entry;
84     ObMenuFrame *frame;
85
86     guint ignore_enters;
87
88     Rect area;
89     gint border;
90
91     Window window;
92     Window icon;
93     Window text;
94     Window bullet;
95
96     RrAppearance *a_normal;
97     RrAppearance *a_selected;
98     RrAppearance *a_disabled;
99     RrAppearance *a_disabled_selected;
100
101     RrAppearance *a_icon;
102     RrAppearance *a_mask;
103     RrAppearance *a_bullet_normal;
104     RrAppearance *a_bullet_selected;
105     RrAppearance *a_separator;
106     RrAppearance *a_text_normal;
107     RrAppearance *a_text_selected;
108     RrAppearance *a_text_disabled;
109     RrAppearance *a_text_disabled_selected;
110     RrAppearance *a_text_title;
111 };
112
113 extern GHashTable *menu_frame_map;
114
115 void menu_frame_startup(gboolean reconfig);
116 void menu_frame_shutdown(gboolean reconfig);
117
118 ObMenuFrame* menu_frame_new(struct _ObMenu *menu,
119                             guint show_from,
120                             struct _ObClient *client);
121 void menu_frame_free(ObMenuFrame *self);
122
123 void menu_frame_move(ObMenuFrame *self, gint x, gint y);
124 void menu_frame_move_on_screen(ObMenuFrame *self, gint x, gint y,
125                                gint *dx, gint *dy);
126
127 gboolean menu_frame_show_topmenu(ObMenuFrame *self, gint x, gint y,
128                                  gint button);
129 gboolean menu_frame_show_submenu(ObMenuFrame *self, ObMenuFrame *parent,
130                                  ObMenuEntryFrame *parent_entry);
131 void menu_frame_hide(ObMenuFrame *self);
132
133 void menu_frame_hide_all();
134 void menu_frame_hide_all_client(struct _ObClient *client);
135
136 void menu_frame_select(ObMenuFrame *self, ObMenuEntryFrame *entry,
137                        gboolean immediate);
138 void menu_frame_select_previous(ObMenuFrame *self);
139 void menu_frame_select_next(ObMenuFrame *self);
140
141 ObMenuFrame* menu_frame_under(gint x, gint y);
142 ObMenuEntryFrame* menu_entry_frame_under(gint x, gint y);
143
144 void menu_entry_frame_show_submenu(ObMenuEntryFrame *self);
145
146 void menu_entry_frame_execute(ObMenuEntryFrame *self, guint state, Time time);
147
148 #endif