gsk.BlurNode 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.BlurNode;
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 blur effect to its single child.
36  */
37 public class BlurNode : RenderNode
38 {
39 	/** the main Gtk struct */
40 	protected GskBlurNode* gskBlurNode;
41 
42 	/** Get the main Gtk struct */
43 	public GskBlurNode* getBlurNodeStruct(bool transferOwnership = false)
44 	{
45 		if (transferOwnership)
46 			ownedRef = false;
47 		return gskBlurNode;
48 	}
49 
50 	/** the main Gtk struct as a void* */
51 	protected override void* getStruct()
52 	{
53 		return cast(void*)gskBlurNode;
54 	}
55 
56 	/**
57 	 * Sets our main struct and passes it to the parent class.
58 	 */
59 	public this (GskBlurNode* gskBlurNode, bool ownedRef = false)
60 	{
61 		this.gskBlurNode = gskBlurNode;
62 		super(cast(GskRenderNode*)gskBlurNode, ownedRef);
63 	}
64 
65 
66 	/** */
67 	public static GType getType()
68 	{
69 		return gsk_blur_node_get_type();
70 	}
71 
72 	/**
73 	 * Creates a render node that blurs the child.
74 	 *
75 	 * Params:
76 	 *     child = the child node to blur
77 	 *     radius = the blur radius
78 	 *
79 	 * Returns: a new `GskRenderNode`
80 	 *
81 	 * Throws: ConstructionException GTK+ fails to create the object.
82 	 */
83 	public this(RenderNode child, float radius)
84 	{
85 		auto __p = gsk_blur_node_new((child is null) ? null : child.getRenderNodeStruct(), radius);
86 
87 		if(__p is null)
88 		{
89 			throw new ConstructionException("null returned by new");
90 		}
91 
92 		this(cast(GskBlurNode*) __p);
93 	}
94 
95 	/**
96 	 * Retrieves the child `GskRenderNode` of the blur @node.
97 	 *
98 	 * Returns: the blurred child node
99 	 */
100 	public RenderNode getChild()
101 	{
102 		auto __p = gsk_blur_node_get_child(cast(GskRenderNode*)gskBlurNode);
103 
104 		if(__p is null)
105 		{
106 			return null;
107 		}
108 
109 		return ObjectG.getDObject!(RenderNode)(cast(GskRenderNode*) __p);
110 	}
111 
112 	/**
113 	 * Retrieves the blur radius of the @node.
114 	 *
115 	 * Returns: the blur radius
116 	 */
117 	public float getRadius()
118 	{
119 		return gsk_blur_node_get_radius(cast(GskRenderNode*)gskBlurNode);
120 	}
121 }