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 glib.ListG; 29 private import gobject.ObjectG; 30 private import gtkc.gtk; 31 public import gtkc.gtktypes; 32 33 34 /** 35 * A #GtkTextChildAnchor is a spot in the buffer where child widgets can 36 * be “anchored” (inserted inline, as if they were characters). The anchor 37 * can have multiple widgets anchored, to allow for multiple views. 38 */ 39 public class TextChildAnchor : ObjectG 40 { 41 /** the main Gtk struct */ 42 protected GtkTextChildAnchor* gtkTextChildAnchor; 43 44 /** Get the main Gtk struct */ 45 public GtkTextChildAnchor* getTextChildAnchorStruct() 46 { 47 return gtkTextChildAnchor; 48 } 49 50 /** the main Gtk struct as a void* */ 51 protected override void* getStruct() 52 { 53 return cast(void*)gtkTextChildAnchor; 54 } 55 56 protected override void setStruct(GObject* obj) 57 { 58 gtkTextChildAnchor = cast(GtkTextChildAnchor*)obj; 59 super.setStruct(obj); 60 } 61 62 /** 63 * Sets our main struct and passes it to the parent class. 64 */ 65 public this (GtkTextChildAnchor* gtkTextChildAnchor, bool ownedRef = false) 66 { 67 this.gtkTextChildAnchor = gtkTextChildAnchor; 68 super(cast(GObject*)gtkTextChildAnchor, ownedRef); 69 } 70 71 /** 72 */ 73 74 public static GType getType() 75 { 76 return gtk_text_child_anchor_get_type(); 77 } 78 79 /** 80 * Creates a new #GtkTextChildAnchor. Usually you would then insert 81 * it into a #GtkTextBuffer with gtk_text_buffer_insert_child_anchor(). 82 * To perform the creation and insertion in one step, use the 83 * convenience function gtk_text_buffer_create_child_anchor(). 84 * 85 * Return: a new #GtkTextChildAnchor 86 * 87 * Throws: ConstructionException GTK+ fails to create the object. 88 */ 89 public this() 90 { 91 auto p = gtk_text_child_anchor_new(); 92 93 if(p is null) 94 { 95 throw new ConstructionException("null returned by new"); 96 } 97 98 this(cast(GtkTextChildAnchor*) p, true); 99 } 100 101 /** 102 * Determines whether a child anchor has been deleted from 103 * the buffer. Keep in mind that the child anchor will be 104 * unreferenced when removed from the buffer, so you need to 105 * hold your own reference (with g_object_ref()) if you plan 106 * to use this function — otherwise all deleted child anchors 107 * will also be finalized. 108 * 109 * Return: %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 * The returned list should be freed with g_list_free(). 119 * 120 * Return: list of widgets anchored at @anchor 121 */ 122 public ListG getWidgets() 123 { 124 auto p = gtk_text_child_anchor_get_widgets(gtkTextChildAnchor); 125 126 if(p is null) 127 { 128 return null; 129 } 130 131 return new ListG(cast(GList*) p); 132 } 133 }