1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
/*
* This file is part of gtkD.
*
* gtkD is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module atk.Hyperlink;
private import atk.ActionIF;
private import atk.ActionT;
private import atk.ObjectAtk;
private import atk.c.functions;
public import atk.c.types;
private import glib.Str;
private import gobject.ObjectG;
private import gobject.Signals;
public import gtkc.atktypes;
private import std.algorithm;
/**
* An ATK object which encapsulates a link or set of links (for
* instance in the case of client-side image maps) in a hypertext
* document. It may implement the AtkAction interface. AtkHyperlink
* may also be used to refer to inline embedded content, since it
* allows specification of a start and end offset within the host
* AtkHypertext object.
*/
public class Hyperlink : ObjectG, ActionIF
{
/** the main Gtk struct */
protected AtkHyperlink* atkHyperlink;
/** Get the main Gtk struct */
public AtkHyperlink* getHyperlinkStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return atkHyperlink;
}
/** the main Gtk struct as a void* */
protected override void* getStruct()
{
return cast(void*)atkHyperlink;
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (AtkHyperlink* atkHyperlink, bool ownedRef = false)
{
this.atkHyperlink = atkHyperlink;
super(cast(GObject*)atkHyperlink, ownedRef);
}
// add the Action capabilities
mixin ActionT!(AtkHyperlink);
/** */
public static GType getType()
{
return atk_hyperlink_get_type();
}
/**
* Gets the index with the hypertext document at which this link ends.
*
* Returns: the index with the hypertext document at which this link ends
*/
public int getEndIndex()
{
return atk_hyperlink_get_end_index(atkHyperlink);
}
/**
* Gets the number of anchors associated with this hyperlink.
*
* Returns: the number of anchors associated with this hyperlink
*/
public int getNAnchors()
{
return atk_hyperlink_get_n_anchors(atkHyperlink);
}
/**
* Returns the item associated with this hyperlinks nth anchor.
* For instance, the returned #AtkObject will implement #AtkText
* if @link_ is a text hyperlink, #AtkImage if @link_ is an image
* hyperlink etc.
*
* Multiple anchors are primarily used by client-side image maps.
*
* Params:
* i = a (zero-index) integer specifying the desired anchor
*
* Returns: an #AtkObject associated with this hyperlinks
* i-th anchor
*/
public ObjectAtk getObject(int i)
{
auto __p = atk_hyperlink_get_object(atkHyperlink, i);
if(__p is null)
{
return null;
}
return ObjectG.getDObject!(ObjectAtk)(cast(AtkObject*) __p);
}
/**
* Gets the index with the hypertext document at which this link begins.
*
* Returns: the index with the hypertext document at which this link begins
*/
public int getStartIndex()
{
return atk_hyperlink_get_start_index(atkHyperlink);
}
/**
* Get a the URI associated with the anchor specified
* by @i of @link_.
*
* Multiple anchors are primarily used by client-side image maps.
*
* Params:
* i = a (zero-index) integer specifying the desired anchor
*
* Returns: a string specifying the URI
*/
public string getUri(int i)
{
auto retStr = atk_hyperlink_get_uri(atkHyperlink, i);
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Indicates whether the link currently displays some or all of its
* content inline. Ordinary HTML links will usually return
* %FALSE, but an inline <src> HTML element will return
* %TRUE.
*
* Returns: whether or not this link displays its content inline.
*/
public bool isInline()
{
return atk_hyperlink_is_inline(atkHyperlink) != 0;
}
/**
* Determines whether this AtkHyperlink is selected
*
* Deprecated: Please use ATK_STATE_FOCUSABLE for all links,
* and ATK_STATE_FOCUSED for focused links.
*
* Returns: True if the AtkHyperlink is selected, False otherwise
*
* Since: 1.4
*/
public bool isSelectedLink()
{
return atk_hyperlink_is_selected_link(atkHyperlink) != 0;
}
/**
* Since the document that a link is associated with may have changed
* this method returns %TRUE if the link is still valid (with
* respect to the document it references) and %FALSE otherwise.
*
* Returns: whether or not this link is still valid
*/
public bool isValid()
{
return atk_hyperlink_is_valid(atkHyperlink) != 0;
}
/**
* The signal link-activated is emitted when a link is activated.
*/
gulong addOnLinkActivated(void delegate(Hyperlink) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
{
return Signals.connect(this, "link-activated", dlg, connectFlags ^ ConnectFlags.SWAPPED);
}
}
|
