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