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.CairoNode;
26 
27 private import cairo.Context;
28 private import cairo.Surface;
29 private import glib.ConstructionException;
30 private import gobject.ObjectG;
31 private import graphene.Rect;
32 private import gsk.RenderNode;
33 private import gsk.c.functions;
34 public  import gsk.c.types;
35 
36 
37 /**
38  * A render node for a Cairo surface.
39  */
40 public class CairoNode : RenderNode
41 {
42 	/** the main Gtk struct */
43 	protected GskCairoNode* gskCairoNode;
44 
45 	/** Get the main Gtk struct */
46 	public GskCairoNode* getCairoNodeStruct(bool transferOwnership = false)
47 	{
48 		if (transferOwnership)
49 			ownedRef = false;
50 		return gskCairoNode;
51 	}
52 
53 	/** the main Gtk struct as a void* */
54 	protected override void* getStruct()
55 	{
56 		return cast(void*)gskCairoNode;
57 	}
58 
59 	/**
60 	 * Sets our main struct and passes it to the parent class.
61 	 */
62 	public this (GskCairoNode* gskCairoNode, bool ownedRef = false)
63 	{
64 		this.gskCairoNode = gskCairoNode;
65 		super(cast(GskRenderNode*)gskCairoNode, ownedRef);
66 	}
67 
68 
69 	/** */
70 	public static GType getType()
71 	{
72 		return gsk_cairo_node_get_type();
73 	}
74 
75 	/**
76 	 * Creates a `GskRenderNode` that will render a cairo surface
77 	 * into the area given by @bounds.
78 	 *
79 	 * You can draw to the cairo surface using [method@Gsk.CairoNode.get_draw_context].
80 	 *
81 	 * Params:
82 	 *     bounds = the rectangle to render to
83 	 *
84 	 * Returns: A new `GskRenderNode`
85 	 *
86 	 * Throws: ConstructionException GTK+ fails to create the object.
87 	 */
88 	public this(Rect bounds)
89 	{
90 		auto __p = gsk_cairo_node_new((bounds is null) ? null : bounds.getRectStruct());
91 
92 		if(__p is null)
93 		{
94 			throw new ConstructionException("null returned by new");
95 		}
96 
97 		this(cast(GskCairoNode*) __p);
98 	}
99 
100 	/**
101 	 * Creates a Cairo context for drawing using the surface associated
102 	 * to the render node.
103 	 *
104 	 * If no surface exists yet, a surface will be created optimized for
105 	 * rendering to @renderer.
106 	 *
107 	 * Returns: a Cairo context used for drawing; use
108 	 *     cairo_destroy() when done drawing
109 	 */
110 	public Context getDrawContext()
111 	{
112 		auto __p = gsk_cairo_node_get_draw_context(cast(GskRenderNode*)gskCairoNode);
113 
114 		if(__p is null)
115 		{
116 			return null;
117 		}
118 
119 		return new Context(cast(cairo_t*) __p);
120 	}
121 
122 	/**
123 	 * Retrieves the Cairo surface used by the render node.
124 	 *
125 	 * Returns: a Cairo surface
126 	 */
127 	public Surface getSurface()
128 	{
129 		auto __p = gsk_cairo_node_get_surface(cast(GskRenderNode*)gskCairoNode);
130 
131 		if(__p is null)
132 		{
133 			return null;
134 		}
135 
136 		return new Surface(cast(cairo_surface_t*) __p);
137 	}
138 }