gtkrc.h 8.14 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * 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.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * 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 29 30
#error "Only <gtk/gtk.h> can be included directly."
#endif

Elliot Lee's avatar
Elliot Lee committed
31 32 33 34 35 36
#ifndef __GTK_RC_H__
#define __GTK_RC_H__


#include <gtk/gtkstyle.h>

37
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
38

39 40 41
/* Forward declarations */
typedef struct _GtkIconFactory  GtkIconFactory;
typedef struct _GtkRcContext    GtkRcContext;
42

43 44
typedef struct _GtkRcStyleClass GtkRcStyleClass;

45 46 47 48 49 50
#define GTK_TYPE_RC_STYLE              (gtk_rc_style_get_type ())
#define GTK_RC_STYLE(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_RC_STYLE, GtkRcStyle))
#define GTK_RC_STYLE_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_RC_STYLE, GtkRcStyleClass))
#define GTK_IS_RC_STYLE(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_RC_STYLE))
#define GTK_IS_RC_STYLE_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_RC_STYLE))
#define GTK_RC_STYLE_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_RC_STYLE, GtkRcStyleClass))
51

52 53 54 55 56 57
typedef enum
{
  GTK_RC_FG		= 1 << 0,
  GTK_RC_BG		= 1 << 1,
  GTK_RC_TEXT		= 1 << 2,
  GTK_RC_BASE		= 1 << 3
58 59 60 61
} GtkRcFlags;

struct _GtkRcStyle
{
62 63 64
  GObject parent_instance;

  /*< public >*/
65

66 67
  gchar *name;
  gchar *bg_pixmap_name[5];
68
  PangoFontDescription *font_desc;
69 70 71 72 73 74 75

  GtkRcFlags color_flags[5];
  GdkColor   fg[5];
  GdkColor   bg[5];
  GdkColor   text[5];
  GdkColor   base[5];

76 77
  gint xthickness;
  gint ythickness;
78

79
  /*< private >*/
80
  GArray *rc_properties;
81

82 83
  /* list of RC style lists including this RC style */
  GSList *rc_style_lists;
84 85

  GSList *icon_factories;
86 87

  guint engine_specified : 1;	/* The RC file specified the engine */
88 89 90 91 92 93
};

struct _GtkRcStyleClass
{
  GObjectClass parent_class;

94 95 96 97 98
  /* Create an empty RC style of the same type as this RC style.
   * The default implementation, which does
   * g_object_new (G_OBJECT_TYPE (style), NULL);
   * should work in most cases.
   */
99
  GtkRcStyle * (*create_rc_style) (GtkRcStyle *rc_style);
100 101

  /* Fill in engine specific parts of GtkRcStyle by parsing contents
Kristian Rietveld's avatar
Kristian Rietveld committed
102
   * of brackets. Returns G_TOKEN_NONE if successful, otherwise returns
103 104
   * the token it expected but didn't get.
   */
105 106 107
  guint     (*parse)  (GtkRcStyle   *rc_style,
		       GtkSettings  *settings,
		       GScanner     *scanner);
108

109
  /* Combine RC style data from src into dest. If overridden, this
110 111
   * function should chain to the parent.
   */
112 113
  void      (*merge)  (GtkRcStyle *dest,
		       GtkRcStyle *src);
114 115 116

  /* Create an empty style suitable to this RC style
   */
117
  GtkStyle * (*create_style) (GtkRcStyle *rc_style);
118 119 120 121 122 123

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
124
};
Elliot Lee's avatar
Elliot Lee committed
125

126 127 128 129 130 131 132
#ifdef G_OS_WIN32
/* Reserve old names for DLL ABI backward compatibility */
#define gtk_rc_add_default_file gtk_rc_add_default_file_utf8
#define gtk_rc_set_default_files gtk_rc_set_default_files_utf8
#define gtk_rc_parse gtk_rc_parse_utf8
#endif

133 134 135 136 137 138 139 140
void	  _gtk_rc_init			 (void);
GSList*   _gtk_rc_parse_widget_class_path (const gchar *pattern);
void      _gtk_rc_free_widget_class_path (GSList       *list);
gboolean  _gtk_rc_match_widget_class     (GSList       *list,
                                          gint          length,
                                          gchar        *path,
                                          gchar        *path_reversed);

141
void      gtk_rc_add_default_file	(const gchar *filename);
142 143
void      gtk_rc_set_default_files      (gchar **filenames);
gchar**   gtk_rc_get_default_files      (void);
144
GtkStyle* gtk_rc_get_style		(GtkWidget   *widget);
145 146 147 148
GtkStyle* gtk_rc_get_style_by_paths     (GtkSettings *settings,
					 const char  *widget_path,
					 const char  *class_path,
					 GType        type);
149

150 151
gboolean gtk_rc_reparse_all_for_settings (GtkSettings *settings,
					  gboolean     force_load);
152 153
void     gtk_rc_reset_styles             (GtkSettings *settings);

154
gchar*   gtk_rc_find_pixmap_in_path (GtkSettings  *settings,
155 156 157 158 159
				     GScanner     *scanner,
				     const gchar  *pixmap_file);

void	  gtk_rc_parse			(const gchar *filename);
void	  gtk_rc_parse_string		(const gchar *rc_string);
160
gboolean  gtk_rc_reparse_all		(void);
161

Elliot Lee's avatar
Elliot Lee committed
162
GType       gtk_rc_style_get_type   (void) G_GNUC_CONST;
163
GtkRcStyle* gtk_rc_style_new        (void);
164
GtkRcStyle* gtk_rc_style_copy       (GtkRcStyle *orig);
165

166
gchar*		gtk_rc_find_module_in_path	(const gchar 	*module_file);
167 168
gchar*		gtk_rc_get_theme_dir		(void);
gchar*		gtk_rc_get_module_dir		(void);
Owen Taylor's avatar
Owen Taylor committed
169 170
gchar*		gtk_rc_get_im_module_path	(void);
gchar*		gtk_rc_get_im_module_file	(void);
Elliot Lee's avatar
Elliot Lee committed
171

172 173 174 175 176 177 178 179 180 181 182 183
/* private functions/definitions */
typedef enum {
  GTK_RC_TOKEN_INVALID = G_TOKEN_LAST,
  GTK_RC_TOKEN_INCLUDE,
  GTK_RC_TOKEN_NORMAL,
  GTK_RC_TOKEN_ACTIVE,
  GTK_RC_TOKEN_PRELIGHT,
  GTK_RC_TOKEN_SELECTED,
  GTK_RC_TOKEN_INSENSITIVE,
  GTK_RC_TOKEN_FG,
  GTK_RC_TOKEN_BG,
  GTK_RC_TOKEN_TEXT,
184 185 186
  GTK_RC_TOKEN_BASE,
  GTK_RC_TOKEN_XTHICKNESS,
  GTK_RC_TOKEN_YTHICKNESS,
187 188
  GTK_RC_TOKEN_FONT,
  GTK_RC_TOKEN_FONTSET,
189
  GTK_RC_TOKEN_FONT_NAME,
190 191 192 193 194 195 196 197 198 199 200
  GTK_RC_TOKEN_BG_PIXMAP,
  GTK_RC_TOKEN_PIXMAP_PATH,
  GTK_RC_TOKEN_STYLE,
  GTK_RC_TOKEN_BINDING,
  GTK_RC_TOKEN_BIND,
  GTK_RC_TOKEN_WIDGET,
  GTK_RC_TOKEN_WIDGET_CLASS,
  GTK_RC_TOKEN_CLASS,
  GTK_RC_TOKEN_LOWEST,
  GTK_RC_TOKEN_GTK,
  GTK_RC_TOKEN_APPLICATION,
201
  GTK_RC_TOKEN_THEME,
202 203
  GTK_RC_TOKEN_RC,
  GTK_RC_TOKEN_HIGHEST,
204 205
  GTK_RC_TOKEN_ENGINE,
  GTK_RC_TOKEN_MODULE_PATH,
Owen Taylor's avatar
Owen Taylor committed
206 207
  GTK_RC_TOKEN_IM_MODULE_PATH,
  GTK_RC_TOKEN_IM_MODULE_FILE,
208 209 210
  GTK_RC_TOKEN_STOCK,
  GTK_RC_TOKEN_LTR,
  GTK_RC_TOKEN_RTL,
211
  GTK_RC_TOKEN_COLOR,
212
  GTK_RC_TOKEN_UNBIND,
213 214 215
  GTK_RC_TOKEN_LAST
} GtkRcTokenType;

216 217
GScanner* gtk_rc_scanner_new	(void);
guint	  gtk_rc_parse_color	(GScanner	     *scanner,
218
				 GdkColor	     *color);
219 220 221
guint	  gtk_rc_parse_color_full (GScanner	     *scanner,
                                   GtkRcStyle        *style,
				   GdkColor	     *color);
222
guint	  gtk_rc_parse_state	(GScanner	     *scanner,
223
				 GtkStateType	     *state);
224
guint	  gtk_rc_parse_priority	(GScanner	     *scanner,
225
				 GtkPathPriorityType *priority);
226

227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
/* rc properties
 * (structure forward declared in gtkstyle.h)
 */
struct _GtkRcProperty
{
  /* quark-ified property identifier like "GtkScrollbar::spacing" */
  GQuark type_name;
  GQuark property_name;

  /* fields similar to GtkSettingsValue */
  gchar *origin;
  GValue value;
};
const GtkRcProperty* _gtk_rc_style_lookup_rc_property (GtkRcStyle *rc_style,
						       GQuark      type_name,
						       GQuark      property_name);
243 244 245 246 247
void	      _gtk_rc_style_set_rc_property	      (GtkRcStyle *rc_style,
						       GtkRcProperty *property);
void	      _gtk_rc_style_unset_rc_property	      (GtkRcStyle *rc_style,
						       GQuark      type_name,
						       GQuark      property_name);
248

249 250
GSList     * _gtk_rc_style_get_color_hashes        (GtkRcStyle *rc_style);

251 252 253 254
void         _gtk_rc_style_set_symbolic_color       (GtkRcStyle     *rc_style,
                                                     const gchar    *name,
                                                     const GdkColor *color);

255
const gchar* _gtk_rc_context_get_default_font_name (GtkSettings *settings);
256
void         _gtk_rc_context_destroy               (GtkSettings *settings);
257

258
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
259 260

#endif /* __GTK_RC_H__ */