gsk.ClipNode 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.ClipNode;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import graphene.Rect;
30 private import gsk.RenderNode;
31 private import gsk.c.functions;
32 public  import gsk.c.types;
33 
34 
35 /**
36  * A render node applying a rectangular clip to its single child node.
37  */
38 public class ClipNode : RenderNode
39 {
40 	/** the main Gtk struct */
41 	protected GskClipNode* gskClipNode;
42 
43 	/** Get the main Gtk struct */
44 	public GskClipNode* getClipNodeStruct(bool transferOwnership = false)
45 	{
46 		if (transferOwnership)
47 			ownedRef = false;
48 		return gskClipNode;
49 	}
50 
51 	/** the main Gtk struct as a void* */
52 	protected override void* getStruct()
53 	{
54 		return cast(void*)gskClipNode;
55 	}
56 
57 	/**
58 	 * Sets our main struct and passes it to the parent class.
59 	 */
60 	public this (GskClipNode* gskClipNode, bool ownedRef = false)
61 	{
62 		this.gskClipNode = gskClipNode;
63 		super(cast(GskRenderNode*)gskClipNode, ownedRef);
64 	}
65 
66 
67 	/** */
68 	public static GType getType()
69 	{
70 		return gsk_clip_node_get_type();
71 	}
72 
73 	/**
74 	 * Creates a `GskRenderNode` that will clip the @child to the area
75 	 * given by @clip.
76 	 *
77 	 * Params:
78 	 *     child = The node to draw
79 	 *     clip = The clip to apply
80 	 *
81 	 * Returns: A new `GskRenderNode`
82 	 *
83 	 * Throws: ConstructionException GTK+ fails to create the object.
84 	 */
85 	public this(RenderNode child, Rect clip)
86 	{
87 		auto __p = gsk_clip_node_new((child is null) ? null : child.getRenderNodeStruct(), (clip is null) ? null : clip.getRectStruct());
88 
89 		if(__p is null)
90 		{
91 			throw new ConstructionException("null returned by new");
92 		}
93 
94 		this(cast(GskClipNode*) __p);
95 	}
96 
97 	/**
98 	 * Gets the child node that is getting clipped by the given @node.
99 	 *
100 	 * Returns: The child that is getting clipped
101 	 */
102 	public RenderNode getChild()
103 	{
104 		auto __p = gsk_clip_node_get_child(cast(GskRenderNode*)gskClipNode);
105 
106 		if(__p is null)
107 		{
108 			return null;
109 		}
110 
111 		return ObjectG.getDObject!(RenderNode)(cast(GskRenderNode*) __p);
112 	}
113 
114 	/**
115 	 * Retrieves the clip rectangle for @node.
116 	 *
117 	 * Returns: a clip rectangle
118 	 */
119 	public Rect getClip()
120 	{
121 		auto __p = gsk_clip_node_get_clip(cast(GskRenderNode*)gskClipNode);
122 
123 		if(__p is null)
124 		{
125 			return null;
126 		}
127 
128 		return ObjectG.getDObject!(Rect)(cast(graphene_rect_t*) __p);
129 	}
130 }