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     Point position;
  43     gboolean center_x;
  44     gboolean center_y;
  45     gboolean opposite_x;
  46     gboolean opposite_y;
  47     gboolean pos_given;
  48
  49     guint desktop;
  50     gint shade;
  51     gint decor;
  52     gint focus;
  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
  79 /*! The algorithm to use for placing new windows */
  80 extern ObPlacePolicy config_place_policy;
  81 /*! Place windows in the center of the free area */
  82 extern gboolean config_place_center;
  83 /*! Place windows on the active monitor (unless they are part of an application
  84   already on another monitor) */
  85 extern gboolean config_place_active;
  86
  87 /*! User-specified margins around the edge of the screen(s) */
  88 extern StrutPartial config_margins;
  89
  90 /*! When true windows' contents are refreshed while they are resized; otherwise
  91   they are not updated until the resize is complete */
  92 extern gboolean config_resize_redraw;
  93 /*! show move/resize popups? 0 = no, 1 = always, 2 = only
  94   resizing !1 increments */
  95 extern gint config_resize_popup_show;
  96 /*! where to show the resize popup */
  97 extern ObResizePopupPos config_resize_popup_pos;
  98 /*! if the resize popup should be centered horizontally if it is being
  99   placed in a fixed position */
 100 extern gboolean config_resize_popup_x_center;
 101 /*! if the resize popup should be centered vertically if it is being
 102   placed in a fixed position */
 103 extern gboolean config_resize_popup_y_center;
 104 /*! if the resize popup should be placed from the right side of the screen when
 105   placed in a fixed position */
 106 extern gboolean config_resize_popup_x_opposite;
 107 /*! if the resize popup should be placed from the bottom side of the screen
 108   when placed in a fixed position */
 109 extern gboolean config_resize_popup_y_opposite;
 110 /*! where the resize popup should be if it is placed in a fixed position */
 111 extern gint config_resize_popup_x;
 112 /*! where the resize popup should be if it is placed in a fixed position */
 113 extern gint config_resize_popup_y;
 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
 152 /*! The font for the active window's title */
 153 extern RrFont *config_font_activewindow;
 154 /*! The font for inactive windows' titles */
 155 extern RrFont *config_font_inactivewindow;
 156 /*! The font for menu titles */
 157 extern RrFont *config_font_menutitle;
 158 /*! The font for menu items */
 159 extern RrFont *config_font_menuitem;
 160 /*! The font for on-screen-displays/popups */
 161 extern RrFont *config_font_osd;
 162
 163 /*! The number of desktops */
 164 extern gint config_desktops_num;
 165 /*! Desktop to start on, put 5 to start in the center of a 3x3 grid */
 166 extern guint config_screen_firstdesk;
 167 /*! Names for the desktops */
 168 extern GSList *config_desktops_names;
 169 /*! Amount of time to show the desktop switch dialog */
 170 extern guint config_desktop_popup_time;
 171
 172 /*! The keycode of the key combo which resets the keybaord chains */
 173 extern guint config_keyboard_reset_keycode;
 174 /*! The modifiers of the key combo which resets the keybaord chains */
 175 extern guint config_keyboard_reset_state;
 176
 177 /*! Number of pixels a drag must go before being considered a drag */
 178 extern gint config_mouse_threshold;
 179 /*! Number of milliseconds within which 2 clicks must occur to be a
 180   double-click */
 181 extern gint config_mouse_dclicktime;
 182 /*! Number of milliseconds that the mouse has to be on the screen edge before
 183   a screen edge event is triggered */
 184 extern gint config_mouse_screenedgetime;
 185
 186 /*! Number of pixels to resist while crossing another window's edge */
 187 extern gint config_resist_win;
 188 /*! Number of pixels to resist while crossing a screen's edge */
 189 extern gint config_resist_edge;
 190
 191 /*! Delay for hiding menu when opening in milliseconds */
 192 extern guint    config_menu_hide_delay;
 193 /*! Center menus vertically about the parent entry */
 194 extern gboolean config_menu_middle;
 195 /*! Delay before opening a submenu in milliseconds */
 196 extern guint    config_submenu_show_delay;
 197 /*! show icons in client_list_menu */
 198 extern gboolean config_menu_client_list_icons;
 199 /*! User-specified menu files */
 200 extern GSList *config_menu_files;
 201 /*! Per app settings */
 202 extern GSList *config_per_app_settings;
 203
 204 void config_startup(struct _ObParseInst *i);
 205 void config_shutdown();
 206
 207 /*! Create an ObAppSettings structure with the default values */
 208 ObAppSettings* config_create_app_settings();
 209 /*! Copies any settings in src to dest, if they are their default value in
 210   src. */
 211 void config_app_settings_copy_non_defaults(const ObAppSettings *src,
 212                                            ObAppSettings *dest);
 213
 214
 215 #endif