2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2002 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 Ximian, Inc.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
25 #include <cspi/spi-private.h>
28 * AccessibleDocument_ref:
29 * @obj: a pointer to the #AccessibleDocument object on which to operate.
31 * Increment the reference count for an #AccessibleDocument object.
34 AccessibleDocument_ref (AccessibleDocument *obj)
36 cspi_object_ref (obj);
40 * AccessibleDocument_unref:
41 * @obj: a pointer to the #Accessible object on which to operate.
43 * Decrement the reference count for an #AccessibleDocument object.
47 AccessibleDocument_unref (AccessibleDocument *obj)
49 cspi_object_unref (obj);
54 * AccessibleDocument_getLocale:
55 * @obj: a pointer to the #Accessible object on which to operate.
57 * Gets the locale associated with the document's content.
58 * e.g. the locale for LOCALE_TYPE_MESSAGES.
60 * Returns: a string compliant with the POSIX standard for locale description.
63 AccessibleDocument_getLocale (AccessibleDocument *obj)
67 cspi_return_val_if_fail (obj != NULL, "C");
69 retval = Accessibility_Document_getLocale (CSPI_OBJREF (obj),
72 cspi_return_val_if_ev ("getLocale", NULL);
79 * AccessibleDocument_getAttributeValue:
80 * @obj: a pointer to the #Accessible object on which to operate.
81 * @attribute: a string indicating the name of a specific attribute
83 * Gets the value of a single attribute, if specified for the document as a whole.
85 * (name-value pair) being queried.
87 * Returns a string corresponding to the value of the specified attribute, or
88 * an empty string if the attribute is unspecified for the object.
91 AccessibleDocument_getAttributeValue (AccessibleDocument *obj,
97 cspi_return_val_if_fail (obj != NULL, NULL);
99 retval = Accessibility_Document_getAttributeValue (CSPI_OBJREF (obj),
103 cspi_return_val_if_ev ("getAttributeValue", NULL);
111 * AccessibleDocument_getAttributes:
112 * @obj: a pointer to the #Accessible object on which to operate.
114 * Gets all attributes specified for a document as a whole.
116 * For attributes which change within
117 * the document content, see Accessibility::Text::getAttributes instead.
119 * Returns an ::AttributeSet containing the attributes of the document,
120 * as name-value pairs.
124 AccessibleAttributeSet *
125 AccessibleDocument_getAttributes (AccessibleDocument *obj){
127 AccessibleAttributeSet *retval;
128 Accessibility_AttributeSet *corba_seq;
130 cspi_return_val_if_fail (obj != NULL, NULL);
132 corba_seq = Accessibility_Document_getAttributes (CSPI_OBJREF (obj),
134 cspi_return_val_if_ev ("getAttributes", NULL);
136 retval = _cspi_attribute_set_from_sequence (corba_seq);
137 CORBA_free (corba_seq);