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