<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>at-spi-idl: Accessibility::Document Interface Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespaceAccessibility.html">Accessibility</a>::<a class="el" href="interfaceAccessibility_1_1Document.html">Document</a></div>
<h1>Accessibility::Document Interface Reference</h1><!-- doxytag: class="Accessibility::Document" --><code>import "<a class="el" href="Accessibility__Document_8idl-source.html">Accessibility_Document.idl</a>";</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Document.html#a8c2f9c290c2d0b3eb1ec34cd8ece2d9">getLocale</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Document.html#423c47959242725c9738acde85e72a5f">getAttributeValue</a> (in string attributename)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceAccessibility.html#45e67db025f22a4a67e3e3fcfc9327e9">AttributeSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Document.html#5259302dc49cae44c8f5bbf778480d90">getAttributes</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Primarily a 'tagging' interface which indicates the start of document content in the <a class="el" href="namespaceAccessibility.html">Accessibility</a> hierarchy. <a class="el" href="interfaceAccessibility_1_1Accessible.html">Accessible</a> objects below the node implementing <a class="el" href="interfaceAccessibility_1_1Document.html">Document</a> are normally assumed to be part of the document content. Attributes of <a class="el" href="interfaceAccessibility_1_1Document.html">Document</a> are those attributes associated with the document as a whole. Objects that implement <a class="el" href="interfaceAccessibility_1_1Document.html">Document</a> are normally expected to implement <a class="el" href="interfaceAccessibility_1_1Collection.html">Collection</a> as well.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="interfaceAccessibility_1_1Collection.html">Accessibility::Collection</a> </dd></dl>
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a8c2f9c290c2d0b3eb1ec34cd8ece2d9"></a><!-- doxytag: member="Accessibility::Document::getLocale" ref="a8c2f9c290c2d0b3eb1ec34cd8ece2d9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Accessibility::Document::getLocale </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the locale associated with the document's content. e.g. the locale for LOCALE_TYPE_MESSAGES.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a string compliant with the POSIX standard for locale description. </dd></dl>
</div>
</div><p>
<a class="anchor" name="423c47959242725c9738acde85e72a5f"></a><!-- doxytag: member="Accessibility::Document::getAttributeValue" ref="423c47959242725c9738acde85e72a5f" args="(in string attributename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Accessibility::Document::getAttributeValue </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"> <em>attributename</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the value of a single attribute, if specified for the document as a whole.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>attributename,:</em> </td><td>a string indicating the name of a specific attribute (name-value pair) being queried.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a string corresponding to the value of the specified attribute, or an empty string if the attribute is unspecified for the object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5259302dc49cae44c8f5bbf778480d90"></a><!-- doxytag: member="Accessibility::Document::getAttributes" ref="5259302dc49cae44c8f5bbf778480d90" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceAccessibility.html#45e67db025f22a4a67e3e3fcfc9327e9">AttributeSet</a> Accessibility::Document::getAttributes </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets all attributes specified for a document as a whole. For attributes which change within the document content, see <a class="el" href="interfaceAccessibility_1_1Text.html#0456e30d8b3d298c8d9973e413e32714">Accessibility::Text::getAttributes</a> instead.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>an <a class="el" href="namespaceAccessibility.html#45e67db025f22a4a67e3e3fcfc9327e9">AttributeSet</a> containing the attributes of the document, as name-value pairs.</dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>AT-SPI 1.8.0 </dd></dl>
</div>
</div><p>
<hr>The documentation for this interface was generated from the following file:<ul>
<li>/home/liyuan/src/at-spi/idl/<a class="el" href="Accessibility__Document_8idl-source.html">Accessibility_Document.idl</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jul 10 10:46:52 2007 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
