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(bool transferOwnership = false) 46 { 47 if (transferOwnership) 48 ownedRef = false; 49 return gtkTextChildAnchor; 50 } 51 52 /** the main Gtk struct as a void* */ 53 protected override void* getStruct() 54 { 55 return cast(void*)gtkTextChildAnchor; 56 } 57 58 protected override void setStruct(GObject* obj) 59 { 60 gtkTextChildAnchor = cast(GtkTextChildAnchor*)obj; 61 super.setStruct(obj); 62 } 63 64 /** 65 * Sets our main struct and passes it to the parent class. 66 */ 67 public this (GtkTextChildAnchor* gtkTextChildAnchor, bool ownedRef = false) 68 { 69 this.gtkTextChildAnchor = gtkTextChildAnchor; 70 super(cast(GObject*)gtkTextChildAnchor, ownedRef); 71 } 72 73 74 /** */ 75 public static GType getType() 76 { 77 return gtk_text_child_anchor_get_type(); 78 } 79 80 /** 81 * Creates a new #GtkTextChildAnchor. Usually you would then insert 82 * it into a #GtkTextBuffer with gtk_text_buffer_insert_child_anchor(). 83 * To perform the creation and insertion in one step, use the 84 * convenience function gtk_text_buffer_create_child_anchor(). 85 * 86 * Returns: a new #GtkTextChildAnchor 87 * 88 * Throws: ConstructionException GTK+ fails to create the object. 89 */ 90 public this() 91 { 92 auto p = gtk_text_child_anchor_new(); 93 94 if(p is null) 95 { 96 throw new ConstructionException("null returned by new"); 97 } 98 99 this(cast(GtkTextChildAnchor*) p, true); 100 } 101 102 /** 103 * Determines whether a child anchor has been deleted from 104 * the buffer. Keep in mind that the child anchor will be 105 * unreferenced when removed from the buffer, so you need to 106 * hold your own reference (with g_object_ref()) if you plan 107 * to use this function — otherwise all deleted child anchors 108 * will also be finalized. 109 * 110 * Returns: %TRUE if the child anchor has been deleted from its buffer 111 */ 112 public bool getDeleted() 113 { 114 return gtk_text_child_anchor_get_deleted(gtkTextChildAnchor) != 0; 115 } 116 117 /** 118 * Gets a list of all widgets anchored at this child anchor. 119 * The returned list should be freed with g_list_free(). 120 * 121 * Returns: list of widgets anchored at @anchor 122 */ 123 public ListG getWidgets() 124 { 125 auto p = gtk_text_child_anchor_get_widgets(gtkTextChildAnchor); 126 127 if(p is null) 128 { 129 return null; 130 } 131 132 return new ListG(cast(GList*) p); 133 } 134 }