]> Pileus Git - ~andy/gtk/blob - gtk/gtkstyleprovider.h
Fix docs typo.
[~andy/gtk] / gtk / gtkstyleprovider.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_STYLE_PROVIDER_H__
21 #define __GTK_STYLE_PROVIDER_H__
22
23 #include <glib-object.h>
24 #include "gtkwidgetpath.h"
25 #include "gtkiconfactory.h"
26 #include "gtkstyleproperties.h"
27 #include "gtkenums.h"
28
29 G_BEGIN_DECLS
30
31 #define GTK_TYPE_STYLE_PROVIDER          (gtk_style_provider_get_type ())
32 #define GTK_STYLE_PROVIDER(o)            (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_STYLE_PROVIDER, GtkStyleProvider))
33 #define GTK_IS_STYLE_PROVIDER(o)         (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_STYLE_PROVIDER))
34 #define GTK_STYLE_PROVIDER_GET_IFACE(o)  (G_TYPE_INSTANCE_GET_INTERFACE ((o), GTK_TYPE_STYLE_PROVIDER, GtkStyleProviderIface))
35
36 /**
37  * GTK_STYLE_PROVIDER_PRIORITY_FALLBACK:
38  *
39  * The priority used for default style information
40  * that is used in the absence of themes.
41  */
42 #define GTK_STYLE_PROVIDER_PRIORITY_FALLBACK      1
43
44 /**
45  * GTK_STYLE_PROVIDER_PRIORITY_THEME:
46  *
47  * The priority used for style information provided
48  * by themes.
49  */
50 #define GTK_STYLE_PROVIDER_PRIORITY_THEME     200
51
52 /**
53  * GTK_STYLE_PROVIDER_PRIORITY_SETTINGS:
54  *
55  * The priority used for style information provided
56  * via #GtkSettings.
57  *
58  * This priority is higher than #GTK_STYLE_PROVIDER_PRIORITY_THEME
59  * to let settings override themes.
60  */
61 #define GTK_STYLE_PROVIDER_PRIORITY_SETTINGS    400
62
63 /**
64  * GTK_STYLE_PROVIDER_PRIORITY_APPLICATION:
65  *
66  * A priority that can be used when adding a #GtkStyleProvider
67  * for application-specific style information.
68  */
69 #define GTK_STYLE_PROVIDER_PRIORITY_APPLICATION 600
70
71 /**
72  * GTK_STYLE_PROVIDER_PRIORITY_USER:
73  *
74  * The priority used for the style information from
75  * <filename>~/.gtk-3.0.css</filename>.
76  *
77  * You should not use priorities higher than this, to
78  * give the user the last word.
79  */
80 #define GTK_STYLE_PROVIDER_PRIORITY_USER        800
81
82 typedef struct _GtkStyleProviderIface GtkStyleProviderIface;
83 typedef struct _GtkStyleProvider GtkStyleProvider; /* dummy typedef */
84
85 /**
86  * GtkStyleProviderIface
87  * @get_style: Gets a set of style information that applies to a widget path.
88  * @get_style_property: Gets the value of a widget style property that applies to a widget path.
89  * @get_icon_factory: Gets the icon factory that applies to a widget path.
90  */
91 struct _GtkStyleProviderIface
92 {
93   GTypeInterface g_iface;
94
95   GtkStyleProperties * (* get_style) (GtkStyleProvider *provider,
96                                       GtkWidgetPath    *path);
97
98   gboolean (* get_style_property) (GtkStyleProvider *provider,
99                                    GtkWidgetPath    *path,
100                                    GtkStateFlags     state,
101                                    GParamSpec       *pspec,
102                                    GValue           *value);
103
104   GtkIconFactory * (* get_icon_factory) (GtkStyleProvider *provider,
105                                          GtkWidgetPath    *path);
106 };
107
108 GType gtk_style_provider_get_type (void) G_GNUC_CONST;
109
110 GtkStyleProperties *gtk_style_provider_get_style (GtkStyleProvider *provider,
111                                                   GtkWidgetPath    *path);
112
113 gboolean gtk_style_provider_get_style_property (GtkStyleProvider *provider,
114                                                 GtkWidgetPath    *path,
115                                                 GtkStateFlags     state,
116                                                 GParamSpec       *pspec,
117                                                 GValue           *value);
118
119 GtkIconFactory * gtk_style_provider_get_icon_factory (GtkStyleProvider *provider,
120                                                       GtkWidgetPath    *path);
121
122 G_END_DECLS
123
124 #endif /* __GTK_STYLE_PROVIDER_H__ */