draw the handle without borders
[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 /*! The decorations the client window wants to be displayed on it */
60 typedef enum {
61     OB_FRAME_DECOR_TITLEBAR    = 1 << 0, /*!< Display a titlebar */
62     OB_FRAME_DECOR_HANDLE      = 1 << 1, /*!< Display a handle (bottom) */
63     OB_FRAME_DECOR_GRIPS       = 1 << 2, /*!< Display grips in the handle */
64     OB_FRAME_DECOR_BORDER      = 1 << 3, /*!< Display a border */
65     OB_FRAME_DECOR_ICON        = 1 << 4, /*!< Display the window's icon */
66     OB_FRAME_DECOR_ICONIFY     = 1 << 5, /*!< Display an iconify button */
67     OB_FRAME_DECOR_MAXIMIZE    = 1 << 6, /*!< Display a maximize button */
68     /*! Display a button to toggle the window's placement on
69       all desktops */
70     OB_FRAME_DECOR_ALLDESKTOPS = 1 << 7,
71     OB_FRAME_DECOR_SHADE       = 1 << 8, /*!< Displays a shade button */
72     OB_FRAME_DECOR_CLOSE       = 1 << 9  /*!< Display a close button */
73 } ObFrameDecorations;
74
75 struct _ObFrame
76 {
77     struct _ObClient *client;
78
79     Window    window;
80     Window    plate;
81
82     Strut     size;
83     Rect      area;
84     gboolean  visible;
85
86     guint     functions;
87     guint     decorations;
88     gboolean  max_horz;
89
90     Window    inner;  /*!< The window for drawing the inner client border */
91     Window    title;
92     Window    label;
93     Window    max;
94     Window    close;
95     Window    desk;
96     Window    shade;
97     Window    icon;
98     Window    iconify;
99     Window    handle;
100     Window    lgrip;
101     Window    rgrip;
102
103     /* These are borders of the frame and its elements */
104     Window    titleleft;
105     Window    titletop;
106     Window    titletopleft;
107     Window    titletopright;
108     Window    titleright;
109     Window    titlebottom;
110     Window    left;
111     Window    right;
112     Window    handleleft;
113     Window    handletop;
114     Window    handleright;
115     Window    handlebottom;
116     Window    lgriptop;
117     Window    lgripleft;
118     Window    lgripbottom;
119     Window    rgriptop;
120     Window    rgripright;
121     Window    rgripbottom;
122
123     /* These are resize handles inside the titlebar */
124     Window    topresize;
125     Window    tltresize;
126     Window    tllresize;
127     Window    trtresize;
128     Window    trrresize;
129
130     Colormap  colormap;
131
132     RrAppearance *a_unfocused_title;
133     RrAppearance *a_focused_title;
134     RrAppearance *a_unfocused_label;
135     RrAppearance *a_focused_label;
136     RrAppearance *a_icon;
137     RrAppearance *a_unfocused_handle;
138     RrAppearance *a_focused_handle;
139
140     GSList   *clients;
141
142     gint      icon_on;    /* if the window icon button is on */
143     gint      label_on;   /* if the window title is on */
144     gint      iconify_on; /* if the window iconify button is on */
145     gint      desk_on;    /* if the window all-desktops button is on */
146     gint      shade_on;   /* if the window shade button is on */
147     gint      max_on;     /* if the window maximize button is on */
148     gint      close_on;   /* if the window close button is on */
149
150     gint      width;         /* width of the titlebar and handle */
151     gint      label_width;   /* width of the label in the titlebar */
152     gint      icon_x;        /* x-position of the window icon button */
153     gint      label_x;       /* x-position of the window title */
154     gint      iconify_x;     /* x-position of the window iconify button */
155     gint      desk_x;        /* x-position of the window all-desktops button */
156     gint      shade_x;       /* x-position of the window shade button */
157     gint      max_x;         /* x-position of the window maximize button */
158     gint      close_x;       /* x-position of the window close button */
159     gint      bwidth;        /* border width */
160     gint      rbwidth;       /* border width between the title and client */
161     gint      cbwidth_x;     /* client border width */
162     gint      cbwidth_y;     /* client border width */
163
164     /* the leftmost and rightmost elements in the titlebar */
165     ObFrameContext leftmost;
166     ObFrameContext rightmost;
167
168     gboolean  max_press;
169     gboolean  close_press;
170     gboolean  desk_press;
171     gboolean  shade_press;
172     gboolean  iconify_press;
173     gboolean  max_hover;
174     gboolean  close_hover;
175     gboolean  desk_hover;
176     gboolean  shade_hover;
177     gboolean  iconify_hover;
178
179     gboolean  focused;
180
181     gboolean  flashing;
182     gboolean  flash_on;
183     GTimeVal  flash_end;
184
185     /*! Is the frame currently in an animation for iconify or restore.
186       0 means that it is not animating. > 0 means it is animating an iconify.
187       < 0 means it is animating a restore.
188     */
189     gint iconify_animation_going;
190     GTimeVal  iconify_animation_end;
191 };
192
193 ObFrame *frame_new(struct _ObClient *c);
194 void frame_free(ObFrame *self);
195
196 void frame_show(ObFrame *self);
197 void frame_hide(ObFrame *self);
198 void frame_adjust_theme(ObFrame *self);
199 void frame_adjust_shape(ObFrame *self);
200 void frame_adjust_area(ObFrame *self, gboolean moved,
201                        gboolean resized, gboolean fake);
202 void frame_adjust_client_area(ObFrame *self);
203 void frame_adjust_state(ObFrame *self);
204 void frame_adjust_focus(ObFrame *self, gboolean hilite);
205 void frame_adjust_title(ObFrame *self);
206 void frame_adjust_icon(ObFrame *self);
207 void frame_grab_client(ObFrame *self);
208 void frame_release_client(ObFrame *self);
209
210 ObFrameContext frame_context_from_string(const gchar *name);
211
212 ObFrameContext frame_context(struct _ObClient *self, Window win,
213                              gint x, gint y);
214
215 /*! Applies gravity to the client's position to find where the frame should
216   be positioned.
217   @return The proper coordinates for the frame, based on the client.
218 */
219 void frame_client_gravity(ObFrame *self, gint *x, gint *y, gint w, gint h);
220
221 /*! Reversly applies gravity to the frame's position to find where the client
222   should be positioned.
223     @return The proper coordinates for the client, based on the frame.
224 */
225 void frame_frame_gravity(ObFrame *self, gint *x, gint *y, gint w, gint h);
226
227 void frame_flash_start(ObFrame *self);
228 void frame_flash_stop(ObFrame *self);
229
230 /*! Start an animation for iconifying or restoring a frame. The callback
231   will be called when the animation finishes. But if another animation is
232   started in the meantime, the callback will never get called. */
233 void frame_begin_iconify_animation(ObFrame *self, gboolean iconifying);
234 void frame_end_iconify_animation(ObFrame *self);
235
236 #define frame_iconify_animating(f) (f->iconify_animation_going != 0)
237
238 #endif