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