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