gtkrc.h 6.38 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * 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 24 25 26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

Elliot Lee's avatar
Elliot Lee committed
27 28 29 30 31 32 33 34 35 36 37
#ifndef __GTK_RC_H__
#define __GTK_RC_H__


#include <gtk/gtkstyle.h>
#include <gtk/gtkwidget.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

38 39 40
/* Forward declaration */
typedef struct _GtkIconFactory GtkIconFactory;

41 42 43 44 45 46
#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))
47

48 49 50 51 52 53
typedef enum
{
  GTK_RC_FG		= 1 << 0,
  GTK_RC_BG		= 1 << 1,
  GTK_RC_TEXT		= 1 << 2,
  GTK_RC_BASE		= 1 << 3
54 55
} GtkRcFlags;

56 57
typedef struct _GtkRcStyleClass GtkRcStyleClass;

58 59
struct _GtkRcStyle
{
60 61 62 63
  GObject parent_instance;

  /*< public >*/
  
64 65
  gchar *name;
  gchar *bg_pixmap_name[5];
66
  PangoFontDescription *font_desc;
67 68 69 70 71 72 73

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

74 75
  gint xthickness;
  gint ythickness;
76
  
77 78 79 80
  /*< private >*/
  
  /* list of RC style lists including this RC style */
  GSList *rc_style_lists;
81 82

  GSList *icon_factories;
83 84 85 86 87 88
};

struct _GtkRcStyleClass
{
  GObjectClass parent_class;

89 90 91 92 93
  /* 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.
   */
94
  GtkRcStyle * (*clone) (GtkRcStyle *rc_style);
95 96 97 98 99

  /* Fill in engine specific parts of GtkRcStyle by parsing contents
   * of brackets. Returns G_TOKEN_NONE if succesful, otherwise returns
   * the token it expected but didn't get.
   */
100 101
  guint     (*parse)  (GtkRcStyle *rc_style,
		       GScanner   *scanner);
102 103 104 105
  
  /* Combine RC style data from src into dest. If overriden, this
   * function should chain to the parent.
   */
106 107
  void      (*merge)  (GtkRcStyle *dest,
		       GtkRcStyle *src);
108 109 110

  /* Create an empty style suitable to this RC style
   */
111
  GtkStyle * (*create_style) (GtkRcStyle *rc_style);
112
};
Elliot Lee's avatar
Elliot Lee committed
113

114
void	  gtk_rc_init			(void);
115 116 117
void      gtk_rc_add_default_file    (const gchar *filename);
void      gtk_rc_set_default_files      (gchar **filenames);
gchar**   gtk_rc_get_default_files      (void);
118 119
void	  gtk_rc_parse			(const gchar *filename);
void	  gtk_rc_parse_string		(const gchar *rc_string);
120
gboolean  gtk_rc_reparse_all		(void);
121
GtkStyle* gtk_rc_get_style		(GtkWidget   *widget);
122
void	  gtk_rc_add_widget_name_style	(GtkRcStyle  *rc_style,
123
					 const gchar *pattern);
124
void	  gtk_rc_add_widget_class_style (GtkRcStyle  *rc_style,
125
					 const gchar *pattern);
126
void	  gtk_rc_add_class_style	(GtkRcStyle  *rc_style,
127 128
					 const gchar *pattern);

Elliot Lee's avatar
Elliot Lee committed
129
GType       gtk_rc_style_get_type   (void) G_GNUC_CONST;
130
GtkRcStyle* gtk_rc_style_new        (void);
131
GtkRcStyle *gtk_rc_style_copy       (GtkRcStyle *orig);
132 133
void        gtk_rc_style_ref        (GtkRcStyle *rc_style);
void        gtk_rc_style_unref      (GtkRcStyle *rc_style);
Elliot Lee's avatar
Elliot Lee committed
134

135
/* Tell gtkrc to use a custom routine to load images specified in rc files instead of
136 137
 *   the default xpm-only loader
 */
138 139 140 141 142 143
typedef	GdkPixmap*  (*GtkImageLoader) 		(GdkWindow   	*window,
						 GdkColormap 	*colormap,
						 GdkBitmap     **mask,
						 GdkColor    	*transparent_color,
						 const gchar 	*filename);
void		gtk_rc_set_image_loader      	(GtkImageLoader	 loader);
144

145 146 147 148 149
GdkPixmap*	gtk_rc_load_image		(GdkColormap 	*colormap,
						 GdkColor    	*transparent_color,
						 const gchar 	*filename);
gchar*		gtk_rc_find_pixmap_in_path	(GScanner    	*scanner,
						 const gchar	*pixmap_file);
150
gchar*		gtk_rc_find_module_in_path	(const gchar 	*module_file);
151 152
gchar*		gtk_rc_get_theme_dir		(void);
gchar*		gtk_rc_get_module_dir		(void);
Owen Taylor's avatar
Owen Taylor committed
153 154
gchar*		gtk_rc_get_im_module_path	(void);
gchar*		gtk_rc_get_im_module_file	(void);
Elliot Lee's avatar
Elliot Lee committed
155

156 157 158 159 160 161 162 163 164 165 166 167
/* 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,
168 169 170
  GTK_RC_TOKEN_BASE,
  GTK_RC_TOKEN_XTHICKNESS,
  GTK_RC_TOKEN_YTHICKNESS,
171 172
  GTK_RC_TOKEN_FONT,
  GTK_RC_TOKEN_FONTSET,
173
  GTK_RC_TOKEN_FONT_NAME,
174 175 176 177 178 179 180 181 182 183 184 185 186
  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,
  GTK_RC_TOKEN_RC,
  GTK_RC_TOKEN_HIGHEST,
187 188
  GTK_RC_TOKEN_ENGINE,
  GTK_RC_TOKEN_MODULE_PATH,
Owen Taylor's avatar
Owen Taylor committed
189 190
  GTK_RC_TOKEN_IM_MODULE_PATH,
  GTK_RC_TOKEN_IM_MODULE_FILE,
191 192 193
  GTK_RC_TOKEN_STOCK,
  GTK_RC_TOKEN_LTR,
  GTK_RC_TOKEN_RTL,
194 195 196 197 198 199 200 201 202 203
  GTK_RC_TOKEN_LAST
} GtkRcTokenType;

guint	gtk_rc_parse_color	(GScanner	     *scanner,
				 GdkColor	     *color);
guint	gtk_rc_parse_state	(GScanner	     *scanner,
				 GtkStateType	     *state);
guint	gtk_rc_parse_priority	(GScanner	     *scanner,
				 GtkPathPriorityType *priority);
     
Tor Lillqvist's avatar
Tor Lillqvist committed
204 205 206 207 208
#ifdef G_OS_WIN32

gchar  *gtk_win32_get_installation_directory (void);

#endif
209 210


Elliot Lee's avatar
Elliot Lee committed
211 212 213 214 215 216
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_RC_H__ */