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