Pileus Git - ~andy/gtk/blob - gtk/gtkrc.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  28 #error "Only <gtk/gtk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GTK_RC_H__
  32 #define __GTK_RC_H__
  33
  34
  35 #include <gtk/gtkstyle.h>
  36
  37 G_BEGIN_DECLS
  38
  39 /* Forward declarations */
  40 typedef struct _GtkIconFactory  GtkIconFactory;
  41 typedef struct _GtkRcContext    GtkRcContext;
  42
  43 typedef struct _GtkRcStyleClass GtkRcStyleClass;
  44
  45 #define GTK_TYPE_RC_STYLE              (gtk_rc_style_get_type ())
  46 #define GTK_RC_STYLE(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_RC_STYLE, GtkRcStyle))
  47 #define GTK_RC_STYLE_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_RC_STYLE, GtkRcStyleClass))
  48 #define GTK_IS_RC_STYLE(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_RC_STYLE))
  49 #define GTK_IS_RC_STYLE_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_RC_STYLE))
  50 #define GTK_RC_STYLE_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_RC_STYLE, GtkRcStyleClass))
  51
  52 typedef enum
  53 {
  54   GTK_RC_FG             = 1 << 0,
  55   GTK_RC_BG             = 1 << 1,
  56   GTK_RC_TEXT           = 1 << 2,
  57   GTK_RC_BASE           = 1 << 3
  58 } GtkRcFlags;
  59
  60 /**
  61  * GtkRcStyle:
  62  * @name:
  63  * @bg_pixmap_name:
  64  * @font_desc:
  65  * @color_flags:
  66  * @fg:
  67  * @bg:
  68  * @text:
  69  * @base:
  70  * @xthickness:
  71  * @ythickness:
  72  *
  73  * The #GtkRcStyle structure is used to represent a set
  74  * of information about the appearance of a widget.
  75  * This can later be composited together with other
  76  * #GtkRcStyle structures to form a #GtkStyle.
  77  */
  78 struct _GtkRcStyle
  79 {
  80   GObject parent_instance;
  81
  82   /*< public >*/
  83
  84   gchar *name;
  85   gchar *bg_pixmap_name[5];
  86   PangoFontDescription *font_desc;
  87
  88   GtkRcFlags color_flags[5];
  89   GdkColor   fg[5];
  90   GdkColor   bg[5];
  91   GdkColor   text[5];
  92   GdkColor   base[5];
  93
  94   gint xthickness;
  95   gint ythickness;
  96
  97   /*< private >*/
  98   GArray *rc_properties;
  99
 100   /* list of RC style lists including this RC style */
 101   GSList *rc_style_lists;
 102
 103   GSList *icon_factories;
 104
 105   guint engine_specified : 1;   /* The RC file specified the engine */
 106 };
 107
 108 struct _GtkRcStyleClass
 109 {
 110   GObjectClass parent_class;
 111
 112   /* Create an empty RC style of the same type as this RC style.
 113    * The default implementation, which does
 114    * g_object_new (G_OBJECT_TYPE (style), NULL);
 115    * should work in most cases.
 116    */
 117   GtkRcStyle * (*create_rc_style) (GtkRcStyle *rc_style);
 118
 119   /* Fill in engine specific parts of GtkRcStyle by parsing contents
 120    * of brackets. Returns G_TOKEN_NONE if successful, otherwise returns
 121    * the token it expected but didn't get.
 122    */
 123   guint     (*parse)  (GtkRcStyle   *rc_style,
 124                        GtkSettings  *settings,
 125                        GScanner     *scanner);
 126
 127   /* Combine RC style data from src into dest. If overridden, this
 128    * function should chain to the parent.
 129    */
 130   void      (*merge)  (GtkRcStyle *dest,
 131                        GtkRcStyle *src);
 132
 133   /* Create an empty style suitable to this RC style
 134    */
 135   GtkStyle * (*create_style) (GtkRcStyle *rc_style);
 136
 137   /* Padding for future expansion */
 138   void (*_gtk_reserved1) (void);
 139   void (*_gtk_reserved2) (void);
 140   void (*_gtk_reserved3) (void);
 141   void (*_gtk_reserved4) (void);
 142 };
 143
 144 GSList*   _gtk_rc_parse_widget_class_path (const gchar *pattern);
 145 void      _gtk_rc_free_widget_class_path (GSList       *list);
 146 gboolean  _gtk_rc_match_widget_class     (GSList       *list,
 147                                           gint          length,
 148                                           gchar        *path,
 149                                           gchar        *path_reversed);
 150
 151 #if !defined(GTK_DISABLE_DEPRECATED) || defined(GTK_COMPILATION)
 152
 153 void      gtk_rc_add_default_file       (const gchar *filename);
 154 void      gtk_rc_set_default_files      (gchar **filenames);
 155 gchar**   gtk_rc_get_default_files      (void);
 156 GtkStyle* gtk_rc_get_style              (GtkWidget   *widget);
 157 GtkStyle* gtk_rc_get_style_by_paths     (GtkSettings *settings,
 158                                          const char  *widget_path,
 159                                          const char  *class_path,
 160                                          GType        type);
 161
 162 gboolean gtk_rc_reparse_all_for_settings (GtkSettings *settings,
 163                                           gboolean     force_load);
 164 void     gtk_rc_reset_styles             (GtkSettings *settings);
 165
 166 gchar*   gtk_rc_find_pixmap_in_path (GtkSettings  *settings,
 167                                      GScanner     *scanner,
 168                                      const gchar  *pixmap_file);
 169
 170 void      gtk_rc_parse                  (const gchar *filename);
 171 void      gtk_rc_parse_string           (const gchar *rc_string);
 172 gboolean  gtk_rc_reparse_all            (void);
 173
 174 GType       gtk_rc_style_get_type   (void) G_GNUC_CONST;
 175 GtkRcStyle* gtk_rc_style_new        (void);
 176 GtkRcStyle* gtk_rc_style_copy       (GtkRcStyle *orig);
 177
 178 gchar*          gtk_rc_find_module_in_path      (const gchar    *module_file);
 179 gchar*          gtk_rc_get_theme_dir            (void);
 180 gchar*          gtk_rc_get_module_dir           (void);
 181 gchar*          gtk_rc_get_im_module_path       (void);
 182 gchar*          gtk_rc_get_im_module_file       (void);
 183
 184 /* private functions/definitions */
 185
 186 /**
 187  * GtkRcTokenType:
 188  * @GTK_RC_TOKEN_INVALID:
 189  * @GTK_RC_TOKEN_INCLUDE:
 190  * @GTK_RC_TOKEN_NORMAL:
 191  * @GTK_RC_TOKEN_ACTIVE:
 192  * @GTK_RC_TOKEN_PRELIGHT:
 193  * @GTK_RC_TOKEN_SELECTED:
 194  * @GTK_RC_TOKEN_INSENSITIVE:
 195  * @GTK_RC_TOKEN_FG:
 196  * @GTK_RC_TOKEN_BG:
 197  * @GTK_RC_TOKEN_TEXT:
 198  * @GTK_RC_TOKEN_BASE:
 199  * @GTK_RC_TOKEN_XTHICKNESS:
 200  * @GTK_RC_TOKEN_YTHICKNESS:
 201  * @GTK_RC_TOKEN_FONT:
 202  * @GTK_RC_TOKEN_FONTSET:
 203  * @GTK_RC_TOKEN_FONT_NAME:
 204  * @GTK_RC_TOKEN_BG_PIXMAP:
 205  * @GTK_RC_TOKEN_PIXMAP_PATH:
 206  * @GTK_RC_TOKEN_STYLE:
 207  * @GTK_RC_TOKEN_BINDING:
 208  * @GTK_RC_TOKEN_BIND:
 209  * @GTK_RC_TOKEN_WIDGET:
 210  * @GTK_RC_TOKEN_WIDGET_CLASS:
 211  * @GTK_RC_TOKEN_CLASS:
 212  * @GTK_RC_TOKEN_LOWEST:
 213  * @GTK_RC_TOKEN_GTK:
 214  * @GTK_RC_TOKEN_APPLICATION:
 215  * @GTK_RC_TOKEN_THEME:
 216  * @GTK_RC_TOKEN_RC:
 217  * @GTK_RC_TOKEN_HIGHEST:
 218  * @GTK_RC_TOKEN_ENGINE:
 219  * @GTK_RC_TOKEN_MODULE_PATH:
 220  * @GTK_RC_TOKEN_IM_MODULE_PATH:
 221  * @GTK_RC_TOKEN_IM_MODULE_FILE:
 222  * @GTK_RC_TOKEN_STOCK:
 223  * @GTK_RC_TOKEN_LTR:
 224  * @GTK_RC_TOKEN_RTL:
 225  * @GTK_RC_TOKEN_COLOR:
 226  * @GTK_RC_TOKEN_UNBIND:
 227  * @GTK_RC_TOKEN_LAST:
 228  *
 229  * The #GtkRcTokenType enumeration represents the tokens
 230  * in the RC file. It is exposed so that theme engines
 231  * can reuse these tokens when parsing the theme-engine
 232  * specific portions of a RC file.
 233  *
 234  * Deprecated: 3.0: Use #GtkCssProvider instead.
 235  */
 236 typedef enum {
 237   GTK_RC_TOKEN_INVALID = G_TOKEN_LAST,
 238   GTK_RC_TOKEN_INCLUDE,
 239   GTK_RC_TOKEN_NORMAL,
 240   GTK_RC_TOKEN_ACTIVE,
 241   GTK_RC_TOKEN_PRELIGHT,
 242   GTK_RC_TOKEN_SELECTED,
 243   GTK_RC_TOKEN_INSENSITIVE,
 244   GTK_RC_TOKEN_FG,
 245   GTK_RC_TOKEN_BG,
 246   GTK_RC_TOKEN_TEXT,
 247   GTK_RC_TOKEN_BASE,
 248   GTK_RC_TOKEN_XTHICKNESS,
 249   GTK_RC_TOKEN_YTHICKNESS,
 250   GTK_RC_TOKEN_FONT,
 251   GTK_RC_TOKEN_FONTSET,
 252   GTK_RC_TOKEN_FONT_NAME,
 253   GTK_RC_TOKEN_BG_PIXMAP,
 254   GTK_RC_TOKEN_PIXMAP_PATH,
 255   GTK_RC_TOKEN_STYLE,
 256   GTK_RC_TOKEN_BINDING,
 257   GTK_RC_TOKEN_BIND,
 258   GTK_RC_TOKEN_WIDGET,
 259   GTK_RC_TOKEN_WIDGET_CLASS,
 260   GTK_RC_TOKEN_CLASS,
 261   GTK_RC_TOKEN_LOWEST,
 262   GTK_RC_TOKEN_GTK,
 263   GTK_RC_TOKEN_APPLICATION,
 264   GTK_RC_TOKEN_THEME,
 265   GTK_RC_TOKEN_RC,
 266   GTK_RC_TOKEN_HIGHEST,
 267   GTK_RC_TOKEN_ENGINE,
 268   GTK_RC_TOKEN_MODULE_PATH,
 269   GTK_RC_TOKEN_IM_MODULE_PATH,
 270   GTK_RC_TOKEN_IM_MODULE_FILE,
 271   GTK_RC_TOKEN_STOCK,
 272   GTK_RC_TOKEN_LTR,
 273   GTK_RC_TOKEN_RTL,
 274   GTK_RC_TOKEN_COLOR,
 275   GTK_RC_TOKEN_UNBIND,
 276   GTK_RC_TOKEN_LAST
 277 } GtkRcTokenType;
 278
 279 GScanner* gtk_rc_scanner_new    (void);
 280 guint     gtk_rc_parse_color    (GScanner            *scanner,
 281                                  GdkColor            *color);
 282 guint     gtk_rc_parse_color_full (GScanner          *scanner,
 283                                    GtkRcStyle        *style,
 284                                    GdkColor          *color);
 285 guint     gtk_rc_parse_state    (GScanner            *scanner,
 286                                  GtkStateType        *state);
 287 guint     gtk_rc_parse_priority (GScanner            *scanner,
 288                                  GtkPathPriorityType *priority);
 289
 290 #endif
 291
 292 /* rc properties
 293  * (structure forward declared in gtkstyle.h)
 294  */
 295 struct _GtkRcProperty
 296 {
 297   /* quark-ified property identifier like "GtkScrollbar::spacing" */
 298   GQuark type_name;
 299   GQuark property_name;
 300
 301   /* fields similar to GtkSettingsValue */
 302   gchar *origin;
 303   GValue value;
 304 };
 305
 306 G_END_DECLS
 307
 308 #endif /* __GTK_RC_H__ */