ce1ff885019703dc5546071b480196cfd27aef2f
[dana/openbox.git] / openbox / config.h
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    config.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 __config_h
21 #define __config_h
22
23 #include "misc.h"
24 #include "stacking.h"
25 #include "place.h"
26 #include "client.h"
27 #include "geom.h"
28 #include "moveresize.h"
29 #include "obrender/render.h"
30 #include "obt/xml.h"
31
32 #include <glib.h>
33
34 typedef struct _ObAppSettings ObAppSettings;
35
36 struct _ObAppSettings
37 {
38     GPatternSpec *class;
39     GPatternSpec *name;
40     GPatternSpec *role;
41     GPatternSpec *group_class;
42     GPatternSpec *group_name;
43     GPatternSpec *title;
44     ObClientType  type;
45
46     GravityPoint position;
47     gboolean pos_given;
48     gboolean pos_force;
49
50     gint width_num;
51     gint width_denom;
52     gint height_num;
53     gint height_denom;
54
55     guint desktop;
56     gint shade;
57     gint decor;
58     gint focus;
59     ObPlaceMonitor monitor_type;
60     gint monitor;
61     gint iconic;
62     gint skip_pager;
63     gint skip_taskbar;
64     gint max_horz;
65     gint max_vert;
66     gint fullscreen;
67
68     gint layer;
69 };
70
71 /*! Should new windows be focused */
72 extern gboolean config_focus_new;
73 /*! Focus windows when the mouse enters them */
74 extern gboolean config_focus_follow;
75 /*! Timeout for focusing windows on focus follows mouse, in milliseconds */
76 extern guint    config_focus_delay;
77 /*! If windows should automatically be raised when they are focused in
78  focus follows mouse */
79 extern gboolean config_focus_raise;
80 /*! Focus the last focused window, not under the mouse, in follow mouse mode */
81 extern gboolean config_focus_last;
82 /*! Try keep focus on the window under the mouse when the mouse is not moving
83  */
84 extern gboolean config_focus_under_mouse;
85 /*! Remove focus from windows when the mouse leaves them
86  */
87 extern gboolean config_unfocus_leave;
88
89 /*! The algorithm to use for placing new windows */
90 extern ObPlacePolicy config_place_policy;
91 /*! Place windows on the active monitor (unless they are part of an application
92   already on another monitor) */
93 extern ObPlaceMonitor config_place_monitor;
94
95 /*! Place dialogs and stuff on this monitor.  Index starts at 1.  If this is
96   0, then use the config_primary_monitor instead. */
97 extern guint config_primary_monitor_index;
98 /*! Where to place dialogs and stuff if it is not specified by index. */
99 extern ObPlaceMonitor config_primary_monitor;
100
101 /*! User-specified margins around the edge of the screen(s) */
102 extern StrutPartial config_margins;
103
104 /*! When true windows' contents are refreshed while they are resized; otherwise
105   they are not updated until the resize is complete */
106 extern gboolean config_resize_redraw;
107 /*! show move/resize popups? 0 = no, 1 = always, 2 = only
108   resizing !1 increments */
109 extern gint config_resize_popup_show;
110 /*! where to show the resize popup */
111 extern ObResizePopupPos config_resize_popup_pos;
112 /*! where to place the popup if it's in a fixed position */
113 extern GravityPoint config_resize_popup_fixed;
114
115 /*! The stacking layer the dock will reside in */
116 extern ObStackingLayer config_dock_layer;
117 /*! Is the dock floating */
118 extern gboolean config_dock_floating;
119 /*! Don't use a strut for the dock */
120 extern gboolean config_dock_nostrut;
121 /*! Where to place the dock if not floating */
122 extern ObDirection config_dock_pos;
123 /*! If config_dock_floating, this is the top-left corner's
124   position */
125 extern gint config_dock_x;
126 /*! If config_dock_floating, this is the top-left corner's
127   position */
128 extern gint config_dock_y;
129 /*! Whether the dock places the dockapps in it horizontally or vertically */
130 extern ObOrientation config_dock_orient;
131 /*! Whether to auto-hide the dock when the pointer is not over it */
132 extern gboolean config_dock_hide;
133 /*! The number of milliseconds to wait before hiding the dock */
134 extern guint config_dock_hide_delay;
135 /*! The number of milliseconds to wait before showing the dock */
136 extern guint config_dock_show_delay;
137 /*! The mouse button to be used to move dock apps */
138 extern guint config_dock_app_move_button;
139 /*! The modifiers to be used with the button to move dock apps */
140 extern guint config_dock_app_move_modifiers;
141
142 /*! The name of the theme */
143 extern gchar *config_theme;
144
145 /*! Show the one-pixel border after toggleDecor */
146 extern gboolean config_theme_keepborder;
147 /*! Titlebar button layout */
148 extern gchar *config_title_layout;
149 /*! Animate windows iconifying and restoring */
150 extern gboolean config_animate_iconify;
151 /*! Size of icons in focus switching dialogs */
152 extern guint config_theme_window_list_icon_size;
153
154 /*! The font for the active window's title */
155 extern RrFont *config_font_activewindow;
156 /*! The font for inactive windows' titles */
157 extern RrFont *config_font_inactivewindow;
158 /*! The font for menu titles */
159 extern RrFont *config_font_menutitle;
160 /*! The font for menu items */
161 extern RrFont *config_font_menuitem;
162 /*! The font for on-screen-displays/popups' active text */
163 extern RrFont *config_font_activeosd;
164 /*! The font for on-screen-displays/popups' inactive text */
165 extern RrFont *config_font_inactiveosd;
166
167 /*! The number of desktops */
168 extern guint config_desktops_num;
169 /*! Desktop to start on, put 5 to start in the center of a 3x3 grid */
170 extern guint config_screen_firstdesk;
171 /*! Names for the desktops */
172 extern GSList *config_desktops_names;
173 /*! Amount of time to show the desktop switch dialog */
174 extern guint config_desktop_popup_time;
175
176 /*! The keycode of the key combo which resets the keybaord chains */
177 extern guint config_keyboard_reset_keycode;
178 /*! The modifiers of the key combo which resets the keybaord chains */
179 extern guint config_keyboard_reset_state;
180
181 /*! Number of pixels a drag must go before being considered a drag */
182 extern gint config_mouse_threshold;
183 /*! Number of milliseconds within which 2 clicks must occur to be a
184   double-click */
185 extern gint config_mouse_dclicktime;
186 /*! Number of milliseconds that the mouse has to be on the screen edge before
187   a screen edge event is triggered */
188 extern gint config_mouse_screenedgetime;
189 /*! When TRUE, the mouse is warped to the other side of the desktop after
190   switching desktops from bumping the screen edge */
191 extern gboolean config_mouse_screenedgewarp;
192
193 /*! Number of pixels to resist while crossing another window's edge */
194 extern gint config_resist_win;
195 /*! Number of pixels to resist while crossing a screen's edge */
196 extern gint config_resist_edge;
197
198 /*! Delay for hiding menu when opening in milliseconds */
199 extern guint    config_menu_hide_delay;
200 /*! Center menus vertically about the parent entry */
201 extern gboolean config_menu_middle;
202 /*! Delay before opening a submenu in milliseconds */
203 extern guint    config_submenu_show_delay;
204 /*! Delay before closing a submenu in milliseconds */
205 extern guint    config_submenu_hide_delay;
206 /*! Show manage desktops in client_list_menu */
207 extern gboolean config_menu_manage_desktops;
208 /*! Load & show icons in user-defined menus */
209 extern gboolean config_menu_show_icons;
210 /*! User-specified menu files */
211 extern GSList *config_menu_files;
212 /*! Per app settings */
213 extern GSList *config_per_app_settings;
214
215 void config_startup(ObtXmlInst *i);
216 void config_shutdown(void);
217
218 /*! Create an ObAppSettings structure with the default values */
219 ObAppSettings* config_create_app_settings(void);
220 /*! Copies any settings in src to dest, if they are their default value in
221   src. */
222 void config_app_settings_copy_non_defaults(const ObAppSettings *src,
223                                            ObAppSettings *dest);
224 /*! Parses an x geometry style position, with some extensions like ratios
225   and percentages */
226 void config_parse_gravity_coord(xmlNodePtr node, GravityCoord *c);
227 /*! Parses a rational number or percentage into num and denom */
228 void config_parse_relative_number(gchar *s, gint *num, gint *denom);
229
230 #endif