|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/21585/root/usr/share/gtk-doc/html/atk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>AtkDocument</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atk.html" title="ATK Library">
<link rel="prev" href="AtkComponent.html" title="AtkComponent">
<link rel="next" href="AtkEditableText.html" title="AtkEditableText">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="atk.html" title="ATK Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in ATK 1.3">
<link rel="index" href="ix04.html" title="Index of new symbols in ATK 1.4">
<link rel="index" href="ix05.html" title="Index of new symbols in ATK 1.6">
<link rel="index" href="ix06.html" title="Index of new symbols in ATK 1.9">
<link rel="index" href="ix07.html" title="Index of new symbols in ATK 1.12">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="AtkComponent.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="atk.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
<td><a accesskey="n" href="AtkEditableText.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2539377" class="shortcut">Top</a>
 | 
<a href="#id2539583" class="shortcut">Description</a>
 | 
<a href="#id2539559" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="AtkDocument"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2539377"></a><span class="refentrytitle">AtkDocument</span>
</h2>
<p>AtkDocument — The ATK interface which allows access to a DOM associated with on object.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="AtkDocument.html#AtkDocument-struct">AtkDocument</a>;
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkDocument.html#atk-document-get-document-type">atk_document_get_document_type</a> (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> <a href="AtkDocument.html#atk-document-get-document">atk_document_get_document</a> (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkDocument.html#atk-document-get-attribute-value">atk_document_get_attribute_value</a>
(<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *attribute_name);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="AtkDocument.html#atk-document-set-attribute-value">atk_document_set_attribute_value</a>
(<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *attribute_name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *attribute_value);
<a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a>* <a href="AtkDocument.html#atk-document-get-attributes">atk_document_get_attributes</a>
(<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkDocument.html#atk-document-get-locale">atk_document_get_locale</a> (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2539559"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----AtkDocument
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2539583"></a><h2>Description</h2>
<p>
The AtkDocument interface should be supported by any object that has an
associated document object model (DOM). This interface provides the
standard mechanism allowing an assistive technology access to the DOM.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2539601"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2539612"></a><h3>
<a name="AtkDocument-struct"></a>AtkDocument</h3>
<a class="indexterm" name="id2539624"></a><pre class="programlisting">typedef struct _AtkDocument AtkDocument;</pre>
<p>
The AtkDocument structure does not contain any fields.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2539640"></a><h3>
<a name="atk-document-get-document-type"></a>atk_document_get_document_type ()</h3>
<a class="indexterm" name="id2539653"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_document_get_document_type (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
<p>
Gets a string indicating the document type.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>document</code></em> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkDocumentIface
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a string indicating the document type
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2539724"></a><h3>
<a name="atk-document-get-document"></a>atk_document_get_document ()</h3>
<a class="indexterm" name="id2539738"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> atk_document_get_document (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
<p>
Gets a <a
href="../glib/glib-Basic-Types.html#gpointer"
><code class="literal">gpointer</code></a> that points to an instance of the DOM. It is
up to the caller to check atk_document_get_type to determine
how to cast this pointer.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>document</code></em> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkDocumentIface
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a <a
href="../glib/glib-Basic-Types.html#gpointer"
><code class="literal">gpointer</code></a> that points to an instance of the DOM.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2539829"></a><h3>
<a name="atk-document-get-attribute-value"></a>atk_document_get_attribute_value ()</h3>
<a class="indexterm" name="id2539844"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_document_get_attribute_value
(<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *attribute_name);</pre>
<p>
Returns:</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>document</code></em> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkDocumentIface
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>attribute_name</code></em> :</span></td>
<td> a character string representing the name of the attribute
whose value is being queried.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a string value associated with the named attribute for this
document, or NULL if a value for <span class="type">attribute_name</span> has not been specified
for this document.
</td>
</tr>
</tbody>
</table></div>
<p>Since ATK 1.12
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2539955"></a><h3>
<a name="atk-document-set-attribute-value"></a>atk_document_set_attribute_value ()</h3>
<a class="indexterm" name="id2539971"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> atk_document_set_attribute_value
(<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *attribute_name,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *attribute_value);</pre>
<p>
Returns:</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>document</code></em> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkDocumentIface
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>attribute_name</code></em> :</span></td>
<td> a character string representing the name of the attribute
whose value is being set.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>attribute_value</code></em> :</span></td>
<td> a string value to be associated with <span class="type">attribute_name</span>.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if <span class="type">value</span> is successfully associated with <span class="type">attribute_name</span>
for this document, FALSE otherwise (e.g. if the document does not
allow the attribute to be modified).
</td>
</tr>
</tbody>
</table></div>
<p>Since ATK 1.12
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2540118"></a><h3>
<a name="atk-document-get-attributes"></a>atk_document_get_attributes ()</h3>
<a class="indexterm" name="id2540134"></a><pre class="programlisting"><a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a>* atk_document_get_attributes
(<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
<p>
Gets an AtkAttributeSet which describes document-wide
attributes as name-value pairs.
</p>
<p>
Returns:</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>document</code></em> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkDocumentIface
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> An AtkAttributeSet containing the explicitly
set name-value-pair attributes associated with this document
as a whole.
</td>
</tr>
</tbody>
</table></div>
<p>Since ATK 1.12
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2540215"></a><h3>
<a name="atk-document-get-locale"></a>atk_document_get_locale ()</h3>
<a class="indexterm" name="id2540228"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_document_get_locale (<a href="AtkDocument.html" title="AtkDocument">AtkDocument</a> *document);</pre>
<p>
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
of the content of this document instance. Individual
text substrings or images within this document may have
a different locale, see atk_text_get_attributes and
atk_image_get_image_locale.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>document</code></em> :</span></td>
<td> a <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> instance that implements AtkDocumentIface
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a UTF-8 string indicating the POSIX-style LC_MESSAGES
locale of the document content as a whole, or NULL if
the document content does not specify a locale.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>