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