gsk.DebugNode 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.DebugNode;
26 
27 private import glib.ConstructionException;
28 private import glib.Str;
29 private import glib.c.functions;
30 private import gobject.ObjectG;
31 private import gsk.RenderNode;
32 private import gsk.c.functions;
33 public  import gsk.c.types;
34 
35 
36 /**
37  * A render node that emits a debugging message when drawing its
38  * child node.
39  */
40 public class DebugNode : RenderNode
41 {
42 	/** the main Gtk struct */
43 	protected GskDebugNode* gskDebugNode;
44 
45 	/** Get the main Gtk struct */
46 	public GskDebugNode* getDebugNodeStruct(bool transferOwnership = false)
47 	{
48 		if (transferOwnership)
49 			ownedRef = false;
50 		return gskDebugNode;
51 	}
52 
53 	/** the main Gtk struct as a void* */
54 	protected override void* getStruct()
55 	{
56 		return cast(void*)gskDebugNode;
57 	}
58 
59 	/**
60 	 * Sets our main struct and passes it to the parent class.
61 	 */
62 	public this (GskDebugNode* gskDebugNode, bool ownedRef = false)
63 	{
64 		this.gskDebugNode = gskDebugNode;
65 		super(cast(GskRenderNode*)gskDebugNode, ownedRef);
66 	}
67 
68 
69 	/** */
70 	public static GType getType()
71 	{
72 		return gsk_debug_node_get_type();
73 	}
74 
75 	/**
76 	 * Creates a `GskRenderNode` that will add debug information about
77 	 * the given @child.
78 	 *
79 	 * Adding this node has no visual effect.
80 	 *
81 	 * Params:
82 	 *     child = The child to add debug info for
83 	 *     message = The debug message
84 	 *
85 	 * Returns: A new `GskRenderNode`
86 	 *
87 	 * Throws: ConstructionException GTK+ fails to create the object.
88 	 */
89 	public this(RenderNode child, string message)
90 	{
91 		auto __p = gsk_debug_node_new((child is null) ? null : child.getRenderNodeStruct(), Str.toStringz(message));
92 
93 		if(__p is null)
94 		{
95 			throw new ConstructionException("null returned by new");
96 		}
97 
98 		this(cast(GskDebugNode*) __p);
99 	}
100 
101 	/**
102 	 * Gets the child node that is getting drawn by the given @node.
103 	 *
104 	 * Returns: the child `GskRenderNode`
105 	 */
106 	public RenderNode getChild()
107 	{
108 		auto __p = gsk_debug_node_get_child(cast(GskRenderNode*)gskDebugNode);
109 
110 		if(__p is null)
111 		{
112 			return null;
113 		}
114 
115 		return ObjectG.getDObject!(RenderNode)(cast(GskRenderNode*) __p);
116 	}
117 
118 	/**
119 	 * Gets the debug message that was set on this node
120 	 *
121 	 * Returns: The debug message
122 	 */
123 	public string getMessage()
124 	{
125 		return Str.toString(gsk_debug_node_get_message(cast(GskRenderNode*)gskDebugNode));
126 	}
127 }