← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/at-spi/intrepid-updates

« back to all changes in this revision

Viewing changes to docs/reference/idl/html/interfaceAccessibility_1_1Hyperlink.html

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2008-09-01 16:58:56 UTC
  • mfrom: (1.1.34 upstream)
  • Revision ID: james.westby@ubuntu.com-20080901165856-itp2lms1sml4a63s
Tags: 1.23.91-0ubuntu1
https://launchpad.net/bugs/263729
* New upstream release (LP: #263729)
  - Bugfixes: #548559, #350552, #547875.
  - Translation update
* debian/control.in:
  - Add B-d on intltool (>= 0.40.0)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/idl/html/interfaceAccessibility_1_1Hyperlink.html
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6
6
</head><body>
7
 
<!-- Generated by Doxygen 1.5.2 -->
8
 
<div class="tabs">
9
 
  <ul>
10
 
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11
 
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
12
 
    <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13
 
    <li><a href="files.html"><span>Files</span></a></li>
14
 
    <li><a href="dirs.html"><span>Directories</span></a></li>
15
 
  </ul>
16
 
</div>
17
 
<div class="tabs">
18
 
  <ul>
19
 
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
20
 
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
21
 
    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
22
 
  </ul>
23
 
</div>
24
 
<div class="nav">
25
 
<a class="el" href="namespaceAccessibility.html">Accessibility</a>::<a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a></div>
 
7
<!-- Generated by Doxygen 1.5.6 -->
 
8
<div class="navigation" id="top">
 
9
  <div class="tabs">
 
10
    <ul>
 
11
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
12
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
13
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
 
14
      <li><a href="files.html"><span>Files</span></a></li>
 
15
      <li><a href="dirs.html"><span>Directories</span></a></li>
 
16
    </ul>
 
17
  </div>
 
18
  <div class="tabs">
 
19
    <ul>
 
20
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
 
21
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
 
22
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
 
23
    </ul>
 
24
  </div>
 
25
  <div class="navpath"><a class="el" href="namespaceAccessibility.html">Accessibility</a>::<a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a>
 
26
  </div>
 
27
</div>
 
28
<div class="contents">
26
29
<h1>Accessibility::Hyperlink Interface Reference</h1><!-- doxytag: class="Accessibility::Hyperlink" --><code>import &quot;<a class="el" href="Accessibility__Hyperlink_8idl-source.html">Accessibility_Hyperlink.idl</a>&quot;;</code>
27
30
<p>
28
31
<table border="0" cellpadding="0" cellspacing="0">
29
32
<tr><td></td></tr>
30
33
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
31
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#91d295ccf1f70fad25da559aeecac15e">getObject</a> (in long i)</td></tr>
32
 
 
33
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#56704bdd0f28b6185980ef5598bc27e3">getURI</a> (in long i)</td></tr>
34
 
 
35
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#0c1be53852aed53315e1c9ded7c1c1de">isValid</a> ()</td></tr>
 
34
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#70527ab0419688742321b9202089385b">getObject</a> (in long i)</td></tr>
 
35
 
 
36
<tr><td class="memItemLeft" nowrap align="right" valign="top">string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#68d393ecf0f993b57613b4ef7f33e413">getURI</a> (in long i)</td></tr>
 
37
 
 
38
<tr><td class="memItemLeft" nowrap align="right" valign="top">boolean&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#d343fa13fb7aa3e63f29b2dfbda04acb">isValid</a> ()</td></tr>
36
39
 
37
40
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
38
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute short&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#f911700a26c410fc9ecdd1d8989e8aa4">nAnchors</a></td></tr>
39
 
 
40
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#de67595afcdb8b60e2ca5b8b7b94f5c0">startIndex</a></td></tr>
41
 
 
42
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#4d7a910fec3e666a2459448b9be44c87">endIndex</a></td></tr>
 
41
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute short&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#310204407b769c9deddf5cccd65c5e0b">nAnchors</a></td></tr>
 
42
 
 
43
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#8f26e50dd42ca0939de07ded7bc23f0d">startIndex</a></td></tr>
 
44
 
 
45
<tr><td class="memItemLeft" nowrap align="right" valign="top">readonly attribute long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Hyperlink.html#2909042757ca789fd497546df8aacd84">endIndex</a></td></tr>
43
46
 
44
47
</table>
45
48
<hr><a name="_details"></a><h2>Detailed Description</h2>
46
49
Instances of <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> are returned by <a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a> objects, and are the means by which end users and clients interact with linked, and in some cases embedded, content. Hyperlinks may have multiple "anchors", where an anchor corresponds to a reference to a particular resource with a corresponding resource identified (URI). Hyperlinks may be queried for their URIs, or queried for the objects corresponding to their anchors. The objects thus obtained are instances of <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a>, and may be queried, and manipulated via the <a class="el" href="interfaceAccessibility_1_1Action.html">Action</a> interface.<p>
47
 
<dl class="note" compact><dt><b>Note:</b></dt><dd>A <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> implementor is normally NOT an <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a>; the preferred usage is for a Hyperlink's associated "objects" (accessed via the getObject method) are Accessibles. This means that Actions such as "open link" are normally invoked on the result of <a class="el" href="interfaceAccessibility_1_1Hyperlink.html#91d295ccf1f70fad25da559aeecac15e">Hyperlink::getObject</a> rather than directly on the <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> instance. For historical reasons some implementors of <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> implement <a class="el" href="interfaceAccessibility_1_1Action.html">Action</a> as well. This usage on the part of implementing applications and toolkits is discouraged, but clients of <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> should be aware of it and prepared to handle such usage. </dd></dl>
48
 
 
49
 
<p>
 
50
<dl class="note" compact><dt><b>Note:</b></dt><dd>A <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> implementor is normally NOT an <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a>; the preferred usage is for a Hyperlink's associated "objects" (accessed via the getObject method) are Accessibles. This means that Actions such as "open link" are normally invoked on the result of <a class="el" href="interfaceAccessibility_1_1Hyperlink.html#70527ab0419688742321b9202089385b">Hyperlink::getObject</a> rather than directly on the <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> instance. For historical reasons some implementors of <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> implement <a class="el" href="interfaceAccessibility_1_1Action.html">Action</a> as well. This usage on the part of implementing applications and toolkits is discouraged, but clients of <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> should be aware of it and prepared to handle such usage. </dd></dl>
50
51
<hr><h2>Member Function Documentation</h2>
51
 
<a class="anchor" name="91d295ccf1f70fad25da559aeecac15e"></a><!-- doxytag: member="Accessibility::Hyperlink::getObject" ref="91d295ccf1f70fad25da559aeecac15e" args="(in long i)" -->
 
52
<a class="anchor" name="70527ab0419688742321b9202089385b"></a><!-- doxytag: member="Accessibility::Hyperlink::getObject" ref="70527ab0419688742321b9202089385b" args="(in long i)" -->
52
53
<div class="memitem">
53
54
<div class="memproto">
54
55
      <table class="memname">
58
59
          <td class="paramtype">in long&nbsp;</td>
59
60
          <td class="paramname"> <em>i</em>          </td>
60
61
          <td>&nbsp;)&nbsp;</td>
61
 
          <td width="100%"></td>
 
62
          <td></td>
62
63
        </tr>
63
64
      </table>
64
65
</div>
71
72
 
72
73
</div>
73
74
</div><p>
74
 
<a class="anchor" name="56704bdd0f28b6185980ef5598bc27e3"></a><!-- doxytag: member="Accessibility::Hyperlink::getURI" ref="56704bdd0f28b6185980ef5598bc27e3" args="(in long i)" -->
 
75
<a class="anchor" name="68d393ecf0f993b57613b4ef7f33e413"></a><!-- doxytag: member="Accessibility::Hyperlink::getURI" ref="68d393ecf0f993b57613b4ef7f33e413" args="(in long i)" -->
75
76
<div class="memitem">
76
77
<div class="memproto">
77
78
      <table class="memname">
81
82
          <td class="paramtype">in long&nbsp;</td>
82
83
          <td class="paramname"> <em>i</em>          </td>
83
84
          <td>&nbsp;)&nbsp;</td>
84
 
          <td width="100%"></td>
 
85
          <td></td>
85
86
        </tr>
86
87
      </table>
87
88
</div>
92
93
 
93
94
</div>
94
95
</div><p>
95
 
<a class="anchor" name="0c1be53852aed53315e1c9ded7c1c1de"></a><!-- doxytag: member="Accessibility::Hyperlink::isValid" ref="0c1be53852aed53315e1c9ded7c1c1de" args="()" -->
 
96
<a class="anchor" name="d343fa13fb7aa3e63f29b2dfbda04acb"></a><!-- doxytag: member="Accessibility::Hyperlink::isValid" ref="d343fa13fb7aa3e63f29b2dfbda04acb" args="()" -->
96
97
<div class="memitem">
97
98
<div class="memproto">
98
99
      <table class="memname">
101
102
          <td>(</td>
102
103
          <td class="paramname">          </td>
103
104
          <td>&nbsp;)&nbsp;</td>
104
 
          <td width="100%"></td>
 
105
          <td></td>
105
106
        </tr>
106
107
      </table>
107
108
</div>
114
115
</div>
115
116
</div><p>
116
117
<hr><h2>Field Documentation</h2>
117
 
<a class="anchor" name="f911700a26c410fc9ecdd1d8989e8aa4"></a><!-- doxytag: member="Accessibility::Hyperlink::nAnchors" ref="f911700a26c410fc9ecdd1d8989e8aa4" args="" -->
 
118
<a class="anchor" name="310204407b769c9deddf5cccd65c5e0b"></a><!-- doxytag: member="Accessibility::Hyperlink::nAnchors" ref="310204407b769c9deddf5cccd65c5e0b" args="" -->
118
119
<div class="memitem">
119
120
<div class="memproto">
120
121
      <table class="memname">
121
122
        <tr>
122
 
          <td class="memname">readonly attribute short <a class="el" href="interfaceAccessibility_1_1Hyperlink.html#f911700a26c410fc9ecdd1d8989e8aa4">Accessibility::Hyperlink::nAnchors</a>          </td>
 
123
          <td class="memname">readonly attribute short <a class="el" href="interfaceAccessibility_1_1Hyperlink.html#310204407b769c9deddf5cccd65c5e0b">Accessibility::Hyperlink::nAnchors</a>          </td>
123
124
        </tr>
124
125
      </table>
125
126
</div>
129
130
the number of separate anchors associated with this <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> 
130
131
</div>
131
132
</div><p>
132
 
<a class="anchor" name="de67595afcdb8b60e2ca5b8b7b94f5c0"></a><!-- doxytag: member="Accessibility::Hyperlink::startIndex" ref="de67595afcdb8b60e2ca5b8b7b94f5c0" args="" -->
 
133
<a class="anchor" name="8f26e50dd42ca0939de07ded7bc23f0d"></a><!-- doxytag: member="Accessibility::Hyperlink::startIndex" ref="8f26e50dd42ca0939de07ded7bc23f0d" args="" -->
133
134
<div class="memitem">
134
135
<div class="memproto">
135
136
      <table class="memname">
136
137
        <tr>
137
 
          <td class="memname">readonly attribute long <a class="el" href="interfaceAccessibility_1_1Hyperlink.html#de67595afcdb8b60e2ca5b8b7b94f5c0">Accessibility::Hyperlink::startIndex</a>          </td>
 
138
          <td class="memname">readonly attribute long <a class="el" href="interfaceAccessibility_1_1Hyperlink.html#8f26e50dd42ca0939de07ded7bc23f0d">Accessibility::Hyperlink::startIndex</a>          </td>
138
139
        </tr>
139
140
      </table>
140
141
</div>
144
145
the starting offset within the containing <a class="el" href="interfaceAccessibility_1_1Hypertext.html">Hypertext</a> content with which this <a class="el" href="interfaceAccessibility_1_1Hyperlink.html">Hyperlink</a> is associated 
145
146
</div>
146
147
</div><p>
147
 
<a class="anchor" name="4d7a910fec3e666a2459448b9be44c87"></a><!-- doxytag: member="Accessibility::Hyperlink::endIndex" ref="4d7a910fec3e666a2459448b9be44c87" args="" -->
 
148
<a class="anchor" name="2909042757ca789fd497546df8aacd84"></a><!-- doxytag: member="Accessibility::Hyperlink::endIndex" ref="2909042757ca789fd497546df8aacd84" args="" -->
148
149
<div class="memitem">
149
150
<div class="memproto">
150
151
      <table class="memname">
151
152
        <tr>
152
 
          <td class="memname">readonly attribute long <a class="el" href="interfaceAccessibility_1_1Hyperlink.html#4d7a910fec3e666a2459448b9be44c87">Accessibility::Hyperlink::endIndex</a>          </td>
 
153
          <td class="memname">readonly attribute long <a class="el" href="interfaceAccessibility_1_1Hyperlink.html#2909042757ca789fd497546df8aacd84">Accessibility::Hyperlink::endIndex</a>          </td>
153
154
        </tr>
154
155
      </table>
155
156
</div>
160
161
</div>
161
162
</div><p>
162
163
<hr>The documentation for this interface was generated from the following file:<ul>
163
 
<li>/home/liyuan/src/at-spi/idl/<a class="el" href="Accessibility__Hyperlink_8idl-source.html">Accessibility_Hyperlink.idl</a></ul>
164
 
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jul 10 10:46:52 2007 for at-spi-idl by&nbsp;
 
164
<li>/export/home/liyuan/src/at-spi/idl/<a class="el" href="Accessibility__Hyperlink_8idl-source.html">Accessibility_Hyperlink.idl</a></ul>
 
165
</div>
 
166
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 1 22:49:50 2008 for at-spi-idl by&nbsp;
165
167
<a href="http://www.doxygen.org/index.html">
166
 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
 
168
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
167
169
</body>
168
170
</html>