gtk.StyleProviderIF source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19  
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 /*
25  * Conversion parameters:
26  * inFile  = GtkStyleProvider.html
27  * outPack = gtk
28  * outFile = StyleProviderIF
29  * strct   = GtkStyleProvider
30  * realStrct=
31  * ctorStrct=
32  * clss    = StyleProviderT
33  * interf  = StyleProviderIF
34  * class Code: No
35  * interface Code: No
36  * template for:
37  * extend  = 
38  * implements:
39  * prefixes:
40  * 	- gtk_style_provider_
41  * omit structs:
42  * omit prefixes:
43  * omit code:
44  * omit signals:
45  * imports:
46  * 	- gobject.ParamSpec
47  * 	- gobject.Value
48  * 	- gtk.IconFactory
49  * 	- gtk.StyleProperties
50  * 	- gtk.WidgetPath
51  * structWrap:
52  * 	- GParamSpec* -> ParamSpec
53  * 	- GValue* -> Value
54  * 	- GtkIconFactory* -> IconFactory
55  * 	- GtkStyleProperties* -> StyleProperties
56  * 	- GtkWidgetPath* -> WidgetPath
57  * module aliases:
58  * local aliases:
59  * overrides:
60  */
61 
62 module gtk.StyleProviderIF;
63 
64 public  import gtkc.gtktypes;
65 
66 private import gtkc.gtk;
67 private import glib.ConstructionException;
68 private import gobject.ObjectG;
69 
70 
71 private import gobject.ParamSpec;
72 private import gobject.Value;
73 private import gtk.IconFactory;
74 private import gtk.StyleProperties;
75 private import gtk.WidgetPath;
76 
77 
78 
79 
80 /**
81  * GtkStyleProvider is an interface used to provide style information to a GtkStyleContext.
82  * See gtk_style_context_add_provider() and gtk_style_context_add_provider_for_screen().
83  */
84 public interface StyleProviderIF
85 {
86 	
87 	
88 	public GtkStyleProvider* getStyleProviderTStruct();
89 	
90 	/** the main Gtk struct as a void* */
91 	protected void* getStruct();
92 	
93 	
94 	/**
95 	 */
96 	
97 	/**
98 	 * Warning
99 	 * gtk_style_provider_get_icon_factory has been deprecated since version 3.8 and should not be used in newly-written code. Will always return NULL for all GTK-provided style providers.
100 	 * Returns the GtkIconFactory defined to be in use for path, or NULL if none
101 	 * is defined.
102 	 * Params:
103 	 * path = GtkWidgetPath to query
104 	 * Returns: The icon factory to use for path, or NULL. [transfer none] Since 3.0
105 	 */
106 	public IconFactory getIconFactory(WidgetPath path);
107 	
108 	/**
109 	 * Warning
110 	 * gtk_style_provider_get_style has been deprecated since version 3.8 and should not be used in newly-written code. Will always return NULL for all GTK-provided style providers
111 	 *  as the interface cannot correctly work the way CSS is specified.
112 	 * Returns the style settings affecting a widget defined by path, or NULL if
113 	 * provider doesn't contemplate styling path.
114 	 * Params:
115 	 * path = GtkWidgetPath to query
116 	 * Returns: a GtkStyleProperties containing the style settings affecting path. [transfer full] Since 3.0
117 	 */
118 	public StyleProperties getStyle(WidgetPath path);
119 	
120 	/**
121 	 * Looks up a widget style property as defined by provider for
122 	 * the widget represented by path.
123 	 * Params:
124 	 * path = GtkWidgetPath to query
125 	 * state = state to query the style property for
126 	 * pspec = The GParamSpec to query
127 	 * value = return location for the property value. [out]
128 	 * Returns: TRUE if the property was found and has a value, FALSE otherwise Since 3.0
129 	 */
130 	public int getStyleProperty(WidgetPath path, GtkStateFlags state, ParamSpec pspec, Value value);
131 }