1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 frame.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.
24 #include "render/render.h"
26 typedef struct _ObFrame ObFrame;
30 typedef void (*ObFrameIconifyAnimateFunc)(gpointer data);
33 OB_FRAME_CONTEXT_NONE,
34 OB_FRAME_CONTEXT_DESKTOP,
35 OB_FRAME_CONTEXT_ROOT,
36 OB_FRAME_CONTEXT_CLIENT,
37 OB_FRAME_CONTEXT_TITLEBAR,
38 OB_FRAME_CONTEXT_FRAME,
39 OB_FRAME_CONTEXT_BLCORNER,
40 OB_FRAME_CONTEXT_BRCORNER,
41 OB_FRAME_CONTEXT_TLCORNER,
42 OB_FRAME_CONTEXT_TRCORNER,
44 OB_FRAME_CONTEXT_BOTTOM,
45 OB_FRAME_CONTEXT_LEFT,
46 OB_FRAME_CONTEXT_RIGHT,
47 OB_FRAME_CONTEXT_MAXIMIZE,
48 OB_FRAME_CONTEXT_ALLDESKTOPS,
49 OB_FRAME_CONTEXT_SHADE,
50 OB_FRAME_CONTEXT_ICONIFY,
51 OB_FRAME_CONTEXT_ICON,
52 OB_FRAME_CONTEXT_CLOSE,
53 /*! This is a special context, which occurs while dragging a window in
55 OB_FRAME_CONTEXT_MOVE_RESIZE,
56 OB_FRAME_CONTEXT_EDGE,
60 #define FRAME_CONTEXT(co, cl) ((cl && cl->type != OB_CLIENT_TYPE_DESKTOP) ? \
61 co == OB_FRAME_CONTEXT_FRAME : FALSE)
62 #define CLIENT_CONTEXT(co, cl) ((cl && cl->type == OB_CLIENT_TYPE_DESKTOP) ? \
63 co == OB_FRAME_CONTEXT_DESKTOP : \
64 co == OB_FRAME_CONTEXT_CLIENT)
66 /*! The decorations the client window wants to be displayed on it */
68 OB_FRAME_DECOR_TITLEBAR = 1 << 0, /*!< Display a titlebar */
69 OB_FRAME_DECOR_HANDLE = 1 << 1, /*!< Display a handle (bottom) */
70 OB_FRAME_DECOR_GRIPS = 1 << 2, /*!< Display grips in the handle */
71 OB_FRAME_DECOR_BORDER = 1 << 3, /*!< Display a border */
72 OB_FRAME_DECOR_ICON = 1 << 4, /*!< Display the window's icon */
73 OB_FRAME_DECOR_ICONIFY = 1 << 5, /*!< Display an iconify button */
74 OB_FRAME_DECOR_MAXIMIZE = 1 << 6, /*!< Display a maximize button */
75 /*! Display a button to toggle the window's placement on
77 OB_FRAME_DECOR_ALLDESKTOPS = 1 << 7,
78 OB_FRAME_DECOR_SHADE = 1 << 8, /*!< Display a shade button */
79 OB_FRAME_DECOR_CLOSE = 1 << 9 /*!< Display a close button */
84 struct _ObClient *client;
107 /* These are borders of the frame and its elements */
111 Window titletopright;
126 Window innerleft; /*!< For drawing the inner client border */
127 Window innertop; /*!< For drawing the inner client border */
128 Window innerright; /*!< For drawing the inner client border */
129 Window innerbottom; /*!< For drawing the inner client border */
134 Window backback; /*!< A colored window shown while resizing */
135 Window backfront; /*!< An undrawn-in window, to prevent flashing on
138 /* These are resize handles inside the titlebar */
147 gint icon_on; /* if the window icon button is on */
148 gint label_on; /* if the window title is on */
149 gint iconify_on; /* if the window iconify button is on */
150 gint desk_on; /* if the window all-desktops button is on */
151 gint shade_on; /* if the window shade button is on */
152 gint max_on; /* if the window maximize button is on */
153 gint close_on; /* if the window close button is on */
155 gint width; /* width of the titlebar and handle */
156 gint label_width; /* width of the label in the titlebar */
157 gint icon_x; /* x-position of the window icon button */
158 gint label_x; /* x-position of the window title */
159 gint iconify_x; /* x-position of the window iconify button */
160 gint desk_x; /* x-position of the window all-desktops button */
161 gint shade_x; /* x-position of the window shade button */
162 gint max_x; /* x-position of the window maximize button */
163 gint close_x; /* x-position of the window close button */
164 gint bwidth; /* border width */
165 gint cbwidth_l; /* client border width */
166 gint cbwidth_t; /* client border width */
167 gint cbwidth_r; /* client border width */
168 gint cbwidth_b; /* client border width */
169 gboolean max_horz; /* when maxed some decorations are hidden */
170 gboolean max_vert; /* when maxed some decorations are hidden */
171 gboolean shaded; /* decorations adjust when shaded */
173 /* the leftmost and rightmost elements in the titlebar */
174 ObFrameContext leftmost;
175 ObFrameContext rightmost;
178 gboolean close_press;
180 gboolean shade_press;
181 gboolean iconify_press;
183 gboolean close_hover;
185 gboolean shade_hover;
186 gboolean iconify_hover;
189 gboolean need_render;
195 /*! Is the frame currently in an animation for iconify or restore.
196 0 means that it is not animating. > 0 means it is animating an iconify.
197 < 0 means it is animating a restore.
199 gint iconify_animation_going;
200 GTimeVal iconify_animation_end;
203 ObFrame *frame_new(struct _ObClient *c);
204 void frame_free(ObFrame *self);
206 void frame_show(ObFrame *self);
207 void frame_hide(ObFrame *self);
208 void frame_adjust_theme(ObFrame *self);
209 void frame_adjust_shape(ObFrame *self);
210 void frame_adjust_area(ObFrame *self, gboolean moved,
211 gboolean resized, gboolean fake);
212 void frame_adjust_client_area(ObFrame *self);
213 void frame_adjust_state(ObFrame *self);
214 void frame_adjust_focus(ObFrame *self, gboolean hilite);
215 void frame_adjust_title(ObFrame *self);
216 void frame_adjust_icon(ObFrame *self);
217 void frame_grab_client(ObFrame *self);
218 void frame_release_client(ObFrame *self);
220 ObFrameContext frame_context_from_string(const gchar *name);
222 ObFrameContext frame_context(struct _ObClient *self, Window win,
225 /*! Applies gravity to the client's position to find where the frame should
227 @return The proper coordinates for the frame, based on the client.
229 void frame_client_gravity(ObFrame *self, gint *x, gint *y);
231 /*! Reversly applies gravity to the frame's position to find where the client
232 should be positioned.
233 @return The proper coordinates for the client, based on the frame.
235 void frame_frame_gravity(ObFrame *self, gint *x, gint *y);
237 /*! Convert a rectangle in client coordinates/sizes to what it would be
238 for the frame, given its current decorations sizes */
239 void frame_rect_to_frame(ObFrame *self, Rect *r);
241 /*! Convert a rectangle in frame coordinates/sizes to what it would be for the
242 client, given its current decorations sizes */
243 void frame_rect_to_client(ObFrame *self, Rect *r);
245 void frame_flash_start(ObFrame *self);
246 void frame_flash_stop(ObFrame *self);
248 /*! Start an animation for iconifying or restoring a frame. The callback
249 will be called when the animation finishes. But if another animation is
250 started in the meantime, the callback will never get called. */
251 void frame_begin_iconify_animation(ObFrame *self, gboolean iconifying);
252 void frame_end_iconify_animation(ObFrame *self);
254 #define frame_iconify_animating(f) (f->iconify_animation_going != 0)