gsk.ContainerNode 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.ContainerNode;
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 that can contain other render nodes.
36  */
37 public class ContainerNode : RenderNode
38 {
39 	/** the main Gtk struct */
40 	protected GskContainerNode* gskContainerNode;
41 
42 	/** Get the main Gtk struct */
43 	public GskContainerNode* getContainerNodeStruct(bool transferOwnership = false)
44 	{
45 		if (transferOwnership)
46 			ownedRef = false;
47 		return gskContainerNode;
48 	}
49 
50 	/** the main Gtk struct as a void* */
51 	protected override void* getStruct()
52 	{
53 		return cast(void*)gskContainerNode;
54 	}
55 
56 	/**
57 	 * Sets our main struct and passes it to the parent class.
58 	 */
59 	public this (GskContainerNode* gskContainerNode, bool ownedRef = false)
60 	{
61 		this.gskContainerNode = gskContainerNode;
62 		super(cast(GskRenderNode*)gskContainerNode, ownedRef);
63 	}
64 
65 
66 	/** */
67 	public static GType getType()
68 	{
69 		return gsk_container_node_get_type();
70 	}
71 
72 	/**
73 	 * Creates a new `GskRenderNode` instance for holding the given @children.
74 	 *
75 	 * The new node will acquire a reference to each of the children.
76 	 *
77 	 * Params:
78 	 *     children = The children of the node
79 	 *
80 	 * Returns: the new `GskRenderNode`
81 	 *
82 	 * Throws: ConstructionException GTK+ fails to create the object.
83 	 */
84 	public this(RenderNode[] children)
85 	{
86 		GskRenderNode*[] childrenArray = new GskRenderNode*[children.length];
87 		for ( int i = 0; i < children.length; i++ )
88 		{
89 			childrenArray[i] = children[i].getRenderNodeStruct();
90 		}
91 
92 		auto __p = gsk_container_node_new(childrenArray.ptr, cast(uint)children.length);
93 
94 		if(__p is null)
95 		{
96 			throw new ConstructionException("null returned by new");
97 		}
98 
99 		this(cast(GskContainerNode*) __p);
100 	}
101 
102 	/**
103 	 * Gets one of the children of @container.
104 	 *
105 	 * Params:
106 	 *     idx = the position of the child to get
107 	 *
108 	 * Returns: the @idx'th child of @container
109 	 */
110 	public RenderNode getChild(uint idx)
111 	{
112 		auto __p = gsk_container_node_get_child(cast(GskRenderNode*)gskContainerNode, idx);
113 
114 		if(__p is null)
115 		{
116 			return null;
117 		}
118 
119 		return ObjectG.getDObject!(RenderNode)(cast(GskRenderNode*) __p);
120 	}
121 
122 	/**
123 	 * Retrieves the number of direct children of @node.
124 	 *
125 	 * Returns: the number of children of the `GskRenderNode`
126 	 */
127 	public uint getNChildren()
128 	{
129 		return gsk_container_node_get_n_children(cast(GskRenderNode*)gskContainerNode);
130 	}
131 }