Pileus Git - ~andy/gtk/blob - gdk/x11/xsettings-client.h

   1 /*
   2  * Copyright © 2001, 2007 Red Hat, Inc.
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that
   7  * copyright notice and this permission notice appear in supporting
   8  * documentation, and that the name of Red Hat not be used in advertising or
   9  * publicity pertaining to distribution of the software without specific,
  10  * written prior permission.  Red Hat makes no representations about the
  11  * suitability of this software for any purpose.  It is provided "as is"
  12  * without express or implied warranty.
  13  *
  14  * RED HAT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL RED HAT
  16  * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  17  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  18  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  19  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  20  *
  21  * Author:  Owen Taylor, Red Hat, Inc.
  22  */
  23 #ifndef XSETTINGS_CLIENT_H
  24 #define XSETTINGS_CLIENT_H
  25
  26 #include <gdk/gdkscreen.h>
  27 #include <X11/Xlib.h>
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif /* __cplusplus */
  32
  33 /* Renames for GDK inclusion */
  34
  35 #define xsettings_client_destroy         _gdk_x11_xsettings_client_destroy
  36 #define xsettings_client_get_setting     _gdk_x11_xsettings_client_get_setting
  37 #define xsettings_client_new             _gdk_x11_xsettings_client_new
  38 #define xsettings_client_process_event   _gdk_x11_xsettings_client_process_event
  39 #define xsettings_setting_equal          _gdk_x11_xsettings_setting_equal
  40 #define xsettings_setting_free           _gdk_x11_xsettings_setting_free
  41
  42 typedef struct _XSettingsBuffer  XSettingsBuffer;
  43 typedef struct _XSettingsColor   XSettingsColor;
  44 typedef struct _XSettingsSetting XSettingsSetting;
  45 typedef struct _XSettingsClient XSettingsClient;
  46
  47 /* Types of settings possible. Enum values correspond to
  48  * protocol values.
  49  */
  50 typedef enum
  51 {
  52   XSETTINGS_TYPE_INT     = 0,
  53   XSETTINGS_TYPE_STRING  = 1,
  54   XSETTINGS_TYPE_COLOR   = 2
  55 } XSettingsType;
  56
  57 typedef enum
  58 {
  59   XSETTINGS_ACTION_NEW,
  60   XSETTINGS_ACTION_CHANGED,
  61   XSETTINGS_ACTION_DELETED
  62 } XSettingsAction;
  63
  64 typedef enum
  65 {
  66   XSETTINGS_SUCCESS,
  67   XSETTINGS_ACCESS,
  68   XSETTINGS_FAILED,
  69   XSETTINGS_NO_ENTRY,
  70   XSETTINGS_DUPLICATE_ENTRY
  71 } XSettingsResult;
  72
  73 struct _XSettingsBuffer
  74 {
  75   char byte_order;
  76   size_t len;
  77   unsigned char *data;
  78   unsigned char *pos;
  79 };
  80
  81 struct _XSettingsColor
  82 {
  83   unsigned short red, green, blue, alpha;
  84 };
  85
  86 struct _XSettingsSetting
  87 {
  88   char *name;
  89   XSettingsType type;
  90
  91   union {
  92     int v_int;
  93     char *v_string;
  94     XSettingsColor v_color;
  95   } data;
  96 };
  97
  98 typedef void (*XSettingsNotifyFunc) (const char       *name,
  99                                      XSettingsAction   action,
 100                                      XSettingsSetting *setting,
 101                                      void             *cb_data);
 102 typedef Bool (*XSettingsWatchFunc)  (Window            window,
 103                                      Bool              is_start,
 104                                      long              mask,
 105                                      void             *cb_data);
 106
 107 void              xsettings_setting_free          (XSettingsSetting    *setting);
 108 int               xsettings_setting_equal         (XSettingsSetting    *setting_a,
 109                                                    XSettingsSetting    *setting_b);
 110
 111 XSettingsClient *xsettings_client_new             (GdkScreen           *screen,
 112                                                    XSettingsNotifyFunc  notify,
 113                                                    XSettingsWatchFunc   watch,
 114                                                    void                *cb_data);
 115 void             xsettings_client_destroy         (XSettingsClient     *client);
 116 Bool             xsettings_client_process_event   (XSettingsClient     *client,
 117                                                    XEvent              *xev);
 118 const XSettingsSetting *
 119                  xsettings_client_get_setting     (XSettingsClient     *client,
 120                                                    const char          *name);
 121
 122 #ifdef __cplusplus
 123 }
 124 #endif /* __cplusplus */
 125
 126 #endif /* XSETTINGS_CLIENT_H */