pyatspi/accessible.py

   1 #Copyright (C) 2008 Codethink Ltd
   2
   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.
   6
   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.
  14
  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
  20 from role import Role
  21
  22 __all__ = [
  23            "LOCALE_TYPE",
  24            "LOCALE_TYPE_COLLATE",
  25            "LOCALE_TYPE_CTYPE",
  26            "LOCALE_TYPE_MESSAGES",
  27            "LOCALE_TYPE_MONETARY",
  28            "LOCALE_TYPE_NUMERIC",
  29            "LOCALE_TYPE_TIME",
  30            "BoundingBox",
  31            "Accessible",
  32           ]
  33
  34 #------------------------------------------------------------------------------
  35
  36 class LOCALE_TYPE(Enum):
  37     _enum_lookup = {
  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',
  43         5:'LOCALE_TYPE_TIME',
  44     }
  45
  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)
  52
  53 #------------------------------------------------------------------------------
  54
  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))
  60
  61     def __str__(self):
  62         return ("(%d, %d, %d, %d)" % (self.x, self.y, self.width, self.height))
  63
  64     def _get_x(self):
  65         return self[0]
  66     def _set_x(self, val):
  67         self[0] = val
  68     x = property(fget=_get_x, fset=_set_x)
  69     def _get_y(self):
  70         return self[1]
  71     def _set_y(self, val):
  72         self[1] = val
  73     y = property(fget=_get_y, fset=_set_y)
  74     def _get_width(self):
  75         return self[2]
  76     def _set_width(self, val):
  77         self[2] = val
  78     width = property(fget=_get_width, fset=_set_width)
  79     def _get_height(self):
  80         return self[3]
  81     def _set_height(self, val):
  82         self[3] = val
  83     height = property(fget=_get_height, fset=_set_height)
  84
  85 #------------------------------------------------------------------------------
  86
  87 class Accessible(BaseProxy):
  88     """
  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.
  93     """
  94
  95     def __nonzero__(self):
  96             return True
  97
  98     def __len__(self):
  99             return self.getChildCount()
 100
 101     def __getitem__(self, index):
 102             return self.getChildAtIndex(index)
 103
 104     def getApplication(self):
 105         """
 106         Get the containing Application for this object.
 107         @return the Application instance to which this object belongs.
 108         """
 109         return self._cache.create_application(self._app_name)
 110
 111     def getAttributes(self):
 112         """
 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
 119         properties.
 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
 124         where appropriate.
 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/).
 137
 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'.
 141         """
 142         func = self.get_dbus_method("getAttributes", dbus_interface=ATSPI_ACCESSIBLE)
 143         return func()
 144
 145     def getChildAtIndex(self, index):
 146         """
 147         Get the accessible child of this object at index.
 148         @param : index
 149         an in parameter indicating which child is requested (zero-indexed).
 150         @return : the 'nth' Accessible child of this object.
 151         """
 152         path = self.cached_data.children[index]
 153         return self._cache.create_accessible(self._app_name, path, ATSPI_ACCESSIBLE)
 154
 155     def getIndexInParent(self):
 156         """
 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
 159         parent's list.
 160         """
 161         if self.parent == None:
 162                 return -1
 163         for i in range(0, self.parent.childCount):
 164                 child = self.parent.getChildAtIndex(i)
 165                 if self.isEqual(child):
 166                         return i
 167         raise AccessibleObjectNoLongerExists("Child not found within parent")
 168
 169     def getLocalizedRoleName(self):
 170         """
 171         Get a string indicating the type of UI role played by this object,
 172         translated to the current locale.
 173         @return : a UTF-8 string indicating the type of UI role played
 174         by this object.
 175         """
 176         func = self.get_dbus_method("getLocalizedRoleName", dbus_interface=ATSPI_ACCESSIBLE)
 177         return func()
 178
 179     def getRelationSet(self):
 180         """
 181         Get a set defining this object's relationship to other accessible
 182         objects.
 183         @return : a RelationSet defining this object's relationships.
 184         """
 185         func = self.get_dbus_method("getRelationSet", dbus_interface=ATSPI_ACCESSIBLE)
 186         relation_set = func()
 187         return _marshal_relation_set(self._cache, self._app_name, relation_set)
 188
 189     def getRole(self):
 190         """
 191         Get the Role indicating the type of UI role played by this object.
 192         @return : a Role indicating the type of UI role played by this
 193         object.
 194         """
 195         return Role(self.cached_data.role)
 196
 197     def getRoleName(self):
 198         """
 199         Get a string indicating the type of UI role played by this object.
 200         @return : a UTF-8 string indicating the type of UI role played
 201         by this object.
 202         """
 203         func = self.get_dbus_method("getRoleName", dbus_interface=ATSPI_ACCESSIBLE)
 204         return func()
 205
 206     def getState(self):
 207         """
 208         Get the current state of the object as a StateSet.
 209         @return : a StateSet encapsulating the currently true states
 210         of the object.
 211         """
 212         return _marshal_state_set(self.cached_data.state)
 213
 214     def isEqual(self, accessible):
 215         """
 216         Determine whether an Accessible refers to the same object as
 217         another. This method should be used rather than brute-force comparison
 218         of object references (i.e. "by-value" comparison), as two object
 219         references may have different apparent values yet refer to the
 220         same object.
 221         @param : obj
 222         an Accessible object reference to compare to
 223         @return : a boolean indicating whether the two object references
 224         point to the same object.
 225         """
 226         return  (self._app_name == accessible._app_name) and \
 227                 (self._acc_path == accessible._acc_path)
 228
 229
 230     def get_childCount(self):
 231         return len(self.cached_data.children)
 232     _childCountDoc = \
 233         """
 234         childCount: the number of children contained by this object.
 235         """
 236     childCount = property(fget=get_childCount, doc=_childCountDoc)
 237
 238     getChildCount = get_childCount
 239
 240     def get_description(self):
 241         return self.cached_data.description
 242     _descriptionDoc = \
 243         """
 244         a string describing the object in more detail than name.
 245         """
 246     description = property(fget=get_description, doc=_descriptionDoc)
 247
 248     def get_name(self):
 249         return self.cached_data.name
 250     _nameDoc = \
 251         """
 252         a (short) string representing the object's name.
 253         """
 254     name = property(fget=get_name, doc=_nameDoc)
 255
 256     def get_parent(self):
 257         return self._cache.create_accessible(self._app_name,
 258                                              self.cached_data.parent,
 259                                              ATSPI_ACCESSIBLE)
 260
 261     _parentDoc = \
 262         """
 263         an Accessible object which is this object's containing object.
 264         """
 265     parent = property(fget=get_parent, doc=_parentDoc)
 266
 267 # Register the accessible class with the factory.
 268 accessible_factory.register_accessible_class(ATSPI_ACCESSIBLE, Accessible)
 269
 270 #END----------------------------------------------------------------------------