File: classGFC_1_1Atk_1_1Hypertext.html

package info (click to toggle)
gfcui 2.3.1-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 43,420 kB
  • ctags: 18,023
  • sloc: cpp: 53,967; sh: 31,555; makefile: 1,322; perl: 108
file content (201 lines) | stat: -rw-r--r-- 10,615 bytes parent folder | download | duplicates (3)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <meta content="text/html; charset=ISO-8859-1"
 http-equiv="content-type">
  <title>GTK+ Foundation Classes</title>
  <link href="gfc.css" rel="stylesheet" type="text/css">
  <meta content="The GFC Development Team" name="author">
  <meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
 alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
 border="0" cellpadding="0" cellspacing="0">
  <tbody>
    <tr>
      <td
 style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
 alt="GFC Logo" src="../images/gfc.png"
 style="width: 207px; height: 92px;"></td>
      <td
 style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
 alt="GFC Title Logo" src="../images/gfc-title.png"
 style="width: 418px; height: 76px;"><br>
      </td>
    </tr>
    <tr>
      <td
 style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
 style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
      </td>
      <td
 style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
 style="font-family: helvetica,arial,sans-serif;"><a
 href="../html/index.html">Main Page</a>&nbsp; |&nbsp; <a
 href="../html/namespaces.html">Namespace List</a>&nbsp; |&nbsp; <a
 href="classes.html">Alphabetical List</a>&nbsp; |&nbsp; <a
 href="../html/annotated.html">Class List</a>&nbsp; |&nbsp; <a
 href="../html/files.html">File List</a></small><br>
      </td>
    </tr>
  </tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Atk::Hypertext Class Reference</h1>An AtkHypertext C++ wrapper class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="hypertext_8hh-source.html">gfc/atk/hypertext.hh</a>&gt;</code>
<p>
<p>Inheritance diagram for GFC::Atk::Hypertext:
<p><center><img src="classGFC_1_1Atk_1_1Hypertext.png" usemap="#GFC::Atk::Hypertext_map" border="0" alt=""></center>
<map name="GFC::Atk::Hypertext_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="0,112,137,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,137,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,137,24">
</map>
<a href="classGFC_1_1Atk_1_1Hypertext-members.html">List of all members.</a><h2>Signal Protptypes</h2>
<ul>
<li>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">LinkSelectedSignalType</a> <a class="el" href="classGFC_1_1Atk_1_1Hypertext.html#z23_2">link_selected_signal</a>
<dl class="el"><dd class="mdescRight">Link selected signal (see <a class="el" href="classGFC_1_1Atk_1_1Hypertext.html#z25_0">sig_link_selected()</a>).  <a href="#z23_2"></a><br></dl></ul>
<h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z24_0" doxytag="GFC::Atk::Hypertext::atk_hypertext" ></a>
AtkHypertext * <a class="el" href="classGFC_1_1Atk_1_1Hypertext.html#z24_0">atk_hypertext</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the AtkHypertext structure. <br></dl><li><a class="anchor" name="z24_1" doxytag="GFC::Atk::Hypertext::operator AtkHypertext *" ></a>
<a class="el" href="classGFC_1_1Atk_1_1Hypertext.html#z24_1">operator AtkHypertext *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Atk_1_1Hypertext.html">Hypertext</a> to an AtkHypertext pointer. <br></dl><li><a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html">Hyperlink</a> * <a class="el" href="classGFC_1_1Atk_1_1Hypertext.html#z24_2">get_link</a> (int link_index) const
<dl class="el"><dd class="mdescRight">Gets the link in this hypertext document at index <em>link_index</em>.  <a href="#z24_2"></a><br></dl><li><a class="anchor" name="z24_3" doxytag="GFC::Atk::Hypertext::get_n_links" ></a>
int <a class="el" href="classGFC_1_1Atk_1_1Hypertext.html#z24_3">get_n_links</a> (int char_index) const
<dl class="el"><dd class="mdescRight">Returns the number of links within this hypertext document. <br></dl><li>int <a class="el" href="classGFC_1_1Atk_1_1Hypertext.html#z24_4">get_link_index</a> (int char_index) const
<dl class="el"><dd class="mdescRight">Gets the index into the array of hyperlinks that is associated with the character specified by <em>char_index</em>, or -1 if there is no hyperlink associated with this character.  <a href="#z24_4"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Signal Proxies</div></td></tr>
<ul>
<li><a class="anchor" name="z25_0" doxytag="GFC::Atk::Hypertext::sig_link_selected" ></a>
const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1SignalProxy.html">LinkSelectedSignalProxy</a> <a class="el" href="classGFC_1_1Atk_1_1Hypertext.html#z25_0">sig_link_selected</a> ()
<dl class="el"><dd class="mdescRight">Connect to the link_selected_signal; emitted when the hypertext object is selected. <br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z22_0" doxytag="GFC::Atk::Hypertext::Hypertext" ></a>
<a class="el" href="classGFC_1_1Atk_1_1Hypertext.html#z22_0">Hypertext</a> ()
<dl class="el"><dd class="mdescRight">Constructs a new <a class="el" href="classGFC_1_1Atk_1_1Hypertext.html">Hypertext</a> object. <br></dl><li><a class="anchor" name="z22_1" doxytag="GFC::Atk::Hypertext::~Hypertext" ></a>
virtual <a class="el" href="classGFC_1_1Atk_1_1Hypertext.html#z22_1">~Hypertext</a> ()=0
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An AtkHypertext C++ wrapper class. 
<p>
<a class="el" href="classGFC_1_1Atk_1_1Hypertext.html">Hypertext</a> is an interface which provides a standard mechanism for manipulating hyperlinks. 
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z24_2" doxytag="GFC::Atk::Hypertext::get_link" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="classGFC_1_1Atk_1_1Hyperlink.html">Hyperlink</a>* GFC::Atk::Hypertext::get_link           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>link_index</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets the link in this hypertext document at index <em>link_index</em>. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>link_index</em>&nbsp;</td><td>An integer specifying the desired link. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The link in this hypertext document at index <em>link_index</em>. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="z24_4" doxytag="GFC::Atk::Hypertext::get_link_index" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> int GFC::Atk::Hypertext::get_link_index           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>char_index</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets the index into the array of hyperlinks that is associated with the character specified by <em>char_index</em>, or -1 if there is no hyperlink associated with this character. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>char_index</em>&nbsp;</td><td>A character index. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>An index into the array of hyperlinks in the hypertext. </dd></dl>
    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="z23_2" doxytag="GFC::Atk::Hypertext::link_selected_signal" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Signal.html">LinkSelectedSignalType</a> <a class="el" href="classGFC_1_1Atk_1_1Hypertext.html#z23_2">GFC::Atk::Hypertext::link_selected_signal</a><code> [static, protected]</code>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Link selected signal (see <a class="el" href="classGFC_1_1Atk_1_1Hypertext.html#z25_0">sig_link_selected()</a>). 
<p>
Calls a slot with the signature: <div class="fragment"><pre>             <span class="keywordtype">void</span> function(<span class="keywordtype">int</span> link_index);
             <span class="comment">// link_index: The index of the hyperlink which is selected.</span>
</pre></div>    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="hypertext_8hh-source.html">hypertext.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:34 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>