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