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_CLIENT,
36 OB_FRAME_CONTEXT_TITLEBAR,
37 OB_FRAME_CONTEXT_HANDLE,
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,
43 OB_FRAME_CONTEXT_MAXIMIZE,
44 OB_FRAME_CONTEXT_ALLDESKTOPS,
45 OB_FRAME_CONTEXT_SHADE,
46 OB_FRAME_CONTEXT_ICONIFY,
47 OB_FRAME_CONTEXT_ICON,
48 OB_FRAME_CONTEXT_CLOSE,
49 /*! This is a special context, which occurs while dragging a window in
51 OB_FRAME_CONTEXT_MOVE_RESIZE,
55 /*! The decorations the client window wants to be displayed on it */
57 OB_FRAME_DECOR_TITLEBAR = 1 << 0, /*!< Display a titlebar */
58 OB_FRAME_DECOR_HANDLE = 1 << 1, /*!< Display a handle (bottom) */
59 OB_FRAME_DECOR_GRIPS = 1 << 2, /*!< Display grips in the handle */
60 OB_FRAME_DECOR_BORDER = 1 << 3, /*!< Display a border */
61 OB_FRAME_DECOR_ICON = 1 << 4, /*!< Display the window's icon */
62 OB_FRAME_DECOR_ICONIFY = 1 << 5, /*!< Display an iconify button */
63 OB_FRAME_DECOR_MAXIMIZE = 1 << 6, /*!< Display a maximize button */
64 /*! Display a button to toggle the window's placement on
66 OB_FRAME_DECOR_ALLDESKTOPS = 1 << 7,
67 OB_FRAME_DECOR_SHADE = 1 << 8, /*!< Displays a shade button */
68 OB_FRAME_DECOR_CLOSE = 1 << 9 /*!< Display a close button */
73 struct _ObClient *client;
85 Window inner; /*!< The window for drawing the inner client border */
105 RrAppearance *a_unfocused_title;
106 RrAppearance *a_focused_title;
107 RrAppearance *a_unfocused_label;
108 RrAppearance *a_focused_label;
109 RrAppearance *a_icon;
110 RrAppearance *a_unfocused_handle;
111 RrAppearance *a_focused_handle;
117 gint width; /* title and handle */
119 gint icon_x; /* x-position of the window icon button */
120 gint label_x; /* x-position of the window title */
121 gint iconify_x; /* x-position of the window iconify button */
122 gint desk_x; /* x-position of the window all-desktops button */
123 gint shade_x; /* x-position of the window shade button */
124 gint max_x; /* x-position of the window maximize button */
125 gint close_x; /* x-position of the window close button */
126 gint bwidth; /* border width */
127 gint rbwidth; /* title border width */
128 gint cbwidth_x; /* client border width */
129 gint cbwidth_y; /* client border width */
132 gboolean close_press;
134 gboolean shade_press;
135 gboolean iconify_press;
137 gboolean close_hover;
139 gboolean shade_hover;
140 gboolean iconify_hover;
148 /*! The step which the client is currently in for animating iconify and
150 0 means that it is not animating. FRAME_ANIMATE_ICONIFY_STEPS is the
151 first step for iconifying, and -FRAME_ANIMATE_ICONIFY_STEPS is the
152 forst step for restoring. It counts towards 0 either way. Visually,
153 +x == -(FRAME_ANIMATE_ICONIFY_STEPS-x+1)
155 gint iconify_animation_step;
156 ObFrameIconifyAnimateFunc iconify_animation_cb;
157 gpointer iconify_animation_data;
160 ObFrame *frame_new(struct _ObClient *c);
161 void frame_show(ObFrame *self);
162 void frame_hide(ObFrame *self);
163 void frame_adjust_theme(ObFrame *self);
164 void frame_adjust_shape(ObFrame *self);
165 void frame_adjust_area(ObFrame *self, gboolean moved,
166 gboolean resized, gboolean fake);
167 void frame_adjust_client_area(ObFrame *self);
168 void frame_adjust_state(ObFrame *self);
169 void frame_adjust_focus(ObFrame *self, gboolean hilite);
170 void frame_adjust_title(ObFrame *self);
171 void frame_adjust_icon(ObFrame *self);
172 void frame_grab_client(ObFrame *self, struct _ObClient *client);
173 void frame_release_client(ObFrame *self, struct _ObClient *client);
175 ObFrameContext frame_context_from_string(const gchar *name);
177 ObFrameContext frame_context(struct _ObClient *self, Window win);
179 /*! Applies gravity to the client's position to find where the frame should
181 @return The proper coordinates for the frame, based on the client.
183 void frame_client_gravity(ObFrame *self, gint *x, gint *y, gint w, gint h);
185 /*! Reversly applies gravity to the frame's position to find where the client
186 should be positioned.
187 @return The proper coordinates for the client, based on the frame.
189 void frame_frame_gravity(ObFrame *self, gint *x, gint *y, gint w, gint h);
191 void frame_flash_start(ObFrame *self);
192 void frame_flash_stop(ObFrame *self);
194 /*! Start an animation for iconifying or restoring a frame. The callback
195 will be called when the animation finishes. But if another animation is
196 started in the meantime, the callback will never get called. */
197 void frame_begin_iconify_animation(ObFrame *self, gboolean iconifying,
198 ObFrameIconifyAnimateFunc callback,