1 #Copyright (C) 2008 Codethink Ltd
3 #This library is free software; you can redistribute it and/or
4 #modify it under the terms of the GNU Lesser General Public
5 #License version 2 as published by the Free Software Foundation.
7 #This program is distributed in the hope that it will be useful,
8 #but WITHOUT ANY WARRANTY; without even the implied warranty of
9 #MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 #GNU General Public License for more details.
11 #You should have received a copy of the GNU Lesser General Public License
12 #along with this program; if not, write to the Free Software
13 #Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
15 from interfaces import ATSPI_ACCESSIBLE, ATSPI_APPLICATION
16 from base import BaseProxy, Enum
17 from factory import accessible_factory
18 from state import StateSet, _marshal_state_set
19 from relation import _marshal_relation_set
24 "LOCALE_TYPE_COLLATE",
26 "LOCALE_TYPE_MESSAGES",
27 "LOCALE_TYPE_MONETARY",
28 "LOCALE_TYPE_NUMERIC",
34 #------------------------------------------------------------------------------
36 class LOCALE_TYPE(Enum):
38 0:'LOCALE_TYPE_MESSAGES',
39 1:'LOCALE_TYPE_COLLATE',
40 2:'LOCALE_TYPE_CTYPE',
41 3:'LOCALE_TYPE_MONETARY',
42 4:'LOCALE_TYPE_NUMERIC',
46 LOCALE_TYPE_COLLATE = LOCALE_TYPE(1)
47 LOCALE_TYPE_CTYPE = LOCALE_TYPE(2)
48 LOCALE_TYPE_MESSAGES = LOCALE_TYPE(0)
49 LOCALE_TYPE_MONETARY = LOCALE_TYPE(3)
50 LOCALE_TYPE_NUMERIC = LOCALE_TYPE(4)
51 LOCALE_TYPE_TIME = LOCALE_TYPE(5)
53 #------------------------------------------------------------------------------
55 class BoundingBox(list):
56 def __new__(cls, x, y, width, height):
57 return list.__new__(cls, (x, y, width, height))
58 def __init__(self, x, y, width, height):
59 list.__init__(self, (x, y, width, height))
62 return ("(%d, %d, %d, %d)" % (self.x, self.y, self.width, self.height))
66 def _set_x(self, val):
68 x = property(fget=_get_x, fset=_set_x)
71 def _set_y(self, val):
73 y = property(fget=_get_y, fset=_set_y)
76 def _set_width(self, val):
78 width = property(fget=_get_width, fset=_set_width)
79 def _get_height(self):
81 def _set_height(self, val):
83 height = property(fget=_get_height, fset=_set_height)
85 #------------------------------------------------------------------------------
87 class Accessible(BaseProxy):
89 The base interface which is implemented by all accessible objects.
90 All objects support interfaces for querying their contained
91 'children' and position in the accessible-object hierarchy,
92 whether or not they actually have children.
95 def __nonzero__(self):
99 return self.getChildCount()
101 def __getitem__(self, index):
102 return self.getChildAtIndex(index)
104 def getApplication(self):
106 Get the containing Application for this object.
107 @return the Application instance to which this object belongs.
109 return self._cache.create_application(self._app_name)
111 def getAttributes(self):
113 Get a list of properties applied to this object as a whole, as
114 an AttributeSet consisting of name-value pairs. As such these
115 attributes may be considered weakly-typed properties or annotations,
116 as distinct from the strongly-typed interface instance data declared
117 using the IDL "attribute" keyword.
118 Not all objects have explicit "name-value pair" AttributeSet
120 Attribute names and values may have any UTF-8 string value, however
121 where possible, in order to facilitate consistent use and exposure
122 of "attribute" properties by applications and AT clients, attribute
123 names and values should chosen from a publicly-specified namespace
125 Where possible, the names and values in the name-value pairs
126 should be chosen from well-established attribute namespaces using
127 standard semantics. For example, attributes of Accessible objects
128 corresponding to XHTML content elements should correspond to
129 attribute names and values specified in the w3c XHTML specification,
130 at http://www.w3.org/TR/xhtml2, where such values are not already
131 exposed via a more strongly-typed aspect of the AT-SPI API. Metadata
132 names and values should be chosen from the 'Dublin Core' Metadata
133 namespace using Dublin Core semantics: http://dublincore.org/dcregistry/
134 Similarly, relevant structural metadata should be exposed using
135 attribute names and values chosen from the CSS2 and WICD specification:
136 http://www.w3.org/TR/1998/REC-CSS2-19980512 WICD (http://www.w3.org/TR/2005/WD-WICD-20051121/).
138 @return : An AttributeSet encapsulating any "attribute values"
139 currently defined for the object. An attribute set is a list of strings
140 with each string comprising an name-value pair format 'name:value'.
142 func = self.get_dbus_method("getAttributes", dbus_interface=ATSPI_ACCESSIBLE)
145 def getChildAtIndex(self, index):
147 Get the accessible child of this object at index.
149 an in parameter indicating which child is requested (zero-indexed).
150 @return : the 'nth' Accessible child of this object.
152 path = self.cached_data.children[index]
153 return self._cache.create_accessible(self._app_name, path, ATSPI_ACCESSIBLE)
155 def getIndexInParent(self):
157 Get the index of this object in its parent's child list.
158 @return : a long integer indicating this object's index in the
161 for i in range(0, self.parent.childCount):
162 child = self.parent.getChildAtIndex(i)
163 if self.isEqual(child):
165 raise AccessibleObjectNoLongerExists("Child not found within parent")
167 def getLocalizedRoleName(self):
169 Get a string indicating the type of UI role played by this object,
170 translated to the current locale.
171 @return : a UTF-8 string indicating the type of UI role played
174 func = self.get_dbus_method("getLocalizedRoleName", dbus_interface=ATSPI_ACCESSIBLE)
177 def getRelationSet(self):
179 Get a set defining this object's relationship to other accessible
181 @return : a RelationSet defining this object's relationships.
183 func = self.get_dbus_method("getRelationSet", dbus_interface=ATSPI_ACCESSIBLE)
184 relation_set = func()
185 return _marshal_relation_set(self._cache, self._app_name, relation_set)
189 Get the Role indicating the type of UI role played by this object.
190 @return : a Role indicating the type of UI role played by this
193 return Role(self.cached_data.role)
195 def getRoleName(self):
197 Get a string indicating the type of UI role played by this object.
198 @return : a UTF-8 string indicating the type of UI role played
201 func = self.get_dbus_method("getRoleName", dbus_interface=ATSPI_ACCESSIBLE)
206 Get the current state of the object as a StateSet.
207 @return : a StateSet encapsulating the currently true states
210 return _marshal_state_set(self.cached_data.state)
212 def isEqual(self, accessible):
214 Determine whether an Accessible refers to the same object as
215 another. This method should be used rather than brute-force comparison
216 of object references (i.e. "by-value" comparison), as two object
217 references may have different apparent values yet refer to the
220 an Accessible object reference to compare to
221 @return : a boolean indicating whether the two object references
222 point to the same object.
224 return (self._app_name == accessible._app_name) and \
225 (self._acc_path == accessible._acc_path)
228 def get_childCount(self):
229 return len(self.cached_data.children)
232 childCount: the number of children contained by this object.
234 childCount = property(fget=get_childCount, doc=_childCountDoc)
236 getChildCount = get_childCount
238 def get_description(self):
239 return self.cached_data.description
242 a string describing the object in more detail than name.
244 description = property(fget=get_description, doc=_descriptionDoc)
247 return self.cached_data.name
250 a (short) string representing the object's name.
252 name = property(fget=get_name, doc=_nameDoc)
254 def get_parent(self):
255 return self._cache.create_accessible(self._app_name,
256 self.cached_data.parent,
261 an Accessible object which is this object's containing object.
263 parent = property(fget=get_parent, doc=_parentDoc)
265 # Register the accessible class with the factory.
266 accessible_factory.register_accessible_class(ATSPI_ACCESSIBLE, Accessible)
268 #END----------------------------------------------------------------------------