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.Hyperlink;
26 
27 private import atk.ActionIF;
28 private import atk.ActionT;
29 private import atk.ObjectAtk;
30 private import glib.Str;
31 private import gobject.ObjectG;
32 private import gobject.Signals;
33 private import gtkc.atk;
34 public  import gtkc.atktypes;
35 public  import gtkc.gdktypes;
36 
37 
38 /**
39  * An ATK object which encapsulates a link or set of links (for
40  * instance in the case of client-side image maps) in a hypertext
41  * document.  It may implement the AtkAction interface.  AtkHyperlink
42  * may also be used to refer to inline embedded content, since it
43  * allows specification of a start and end offset within the host
44  * AtkHypertext object.
45  */
46 public class Hyperlink : ObjectG, ActionIF
47 {
48 	/** the main Gtk struct */
49 	protected AtkHyperlink* atkHyperlink;
50 
51 	/** Get the main Gtk struct */
52 	public AtkHyperlink* getHyperlinkStruct()
53 	{
54 		return atkHyperlink;
55 	}
56 
57 	/** the main Gtk struct as a void* */
58 	protected override void* getStruct()
59 	{
60 		return cast(void*)atkHyperlink;
61 	}
62 
63 	protected override void setStruct(GObject* obj)
64 	{
65 		atkHyperlink = cast(AtkHyperlink*)obj;
66 		super.setStruct(obj);
67 	}
68 
69 	/**
70 	 * Sets our main struct and passes it to the parent class.
71 	 */
72 	public this (AtkHyperlink* atkHyperlink, bool ownedRef = false)
73 	{
74 		this.atkHyperlink = atkHyperlink;
75 		super(cast(GObject*)atkHyperlink, ownedRef);
76 	}
77 
78 	// add the Action capabilities
79 	mixin ActionT!(AtkHyperlink);
80 
81 	/**
82 	 */
83 
84 	public static GType getType()
85 	{
86 		return atk_hyperlink_get_type();
87 	}
88 
89 	/**
90 	 * Gets the index with the hypertext document at which this link ends.
91 	 *
92 	 * Return: the index with the hypertext document at which this link ends
93 	 */
94 	public int getEndIndex()
95 	{
96 		return atk_hyperlink_get_end_index(atkHyperlink);
97 	}
98 
99 	/**
100 	 * Gets the number of anchors associated with this hyperlink.
101 	 *
102 	 * Return: the number of anchors associated with this hyperlink
103 	 */
104 	public int getNAnchors()
105 	{
106 		return atk_hyperlink_get_n_anchors(atkHyperlink);
107 	}
108 
109 	/**
110 	 * Returns the item associated with this hyperlinks nth anchor.
111 	 * For instance, the returned #AtkObject will implement #AtkText
112 	 * if @link_ is a text hyperlink, #AtkImage if @link_ is an image
113 	 * hyperlink etc.
114 	 *
115 	 * Multiple anchors are primarily used by client-side image maps.
116 	 *
117 	 * Params:
118 	 *     i = a (zero-index) integer specifying the desired anchor
119 	 *
120 	 * Return: an #AtkObject associated with this hyperlinks
121 	 *     i-th anchor
122 	 */
123 	public ObjectAtk getObject(int i)
124 	{
125 		auto p = atk_hyperlink_get_object(atkHyperlink, i);
126 		
127 		if(p is null)
128 		{
129 			return null;
130 		}
131 		
132 		return ObjectG.getDObject!(ObjectAtk)(cast(AtkObject*) p);
133 	}
134 
135 	/**
136 	 * Gets the index with the hypertext document at which this link begins.
137 	 *
138 	 * Return: the index with the hypertext document at which this link begins
139 	 */
140 	public int getStartIndex()
141 	{
142 		return atk_hyperlink_get_start_index(atkHyperlink);
143 	}
144 
145 	/**
146 	 * Get a the URI associated with the anchor specified
147 	 * by @i of @link_.
148 	 *
149 	 * Multiple anchors are primarily used by client-side image maps.
150 	 *
151 	 * Params:
152 	 *     i = a (zero-index) integer specifying the desired anchor
153 	 *
154 	 * Return: a string specifying the URI
155 	 */
156 	public string getUri(int i)
157 	{
158 		return Str.toString(atk_hyperlink_get_uri(atkHyperlink, i));
159 	}
160 
161 	/**
162 	 * Indicates whether the link currently displays some or all of its
163 	 * content inline.  Ordinary HTML links will usually return
164 	 * %FALSE, but an inline <src> HTML element will return
165 	 * %TRUE.
166 	 *
167 	 * Return: whether or not this link displays its content inline.
168 	 */
169 	public bool isInline()
170 	{
171 		return atk_hyperlink_is_inline(atkHyperlink) != 0;
172 	}
173 
174 	/**
175 	 * Determines whether this AtkHyperlink is selected
176 	 *
177 	 * Deprecated: This method is deprecated since ATK version 1.8.
178 	 * Please use ATK_STATE_FOCUSABLE for all links, and ATK_STATE_FOCUSED
179 	 * for focused links.
180 	 *
181 	 * Return: True if the AtkHyperlink is selected, False otherwise
182 	 *
183 	 * Since: 1.4
184 	 */
185 	public bool isSelectedLink()
186 	{
187 		return atk_hyperlink_is_selected_link(atkHyperlink) != 0;
188 	}
189 
190 	/**
191 	 * Since the document that a link is associated with may have changed
192 	 * this method returns %TRUE if the link is still valid (with
193 	 * respect to the document it references) and %FALSE otherwise.
194 	 *
195 	 * Return: whether or not this link is still valid
196 	 */
197 	public bool isValid()
198 	{
199 		return atk_hyperlink_is_valid(atkHyperlink) != 0;
200 	}
201 
202 	int[string] connectedSignals;
203 
204 	void delegate(Hyperlink)[] onLinkActivatedListeners;
205 	/**
206 	 * The signal link-activated is emitted when a link is activated.
207 	 */
208 	void addOnLinkActivated(void delegate(Hyperlink) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
209 	{
210 		if ( "link-activated" !in connectedSignals )
211 		{
212 			Signals.connectData(
213 				this,
214 				"link-activated",
215 				cast(GCallback)&callBackLinkActivated,
216 				cast(void*)this,
217 				null,
218 				connectFlags);
219 			connectedSignals["link-activated"] = 1;
220 		}
221 		onLinkActivatedListeners ~= dlg;
222 	}
223 	extern(C) static void callBackLinkActivated(AtkHyperlink* hyperlinkStruct, Hyperlink _hyperlink)
224 	{
225 		foreach ( void delegate(Hyperlink) dlg; _hyperlink.onLinkActivatedListeners )
226 		{
227 			dlg(_hyperlink);
228 		}
229 	}
230 }