update openbox to use the current parser interface in libobt
[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 "geom.h"
27 #include "moveresize.h"
28 #include "render/render.h"
29 #include "obt/parse.h"
30
31 #include <glib.h>
32
33 typedef struct _ObAppSettings ObAppSettings;
34
35 struct _ObAppSettings
36 {
37     GPatternSpec *class;
38     GPatternSpec *name;
39     GPatternSpec *role;
40
41     GravityPoint position;
42     gboolean pos_given;
43
44     guint desktop;
45     gint shade;
46     gint decor;
47     gint focus;
48     gint monitor;
49     gint iconic;
50     gint skip_pager;
51     gint skip_taskbar;
52     gint max_horz;
53     gint max_vert;
54     gint fullscreen;
55
56     gint layer;
57 };
58
59 /*! Should new windows be focused */
60 extern gboolean config_focus_new;
61 /*! Focus windows when the mouse enters them */
62 extern gboolean config_focus_follow;
63 /*! Timeout for focusing windows on focus follows mouse, in milliseconds */
64 extern guint    config_focus_delay;
65 /*! If windows should automatically be raised when they are focused in
66  focus follows mouse */
67 extern gboolean config_focus_raise;
68 /*! Focus the last focused window, not under the mouse, in follow mouse mode */
69 extern gboolean config_focus_last;
70 /*! Try keep focus on the window under the mouse when the mouse is not moving
71  */
72 extern gboolean config_focus_under_mouse;
73
74 /*! The algorithm to use for placing new windows */
75 extern ObPlacePolicy config_place_policy;
76 /*! Place windows in the center of the free area */
77 extern gboolean config_place_center;
78 /*! Place windows on the active monitor (unless they are part of an application
79   already on another monitor) */
80 extern gboolean config_place_active;
81
82 /*! User-specified margins around the edge of the screen(s) */
83 extern StrutPartial config_margins;
84
85 /*! When true windows' contents are refreshed while they are resized; otherwise
86   they are not updated until the resize is complete */
87 extern gboolean config_resize_redraw;
88 /*! show move/resize popups? 0 = no, 1 = always, 2 = only
89   resizing !1 increments */
90 extern gint config_resize_popup_show;
91 /*! where to show the resize popup */
92 extern ObResizePopupPos config_resize_popup_pos;
93 /*! where to place the popup if it's in a fixed position */
94 extern GravityPoint config_resize_popup_fixed;
95
96 /*! The stacking layer the dock will reside in */
97 extern ObStackingLayer config_dock_layer;
98 /*! Is the dock floating */
99 extern gboolean config_dock_floating;
100 /*! Don't use a strut for the dock */
101 extern gboolean config_dock_nostrut;
102 /*! Where to place the dock if not floating */
103 extern ObDirection config_dock_pos;
104 /*! If config_dock_floating, this is the top-left corner's
105   position */
106 extern gint config_dock_x;
107 /*! If config_dock_floating, this is the top-left corner's
108   position */
109 extern gint config_dock_y;
110 /*! Whether the dock places the dockapps in it horizontally or vertically */
111 extern ObOrientation config_dock_orient;
112 /*! Whether to auto-hide the dock when the pointer is not over it */
113 extern gboolean config_dock_hide;
114 /*! The number of milliseconds to wait before hiding the dock */
115 extern guint config_dock_hide_delay;
116 /*! The number of milliseconds to wait before showing the dock */
117 extern guint config_dock_show_delay;
118 /*! The mouse button to be used to move dock apps */
119 extern guint config_dock_app_move_button;
120 /*! The modifiers to be used with the button to move dock apps */
121 extern guint config_dock_app_move_modifiers;
122
123 /*! The name of the theme */
124 extern gchar *config_theme;
125
126 /*! Show the one-pixel border after toggleDecor */
127 extern gboolean config_theme_keepborder;
128 /*! Titlebar button layout */
129 extern gchar *config_title_layout;
130 /*! Animate windows iconifying and restoring */
131 extern gboolean config_animate_iconify;
132
133 /*! The font for the active window's title */
134 extern RrFont *config_font_activewindow;
135 /*! The font for inactive windows' titles */
136 extern RrFont *config_font_inactivewindow;
137 /*! The font for menu titles */
138 extern RrFont *config_font_menutitle;
139 /*! The font for menu items */
140 extern RrFont *config_font_menuitem;
141 /*! The font for on-screen-displays/popups */
142 extern RrFont *config_font_osd;
143
144 /*! The number of desktops */
145 extern gint config_desktops_num;
146 /*! Desktop to start on, put 5 to start in the center of a 3x3 grid */
147 extern guint config_screen_firstdesk;
148 /*! Names for the desktops */
149 extern GSList *config_desktops_names;
150 /*! Amount of time to show the desktop switch dialog */
151 extern guint config_desktop_popup_time;
152
153 /*! The keycode of the key combo which resets the keybaord chains */
154 extern guint config_keyboard_reset_keycode;
155 /*! The modifiers of the key combo which resets the keybaord chains */
156 extern guint config_keyboard_reset_state;
157
158 /*! Number of pixels a drag must go before being considered a drag */
159 extern gint config_mouse_threshold;
160 /*! Number of milliseconds within which 2 clicks must occur to be a
161   double-click */
162 extern gint config_mouse_dclicktime;
163 /*! Number of milliseconds that the mouse has to be on the screen edge before
164   a screen edge event is triggered */
165 extern gint config_mouse_screenedgetime;
166
167 /*! Number of pixels to resist while crossing another window's edge */
168 extern gint config_resist_win;
169 /*! Number of pixels to resist while crossing a screen's edge */
170 extern gint config_resist_edge;
171
172 /*! Delay for hiding menu when opening in milliseconds */
173 extern guint    config_menu_hide_delay;
174 /*! Center menus vertically about the parent entry */
175 extern gboolean config_menu_middle;
176 /*! Delay before opening a submenu in milliseconds */
177 extern guint    config_submenu_show_delay;
178 /*! show icons in client_list_menu */
179 extern gboolean config_menu_client_list_icons;
180 /*! User-specified menu files */
181 extern GSList *config_menu_files;
182 /*! Per app settings */
183 extern GSList *config_per_app_settings;
184
185 void config_startup(ObtParseInst *i);
186 void config_shutdown();
187
188 /*! Create an ObAppSettings structure with the default values */
189 ObAppSettings* config_create_app_settings();
190 /*! Copies any settings in src to dest, if they are their default value in
191   src. */
192 void config_app_settings_copy_non_defaults(const ObAppSettings *src,
193                                            ObAppSettings *dest);
194
195
196 #endif