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