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 atk.HypertextT; 26 27 public import atk.Hyperlink; 28 public import atk.c.functions; 29 public import atk.c.types; 30 public import gobject.ObjectG; 31 public import gobject.Signals; 32 public import gtkc.atktypes; 33 public import std.algorithm; 34 35 36 /** 37 * An interface used for objects which implement linking between 38 * multiple resource or content locations, or multiple 'markers' 39 * within a single document. A Hypertext instance is associated with 40 * one or more Hyperlinks, which are associated with particular 41 * offsets within the Hypertext's included content. While this 42 * interface is derived from Text, there is no requirement that 43 * Hypertext instances have textual content; they may implement Image 44 * as well, and Hyperlinks need not have non-zero text offsets. 45 */ 46 public template HypertextT(TStruct) 47 { 48 /** Get the main Gtk struct */ 49 public AtkHypertext* getHypertextStruct(bool transferOwnership = false) 50 { 51 if (transferOwnership) 52 ownedRef = false; 53 return cast(AtkHypertext*)getStruct(); 54 } 55 56 57 /** 58 * Gets the link in this hypertext document at index 59 * @link_index 60 * 61 * Params: 62 * linkIndex = an integer specifying the desired link 63 * 64 * Returns: the link in this hypertext document at 65 * index @link_index 66 */ 67 public Hyperlink getLink(int linkIndex) 68 { 69 auto __p = atk_hypertext_get_link(getHypertextStruct(), linkIndex); 70 71 if(__p is null) 72 { 73 return null; 74 } 75 76 return ObjectG.getDObject!(Hyperlink)(cast(AtkHyperlink*) __p); 77 } 78 79 /** 80 * Gets the index into the array of hyperlinks that is associated with 81 * the character specified by @char_index. 82 * 83 * Params: 84 * charIndex = a character index 85 * 86 * Returns: an index into the array of hyperlinks in @hypertext, 87 * or -1 if there is no hyperlink associated with this character. 88 */ 89 public int getLinkIndex(int charIndex) 90 { 91 return atk_hypertext_get_link_index(getHypertextStruct(), charIndex); 92 } 93 94 /** 95 * Gets the number of links within this hypertext document. 96 * 97 * Returns: the number of links within this hypertext document 98 */ 99 public int getNLinks() 100 { 101 return atk_hypertext_get_n_links(getHypertextStruct()); 102 } 103 104 /** 105 * The "link-selected" signal is emitted by an AtkHyperText 106 * object when one of the hyperlinks associated with the object 107 * is selected. 108 * 109 * Params: 110 * arg1 = the index of the hyperlink which is selected 111 */ 112 gulong addOnLinkSelected(void delegate(int, HypertextIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0) 113 { 114 return Signals.connect(this, "link-selected", dlg, connectFlags ^ ConnectFlags.SWAPPED); 115 } 116 }