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