<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>at-spi-idl: Accessibility::Document Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<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="tabs2">
<ul class="tablist">
<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="navpath">
<ul>
<li><a class="el" href="namespaceAccessibility.html">Accessibility</a> </li>
<li><a class="el" href="interfaceAccessibility_1_1Document.html">Accessibility::Document</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Accessibility::Document Interface Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Accessibility::Document" -->
<p><code>import "<a class="el" href="Accessibility__Document_8idl_source.html">Accessibility_Document.idl</a>";</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Document.html#a634e4f2196a38c688cf2e89dbbd3f1ec">getLocale</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Document.html#ac8faa16758de3481df32940b75f5bde5">getAttributeValue</a> (in string attributename)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceAccessibility.html#a917a6a01da45802ba562d131cae3c4e9">AttributeSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1Document.html#a06fb8f1347e46459b261de33df0cbf7e">getAttributes</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>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"><dt><b>See also:</b></dt><dd><a class="el" href="interfaceAccessibility_1_1Collection.html">Accessibility::Collection</a> </dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a06fb8f1347e46459b261de33df0cbf7e"></a><!-- doxytag: member="Accessibility::Document::getAttributes" ref="a06fb8f1347e46459b261de33df0cbf7e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceAccessibility.html#a917a6a01da45802ba562d131cae3c4e9">AttributeSet</a> Accessibility::Document::getAttributes </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></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#a6fc2c01b914fb791fb190275f6ad188d">Accessibility::Text::getAttributes</a> instead.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>an <a class="el" href="namespaceAccessibility.html#a917a6a01da45802ba562d131cae3c4e9">AttributeSet</a> containing the attributes of the document, as name-value pairs.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>AT-SPI 1.8.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ac8faa16758de3481df32940b75f5bde5"></a><!-- doxytag: member="Accessibility::Document::getAttributeValue" ref="ac8faa16758de3481df32940b75f5bde5" 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></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><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>
</dd>
</dl>
<dl class="return"><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>
<a class="anchor" id="a634e4f2196a38c688cf2e89dbbd3f1ec"></a><!-- doxytag: member="Accessibility::Document::getLocale" ref="a634e4f2196a38c688cf2e89dbbd3f1ec" 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></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"><dt><b>Returns:</b></dt><dd>a string compliant with the POSIX standard for locale description. </dd></dl>
</div>
</div>
<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></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Sep 27 2010 16:50:43 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
