Don't need to explicitly check for xft.
[mikachu/openbox.git] / openbox / frame.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    frame.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 __frame_h
21 #define __frame_h
22
23 #include "geom.h"
24 #include "render/render.h"
25
26 typedef struct _ObFrame ObFrame;
27
28 struct _ObClient;
29
30 typedef void (*ObFrameIconifyAnimateFunc)(gpointer data);
31
32 typedef enum {
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,
43     OB_FRAME_CONTEXT_TOP,
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
54       a move/resize */
55     OB_FRAME_CONTEXT_MOVE_RESIZE,
56     OB_FRAME_NUM_CONTEXTS
57 } ObFrameContext;
58
59 #define FRAME_CONTEXT(co, cl) ((cl && cl->type != OB_CLIENT_TYPE_DESKTOP) ? \
60                                co == OB_FRAME_CONTEXT_FRAME : FALSE)
61 #define CLIENT_CONTEXT(co, cl) ((cl && cl->type == OB_CLIENT_TYPE_DESKTOP) ? \
62                                 co == OB_FRAME_CONTEXT_DESKTOP : \
63                                 co == OB_FRAME_CONTEXT_CLIENT)
64
65 /*! The decorations the client window wants to be displayed on it */
66 typedef enum {
67     OB_FRAME_DECOR_TITLEBAR    = 1 << 0, /*!< Display a titlebar */
68     OB_FRAME_DECOR_HANDLE      = 1 << 1, /*!< Display a handle (bottom) */
69     OB_FRAME_DECOR_GRIPS       = 1 << 2, /*!< Display grips in the handle */
70     OB_FRAME_DECOR_BORDER      = 1 << 3, /*!< Display a border */
71     OB_FRAME_DECOR_ICON        = 1 << 4, /*!< Display the window's icon */
72     OB_FRAME_DECOR_ICONIFY     = 1 << 5, /*!< Display an iconify button */
73     OB_FRAME_DECOR_MAXIMIZE    = 1 << 6, /*!< Display a maximize button */
74     /*! Display a button to toggle the window's placement on
75       all desktops */
76     OB_FRAME_DECOR_ALLDESKTOPS = 1 << 7,
77     OB_FRAME_DECOR_SHADE       = 1 << 8, /*!< Display a shade button */
78     OB_FRAME_DECOR_CLOSE       = 1 << 9  /*!< Display a close button */
79 } ObFrameDecorations;
80
81 struct _ObFrame
82 {
83     struct _ObClient *client;
84
85     Window    window;
86
87     Strut     size;
88     Rect      area;
89     gboolean  visible;
90
91     guint     functions;
92     guint     decorations;
93
94     Window    title;
95     Window    label;
96     Window    max;
97     Window    close;
98     Window    desk;
99     Window    shade;
100     Window    icon;
101     Window    iconify;
102     Window    handle;
103     Window    lgrip;
104     Window    rgrip;
105
106     /* These are borders of the frame and its elements */
107     Window    titleleft;
108     Window    titletop;
109     Window    titletopleft;
110     Window    titletopright;
111     Window    titleright;
112     Window    titlebottom;
113     Window    left;
114     Window    right;
115     Window    handleleft;
116     Window    handletop;
117     Window    handleright;
118     Window    handlebottom;
119     Window    lgriptop;
120     Window    lgripleft;
121     Window    lgripbottom;
122     Window    rgriptop;
123     Window    rgripright;
124     Window    rgripbottom;
125     Window    innerleft;    /*!< For drawing the inner client border */
126     Window    innertop;     /*!< For drawing the inner client border */
127     Window    innerright;   /*!< For drawing the inner client border */
128     Window    innerbottom;  /*!< For drawing the inner client border */
129     Window    innerblb;
130     Window    innerbll;
131     Window    innerbrb;
132     Window    innerbrr;
133     Window    backback;     /*!< A colored window shown while resizing */
134     Window    backfront;    /*!< An undrawn-in window, to prevent flashing on
135                                  unmap */
136
137     /* These are resize handles inside the titlebar */
138     Window    topresize;
139     Window    tltresize;
140     Window    tllresize;
141     Window    trtresize;
142     Window    trrresize;
143
144     Colormap  colormap;
145
146     gint      icon_on;    /* if the window icon button is on */
147     gint      label_on;   /* if the window title is on */
148     gint      iconify_on; /* if the window iconify button is on */
149     gint      desk_on;    /* if the window all-desktops button is on */
150     gint      shade_on;   /* if the window shade button is on */
151     gint      max_on;     /* if the window maximize button is on */
152     gint      close_on;   /* if the window close button is on */
153
154     gint      width;         /* width of the titlebar and handle */
155     gint      label_width;   /* width of the label in the titlebar */
156     gint      icon_x;        /* x-position of the window icon button */
157     gint      label_x;       /* x-position of the window title */
158     gint      iconify_x;     /* x-position of the window iconify button */
159     gint      desk_x;        /* x-position of the window all-desktops button */
160     gint      shade_x;       /* x-position of the window shade button */
161     gint      max_x;         /* x-position of the window maximize button */
162     gint      close_x;       /* x-position of the window close button */
163     gint      bwidth;        /* border width */
164     gint      cbwidth_l;     /* client border width */
165     gint      cbwidth_t;     /* client border width */
166     gint      cbwidth_r;     /* client border width */
167     gint      cbwidth_b;     /* client border width */
168     gboolean  max_horz;      /* when maxed some decorations are hidden */
169     gboolean  max_vert;      /* when maxed some decorations are hidden */
170     gboolean  shaded;        /* decorations adjust when shaded */
171
172     /* the leftmost and rightmost elements in the titlebar */
173     ObFrameContext leftmost;
174     ObFrameContext rightmost;
175
176     gboolean  max_press;
177     gboolean  close_press;
178     gboolean  desk_press;
179     gboolean  shade_press;
180     gboolean  iconify_press;
181     gboolean  max_hover;
182     gboolean  close_hover;
183     gboolean  desk_hover;
184     gboolean  shade_hover;
185     gboolean  iconify_hover;
186
187     gboolean  focused;
188     gboolean  need_render;
189
190     gboolean  flashing;
191     gboolean  flash_on;
192     GTimeVal  flash_end;
193
194     /*! Is the frame currently in an animation for iconify or restore.
195       0 means that it is not animating. > 0 means it is animating an iconify.
196       < 0 means it is animating a restore.
197     */
198     gint iconify_animation_going;
199     GTimeVal  iconify_animation_end;
200 };
201
202 ObFrame *frame_new(struct _ObClient *c);
203 void frame_free(ObFrame *self);
204
205 void frame_show(ObFrame *self);
206 void frame_hide(ObFrame *self);
207 void frame_adjust_theme(ObFrame *self);
208 void frame_adjust_shape(ObFrame *self);
209 void frame_adjust_area(ObFrame *self, gboolean moved,
210                        gboolean resized, gboolean fake);
211 void frame_adjust_client_area(ObFrame *self);
212 void frame_adjust_state(ObFrame *self);
213 void frame_adjust_focus(ObFrame *self, gboolean hilite);
214 void frame_adjust_title(ObFrame *self);
215 void frame_adjust_icon(ObFrame *self);
216 void frame_grab_client(ObFrame *self);
217 void frame_release_client(ObFrame *self);
218
219 ObFrameContext frame_context_from_string(const gchar *name);
220
221 ObFrameContext frame_context(struct _ObClient *self, Window win,
222                              gint x, gint y);
223
224 /*! Applies gravity to the client's position to find where the frame should
225   be positioned.
226   @return The proper coordinates for the frame, based on the client.
227 */
228 void frame_client_gravity(ObFrame *self, gint *x, gint *y);
229
230 /*! Reversly applies gravity to the frame's position to find where the client
231   should be positioned.
232     @return The proper coordinates for the client, based on the frame.
233 */
234 void frame_frame_gravity(ObFrame *self, gint *x, gint *y);
235
236 /*! Convert a rectangle in client coordinates/sizes to what it would be
237   for the frame, given its current decorations sizes */
238 void frame_rect_to_frame(ObFrame *self, Rect *r);
239
240 /*! Convert a rectangle in frame coordinates/sizes to what it would be for the
241   client, given its current decorations sizes */
242 void frame_rect_to_client(ObFrame *self, Rect *r);
243
244 void frame_flash_start(ObFrame *self);
245 void frame_flash_stop(ObFrame *self);
246
247 /*! Start an animation for iconifying or restoring a frame. The callback
248   will be called when the animation finishes. But if another animation is
249   started in the meantime, the callback will never get called. */
250 void frame_begin_iconify_animation(ObFrame *self, gboolean iconifying);
251 void frame_end_iconify_animation(ObFrame *self);
252
253 #define frame_iconify_animating(f) (f->iconify_animation_going != 0)
254
255 #endif