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 gtk.c.functions; 31 public import gtk.c.types; 32 public import gtkc.gtktypes; 33 34 35 /** 36 * A #GtkTextChildAnchor is a spot in the buffer where child widgets can 37 * be “anchored” (inserted inline, as if they were characters). The anchor 38 * 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. Usually you would then insert 77 * it into a #GtkTextBuffer with gtk_text_buffer_insert_child_anchor(). 78 * To perform the creation and insertion in one step, use the 79 * convenience function gtk_text_buffer_create_child_anchor(). 80 * 81 * Returns: a new #GtkTextChildAnchor 82 * 83 * Throws: ConstructionException GTK+ fails to create the object. 84 */ 85 public this() 86 { 87 auto p = gtk_text_child_anchor_new(); 88 89 if(p is null) 90 { 91 throw new ConstructionException("null returned by new"); 92 } 93 94 this(cast(GtkTextChildAnchor*) p, true); 95 } 96 97 /** 98 * Determines whether a child anchor has been deleted from 99 * the buffer. Keep in mind that the child anchor will be 100 * unreferenced when removed from the buffer, so you need to 101 * hold your own reference (with g_object_ref()) if you plan 102 * to use this function — otherwise all deleted child anchors 103 * will also be finalized. 104 * 105 * Returns: %TRUE if the child anchor has been deleted from its buffer 106 */ 107 public bool getDeleted() 108 { 109 return gtk_text_child_anchor_get_deleted(gtkTextChildAnchor) != 0; 110 } 111 112 /** 113 * Gets a list of all widgets anchored at this child anchor. 114 * The returned list should be freed with g_list_free(). 115 * 116 * Returns: list of widgets anchored at @anchor 117 */ 118 public ListG getWidgets() 119 { 120 auto p = gtk_text_child_anchor_get_widgets(gtkTextChildAnchor); 121 122 if(p is null) 123 { 124 return null; 125 } 126 127 return new ListG(cast(GList*) p); 128 } 129 }