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