gsk.CairoRenderer 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 module gsk.CairoRenderer;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gsk.Renderer;
30 private import gsk.c.functions;
31 public  import gsk.c.types;
32 
33 
34 /**
35  * A GSK renderer that is using cairo.
36  * 
37  * Since it is using cairo, this renderer cannot support
38  * 3D transformations.
39  */
40 public class CairoRenderer : Renderer
41 {
42 	/** the main Gtk struct */
43 	protected GskCairoRenderer* gskCairoRenderer;
44 
45 	/** Get the main Gtk struct */
46 	public GskCairoRenderer* getCairoRendererStruct(bool transferOwnership = false)
47 	{
48 		if (transferOwnership)
49 			ownedRef = false;
50 		return gskCairoRenderer;
51 	}
52 
53 	/** the main Gtk struct as a void* */
54 	protected override void* getStruct()
55 	{
56 		return cast(void*)gskCairoRenderer;
57 	}
58 
59 	/**
60 	 * Sets our main struct and passes it to the parent class.
61 	 */
62 	public this (GskCairoRenderer* gskCairoRenderer, bool ownedRef = false)
63 	{
64 		this.gskCairoRenderer = gskCairoRenderer;
65 		super(cast(GskRenderer*)gskCairoRenderer, ownedRef);
66 	}
67 
68 
69 	/** */
70 	public static GType getType()
71 	{
72 		return gsk_cairo_renderer_get_type();
73 	}
74 
75 	/**
76 	 * Creates a new Cairo renderer.
77 	 *
78 	 * The Cairo renderer is the fallback renderer drawing in ways similar
79 	 * to how GTK 3 drew its content. Its primary use is as comparison tool.
80 	 *
81 	 * The Cairo renderer is incomplete. It cannot render 3D transformed
82 	 * content and will instead render an error marker. Its usage should be
83 	 * avoided.
84 	 *
85 	 * Returns: a new Cairo renderer.
86 	 *
87 	 * Throws: ConstructionException GTK+ fails to create the object.
88 	 */
89 	public this()
90 	{
91 		auto __p = gsk_cairo_renderer_new();
92 
93 		if(__p is null)
94 		{
95 			throw new ConstructionException("null returned by new");
96 		}
97 
98 		this(cast(GskCairoRenderer*) __p, true);
99 	}
100 }