]> Pileus Git - ~andy/gtk/blob - gtk/gtkthemingengine.h
Add theming docs
[~andy/gtk] / gtk / gtkthemingengine.h
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 2010 Carlos Garnacho <carlosg@gnome.org>
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 #ifndef __GTK_THEMING_ENGINE_H__
21 #define __GTK_THEMING_ENGINE_H__
22
23 #include <glib-object.h>
24 #include <cairo.h>
25
26 #include <gtk/gtkstylecontext.h>
27 #include <gtk/gtkwidgetpath.h>
28 #include <gtk/gtkenums.h>
29
30 G_BEGIN_DECLS
31
32 #define GTK_TYPE_THEMING_ENGINE         (gtk_theming_engine_get_type ())
33 #define GTK_THEMING_ENGINE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_THEMING_ENGINE, GtkThemingEngine))
34 #define GTK_THEMING_ENGINE_CLASS(c)     (G_TYPE_CHECK_CLASS_CAST    ((c), GTK_TYPE_THEMING_ENGINE, GtkThemingEngineClass))
35 #define GTK_IS_THEMING_ENGINE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_THEMING_ENGINE))
36 #define GTK_IS_THEMING_ENGINE_CLASS(c)  (G_TYPE_CHECK_CLASS_TYPE    ((c), GTK_TYPE_THEMING_ENGINE))
37 #define GTK_THEMING_ENGINE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS  ((o), GTK_TYPE_THEMING_ENGINE, GtkThemingEngineClass))
38
39 typedef struct _GtkThemingEngine GtkThemingEngine;
40 typedef struct _GtkThemingEngineClass GtkThemingEngineClass;
41
42 struct _GtkThemingEngine
43 {
44   GObject parent_object;
45   gpointer priv;
46 };
47
48 /**
49  * GtkThemingEngineClass
50  * @parent_class: The parent class.
51  * @render_line: Renders a line between two points.
52  * @render_background: Renders the background area of a widget region.
53  * @render_frame: Renders the frame around a widget area.
54  * @render_frame_gap: Renders the frame around a widget area with a gap in it.
55  * @render_extension: Renders a extension to a box, usually a notebook tab.
56  * @render_check: Renders a checkmark, as in #GtkCheckButton.
57  * @render_option: Renders an option, as in #GtkRadioButton.
58  * @render_arrow: Renders an arrow pointing to a certain direction.
59  * @render_expander: Renders an element what will expose/expand part of
60  *                   the UI, as in #GtkExpander.
61  * @render_focus: Renders the focus indicator.
62  * @render_layout: Renders a #PangoLayout
63  * @render_slider: Renders a slider control, as in #GtkScale.
64  * @render_handle: Renders a handle to drag UI elements, as in #GtkPaned.
65  *
66  * Base class for theming engines.
67  */
68 struct _GtkThemingEngineClass
69 {
70   GObjectClass parent_class;
71
72   void (* render_line) (GtkThemingEngine *engine,
73                         cairo_t          *cr,
74                         gdouble           x0,
75                         gdouble           y0,
76                         gdouble           x1,
77                         gdouble           y1);
78   void (* render_background) (GtkThemingEngine *engine,
79                               cairo_t          *cr,
80                               gdouble           x,
81                               gdouble           y,
82                               gdouble           width,
83                               gdouble           height);
84   void (* render_frame) (GtkThemingEngine *engine,
85                          cairo_t          *cr,
86                          gdouble           x,
87                          gdouble           y,
88                          gdouble           width,
89                          gdouble           height);
90   void (* render_frame_gap) (GtkThemingEngine *engine,
91                              cairo_t          *cr,
92                              gdouble           x,
93                              gdouble           y,
94                              gdouble           width,
95                              gdouble           height,
96                              GtkPositionType   gap_side,
97                              gdouble           xy0_gap,
98                              gdouble           xy1_gap);
99   void (* render_extension) (GtkThemingEngine *engine,
100                              cairo_t          *cr,
101                              gdouble           x,
102                              gdouble           y,
103                              gdouble           width,
104                              gdouble           height,
105                              GtkPositionType   gap_side);
106   void (* render_check) (GtkThemingEngine *engine,
107                          cairo_t          *cr,
108                          gdouble           x,
109                          gdouble           y,
110                          gdouble           width,
111                          gdouble           height);
112   void (* render_option) (GtkThemingEngine *engine,
113                           cairo_t          *cr,
114                           gdouble           x,
115                           gdouble           y,
116                           gdouble           width,
117                           gdouble           height);
118   void (* render_arrow) (GtkThemingEngine *engine,
119                          cairo_t          *cr,
120                          gdouble           angle,
121                          gdouble           x,
122                          gdouble           y,
123                          gdouble           size);
124   void (* render_expander) (GtkThemingEngine *engine,
125                             cairo_t          *cr,
126                             gdouble           x,
127                             gdouble           y,
128                             gdouble           width,
129                             gdouble           height);
130   void (* render_focus) (GtkThemingEngine *engine,
131                          cairo_t          *cr,
132                          gdouble           x,
133                          gdouble           y,
134                          gdouble           width,
135                          gdouble           height);
136   void (* render_layout) (GtkThemingEngine *engine,
137                           cairo_t          *cr,
138                           gdouble           x,
139                           gdouble           y,
140                           PangoLayout      *layout);
141   void (* render_slider) (GtkThemingEngine *engine,
142                           cairo_t          *cr,
143                           gdouble           x,
144                           gdouble           y,
145                           gdouble           width,
146                           gdouble           height,
147                           GtkOrientation    orientation);
148   void (* render_handle)    (GtkThemingEngine *engine,
149                              cairo_t          *cr,
150                              gdouble           x,
151                              gdouble           y,
152                              gdouble           width,
153                              gdouble           height);
154 };
155
156 GType gtk_theming_engine_get_type (void) G_GNUC_CONST;
157
158 void _gtk_theming_engine_set_context (GtkThemingEngine *engine,
159                                       GtkStyleContext  *context);
160
161 void gtk_theming_engine_register_property (GtkThemingEngine       *engine,
162                                            const gchar            *property_name,
163                                            GType                   type,
164                                            const GValue           *default_value,
165                                            GtkStylePropertyParser  parse_func);
166
167 void gtk_theming_engine_get_property (GtkThemingEngine *engine,
168                                       const gchar      *property,
169                                       GtkStateFlags     state,
170                                       GValue           *value);
171 void gtk_theming_engine_get_valist   (GtkThemingEngine *engine,
172                                       GtkStateFlags     state,
173                                       va_list           args);
174 void gtk_theming_engine_get          (GtkThemingEngine *engine,
175                                       GtkStateFlags     state,
176                                       ...) G_GNUC_NULL_TERMINATED;
177
178 void gtk_theming_engine_get_style_property (GtkThemingEngine *engine,
179                                             const gchar      *property_name,
180                                             GValue           *value);
181 void gtk_theming_engine_get_style_valist   (GtkThemingEngine *engine,
182                                             va_list           args);
183 void gtk_theming_engine_get_style          (GtkThemingEngine *engine,
184                                             ...);
185
186
187 G_CONST_RETURN GtkWidgetPath * gtk_theming_engine_get_path (GtkThemingEngine *engine);
188
189 gboolean gtk_theming_engine_has_class  (GtkThemingEngine *engine,
190                                         const gchar      *style_class);
191 gboolean gtk_theming_engine_has_region (GtkThemingEngine *engine,
192                                         const gchar      *style_class,
193                                         GtkRegionFlags   *flags);
194
195 GtkStateFlags gtk_theming_engine_get_state     (GtkThemingEngine *engine);
196 gboolean      gtk_theming_engine_is_state_set  (GtkThemingEngine *engine,
197                                                 GtkStateType      state,
198                                                 gdouble          *progress);
199
200 GtkTextDirection gtk_theming_engine_get_direction (GtkThemingEngine *engine);
201
202 GtkJunctionSides gtk_theming_engine_get_junction_sides (GtkThemingEngine *engine);
203
204 GtkThemingEngine * gtk_theming_engine_load (const gchar *name);
205
206 GdkScreen * gtk_theming_engine_get_screen (GtkThemingEngine *engine);
207
208
209 G_END_DECLS
210
211 #endif /* __GTK_THEMING_ENGINE_H__ */