gsk.OpacityNode 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.OpacityNode;
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 controlling the opacity of its single child node.
36  */
37 public class OpacityNode : RenderNode
38 {
39 	/** the main Gtk struct */
40 	protected GskOpacityNode* gskOpacityNode;
41 
42 	/** Get the main Gtk struct */
43 	public GskOpacityNode* getOpacityNodeStruct(bool transferOwnership = false)
44 	{
45 		if (transferOwnership)
46 			ownedRef = false;
47 		return gskOpacityNode;
48 	}
49 
50 	/** the main Gtk struct as a void* */
51 	protected override void* getStruct()
52 	{
53 		return cast(void*)gskOpacityNode;
54 	}
55 
56 	/**
57 	 * Sets our main struct and passes it to the parent class.
58 	 */
59 	public this (GskOpacityNode* gskOpacityNode, bool ownedRef = false)
60 	{
61 		this.gskOpacityNode = gskOpacityNode;
62 		super(cast(GskRenderNode*)gskOpacityNode, ownedRef);
63 	}
64 
65 
66 	/** */
67 	public static GType getType()
68 	{
69 		return gsk_opacity_node_get_type();
70 	}
71 
72 	/**
73 	 * Creates a `GskRenderNode` that will drawn the @child with reduced
74 	 * @opacity.
75 	 *
76 	 * Params:
77 	 *     child = The node to draw
78 	 *     opacity = The opacity to apply
79 	 *
80 	 * Returns: A new `GskRenderNode`
81 	 *
82 	 * Throws: ConstructionException GTK+ fails to create the object.
83 	 */
84 	public this(RenderNode child, float opacity)
85 	{
86 		auto __p = gsk_opacity_node_new((child is null) ? null : child.getRenderNodeStruct(), opacity);
87 
88 		if(__p is null)
89 		{
90 			throw new ConstructionException("null returned by new");
91 		}
92 
93 		this(cast(GskOpacityNode*) __p);
94 	}
95 
96 	/**
97 	 * Gets the child node that is getting opacityed by the given @node.
98 	 *
99 	 * Returns: The child that is getting opacityed
100 	 */
101 	public RenderNode getChild()
102 	{
103 		auto __p = gsk_opacity_node_get_child(cast(GskRenderNode*)gskOpacityNode);
104 
105 		if(__p is null)
106 		{
107 			return null;
108 		}
109 
110 		return ObjectG.getDObject!(RenderNode)(cast(GskRenderNode*) __p);
111 	}
112 
113 	/**
114 	 * Gets the transparency factor for an opacity node.
115 	 *
116 	 * Returns: the opacity factor
117 	 */
118 	public float getOpacity()
119 	{
120 		return gsk_opacity_node_get_opacity(cast(GskRenderNode*)gskOpacityNode);
121 	}
122 }