WPrefs.app/WPrefs.h

   1 /* WPrefs.h- general definitions
   2  *
   3  *  WPrefs - Window Maker Preferences Program
   4  *
   5  *  Copyright (c) 1998-2003 Alfredo K. Kojima
   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  *  You should have received a copy of the GNU General Public License along
  18  *  with this program; if not, write to the Free Software Foundation, Inc.,
  19  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #ifndef WPREFS_H_
  23 #define WPREFS_H_
  24
  25 #include <stdlib.h>
  26 #include <stdio.h>
  27 #include <string.h>
  28 #include <strings.h>
  29 #include <signal.h>
  30
  31 #include <X11/Xlib.h>
  32
  33 #include <wraster.h>
  34
  35 #include <WINGs/WINGs.h>
  36
  37 /* Needed for HAVE_LIBINTL_H and EXTENDED_WINDOWSHORTCUT */
  38 #include "../src/wconfig.h"
  39
  40 /*
  41  * The macro 'wlengthof' should be used as much as possible, this macro
  42  * is reserved for the cases where wlengthof cannot be used because the
  43  * static_assert. Typical symptom is this compiler error (gcc):
  44  *
  45  *   error: braced-group within expression allowed only inside a function
  46  *
  47  * which appears when you try to create an array whose size is determined using
  48  * wlengthof on some other array.
  49  */
  50 #define wlengthof_nocheck(array)  \
  51         (sizeof(array) / sizeof(array[0]))
  52
  53
  54 /****/
  55
  56 extern char *NOptionValueChanged;
  57 extern Bool xext_xkb_supported;
  58
  59 typedef struct _Panel Panel;
  60
  61 typedef struct {
  62     unsigned flags;                    /* reserved for WPrefs.c Don't access it */
  63
  64     void (*createWidgets)(Panel*);     /* called when showing for first time */
  65     void (*updateDomain)(Panel*);      /* save the changes to the dictionary */
  66     Bool (*requiresRestart)(Panel*);   /* return True if some static option was changed */
  67     void (*undoChanges)(Panel*);       /* reset values to those in the dictionary */
  68     void (*prepareForClose)(Panel*);   /* called when exiting WPrefs */
  69     void (*showPanel)(Panel*);         /* called when entering the panel */
  70     void (*hidePanel)(Panel*);         /* called when exiting the panel */
  71 } CallbackRec;
  72
  73
  74 /* all Panels must start with the following layout */
  75 typedef struct PanelRec {
  76     WMBox *box;
  77
  78     char *sectionName;                 /* section name to display in titlebar */
  79
  80     char *description;
  81
  82     CallbackRec callbacks;
  83 } PanelRec;
  84
  85
  86 /* ---[ Wprefs.c ] ------------------------------------------------------- */
  87
  88 void AddSection(Panel *panel, const char *iconFile);
  89
  90 char *LocateImage(const char *name);
  91
  92 void SetButtonAlphaImage(WMScreen *scr, WMButton *bPtr, const char *file);
  93
  94 /* Loads `file' into `icon_normal'. If `icon_greyed' is not NULL,
  95  * combine `icon_normal' with some grey and then optionally with image
  96  * `xis', and store it in `icon_greyed' (typically to produce a
  97  * greyed-out, red-crossed version of `icon_normal') */
  98 void CreateImages(WMScreen *scr, RContext *rc, RImage *xis, const char *file,
  99                 WMPixmap **icon_normal, WMPixmap **icon_greyed);
 100
 101 WMWindow *GetWindow(void);
 102
 103 /* manipulate the dictionary for the WindowMaker domain */
 104
 105 WMPropList *GetObjectForKey(const char *defaultName);
 106
 107 void SetObjectForKey(WMPropList *object, const char *defaultName);
 108
 109 void RemoveObjectForKey(const char *defaultName);
 110
 111 char *GetStringForKey(const char *defaultName);
 112
 113 int GetIntegerForKey(const char *defaultName);
 114
 115 Bool GetBoolForKey(const char *defaultName);
 116
 117 int GetSpeedForKey(const char *defaultName);
 118
 119 void SetIntegerForKey(int value, const char *defaultName);
 120
 121 void SetStringForKey(const char *value, const char *defaultName);
 122
 123 void SetBoolForKey(Bool value, const char *defaultName);
 124
 125 void SetSpeedForKey(int speed, const char *defaultName);
 126
 127
 128 /* ---[ KeyboardShortcuts.c ] -------------------------------------------- */
 129
 130 char *capture_shortcut(Display *dpy, Bool *capturing, Bool convert_case);
 131
 132
 133 /* ---[ double.c ] ------------------------------------------------------- */
 134 typedef struct W_DoubleTest DoubleTest;
 135
 136 DoubleTest *CreateDoubleTest(WMWidget *parent, const char *text);
 137
 138
 139 /* ---[ main.c ] --------------------------------------------------------- */
 140 void AddDeadChildHandler(pid_t pid, void (*handler)(void*), void *data);
 141
 142
 143 /* ---[ xmodifier.c ] ---------------------------------------------------- */
 144 int ModifierFromKey(Display * dpy, const char *key);
 145
 146
 147 /* ---[ Panel Initializers ]---------------------------------------------- */
 148
 149 void Initialize(WMScreen *scr);
 150
 151 /* in alphabetical order - in case you'd want to add one */
 152 Panel *InitAppearance(WMWidget *parent);
 153 Panel *InitConfigurations(WMWidget *parent);
 154 Panel *InitDocks(WMWidget *parent);
 155 Panel *InitExpert(WMWidget *parent);
 156 Panel *InitFocus(WMWidget *parent);
 157 Panel *InitFontSimple(WMWidget *parent);
 158 Panel *InitIcons(WMWidget *parent);
 159 Panel *InitKeyboardShortcuts(WMWidget *parent);
 160 Panel *InitMenu(WMWidget *parent);
 161 Panel *InitMenuPreferences(WMWidget *parent);
 162 Panel *InitMouseSettings(WMWidget *parent);
 163 Panel *InitPaths(WMWidget *parent);
 164 Panel *InitPreferences(WMWidget *parent);
 165 Panel *InitWindowHandling(WMWidget *parent);
 166 Panel *InitWorkspace(WMWidget *parent);
 167
 168
 169 #define FRAME_TOP       105
 170 #define FRAME_LEFT      -2
 171 #define FRAME_WIDTH     524
 172 #define FRAME_HEIGHT    235
 173 #endif /* WPREFS_H_ */
 174