yay. way way cleaner code for iconify animations. let people show/hide the frame...
[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_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
50       a move/resize */
51     OB_FRAME_CONTEXT_MOVE_RESIZE,
52     OB_FRAME_NUM_CONTEXTS
53 } ObFrameContext;
54
55 /*! The decorations the client window wants to be displayed on it */
56 typedef enum {
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
65       all desktops */
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 */
69 } ObFrameDecorations;
70
71 struct _ObFrame
72 {
73     struct _ObClient *client;
74
75     Window    window;
76     Window    plate;
77
78     Strut     size;
79     Rect      area;
80     gboolean  visible;
81
82     guint     decorations;
83     gboolean  max_horz;
84
85     Window    inner;  /*!< The window for drawing the inner client border */
86     Window    title;
87     Window    label;
88     Window    max;
89     Window    close;
90     Window    desk;
91     Window    shade;
92     Window    icon;
93     Window    iconify;
94     Window    handle;
95     Window    lgrip;
96     Window    rgrip;
97
98     Window    tltresize;
99     Window    tllresize;
100     Window    trtresize;
101     Window    trrresize;
102
103     Colormap  colormap;
104
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;
112
113     Strut     innersize;
114
115     GSList   *clients;
116
117     gint      width;         /* title and handle */
118     gint      label_width;
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 */
130
131     gboolean  max_press;
132     gboolean  close_press;
133     gboolean  desk_press;
134     gboolean  shade_press;
135     gboolean  iconify_press;
136     gboolean  max_hover;
137     gboolean  close_hover;
138     gboolean  desk_hover;
139     gboolean  shade_hover;
140     gboolean  iconify_hover;
141
142     gboolean  focused;
143
144     gboolean  flashing;
145     gboolean  flash_on;
146     GTimeVal  flash_end;
147
148     /*! Is the frame currently in an animation for iconify or restore.
149       0 means that it is not animating. > 0 means it is animating an iconify.
150       < 0 means it is animating a restore.
151     */
152     gint iconify_animation_going;
153     GTimeVal  iconify_animation_end;
154 };
155
156 ObFrame *frame_new(struct _ObClient *c);
157 void frame_show(ObFrame *self);
158 void frame_hide(ObFrame *self);
159 void frame_adjust_theme(ObFrame *self);
160 void frame_adjust_shape(ObFrame *self);
161 void frame_adjust_area(ObFrame *self, gboolean moved,
162                        gboolean resized, gboolean fake);
163 void frame_adjust_client_area(ObFrame *self);
164 void frame_adjust_state(ObFrame *self);
165 void frame_adjust_focus(ObFrame *self, gboolean hilite);
166 void frame_adjust_title(ObFrame *self);
167 void frame_adjust_icon(ObFrame *self);
168 void frame_grab_client(ObFrame *self, struct _ObClient *client);
169 void frame_release_client(ObFrame *self, struct _ObClient *client);
170
171 ObFrameContext frame_context_from_string(const gchar *name);
172
173 ObFrameContext frame_context(struct _ObClient *self, Window win);
174
175 /*! Applies gravity to the client's position to find where the frame should
176   be positioned.
177   @return The proper coordinates for the frame, based on the client.
178 */
179 void frame_client_gravity(ObFrame *self, gint *x, gint *y, gint w, gint h);
180
181 /*! Reversly applies gravity to the frame's position to find where the client
182   should be positioned.
183     @return The proper coordinates for the client, based on the frame.
184 */
185 void frame_frame_gravity(ObFrame *self, gint *x, gint *y, gint w, gint h);
186
187 void frame_flash_start(ObFrame *self);
188 void frame_flash_stop(ObFrame *self);
189
190 /*! Start an animation for iconifying or restoring a frame. The callback
191   will be called when the animation finishes. But if another animation is
192   started in the meantime, the callback will never get called. */
193 void frame_begin_iconify_animation(ObFrame *self, gboolean iconifying);
194 void frame_end_iconify_animation(ObFrame *self);
195
196 #define frame_iconify_animating(f) (f->iconify_animation_going != 0)
197
198 #endif