gsk.BlendNode 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.BlendNode;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gsk.RenderNode;
30 private import gsk.c.functions;
31 public  import gsk.c.types;
32 
33 
34 /**
35  * A render node applying a blending function between its two child nodes.
36  */
37 public class BlendNode : RenderNode
38 {
39 	/** the main Gtk struct */
40 	protected GskBlendNode* gskBlendNode;
41 
42 	/** Get the main Gtk struct */
43 	public GskBlendNode* getBlendNodeStruct(bool transferOwnership = false)
44 	{
45 		if (transferOwnership)
46 			ownedRef = false;
47 		return gskBlendNode;
48 	}
49 
50 	/** the main Gtk struct as a void* */
51 	protected override void* getStruct()
52 	{
53 		return cast(void*)gskBlendNode;
54 	}
55 
56 	/**
57 	 * Sets our main struct and passes it to the parent class.
58 	 */
59 	public this (GskBlendNode* gskBlendNode, bool ownedRef = false)
60 	{
61 		this.gskBlendNode = gskBlendNode;
62 		super(cast(GskRenderNode*)gskBlendNode, ownedRef);
63 	}
64 
65 
66 	/** */
67 	public static GType getType()
68 	{
69 		return gsk_blend_node_get_type();
70 	}
71 
72 	/**
73 	 * Creates a `GskRenderNode` that will use @blend_mode to blend the @top
74 	 * node onto the @bottom node.
75 	 *
76 	 * Params:
77 	 *     bottom = The bottom node to be drawn
78 	 *     top = The node to be blended onto the @bottom node
79 	 *     blendMode = The blend mode to use
80 	 *
81 	 * Returns: A new `GskRenderNode`
82 	 *
83 	 * Throws: ConstructionException GTK+ fails to create the object.
84 	 */
85 	public this(RenderNode bottom, RenderNode top, GskBlendMode blendMode)
86 	{
87 		auto __p = gsk_blend_node_new((bottom is null) ? null : bottom.getRenderNodeStruct(), (top is null) ? null : top.getRenderNodeStruct(), blendMode);
88 
89 		if(__p is null)
90 		{
91 			throw new ConstructionException("null returned by new");
92 		}
93 
94 		this(cast(GskBlendNode*) __p);
95 	}
96 
97 	/**
98 	 * Retrieves the blend mode used by @node.
99 	 *
100 	 * Returns: the blend mode
101 	 */
102 	public GskBlendMode getBlendMode()
103 	{
104 		return gsk_blend_node_get_blend_mode(cast(GskRenderNode*)gskBlendNode);
105 	}
106 
107 	/**
108 	 * Retrieves the bottom `GskRenderNode` child of the @node.
109 	 *
110 	 * Returns: the bottom child node
111 	 */
112 	public RenderNode getBottomChild()
113 	{
114 		auto __p = gsk_blend_node_get_bottom_child(cast(GskRenderNode*)gskBlendNode);
115 
116 		if(__p is null)
117 		{
118 			return null;
119 		}
120 
121 		return ObjectG.getDObject!(RenderNode)(cast(GskRenderNode*) __p);
122 	}
123 
124 	/**
125 	 * Retrieves the top `GskRenderNode` child of the @node.
126 	 *
127 	 * Returns: the top child node
128 	 */
129 	public RenderNode getTopChild()
130 	{
131 		auto __p = gsk_blend_node_get_top_child(cast(GskRenderNode*)gskBlendNode);
132 
133 		if(__p is null)
134 		{
135 			return null;
136 		}
137 
138 		return ObjectG.getDObject!(RenderNode)(cast(GskRenderNode*) __p);
139 	}
140 }