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 gtk.TextChildAnchor;
26 
27 private import glib.ConstructionException;
28 private import gobject.ObjectG;
29 private import gtk.Widget;
30 private import gtk.c.functions;
31 public  import gtk.c.types;
32 
33 
34 /**
35  * A `GtkTextChildAnchor` is a spot in a `GtkTextBuffer` where child widgets can
36  * be “anchored”.
37  * 
38  * The anchor can have multiple widgets anchored, to allow for multiple views.
39  */
40 public class TextChildAnchor : ObjectG
41 {
42 	/** the main Gtk struct */
43 	protected GtkTextChildAnchor* gtkTextChildAnchor;
44 
45 	/** Get the main Gtk struct */
46 	public GtkTextChildAnchor* getTextChildAnchorStruct(bool transferOwnership = false)
47 	{
48 		if (transferOwnership)
49 			ownedRef = false;
50 		return gtkTextChildAnchor;
51 	}
52 
53 	/** the main Gtk struct as a void* */
54 	protected override void* getStruct()
55 	{
56 		return cast(void*)gtkTextChildAnchor;
57 	}
58 
59 	/**
60 	 * Sets our main struct and passes it to the parent class.
61 	 */
62 	public this (GtkTextChildAnchor* gtkTextChildAnchor, bool ownedRef = false)
63 	{
64 		this.gtkTextChildAnchor = gtkTextChildAnchor;
65 		super(cast(GObject*)gtkTextChildAnchor, ownedRef);
66 	}
67 
68 
69 	/** */
70 	public static GType getType()
71 	{
72 		return gtk_text_child_anchor_get_type();
73 	}
74 
75 	/**
76 	 * Creates a new `GtkTextChildAnchor`.
77 	 *
78 	 * Usually you would then insert it into a `GtkTextBuffer` with
79 	 * [method@Gtk.TextBuffer.insert_child_anchor]. To perform the
80 	 * creation and insertion in one step, use the convenience
81 	 * function [method@Gtk.TextBuffer.create_child_anchor].
82 	 *
83 	 * Returns: a new `GtkTextChildAnchor`
84 	 *
85 	 * Throws: ConstructionException GTK+ fails to create the object.
86 	 */
87 	public this()
88 	{
89 		auto __p = gtk_text_child_anchor_new();
90 
91 		if(__p is null)
92 		{
93 			throw new ConstructionException("null returned by new");
94 		}
95 
96 		this(cast(GtkTextChildAnchor*) __p, true);
97 	}
98 
99 	/**
100 	 * Determines whether a child anchor has been deleted from
101 	 * the buffer.
102 	 *
103 	 * Keep in mind that the child anchor will be unreferenced
104 	 * when removed from the buffer, so you need to hold your own
105 	 * reference (with g_object_ref()) if you plan to use this
106 	 * function — otherwise all deleted child anchors will also
107 	 * be finalized.
108 	 *
109 	 * Returns: %TRUE if the child anchor has been deleted from its buffer
110 	 */
111 	public bool getDeleted()
112 	{
113 		return gtk_text_child_anchor_get_deleted(gtkTextChildAnchor) != 0;
114 	}
115 
116 	/**
117 	 * Gets a list of all widgets anchored at this child anchor.
118 	 *
119 	 * The order in which the widgets are returned is not defined.
120 	 *
121 	 * Returns: an
122 	 *     array of widgets anchored at @anchor
123 	 */
124 	public Widget[] getWidgets()
125 	{
126 		uint outLen;
127 
128 		auto __p = gtk_text_child_anchor_get_widgets(gtkTextChildAnchor, &outLen);
129 
130 		if(__p is null)
131 		{
132 			return null;
133 		}
134 
135 		Widget[] arr = new Widget[outLen];
136 		for(int i = 0; i < outLen; i++)
137 		{
138 			arr[i] = ObjectG.getDObject!(Widget)(cast(GtkWidget*) __p[i]);
139 		}
140 
141 		return arr;
142 	}
143 }