#along with this program; if not, write to the Free Software
#Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-from base import *
+from base import _BaseProxy, _Enum
+from base import Accessible as _Accessible
-BUTTON_PRESSED_EVENT = Accessibility.EventType(2)
+import constants
-BUTTON_RELEASED_EVENT = Accessibility.EventType(3)
+from factory import add_accessible_class
-KEY_PRESS = Accessibility.KeySynthType(0)
-
-KEY_PRESSED = Accessibility.KeyEventType(0)
-
-KEY_PRESSED_EVENT = Accessibility.EventType(0)
-
-KEY_PRESSRELEASE = Accessibility.KeySynthType(2)
-
-KEY_RELEASE = Accessibility.KeySynthType(1)
-
-KEY_RELEASED = Accessibility.KeyEventType(1)
-
-KEY_RELEASED_EVENT = Accessibility.EventType(1)
-
-KEY_STRING = Accessibility.KeySynthType(4)
-
-KEY_SYM = Accessibility.KeySynthType(3)
-
-LAYER_BACKGROUND = Accessibility.ComponentLayer(1)
-
-LAYER_CANVAS = Accessibility.ComponentLayer(2)
-
-LAYER_INVALID = Accessibility.ComponentLayer(0)
-
-LAYER_LAST_DEFINED = Accessibility.ComponentLayer(8)
-
-LAYER_MDI = Accessibility.ComponentLayer(4)
-
-LAYER_OVERLAY = Accessibility.ComponentLayer(6)
-
-LAYER_POPUP = Accessibility.ComponentLayer(5)
-
-LAYER_WIDGET = Accessibility.ComponentLayer(3)
-
-LAYER_WINDOW = Accessibility.ComponentLayer(7)
-
-LOCALE_TYPE_COLLATE = Accessibility.LOCALE_TYPE(1)
-
-LOCALE_TYPE_CTYPE = Accessibility.LOCALE_TYPE(2)
-
-LOCALE_TYPE_MESSAGES = Accessibility.LOCALE_TYPE(0)
-
-LOCALE_TYPE_MONETARY = Accessibility.LOCALE_TYPE(3)
-
-LOCALE_TYPE_NUMERIC = Accessibility.LOCALE_TYPE(4)
-
-LOCALE_TYPE_TIME = Accessibility.LOCALE_TYPE(5)
-
-MODIFIER_ALT = Accessibility.ModifierType(3)
-
-MODIFIER_CONTROL = Accessibility.ModifierType(2)
-
-MODIFIER_META = Accessibility.ModifierType(4)
-
-MODIFIER_META2 = Accessibility.ModifierType(5)
-
-MODIFIER_META3 = Accessibility.ModifierType(6)
-
-MODIFIER_NUMLOCK = Accessibility.ModifierType(7)
-
-MODIFIER_SHIFT = Accessibility.ModifierType(0)
-
-MODIFIER_SHIFTLOCK = Accessibility.ModifierType(1)
-
-RELATION_CONTROLLED_BY = Accessibility.RelationType(4)
-
-RELATION_CONTROLLER_FOR = Accessibility.RelationType(3)
-
-RELATION_DESCRIBED_BY = Accessibility.RelationType(17)
-
-RELATION_DESCRIPTION_FOR = Accessibility.RelationType(16)
-
-RELATION_EMBEDDED_BY = Accessibility.RelationType(13)
-
-RELATION_EMBEDS = Accessibility.RelationType(12)
-
-RELATION_EXTENDED = Accessibility.RelationType(8)
-
-RELATION_FLOWS_FROM = Accessibility.RelationType(10)
-
-RELATION_FLOWS_TO = Accessibility.RelationType(9)
-
-RELATION_LABELLED_BY = Accessibility.RelationType(2)
-
-RELATION_LABEL_FOR = Accessibility.RelationType(1)
-
-RELATION_LAST_DEFINED = Accessibility.RelationType(18)
-
-RELATION_MEMBER_OF = Accessibility.RelationType(5)
-
-RELATION_NODE_CHILD_OF = Accessibility.RelationType(7)
-
-RELATION_NULL = Accessibility.RelationType(0)
-
-RELATION_PARENT_WINDOW_OF = Accessibility.RelationType(15)
-
-RELATION_POPUP_FOR = Accessibility.RelationType(14)
-
-RELATION_SUBWINDOW_OF = Accessibility.RelationType(11)
-
-RELATION_TOOLTIP_FOR = Accessibility.RelationType(6)
-
-ROLE_ACCELERATOR_LABEL = Accessibility.Role(1)
-
-ROLE_ALERT = Accessibility.Role(2)
-
-ROLE_ANIMATION = Accessibility.Role(3)
-
-ROLE_APPLICATION = Accessibility.Role(75)
-
-ROLE_ARROW = Accessibility.Role(4)
-
-ROLE_AUTOCOMPLETE = Accessibility.Role(76)
-
-ROLE_CALENDAR = Accessibility.Role(5)
-
-ROLE_CANVAS = Accessibility.Role(6)
-
-ROLE_CAPTION = Accessibility.Role(81)
-
-ROLE_CHART = Accessibility.Role(80)
-
-ROLE_CHECK_BOX = Accessibility.Role(7)
-
-ROLE_CHECK_MENU_ITEM = Accessibility.Role(8)
-
-ROLE_COLOR_CHOOSER = Accessibility.Role(9)
-
-ROLE_COLUMN_HEADER = Accessibility.Role(10)
-
-ROLE_COMBO_BOX = Accessibility.Role(11)
-
-ROLE_DATE_EDITOR = Accessibility.Role(12)
-
-ROLE_DESKTOP_FRAME = Accessibility.Role(14)
-
-ROLE_DESKTOP_ICON = Accessibility.Role(13)
-
-ROLE_DIAL = Accessibility.Role(15)
-
-ROLE_DIALOG = Accessibility.Role(16)
-
-ROLE_DIRECTORY_PANE = Accessibility.Role(17)
-
-ROLE_DOCUMENT_FRAME = Accessibility.Role(82)
-
-ROLE_DRAWING_AREA = Accessibility.Role(18)
-
-ROLE_EDITBAR = Accessibility.Role(77)
-
-ROLE_EMBEDDED = Accessibility.Role(78)
-
-ROLE_ENTRY = Accessibility.Role(79)
-
-ROLE_EXTENDED = Accessibility.Role(70)
-
-ROLE_FILE_CHOOSER = Accessibility.Role(19)
-
-ROLE_FILLER = Accessibility.Role(20)
-
-ROLE_FOCUS_TRAVERSABLE = Accessibility.Role(21)
-
-ROLE_FONT_CHOOSER = Accessibility.Role(22)
-
-ROLE_FOOTER = Accessibility.Role(72)
-
-ROLE_FORM = Accessibility.Role(87)
-
-ROLE_FRAME = Accessibility.Role(23)
-
-ROLE_GLASS_PANE = Accessibility.Role(24)
-
-ROLE_HEADER = Accessibility.Role(71)
-
-ROLE_HEADING = Accessibility.Role(83)
-
-ROLE_HTML_CONTAINER = Accessibility.Role(25)
-
-ROLE_ICON = Accessibility.Role(26)
-
-ROLE_IMAGE = Accessibility.Role(27)
-
-ROLE_INPUT_METHOD_WINDOW = Accessibility.Role(89)
-
-ROLE_INTERNAL_FRAME = Accessibility.Role(28)
-
-ROLE_INVALID = Accessibility.Role(0)
-
-ROLE_LABEL = Accessibility.Role(29)
-
-ROLE_LAST_DEFINED = Accessibility.Role(90)
-
-ROLE_LAYERED_PANE = Accessibility.Role(30)
-
-ROLE_LINK = Accessibility.Role(88)
-
-ROLE_LIST = Accessibility.Role(31)
-
-ROLE_LIST_ITEM = Accessibility.Role(32)
-
-ROLE_MENU = Accessibility.Role(33)
-
-ROLE_MENU_BAR = Accessibility.Role(34)
-
-ROLE_MENU_ITEM = Accessibility.Role(35)
-
-ROLE_OPTION_PANE = Accessibility.Role(36)
-
-ROLE_PAGE = Accessibility.Role(84)
-
-ROLE_PAGE_TAB = Accessibility.Role(37)
-
-ROLE_PAGE_TAB_LIST = Accessibility.Role(38)
-
-ROLE_PANEL = Accessibility.Role(39)
-
-ROLE_PARAGRAPH = Accessibility.Role(73)
-
-ROLE_PASSWORD_TEXT = Accessibility.Role(40)
-
-ROLE_POPUP_MENU = Accessibility.Role(41)
-
-ROLE_PROGRESS_BAR = Accessibility.Role(42)
-
-ROLE_PUSH_BUTTON = Accessibility.Role(43)
-
-ROLE_RADIO_BUTTON = Accessibility.Role(44)
-
-ROLE_RADIO_MENU_ITEM = Accessibility.Role(45)
-
-ROLE_REDUNDANT_OBJECT = Accessibility.Role(86)
-
-ROLE_ROOT_PANE = Accessibility.Role(46)
-
-ROLE_ROW_HEADER = Accessibility.Role(47)
-
-ROLE_RULER = Accessibility.Role(74)
-
-ROLE_SCROLL_BAR = Accessibility.Role(48)
-
-ROLE_SCROLL_PANE = Accessibility.Role(49)
-
-ROLE_SECTION = Accessibility.Role(85)
-
-ROLE_SEPARATOR = Accessibility.Role(50)
-
-ROLE_SLIDER = Accessibility.Role(51)
-
-ROLE_SPIN_BUTTON = Accessibility.Role(52)
-
-ROLE_SPLIT_PANE = Accessibility.Role(53)
-
-ROLE_STATUS_BAR = Accessibility.Role(54)
-
-ROLE_TABLE = Accessibility.Role(55)
-
-ROLE_TABLE_CELL = Accessibility.Role(56)
-
-ROLE_TABLE_COLUMN_HEADER = Accessibility.Role(57)
-
-ROLE_TABLE_ROW_HEADER = Accessibility.Role(58)
-
-ROLE_TEAROFF_MENU_ITEM = Accessibility.Role(59)
-
-ROLE_TERMINAL = Accessibility.Role(60)
-
-ROLE_TEXT = Accessibility.Role(61)
-
-ROLE_TOGGLE_BUTTON = Accessibility.Role(62)
-
-ROLE_TOOL_BAR = Accessibility.Role(63)
-
-ROLE_TOOL_TIP = Accessibility.Role(64)
-
-ROLE_TREE = Accessibility.Role(65)
-
-ROLE_TREE_TABLE = Accessibility.Role(66)
-
-ROLE_UNKNOWN = Accessibility.Role(67)
-
-ROLE_VIEWPORT = Accessibility.Role(68)
-
-ROLE_WINDOW = Accessibility.Role(69)
-
-STATE_ACTIVE = Accessibility.StateType(1)
-
-STATE_ANIMATED = Accessibility.StateType(35)
-
-STATE_ARMED = Accessibility.StateType(2)
-
-STATE_BUSY = Accessibility.StateType(3)
-
-STATE_CHECKED = Accessibility.StateType(4)
-
-STATE_COLLAPSED = Accessibility.StateType(5)
-
-STATE_DEFUNCT = Accessibility.StateType(6)
-
-STATE_EDITABLE = Accessibility.StateType(7)
-
-STATE_ENABLED = Accessibility.StateType(8)
-
-STATE_EXPANDABLE = Accessibility.StateType(9)
-
-STATE_EXPANDED = Accessibility.StateType(10)
-
-STATE_FOCUSABLE = Accessibility.StateType(11)
-
-STATE_FOCUSED = Accessibility.StateType(12)
-
-STATE_HAS_TOOLTIP = Accessibility.StateType(13)
-
-STATE_HORIZONTAL = Accessibility.StateType(14)
-
-STATE_ICONIFIED = Accessibility.StateType(15)
-
-STATE_INDETERMINATE = Accessibility.StateType(32)
-
-STATE_INVALID = Accessibility.StateType(0)
-
-STATE_INVALID_ENTRY = Accessibility.StateType(36)
-
-STATE_IS_DEFAULT = Accessibility.StateType(39)
-
-STATE_LAST_DEFINED = Accessibility.StateType(41)
-
-STATE_MANAGES_DESCENDANTS = Accessibility.StateType(31)
-
-STATE_MODAL = Accessibility.StateType(16)
-
-STATE_MULTISELECTABLE = Accessibility.StateType(18)
-
-STATE_MULTI_LINE = Accessibility.StateType(17)
-
-STATE_OPAQUE = Accessibility.StateType(19)
-
-STATE_PRESSED = Accessibility.StateType(20)
-
-STATE_REQUIRED = Accessibility.StateType(33)
-
-STATE_RESIZABLE = Accessibility.StateType(21)
-
-STATE_SELECTABLE = Accessibility.StateType(22)
-
-STATE_SELECTABLE_TEXT = Accessibility.StateType(38)
-
-STATE_SELECTED = Accessibility.StateType(23)
-
-STATE_SENSITIVE = Accessibility.StateType(24)
-
-STATE_SHOWING = Accessibility.StateType(25)
-
-STATE_SINGLE_LINE = Accessibility.StateType(26)
-
-STATE_STALE = Accessibility.StateType(27)
-
-STATE_SUPPORTS_AUTOCOMPLETION = Accessibility.StateType(37)
-
-STATE_TRANSIENT = Accessibility.StateType(28)
-
-STATE_TRUNCATED = Accessibility.StateType(34)
-
-STATE_VERTICAL = Accessibility.StateType(29)
-
-STATE_VISIBLE = Accessibility.StateType(30)
-
-STATE_VISITED = Accessibility.StateType(40)
-
-TEXT_BOUNDARY_CHAR = Accessibility.TEXT_BOUNDARY_TYPE(0)
-
-TEXT_BOUNDARY_LINE_END = Accessibility.TEXT_BOUNDARY_TYPE(6)
-
-TEXT_BOUNDARY_LINE_START = Accessibility.TEXT_BOUNDARY_TYPE(5)
-
-TEXT_BOUNDARY_SENTENCE_END = Accessibility.TEXT_BOUNDARY_TYPE(4)
-
-TEXT_BOUNDARY_SENTENCE_START = Accessibility.TEXT_BOUNDARY_TYPE(3)
-
-TEXT_BOUNDARY_WORD_END = Accessibility.TEXT_BOUNDARY_TYPE(2)
-
-TEXT_BOUNDARY_WORD_START = Accessibility.TEXT_BOUNDARY_TYPE(1)
-
-TEXT_CLIP_BOTH = Accessibility.TEXT_CLIP_TYPE(3)
-
-TEXT_CLIP_MAX = Accessibility.TEXT_CLIP_TYPE(2)
-
-TEXT_CLIP_MIN = Accessibility.TEXT_CLIP_TYPE(1)
-
-TEXT_CLIP_NONE = Accessibility.TEXT_CLIP_TYPE(0)
-
-
-class Action(BaseProxy):
-
-
+class Action(_BaseProxy):
"""
An interface through which a user-actionable user interface component
can be manipulated. Components which react to mouse or keyboard
func = self.get_dbus_method("getName")
return func(*args, **kwargs)
- def unImplemented(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented")
- return func(*args, **kwargs)
-
- def unImplemented2(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2")
- return func(*args, **kwargs)
-
- def unImplemented3(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3")
- return func(*args, **kwargs)
-
- def unImplemented4(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented4")
- return func(*args, **kwargs)
-
def get_nActions(self):
self._pgetter(self._dbus_interface, "nActions")
def set_nActions(self, value):
nActions = property(fget=get_nActions, fset=set_nActions, doc=_nActionsDoc)
-class Application(Accessible):
-
+#------------------------------------------------------------------------------
+
+class BoundingBox(list):
+ def __new__(cls, x, y, width, height):
+ list.__new__(cls, (x, y, width, height))
+ def __init__(self, x, y, width, height):
+ list.__init__(self, (x, y, width, height))
- """
- An interface identifying an object which is the root of the user
- interface Accessible hierarchy associated with a running application.
- Children of Application are typically, but not exclusively, top-level
- windows.
- """
+ def _get_x(self):
+ return self[0]
+ def _set_x(self, val):
+ self[0] = val
+ x = property(fget=_get_x, fset=_set_x)
+ def _get_y(self):
+ return self[1]
+ def _set_y(self, val):
+ self[1] = val
+ y = property(fget=_get_y, fset=_set_y)
+ def _get_width(self):
+ return self[2]
+ def _set_width(self, val):
+ self[2] = val
+ width = property(fget=_get_width, fset=_set_width)
+ def _get_height(self):
+ return self[3]
+ def _set_height(self, val):
+ self[3] = val
+ height = property(fget=_get_height, fset=_set_height)
+
+
+class Collection(_BaseProxy):
+ def createMatchRule(self, *args, **kwargs):
+ func = self.get_dbus_method("createMatchRule")
+ return func(*args, **kwargs)
- def getLocale(self, *args, **kwargs):
- """
- Gets the locale in which the application is currently operating.
- For the current message locale, use lctype LOCALE_TYPE_MESSAGES.
- @param : lctype
- The LocaleType for which the locale is queried.
- @return a string compliant with the POSIX standard for locale
- description.
- """
- func = self.get_dbus_method("getLocale")
- return func(*args, **kwargs)
-
- def pause(self, *args, **kwargs):
- """
- Request that the application temporarily stop sending events.
- In most cases this should pause the application's main event
- loop.
- @return : true if the request succeeded, false otherwise.
- """
- func = self.get_dbus_method("pause")
- return func(*args, **kwargs)
-
- def registerObjectEventListener(self, *args, **kwargs):
- """
- registerObjectEventListener:
- @param : listener
- an EventListener object which will receive the requested events
- @param : eventName
- a UTF-8 string indicating the type of (toolkit-specific) event
- being requested. Register with this application toolkit for "Accessibility::Accessible"
- event notifications.
- """
- func = self.get_dbus_method("registerObjectEventListener")
- return func(*args, **kwargs)
-
- def registerToolkitEventListener(self, *args, **kwargs):
- """
- @param : listener
- an EventListener object which will receive the requested events
- from the application's toolkits via toolit 'bridges'
- @param : eventName
- a UTF-8 string indicating the type of (toolkit-specific) event
- being requested. Not all applications can generate toolkit events
- of a given type.
- Register with this application's toolkit for "toolkit-specific"
- event notifications.
- """
- func = self.get_dbus_method("registerToolkitEventListener")
- return func(*args, **kwargs)
-
- def resume(self, *args, **kwargs):
- """
- Request that the application resume sending events.
- @return : True if the request succeeded, False otherwise.
- """
- func = self.get_dbus_method("resume")
- return func(*args, **kwargs)
-
- def unImplemented2_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2_")
- return func(*args, **kwargs)
-
- def unImplemented3_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3_")
- return func(*args, **kwargs)
-
- def unImplemented_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented_")
- return func(*args, **kwargs)
-
- def get_id(self):
- self._pgetter(self._dbus_interface, "id")
- def set_id(self, value):
- self._psetter(self._dbus_interface, "id", value)
- _idDoc = \
- """
- The application instance's unique ID as assigned by the registry.
- """
- id = property(fget=get_id, fset=set_id, doc=_idDoc)
-
- def get_toolkitName(self):
- self._pgetter(self._dbus_interface, "toolkitName")
- def set_toolkitName(self, value):
- self._psetter(self._dbus_interface, "toolkitName", value)
- _toolkitNameDoc = \
- """
- A string indicating the type of user interface toolkit which
- is used by the application.
- """
- toolkitName = property(fget=get_toolkitName, fset=set_toolkitName, doc=_toolkitNameDoc)
-
- def get_version(self):
- self._pgetter(self._dbus_interface, "version")
- def set_version(self, value):
- self._psetter(self._dbus_interface, "version", value)
- _versionDoc = \
- """
- A string indicating the version number of the application's accessibility
- bridge implementation.
- """
- version = property(fget=get_version, fset=set_version, doc=_versionDoc)
-
-
-class BoundingBox(list):
- def __new__(cls, x, y, width, height):
- list.__new__(cls, (x, y, width, height)
- def __init__(self, x, y, width, height):
- list.__init__(self, (x, y, width, height))
-
- x = property(fget=_get_x, fset=_set_x)
- def _get_x(self):
- return self[0]
- def _set_x(self, val):
- self[0] = val
- y = property(fget=_get_y, fset=_set_y)
- def _get_y(self):
- return self[1]
- def _set_y(self, val):
- self[1] = val
- width = property(fget=_get_width, fset=_set_width)
- def _get_width(self):
- return self[2]
- def _set_width(self, val):
- self[2] = val
- height = property(fget=_get_height, fset=_set_height)
- def _get_height(self):
- return self[3]
- def _set_height(self, val):
- self[3] = val
-
-
-class Collection(BaseProxy):
-
-
-
-
- def createMatchRule(self, *args, **kwargs):
- func = self.get_dbus_method("createMatchRule")
- return func(*args, **kwargs)
-
- def freeMatchRule(self, *args, **kwargs):
- func = self.get_dbus_method("freeMatchRule")
+ def freeMatchRule(self, *args, **kwargs):
+ func = self.get_dbus_method("freeMatchRule")
return func(*args, **kwargs)
def getActiveDescendant(self, *args, **kwargs):
def unImplemented4(self, *args, **kwargs):
func = self.get_dbus_method("unImplemented4")
return func(*args, **kwargs)
-
- MATCH_ALL = Accessibility.MatchType(1)
-
- MATCH_ANY = Accessibility.MatchType(2)
-
- MATCH_EMPTY = Accessibility.MatchType(4)
-
- MATCH_INVALID = Accessibility.MatchType(0)
-
- MATCH_LAST_DEFINED = Accessibility.MatchType(5)
-
- MATCH_NONE = Accessibility.MatchType(3)
-
- class MatchType(Enum):
+
+ class MatchType(_Enum):
_enum_lookup = {
0:'MATCH_INVALID',
1:'MATCH_ALL',
5:'MATCH_LAST_DEFINED',
}
+ MATCH_ALL = MatchType(1)
- SORT_ORDER_CANONICAL = Accessibility.SortOrder(1)
+ MATCH_ANY = MatchType(2)
- SORT_ORDER_FLOW = Accessibility.SortOrder(2)
+ MATCH_EMPTY = MatchType(4)
- SORT_ORDER_INVALID = Accessibility.SortOrder(0)
+ MATCH_INVALID = MatchType(0)
- SORT_ORDER_LAST_DEFINED = Accessibility.SortOrder(7)
+ MATCH_LAST_DEFINED = MatchType(5)
- SORT_ORDER_REVERSE_CANONICAL = Accessibility.SortOrder(4)
-
- SORT_ORDER_REVERSE_FLOW = Accessibility.SortOrder(5)
-
- SORT_ORDER_REVERSE_TAB = Accessibility.SortOrder(6)
-
- SORT_ORDER_TAB = Accessibility.SortOrder(3)
-
- class SortOrder(Enum):
+ MATCH_NONE = MatchType(3)
+
+ class SortOrder(_Enum):
_enum_lookup = {
0:'SORT_ORDER_INVALID',
1:'SORT_ORDER_CANONICAL',
7:'SORT_ORDER_LAST_DEFINED',
}
+ SORT_ORDER_CANONICAL = SortOrder(1)
+
+ SORT_ORDER_FLOW = SortOrder(2)
- TREE_INORDER = Accessibility.TreeTraversalType(2)
+ SORT_ORDER_INVALID = SortOrder(0)
- TREE_LAST_DEFINED = Accessibility.TreeTraversalType(3)
+ SORT_ORDER_LAST_DEFINED = SortOrder(7)
- TREE_RESTRICT_CHILDREN = Accessibility.TreeTraversalType(0)
+ SORT_ORDER_REVERSE_CANONICAL = SortOrder(4)
- TREE_RESTRICT_SIBLING = Accessibility.TreeTraversalType(1)
+ SORT_ORDER_REVERSE_FLOW = SortOrder(5)
- class TreeTraversalType(Enum):
+ SORT_ORDER_REVERSE_TAB = SortOrder(6)
+
+ SORT_ORDER_TAB = SortOrder(3)
+
+ class TreeTraversalType(_Enum):
_enum_lookup = {
0:'TREE_RESTRICT_CHILDREN',
1:'TREE_RESTRICT_SIBLING',
2:'TREE_INORDER',
3:'TREE_LAST_DEFINED',
}
-
+
+ TREE_INORDER = TreeTraversalType(2)
+
+ TREE_LAST_DEFINED = TreeTraversalType(3)
+
+ TREE_RESTRICT_CHILDREN = TreeTraversalType(0)
+
+ TREE_RESTRICT_SIBLING = TreeTraversalType(1)
class Command(list):
def __new__(cls, name, id):
- list.__new__(cls, (name, id)
+ list.__new__(cls, (name, id))
def __init__(self, name, id):
list.__init__(self, (name, id))
- name = property(fget=_get_name, fset=_set_name)
def _get_name(self):
return self[0]
def _set_name(self, val):
self[0] = val
- id = property(fget=_get_id, fset=_set_id)
+ name = property(fget=_get_name, fset=_set_name)
def _get_id(self):
return self[1]
def _set_id(self, val):
self[1] = val
+ id = property(fget=_get_id, fset=_set_id)
-
-class CommandListener(BaseProxy):
-
-
+class CommandListener(_BaseProxy):
"""
An interface which should be implemented by assistive technologies
or other clients of the Selector interface, over which notifications
return func(*args, **kwargs)
-class Component(BaseProxy):
+class Component(_BaseProxy):
"""
return func(*args, **kwargs)
-class ComponentLayer(Enum):
+class ComponentLayer(_Enum):
_enum_lookup = {
0:'LAYER_INVALID',
1:'LAYER_BACKGROUND',
}
-class ContentStream(BaseProxy):
-
-
+class ContentStream(_BaseProxy):
"""
An interface by which the requested data from a StreamableContent
object may be read by the client.
"""
-
def close(self, *args, **kwargs):
"""
close the stream and release associated resources. A client should
class NotSupported(Exception):
pass
-
- SEEK_CURRENT = Accessibility.SeekType(1)
-
- SEEK_END = Accessibility.SeekType(2)
-
- SEEK_SET = Accessibility.SeekType(0)
-
- class SeekType(Enum):
+
+ class SeekType(_Enum):
"""
Specifies the meaning of a seek 'offset'. Not all SeekTypes are
supported by all StreamableContent data sources, for instance
some streams may not support seeking from the beginning or other
types of 'backwards' seeks.
"""
-
_enum_lookup = {
0:'SEEK_SET',
1:'SEEK_CURRENT',
2:'SEEK_END',
}
-
-class Desktop(Accessible):
-
-
- """
- At the moment this is only a marker interface, it acts just like
- any other Accessible. In all known implementations, the children
- are all instances of Application, but this is not guaranteed
- by this interface.
- """
-
-
- def unImplemented2_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2_")
- return func(*args, **kwargs)
- def unImplemented3_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3_")
- return func(*args, **kwargs)
+ SEEK_CURRENT = SeekType(1)
- def unImplemented4_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented4_")
- return func(*args, **kwargs)
+ SEEK_END = SeekType(2)
- def unImplemented_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented_")
- return func(*args, **kwargs)
-
+ SEEK_SET = SeekType(0)
class DeviceEvent(list):
def __new__(cls, type, id, hw_code, modifiers, timestamp, event_string, is_text):
- list.__new__(cls, (type, id, hw_code, modifiers, timestamp, event_string, is_text)
+ list.__new__(cls, (type, id, hw_code, modifiers, timestamp, event_string, is_text))
def __init__(self, type, id, hw_code, modifiers, timestamp, event_string, is_text):
list.__init__(self, (type, id, hw_code, modifiers, timestamp, event_string, is_text))
- type = property(fget=_get_type, fset=_set_type)
def _get_type(self):
return self[0]
def _set_type(self, val):
self[0] = val
- id = property(fget=_get_id, fset=_set_id)
+ type = property(fget=_get_type, fset=_set_type)
def _get_id(self):
return self[1]
def _set_id(self, val):
self[1] = val
- hw_code = property(fget=_get_hw_code, fset=_set_hw_code)
+ id = property(fget=_get_id, fset=_set_id)
def _get_hw_code(self):
return self[2]
def _set_hw_code(self, val):
self[2] = val
- modifiers = property(fget=_get_modifiers, fset=_set_modifiers)
+ hw_code = property(fget=_get_hw_code, fset=_set_hw_code)
def _get_modifiers(self):
return self[3]
def _set_modifiers(self, val):
self[3] = val
- timestamp = property(fget=_get_timestamp, fset=_set_timestamp)
+ modifiers = property(fget=_get_modifiers, fset=_set_modifiers)
def _get_timestamp(self):
return self[4]
def _set_timestamp(self, val):
self[4] = val
- event_string = property(fget=_get_event_string, fset=_set_event_string)
+ timestamp = property(fget=_get_timestamp, fset=_set_timestamp)
def _get_event_string(self):
return self[5]
def _set_event_string(self, val):
self[5] = val
- is_text = property(fget=_get_is_text, fset=_set_is_text)
+ event_string = property(fget=_get_event_string, fset=_set_event_string)
def _get_is_text(self):
return self[6]
def _set_is_text(self, val):
self[6] = val
+ is_text = property(fget=_get_is_text, fset=_set_is_text)
-
-class DeviceEventController(BaseProxy):
-
-
+class DeviceEventController(_BaseProxy):
"""
The interface via which clients request notification of device
events, and through which device events may be simulated.
"""
-
-
+
def deregisterDeviceEventListener(self, *args, **kwargs):
"""
De-register a previously registered keyboard eventlistener.
func = self.get_dbus_method("registerKeystrokeListener")
return func(*args, **kwargs)
- def unImplemented(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented")
- return func(*args, **kwargs)
-
- def unImplemented2(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2")
- return func(*args, **kwargs)
-
- def unImplemented3(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3")
- return func(*args, **kwargs)
-
- def unImplemented4(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented4")
- return func(*args, **kwargs)
-
-
-class DeviceEventListener(BaseProxy):
-
-
+class DeviceEventListener(_BaseProxy):
"""
This interface should be implemented by AT-SPI clients who wish
to make use of the DeviceEventController to receive device event
button/motion events.
"""
-
def notifyEvent(self, *args, **kwargs):
"""
Notify an interested DeviceEventListener that a DeviceEvent has
func = self.get_dbus_method("notifyEvent")
return func(*args, **kwargs)
- def unImplemented_2_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented_2_")
- return func(*args, **kwargs)
-
- def unImplemented_3_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented_3_")
- return func(*args, **kwargs)
-
- def unImplemented_4_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented_4_")
- return func(*args, **kwargs)
-
- def unImplemented_5_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented_5_")
- return func(*args, **kwargs)
-
- def unImplemented_6_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented_6_")
- return func(*args, **kwargs)
-
- def unImplemented__(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented__")
- return func(*args, **kwargs)
-
-
-class Document(BaseProxy):
-
-
+class Document(_BaseProxy):
"""
Primarily a 'tagging' interface which indicates the start of
document content in the Accessibility hierarchy. Accessible objects
as well.
"""
-
def getAttributeValue(self, *args, **kwargs):
"""
Gets the value of a single attribute, if specified for the document
func = self.get_dbus_method("unImplemented_")
return func(*args, **kwargs)
-
-class EditableText(Text):
-
-
+class Text(_BaseProxy):
"""
- Derived from interface Text, EditableText provides methods for
- modifying textual content of components which support editing.
- EditableText also interacts with the system clipboard via copyText,
- cutText, and pasteText.
+ The text interface should be implemented by objects which place
+ textual information onscreen as character strings or glyphs.
+ The text interface allows access to textual content, including
+ display attributes and semantic hints associated with runs of
+ text, and access to bounding box information for glyphs and substrings.
+ It also allows portions of textual content to be selected, if
+ the object's StateSet includes STATE_SELECTABLE_TEXT.
+ In some cases a Text object may have, as its content, an empty
+ string. In particular this can occur in the case of Hypertext
+ objects which do not display explicitly textual information onscreen,
+ as Hypertext is derived from the Text interface.
+ Typographic and semantic attributes of onscreen textual content,
+ for instance typeface, weight, language, and such qualities as
+ 'emphasis' or 'blockquote', are represented as text attributes.
+ Contiguous sequences of characters over which these attributes
+ are unchanged are referred to as "attribute runs", and are available
+ via Text::getAttributeRun. Where possible, implementing clients
+ will report textual attributes which are the same over the entire
+ text object, for instance those inherited from a default or document-scope
+ style, via getDefaultAttributes instead of reporting them explicitly
+ for each character. Therefore, for any span of text, the attributes
+ in effect are the union of the set returned by Text::getDefaultAttributes,
+ and the set returned at a particular character offset via Text::getAttributeRun.
"""
- def copyText(self, *args, **kwargs):
+ def addSelection(self, *args, **kwargs):
"""
- Copy a range of text into the system clipboard.
- @param : startPos
- the character offset of the first character in the range of text
- being copied.
- @param : endPos
- the offset of the first character past the end of the range of
- text being copied.
+ The result of calling addSelection on objects which already have
+ one selection present, and which do not include STATE_MULTISELECTABLE,
+ is undefined, other than the return value.
+ @return True of the selection was successfully added, False otherwise.
+ Selection may fail if the object does not support selection of
+ text (see STATE_SELECTABLE_TEXT), if the object does not support
+ multiple selections and a selection is already defined, or for
+ other reasons (for instance if the user does not have permission
+ to copy the text into the relevant selection buffer).
"""
- func = self.get_dbus_method("copyText")
+ func = self.get_dbus_method("addSelection")
return func(*args, **kwargs)
- def cutText(self, *args, **kwargs):
- """
- Excise a range of text from a Text object, copying it into the
- system clipboard.
- @param : startPos
- the character offset of the first character in the range of text
- being cut.
- @param : endPos
- the offset of the first character past the end of the range of
- text being cut.
- @return True if the text was successfully cut, False otherwise.
+ def getAttributeRun(self, *args, **kwargs):
"""
- func = self.get_dbus_method("cutText")
+ Query a particular text object for the text attributes defined
+ at a given offset, obtaining the start and end of the "attribute
+ run" over which these attributes are currently invariant. Text
+ attributes are those presentational, typographic, or semantic
+ attributes or qualitites which apply to a range of text specifyable
+ by starting and ending offsets. Attributes relevant to localization
+ should be provided in accordance with the w3c "Internationalization
+ and Localization Markup Requirements", http://www.w3.org/TR/2005/WD-itsreq-20051122/
+ Other text attributes should choose their names and value semantics
+ in accordance with relevant standards such as CSS level 2 (http://www.w3.org/TR/1998/REC-CSS2-19980512),
+ XHTML 1.0 (http://www.w3.org/TR/2002/REC-xhtml1-20020801), and
+ WICD (http://www.w3.org/TR/2005/WD-WICD-20051121/). Those attributes
+ from the aforementioned specifications and recommendations which
+ do not concern typographic, presentational, or semantic aspects
+ of text should be exposed via the more general Accessible::getAttributes()
+ API (if at all).
+ For example, CSS attributes which should be exposed on text (either
+ as default attributes, or as explicitly-set attributes when non-default
+ values are specified in the content view) include the Font attributes
+ (i.e. "css2:font-weight", "css2:font-style"), the "css2:color"
+ and "css2:background-color" attributes, and "css2:text-decoration"
+ attribute.
+ If includeDefaults is TRUE, then this AttributeSet should include
+ the default attributes as well as those which are explicitly
+ assigned to the attribute run in question. startOffset and endOffset
+ will be back-filled to indicate the start and end of the attribute
+ run which contains 'offset' - an attribute run is a contiguous
+ section of text whose attributes are homogeneous.
+ @param : offset
+ the offset of the character whose attributes will be reported.
+ @param : startOffset
+ backfilled with the starting offset of the character range over
+ which all text attributes match those of offset, i.e. the start
+ of the homogeneous attribute run including offset.
+ @param : endOffset
+ backfilled with the offset of the first character past the character
+ range over which all text attributes match those of offset, i.e.
+ the character immediately after the homogeneous attribute run
+ including offset.
+ @param : includeDefaults
+ if False, the call should only return those attributes which
+ are explicitly set on the current attribute run, omitting any
+ attributes which are inherited from the default values. See also
+ Text::getDefaultAttributes.
+ @return the AttributeSet defined at offset, optionally including
+ the 'default' attributes.
+ """
+ func = self.get_dbus_method("getAttributeRun")
return func(*args, **kwargs)
- def deleteText(self, *args, **kwargs):
+ def getAttributeValue(self, *args, **kwargs):
"""
- Excise a range of text from a Text object without copying it
- into the system clipboard.
- @param : startPos
- the character offset of the first character in the range of text
- being deleted.
- @param : endPos
- the offset of the first character past the end of the range of
- text being deleted.
- @return True if the text was successfully deleted, False otherwise.
+ Get the string value of a named attribute at a given offset,
+ if defined.
+ @param : offset
+ the offset of the character for which the attribute run is to
+ be obtained.
+ @param : attributeName
+ the name of the attribute for which the value is to be returned,
+ if defined.
+ @param : startOffset
+ back-filled with the offset of the first character in the attribute
+ run containing the character at offset.
+ @param : endOffset
+ back-filled with the offset of the first character past the end
+ of the attribute run containing the character at offset.
+ @param : defined
+ back-filled with True if the attributeName has a defined value
+ at offset, False otherwise.
+ @return the value of attribute (name-value pair) corresponding
+ to "name", if defined.
"""
- func = self.get_dbus_method("deleteText")
+ func = self.get_dbus_method("getAttributeValue")
return func(*args, **kwargs)
- def insertText(self, *args, **kwargs):
+ def getAttributes(self, *args, **kwargs):
"""
- Insert new text contents into an existing text object at a given
- location, while retaining the old contents.
- @param : position
- the character offset into the Text implementor's content at which
- the new content will be inserted.
- @param : text
- a UTF-8 string of which length characters will be inserted into
- the text object's text buffer.
- @param : length
- the number of characters of text to insert. If the character
- count of text is less than or equal to length, the entire contents
- of text will be inserted.
- @return True if the text content was successfully inserted, False
- otherwise.
+ getAttributes is deprecated in favor of getAttributeRun.
+ @return the attributes at offset, as a semicolon-delimited set
+ of colon-delimited name-value pairs.
"""
- func = self.get_dbus_method("insertText")
+ func = self.get_dbus_method("getAttributes")
return func(*args, **kwargs)
- def pasteText(self, *args, **kwargs):
+ def getBoundedRanges(self, *args, **kwargs):
"""
- Copy the text contents of the system clipboard, if any, into
- a Text object, inserting it at a particular character offset.
- @param : position
- the character offset before which the text will be inserted.
- @return True if the text was successfully pasted into the Text
- object, False otherwise.
+ Return the text content within a bounding box, as a list of Range
+ structures. Depending on the TEXT_CLIP_TYPE parameters, glyphs
+ which are clipped by the bounding box (i.e. which lie partially
+ inside and partially outside it) may or may not be included in
+ the ranges returned.
+ @param : x
+ the minimum x ( i.e. leftmost) coordinate of the bounding box.
+ @param : y
+ the minimum y coordinate of the bounding box.
+ @param : width
+ the horizontal size of the bounding box. The rightmost bound
+ of the bounding box is (x + width);
+ @param : height
+ the vertical size of the bounding box. The maximum y value of
+ the bounding box is (y + height);
+ @param : coordType
+ If 0, the above coordinates are interpreted as pixels relative
+ to corner of the screen; if 1, the coordinates are interpreted
+ as pixels relative to the corner of the containing toplevel window.
+ @param : xClipType
+ determines whether text which intersects the bounding box in
+ the x direction is included.
+ @param : yClipType
+ determines whether text which intersects the bounding box in
+ the y direction is included.
"""
- func = self.get_dbus_method("pasteText")
+ func = self.get_dbus_method("getBoundedRanges")
return func(*args, **kwargs)
- def setAttributes(self, *args, **kwargs):
+ def getCharacterAtOffset(self, *args, **kwargs):
"""
- Apply a particular set of attributes to a range of text.
- @return True if the text attributes were successfully modified,
- False otherwise.
+ @return an unsigned long integer whose value corresponds to the
+ UCS-4 representation of the character at the specified text offset,
+ or 0 if offset is out of range.
"""
- func = self.get_dbus_method("setAttributes")
+ func = self.get_dbus_method("getCharacterAtOffset")
return func(*args, **kwargs)
- def setTextContents(self, *args, **kwargs):
+ def getCharacterExtents(self, *args, **kwargs):
"""
- Replace the text contents with a new string, discarding the old
- contents.
- @param : newContents
- a UTF-8 string with which the text object's contents will be
- replaced.
- @return True if the text content was successfully changed, False
- otherwise.
+ Obtain a the bounding box, as x, y, width, and height, of the
+ character or glyph at a particular character offset in this object's
+ text content. The coordinate system in which the results are
+ reported is specified by coordType. If an onscreen glyph corresponds
+ to multiple character offsets, for instance if the glyph is a
+ ligature, the bounding box reported will include the entire glyph
+ and therefore may apply to more than one character offset.
+ @param : offset
+ the character offset of the character or glyph being queried.
+ @param : x
+ the minimum horizontal coordinate of the bounding box of the
+ glyph representing the character at offset.
+ @param : y
+ the minimum vertical coordinate of the bounding box of the glyph
+ representing the character at offset.
+ @param : width
+ the horizontal extent of the bounding box of the glyph representing
+ the character at offset.
+ @param : height
+ the vertical extent of the bounding box of the glyph representing
+ the character at offset.
+ @param : coordType
+ If 0, the results will be reported in screen coordinates, i.e.
+ in pixels relative to the upper-left corner of the screen, with
+ the x axis pointing right and the y axis pointing down. If 1,
+ the results will be reported relative to the containing toplevel
+ window, with the x axis pointing right and the y axis pointing
+ down.
"""
- func = self.get_dbus_method("setTextContents")
- return func(*args, **kwargs)
-
- def unImplemented10(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented10")
+ func = self.get_dbus_method("getCharacterExtents")
return func(*args, **kwargs)
- def unImplemented11(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented11")
+ def getDefaultAttributeSet(self, *args, **kwargs):
+ """
+ Return an AttributeSet containing the text attributes which apply
+ to all text in the object by virtue of the default settings of
+ the document, view, or user agent; e.g. those attributes which
+ are implied rather than explicitly applied to the text object.
+ For instance, an object whose entire text content has been explicitly
+ marked as 'bold' will report the 'bold' attribute via getAttributeRun(),
+ whereas an object whose text weight is inspecified may report
+ the default or implied text weight in the default AttributeSet.
+ """
+ func = self.get_dbus_method("getDefaultAttributeSet")
return func(*args, **kwargs)
- def unImplemented12(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented12")
+ def getDefaultAttributes(self, *args, **kwargs):
+ """
+ Deprecated in favor of getDefaultAttributeSet.
+ @return the attributes which apply to the entire text content,
+ but which were not explicitly specified by the content creator.
+ """
+ func = self.get_dbus_method("getDefaultAttributes")
return func(*args, **kwargs)
- def unImplemented5(self, *args, **kwargs):
+ def getNSelections(self, *args, **kwargs):
"""
- unImplemented:
- placeholders for future expansion. Note that these are named
- 'unimplemented5 and unimplemented6' to avoid conflict with placeholders
- from Accessibility::Text.
+ Obtain the number of separate, contiguous selections in the current
+ Text object. Text objects which do not implement selection of
+ discontiguous text regions will always return '0' or '1'. Note
+ that "contiguous" is defined by continuity of the offsets, i.e.
+ a text 'selection' is defined by a start/end offset pair. In
+ the case of bidirectional text, this means that a continguous
+ selection may appear visually discontiguous, and vice-versa.
+ @return the number of contiguous selections in the current Text
+ object.
"""
- func = self.get_dbus_method("unImplemented5")
+ func = self.get_dbus_method("getNSelections")
return func(*args, **kwargs)
- def unImplemented6(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented6")
+ def getOffsetAtPoint(self, *args, **kwargs):
+ """
+ Get the offset of the character at a given onscreen coordinate.
+ The coordinate system used to interpret x and y is determined
+ by parameter coordType.
+ @param : x
+ @param : y
+ @param : coordType
+ if 0, the input coordinates are interpreted relative to the entire
+ screen, if 1, they are relative to the toplevel window containing
+ this Text object.
+ @return the text offset (as an offset into the character array)
+ of the glyph whose onscreen bounds contain the point x,y, or
+ -1 if the point is outside the bounds of any glyph.
+ """
+ func = self.get_dbus_method("getOffsetAtPoint")
return func(*args, **kwargs)
- def unImplemented9(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented9")
- return func(*args, **kwargs)
-
-
-class Event(list):
- def __new__(cls, type, source, detail1, detail2, any_data):
- list.__new__(cls, (type, source, detail1, detail2, any_data)
- def __init__(self, type, source, detail1, detail2, any_data):
- list.__init__(self, (type, source, detail1, detail2, any_data))
-
- type = property(fget=_get_type, fset=_set_type)
- def _get_type(self):
- return self[0]
- def _set_type(self, val):
- self[0] = val
- source = property(fget=_get_source, fset=_set_source)
- def _get_source(self):
- return self[1]
- def _set_source(self, val):
- self[1] = val
- detail1 = property(fget=_get_detail1, fset=_set_detail1)
- def _get_detail1(self):
- return self[2]
- def _set_detail1(self, val):
- self[2] = val
- detail2 = property(fget=_get_detail2, fset=_set_detail2)
- def _get_detail2(self):
- return self[3]
- def _set_detail2(self, val):
- self[3] = val
- any_data = property(fget=_get_any_data, fset=_set_any_data)
- def _get_any_data(self):
- return self[4]
- def _set_any_data(self, val):
- self[4] = val
-
-
-class EventDetails(list):
- def __new__(cls, host_application, source_role, source_name, any_data):
- list.__new__(cls, (host_application, source_role, source_name, any_data)
- def __init__(self, host_application, source_role, source_name, any_data):
- list.__init__(self, (host_application, source_role, source_name, any_data))
-
- host_application = property(fget=_get_host_application, fset=_set_host_application)
- def _get_host_application(self):
- return self[0]
- def _set_host_application(self, val):
- self[0] = val
- source_role = property(fget=_get_source_role, fset=_set_source_role)
- def _get_source_role(self):
- return self[1]
- def _set_source_role(self, val):
- self[1] = val
- source_name = property(fget=_get_source_name, fset=_set_source_name)
- def _get_source_name(self):
- return self[2]
- def _set_source_name(self, val):
- self[2] = val
- any_data = property(fget=_get_any_data, fset=_set_any_data)
- def _get_any_data(self):
- return self[3]
- def _set_any_data(self, val):
- self[3] = val
-
-
-class EventListener(BaseProxy):
-
-
- """
- A generic interface implemented by objects for the receipt of
- event notifications. EventListener is the interface from which
- Accessibility::Registry is derived, and via which clients of
- the Registry receive notification of changes to an application's
- user interface and content.
- """
-
-
- def notifyEvent(self, *args, **kwargs):
- """
- Synchronously notify an EventListener that an event has occurred,
- by passing it an Event struct.
- @param : e
- The Event about which the listener is being notified.
- """
- func = self.get_dbus_method("notifyEvent")
- return func(*args, **kwargs)
-
- def unImplemented2_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2_")
- return func(*args, **kwargs)
-
- def unImplemented3_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3_")
- return func(*args, **kwargs)
-
- def unImplemented4_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented4_")
- return func(*args, **kwargs)
-
- def unImplemented_(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented_")
- return func(*args, **kwargs)
-
-
-class EventListenerMode(list):
- def __new__(cls, synchronous, preemptive, global):
- list.__new__(cls, (synchronous, preemptive, global)
- def __init__(self, synchronous, preemptive, global):
- list.__init__(self, (synchronous, preemptive, global))
-
- synchronous = property(fget=_get_synchronous, fset=_set_synchronous)
- def _get_synchronous(self):
- return self[0]
- def _set_synchronous(self, val):
- self[0] = val
- preemptive = property(fget=_get_preemptive, fset=_set_preemptive)
- def _get_preemptive(self):
- return self[1]
- def _set_preemptive(self, val):
- self[1] = val
- global = property(fget=_get_global, fset=_set_global)
- def _get_global(self):
- return self[2]
- def _set_global(self, val):
- self[2] = val
-
-
-class EventType(Enum):
- _enum_lookup = {
- 0:'KEY_PRESSED_EVENT',
- 1:'KEY_RELEASED_EVENT',
- 2:'BUTTON_PRESSED_EVENT',
- 3:'BUTTON_RELEASED_EVENT',
- }
-
-
-class Hyperlink(BaseProxy):
-
-
- """
- Instances of Hyperlink are returned by Hypertext objects, and
- are the means by which end users and clients interact with linked,
- and in some cases embedded, content. Hyperlinks may have multiple
- "anchors", where an anchor corresponds to a reference to a particular
- resource with a corresponding resource identified (URI). Hyperlinks
- may be queried for their URIs, or queried for the objects corresponding
- to their anchors. The objects thus obtained are instances of
- Accessible, and may be queried, and manipulated via the Action
- interface.
- """
-
-
- def getObject(self, *args, **kwargs):
- """
- Gets the i'th object, (where i is an integer between 0 and Hyperlink::numAnchors
- - 1, inclusive) associated with a Hyperlink. The objects returned
- are usually actionable (i.e. they should implement Accessibility::Action),
- and the available actions often include "open", "bookmark", "save
- link as", etc. They may also implement Accessibility::StreamableContent,
- although clients can normally use getURI to obtain a resource
- locator via which the object's data may be accessed.
- @return an Accessible object instance representing the Hyperlink's
- ith anchor, or through which the content associated with the
- ith anchor can be accessed.
- """
- func = self.get_dbus_method("getObject")
- return func(*args, **kwargs)
-
- def getURI(self, *args, **kwargs):
- """
- Obtain a resource locator ('URI') which can be used to access
- the content to which this link "points" or is connected.
- @return a string corresponding to the URI of the Hyperlink's
- 'ith' anchor, if one exists, or a NIL string otherwise.
- """
- func = self.get_dbus_method("getURI")
- return func(*args, **kwargs)
-
- def isValid(self, *args, **kwargs):
- """
- Check the hyperlink to see if a connection to its backing content
- can be established, or if its URI is valid.
- @return True if the object's content is available, or False if
- the hyperlink's URI is invalid, or a connection to the resource
- can not be established.
- """
- func = self.get_dbus_method("isValid")
- return func(*args, **kwargs)
-
- def unImplemented(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented")
- return func(*args, **kwargs)
-
- def unImplemented2(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2")
- return func(*args, **kwargs)
-
- def unImplemented3(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3")
- return func(*args, **kwargs)
-
- def unImplemented4(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented4")
- return func(*args, **kwargs)
-
- def get_endIndex(self):
- self._pgetter(self._dbus_interface, "endIndex")
- def set_endIndex(self, value):
- self._psetter(self._dbus_interface, "endIndex", value)
- _endIndexDoc = \
- """
- the ending offset within the containing Hypertext content with
- which this Hyperlink is associated; that is, the offset of the
- first element past the range within the Hypertext associated
- with this Hyperlink.
- """
- endIndex = property(fget=get_endIndex, fset=set_endIndex, doc=_endIndexDoc)
-
- def get_nAnchors(self):
- self._pgetter(self._dbus_interface, "nAnchors")
- def set_nAnchors(self, value):
- self._psetter(self._dbus_interface, "nAnchors", value)
- _nAnchorsDoc = \
- """
- the number of separate anchors associated with this Hyperlink
- """
- nAnchors = property(fget=get_nAnchors, fset=set_nAnchors, doc=_nAnchorsDoc)
-
- def get_startIndex(self):
- self._pgetter(self._dbus_interface, "startIndex")
- def set_startIndex(self, value):
- self._psetter(self._dbus_interface, "startIndex", value)
- _startIndexDoc = \
- """
- the starting offset within the containing Hypertext content with
- which this Hyperlink is associated
- """
- startIndex = property(fget=get_startIndex, fset=set_startIndex, doc=_startIndexDoc)
-
-
-class Hypertext(BaseProxy):
-
-
- """
- An interface used for objects which implement linking between
- multiple resource or content locations, or multiple 'markers'
- within a single document. A Hypertext instance is associated
- with one or more Hyperlinks, which are associated with particular
- offsets within the Hypertext's included content.
- """
-
-
- def getLink(self, *args, **kwargs):
- """
- Get one of the Hyperlinks associated with this Hypertext object,
- by index.
- @param : linkIndex
- an integer from 0 to getNLinks() - 1.
- @return the Hyperlink in this Hypertext object.
- """
- func = self.get_dbus_method("getLink")
- return func(*args, **kwargs)
-
- def getLinkIndex(self, *args, **kwargs):
- """
- Get the hyperlink index, if any, associated with a particular
- character offset in the Hypertext object. For Hypertext implementors
- without textual content, all hyperlinks are associated with character
- offset '0'.
- @return the index of the Hyperlink associated with character
- offset characterIndex, or -1 if no Hyperlink is associated with
- that character offset.
- """
- func = self.get_dbus_method("getLinkIndex")
- return func(*args, **kwargs)
-
- def getNLinks(self, *args, **kwargs):
- """
- Query the hypertext object for the number of Hyperlinks it contains.
- @return the number of Hyperlinks associated with this Hypertext
- object, as a long integer.
- """
- func = self.get_dbus_method("getNLinks")
- return func(*args, **kwargs)
-
- def unImplemented(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented")
- return func(*args, **kwargs)
-
- def unImplemented2(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2")
- return func(*args, **kwargs)
-
- def unImplemented3(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3")
- return func(*args, **kwargs)
-
- def unImplemented4(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented4")
- return func(*args, **kwargs)
-
-
-class Image(BaseProxy):
-
-
- """
- An interface implemented by objects which render image data or
- pictorial information to the screen. When onscreen components
- include graphical information that is not purely intended to
- enhance "3d effect" or visual layout, but which conveys some
- semantic or informational content to the sighted user, they should
- implement Image, and that semantic content should be conveyed
- textually to the extent possible via the image description, as
- well as the Accessible::name and Accessible::description properties.
- """
-
-
- def getImageExtents(self, *args, **kwargs):
- """
- Obtain a bounding box which entirely contains the image contents,
- as displayed on screen. The bounds returned do not account for
- any viewport clipping or the fact that the image may be partially
- or wholly obscured by other onscreen content.
- @param : coordType
- If 0, the returned bounding box position is returned relative
- to the screen; if 1, the bounding box position is returned relative
- to the containing window.
- @return a BoundingBox enclosing the image's onscreen representation.
- """
- func = self.get_dbus_method("getImageExtents")
- return func(*args, **kwargs)
-
- def getImagePosition(self, *args, **kwargs):
- """
- Get the coordinates of the current image position on screen.
- @param : x
- Back-filled with the x coordinate of the onscreen image (i.e.
- the minimum x coordinate)
- @param : y
- Back-filled with the y coordinate of the onscreen image (i.e.
- the minimum y coordinate)
- @param : coordType
- If 0, the returned x and y coordinates are returned relative
- to the screen; if 1, they are returned relative to the containing
- window.
- """
- func = self.get_dbus_method("getImagePosition")
- return func(*args, **kwargs)
-
- def getImageSize(self, *args, **kwargs):
- """
- Obtain the width and height of the current onscreen view of the
- image. The extents returned do not account for any viewport clipping
- or the fact that the image may be partially or wholly obscured
- by other onscreen content.
- @param : width
- Back-filled with the x extents of the onscreen image (i.e. the
- image width in pixels)
- @param : height
- Back-filled with the y extents of the onscreen image (i.e. the
- image height in pixels)
- """
- func = self.get_dbus_method("getImageSize")
- return func(*args, **kwargs)
-
- def unImplemented(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented")
- return func(*args, **kwargs)
-
- def unImplemented2(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2")
- return func(*args, **kwargs)
-
- def unImplemented3(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3")
- return func(*args, **kwargs)
-
- def get_imageDescription(self):
- self._pgetter(self._dbus_interface, "imageDescription")
- def set_imageDescription(self, value):
- self._psetter(self._dbus_interface, "imageDescription", value)
- _imageDescriptionDoc = \
- """
- A UTF-8 string providing a textual description of what is visually
- depicted in the image.
- """
- imageDescription = property(fget=get_imageDescription, fset=set_imageDescription, doc=_imageDescriptionDoc)
-
- def get_imageLocale(self):
- self._pgetter(self._dbus_interface, "imageLocale")
- def set_imageLocale(self, value):
- self._psetter(self._dbus_interface, "imageLocale", value)
- _imageLocaleDoc = \
- """
- A string corresponding to the POSIX LC_MESSAGES locale used by
- the imageDescription.
- """
- imageLocale = property(fget=get_imageLocale, fset=set_imageLocale, doc=_imageLocaleDoc)
-
-
-class KeyDefinition(list):
- def __new__(cls, keycode, keysym, keystring, unused):
- list.__new__(cls, (keycode, keysym, keystring, unused)
- def __init__(self, keycode, keysym, keystring, unused):
- list.__init__(self, (keycode, keysym, keystring, unused))
-
- keycode = property(fget=_get_keycode, fset=_set_keycode)
- def _get_keycode(self):
- return self[0]
- def _set_keycode(self, val):
- self[0] = val
- keysym = property(fget=_get_keysym, fset=_set_keysym)
- def _get_keysym(self):
- return self[1]
- def _set_keysym(self, val):
- self[1] = val
- keystring = property(fget=_get_keystring, fset=_set_keystring)
- def _get_keystring(self):
- return self[2]
- def _set_keystring(self, val):
- self[2] = val
- unused = property(fget=_get_unused, fset=_set_unused)
- def _get_unused(self):
- return self[3]
- def _set_unused(self, val):
- self[3] = val
-
-
-class KeyEventType(Enum):
- _enum_lookup = {
- 0:'KEY_PRESSED',
- 1:'KEY_RELEASED',
- }
-
-
-class KeySynthType(Enum):
- _enum_lookup = {
- 0:'KEY_PRESS',
- 1:'KEY_RELEASE',
- 2:'KEY_PRESSRELEASE',
- 3:'KEY_SYM',
- 4:'KEY_STRING',
- }
-
-
-class LOCALE_TYPE(Enum):
- _enum_lookup = {
- 0:'LOCALE_TYPE_MESSAGES',
- 1:'LOCALE_TYPE_COLLATE',
- 2:'LOCALE_TYPE_CTYPE',
- 3:'LOCALE_TYPE_MONETARY',
- 4:'LOCALE_TYPE_NUMERIC',
- 5:'LOCALE_TYPE_TIME',
- }
-
-
-class LoginHelper(BaseProxy):
-
-
- """
- An interface for use by assistive technologies by which they
- can access system information and services on a 'need to know'
- basis while the screen is locked, during user authentication,
- or during other sensitive operations.
- This interface is intended for use by assistive technologies
- and related user-enabling services, and by applications and utilities
- which may wish to restrict access to certain system devices and
- services during security-sensitive states, e.g. when the screen
- is locked or during authentication into some secure service.
- Such 'applications' (for instance, screen lock dialogs and security-enabled
- web browsers) use the LoginHelper client interfaces, and the
- bonobo-activation query service, to query for assistive technologies
- which advertise the LoginHelper service. The client then queries
- these assistive technologies for their device I/O requirements,
- via the getDeviceReqs call. The client may then issue the advisory
- request setSafe (TRUE), which requests that the LoginHelper -implementing
- service make a best-effort attempt to make itself more secure
- (for instance, an onscreen keyboard might turn off word prediction,
- and a screenreader may turn off keyboard echo via speech). The
- return value of setSafe is an advisory indication of whether
- this attempt was successful (no specific guarantees are implied).
- Once the 'security sensitive' state is exited, the client should
- call setSafe (FALSE).
- The return values from getDeviceReqs inform the client of which
- services the LoginHelper service (e. g. assistive technology)
- needs in order to do its job. The client may use this information
- to loosen any restrictions on access which it may currently have
- in place (for instance, keyboard grabs, etc.). If it does not
- do so, the likely outcome is that the end-user will experience
- loss of access to the system.
- """
-
-
- def getDeviceReqs(self, *args, **kwargs):
+ def getRangeExtents(self, *args, **kwargs):
"""
- getDeviceReqs:
- Query a LoginHelper for the types of device I/O it requires,
- in order to do its job. For instance, a LoginHelper which needs
- to receive keyboard events will include Accessibility_LoginHelper_CORE_KEYBOARD
- in this list.
- @return : A sequence of LoginHelper_DeviceReq indicating the
- device I/O required in order to facilitate end-user access to
- the system.
+ Obtain the bounding box which entirely contains a given text
+ range. Negative values may be returned for the bounding box parameters
+ in the event that all or part of the text range is offscreen
+ or not mapped to the screen.
+ @param : startOffset
+ the offset of the first character in the specified range.
+ @param : endOffset
+ the offset of the character immediately after the last character
+ in the specified range.
+ @param : x
+ an integer parameter which is back-filled with the minimum horizontal
+ coordinate of the resulting bounding box.
+ @param : y
+ an integer parameter which is back-filled with the minimum vertical
+ coordinate of the resulting bounding box.
+ @param : width
+ an integer parameter which is back-filled with the horizontal
+ extent of the bounding box.
+ @param : height
+ an integer parameter which is back-filled with the vertical extent
+ of the bounding box.
+ @param : coordType
+ If 0, the above coordinates are reported in pixels relative to
+ corner of the screen; if 1, the coordinates are reported relative
+ to the corner of the containing toplevel window.
"""
- func = self.get_dbus_method("getDeviceReqs")
+ func = self.get_dbus_method("getRangeExtents")
return func(*args, **kwargs)
- def getRaiseWindows(self, *args, **kwargs):
+ def getSelection(self, *args, **kwargs):
"""
- getRaiseWindows:
- Get a list of window IDs that need raising on login.
- @return : a sequence containing window IDS for toplevels which
- need to be raised/made visible during user authentication, in
- order for the LoginHelper to facilitate end-user access to the
- system.
+ The result of calling getSelection with an out-of-range selectionNum
+ (i.e. for a selection which does not exist) is not strictly defined,
+ but should set endOffset equal to startOffset.
"""
- func = self.get_dbus_method("getRaiseWindows")
+ func = self.get_dbus_method("getSelection")
return func(*args, **kwargs)
- def setSafe(self, *args, **kwargs):
+ def getText(self, *args, **kwargs):
"""
- setSafe:
- @param : safe_mode
- TRUE if the client is requesting that 'safe mode' be initiated,
- FALSE if the client is advising that 'safe mode' may be exited,
- i.e. normal operation may be resumed.
- Request a LoginHelper to enter "safe" mode, or inform LoginHelper
- that "safe" mode may be exited. If safe_mode is TRUE, but the
- return value is FALSE, the requesting client may wish to deny
- services to the LoginHelper, for instance avoid raising its toplevels.
- The return value is purely advisory, and no guarantees are intended
- about what the implementing LoginHelper will do to improve security
- when in "safe" mode.
- @return : whether the LoginHelper is now "safe" or not.
+ Obtain all or part of the onscreen textual content of a Text
+ object. If endOffset is specified as "-1", then this method will
+ return the entire onscreen textual contents of the Text object.
+ @return the textual content of the current Text object beginning
+ startOffset (inclusive) up to but not including the character
+ at endOffset.
"""
- func = self.get_dbus_method("setSafe")
+ func = self.get_dbus_method("getText")
return func(*args, **kwargs)
- def unImplemented(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented")
+ def getTextAfterOffset(self, *args, **kwargs):
+ """
+ Obtain a subset of the text content of an object which entirely
+ follows offset, delimited by character, word, line, or sentence
+ boundaries as specified by type. The starting and ending offsets
+ of the resulting substring are returned in startOffset and endOffset.
+ By definition, if such a substring exists, startOffset must be
+ greater than offset.
+ @param : offset
+ the offset from which the substring search begins, and which
+ must lie before the returned substring.
+ @param : type
+ the text-boundary delimiter which determines whether the returned
+ text constitures a character, word, line, or sentence (and possibly
+ attendant whitespace), and whether the start or ending of such
+ a substring forms the boundary condition.
+ @param : startOffset
+ back-filled with the starting offset of the resulting substring,
+ if one exists.
+ @param : endOffset
+ back-filled with the offset of the character immediately following
+ the resulting substring, if one exists.
+ @return a string which is a substring of the text content of
+ the object, delimited by the specified boundary condition.
+ """
+ func = self.get_dbus_method("getTextAfterOffset")
return func(*args, **kwargs)
- def unImplemented2(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2")
+ def getTextAtOffset(self, *args, **kwargs):
+ """
+ Obtain a subset of the text content of an object which includes
+ the specified offset, delimited by character, word, line, or
+ sentence boundaries as specified by type. The starting and ending
+ offsets of the resulting substring are returned in startOffset
+ and endOffset.
+ @param : offset
+ the offset from which the substring search begins, and which
+ must lie within the returned substring.
+ @param : type
+ the text-boundary delimiter which determines whether the returned
+ text constitures a character, word, line, or sentence (and possibly
+ attendant whitespace), and whether the start or ending of such
+ a substring forms the boundary condition.
+ @param : startOffset
+ back-filled with the starting offset of the resulting substring,
+ if one exists.
+ @param : endOffset
+ back-filled with the offset of the character immediately following
+ the resulting substring, if one exists.
+ @return a string which is a substring of the text content of
+ the object, delimited by the specified boundary condition.
+ """
+ func = self.get_dbus_method("getTextAtOffset")
return func(*args, **kwargs)
- def unImplemented3(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3")
+ def getTextBeforeOffset(self, *args, **kwargs):
+ """
+ Obtain a subset of the text content of an object which entirely
+ precedes offset, delimited by character, word, line, or sentence
+ boundaries as specified by type. The starting and ending offsets
+ of the resulting substring are returned in startOffset and endOffset.
+ By definition, if such a substring exists, endOffset is less
+ than or equal to offset.
+ @param : offset
+ the offset from which the substring search begins.
+ @param : type
+ the text-boundary delimiter which determines whether the returned
+ text constitures a character, word, line, or sentence (and possibly
+ attendant whitespace), and whether the start or ending of such
+ a substring forms the boundary condition.
+ @param : startOffset
+ back-filled with the starting offset of the resulting substring,
+ if one exists.
+ @param : endOffset
+ back-filled with the offset of the character immediately following
+ the resulting substring, if one exists.
+ @return a string which is a substring of the text content of
+ the object, delimited by the specified boundary condition.
+ """
+ func = self.get_dbus_method("getTextBeforeOffset")
return func(*args, **kwargs)
- def unImplemented4(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented4")
+ def removeSelection(self, *args, **kwargs):
+ """
+ Deselect the text contained in the specified selectionNum, if
+ such a selection exists, otherwise do nothing. Removal of a non-existant
+ selectionNum has no effect.
+ @return True if the selection was successfully removed, False
+ otherwise.
+ """
+ func = self.get_dbus_method("removeSelection")
return func(*args, **kwargs)
- AUDIO_IN = Accessibility.DeviceReq(6)
-
- AUDIO_OUT = Accessibility.DeviceReq(5)
-
- CORE_KEYBOARD = Accessibility.DeviceReq(1)
-
- CORE_POINTER = Accessibility.DeviceReq(2)
-
- class DeviceReq(Enum):
- _enum_lookup = {
- 0:'GUI_EVENTS',
- 1:'CORE_KEYBOARD',
- 2:'CORE_POINTER',
- 3:'EXT_INPUT',
- 4:'POST_WINDOWS',
- 5:'AUDIO_OUT',
- 6:'AUDIO_IN',
- 7:'NETWORK',
- 8:'LOCALHOST',
- 9:'SERIAL_OUT',
- 10:'SERIAL_IN',
- }
-
-
- EXT_INPUT = Accessibility.DeviceReq(3)
-
- GUI_EVENTS = Accessibility.DeviceReq(0)
-
- LOCALHOST = Accessibility.DeviceReq(8)
-
- NETWORK = Accessibility.DeviceReq(7)
-
- POST_WINDOWS = Accessibility.DeviceReq(4)
+ def setCaretOffset(self, *args, **kwargs):
+ """
+ Programmatically move the text caret (visible or virtual, as
+ above) to a given position.
+ @param : offset
+ a long int indicating the desired character offset. Not all implementations
+ of Text will honor setCaretOffset requests, so the return value
+ below should be checked by the client.
+ @return TRUE if the request was carried out, or FALSE if the
+ caret could not be moved to the requested position.
+ """
+ func = self.get_dbus_method("setCaretOffset")
+ return func(*args, **kwargs)
- SERIAL_IN = Accessibility.DeviceReq(10)
+ def setSelection(self, *args, **kwargs):
+ """
+ Modify an existing selection's start or ending offset.
+ Calling setSelection for a selectionNum that is not already defined
+ has no effect. The result of calling setSelection with a selectionNum
+ greater than 0 for objects that do not include STATE_MULTISELECTABLE
+ is undefined.
+ @param : selectionNum
+ indicates which of a set of non-contiguous selections to modify.
+ @param : startOffset
+ the new starting offset for the selection
+ @param : endOffset
+ the new ending offset for the selection
+ @return True if the selection corresponding to selectionNum is
+ successfully modified, False otherwise.
+ """
+ func = self.get_dbus_method("setSelection")
+ return func(*args, **kwargs)
+
+ def get_caretOffset(self):
+ self._pgetter(self._dbus_interface, "caretOffset")
+ def set_caretOffset(self, value):
+ self._psetter(self._dbus_interface, "caretOffset", value)
+ _caretOffsetDoc = \
+ """
+ The current offset of the text caret in the Text object. This
+ caret may be virtual, e.g. non-visual and notional-only, but
+ if an onscreen representation of the caret position is visible,
+ it will correspond to this offset. The caret offset is given
+ as a character offset, as opposed to a byte offset into a text
+ buffer or a column offset.
+ """
+ caretOffset = property(fget=get_caretOffset, fset=set_caretOffset, doc=_caretOffsetDoc)
- SERIAL_OUT = Accessibility.DeviceReq(9)
+ def get_characterCount(self):
+ self._pgetter(self._dbus_interface, "characterCount")
+ def set_characterCount(self, value):
+ self._psetter(self._dbus_interface, "characterCount", value)
+ _characterCountDoc = \
+ """
+ The total current number of characters in the Text object, including
+ whitespace and non-spacing characters.
+ """
+ characterCount = property(fget=get_characterCount, fset=set_characterCount, doc=_characterCountDoc)
- class WindowInfo(list):
- def __new__(cls, winID):
- list.__new__(cls, (winID)
- def __init__(self, winID):
- list.__init__(self, (winID))
+ class Range(list):
+ def __new__(cls, startOffset, endOffset, content, data):
+ list.__new__(cls, (startOffset, endOffset, content, data))
+ def __init__(self, startOffset, endOffset, content, data):
+ list.__init__(self, (startOffset, endOffset, content, data))
- winID = property(fget=_get_winID, fset=_set_winID)
- def _get_winID(self):
+ def _get_startOffset(self):
return self[0]
- def _set_winID(self, val):
+ def _set_startOffset(self, val):
self[0] = val
+ startOffset = property(fget=_get_startOffset, fset=_set_startOffset)
+ def _get_endOffset(self):
+ return self[1]
+ def _set_endOffset(self, val):
+ self[1] = val
+ endOffset = property(fget=_get_endOffset, fset=_set_endOffset)
+ def _get_content(self):
+ return self[2]
+ def _set_content(self, val):
+ self[2] = val
+ content = property(fget=_get_content, fset=_set_content)
+ def _get_data(self):
+ return self[3]
+ def _set_data(self, val):
+ self[3] = val
+ data = property(fget=_get_data, fset=_set_data)
-class ModifierType(Enum):
- _enum_lookup = {
- 0:'MODIFIER_SHIFT',
- 1:'MODIFIER_SHIFTLOCK',
- 2:'MODIFIER_CONTROL',
- 3:'MODIFIER_ALT',
- 4:'MODIFIER_META',
- 5:'MODIFIER_META2',
- 6:'MODIFIER_META3',
- 7:'MODIFIER_NUMLOCK',
- }
-
-
-class Registry(EventListener):
-
-
+class EditableText(Text):
"""
- The Registry is a service through which applications providing
- accessibility services (servers) can rendezvous with consumers
- of those services (Assistive Technologies). The Registry is the
- first "port of call" for accessible applications and for assistive
- technologies wishing to query and interact with those applications.
- The Registry service provides four basic functions to Assistive
- Technology (AT) clients:
- it provides a list of the applications who have registered with
- the AT-SPI framework, thereby announcing their participation
- in the AT-SPI framework;
- it allows AT clients to register for notification of changes
- in application state (at-spi Events);
- it dispatches/relays said events from participating applications
- to the registered listeners;
- it gives access to system device events via the associated DeviceEventController
- interface.
- From the point of view of accessible applications (i.e. AT-SPI
- service producers), the Registry is primarily a registration
- and event delivery service. Applications normally only call the
- registerApplication and deregisterApplication Registry methods,
- and its inherited EventListener::notifyEvent method.
- The Registry normally lives in its own process space; communication
- via Registry and both application services and AT clients takes
- place via IPC. A process space diagram illustrating the relationship
- between applications, Registry, and AT is shown below.
+ Derived from interface Text, EditableText provides methods for
+ modifying textual content of components which support editing.
+ EditableText also interacts with the system clipboard via copyText,
+ cutText, and pasteText.
"""
-
- def deregisterApplication(self, *args, **kwargs):
+ def copyText(self, *args, **kwargs):
"""
- De-register an application previously registered with the broker.
- deregisterApplication:
- @param : app
- a reference to the Application to be deregistered.
+ Copy a range of text into the system clipboard.
+ @param : startPos
+ the character offset of the first character in the range of text
+ being copied.
+ @param : endPos
+ the offset of the first character past the end of the range of
+ text being copied.
"""
- func = self.get_dbus_method("deregisterApplication")
+ func = self.get_dbus_method("copyText")
return func(*args, **kwargs)
- def deregisterGlobalEventListener(self, *args, **kwargs):
+ def cutText(self, *args, **kwargs):
"""
- deregisterGlobalEventListener:
- @param : listener
- the requesting EventListener
- @param : eventName
- a string indicating the type of events
- Request that a previously registered client stop receiving global
- notifications for events of a certain type.
+ Excise a range of text from a Text object, copying it into the
+ system clipboard.
+ @param : startPos
+ the character offset of the first character in the range of text
+ being cut.
+ @param : endPos
+ the offset of the first character past the end of the range of
+ text being cut.
+ @return True if the text was successfully cut, False otherwise.
"""
- func = self.get_dbus_method("deregisterGlobalEventListener")
+ func = self.get_dbus_method("cutText")
return func(*args, **kwargs)
- def deregisterGlobalEventListenerAll(self, *args, **kwargs):
+ def deleteText(self, *args, **kwargs):
"""
- deregisterGlobalEventListenerAll:
- @param : listener
- the requesting EventListener
- Request that a previously registered client stop receiving global
- notifications for all events for which it was registered.
+ Excise a range of text from a Text object without copying it
+ into the system clipboard.
+ @param : startPos
+ the character offset of the first character in the range of text
+ being deleted.
+ @param : endPos
+ the offset of the first character past the end of the range of
+ text being deleted.
+ @return True if the text was successfully deleted, False otherwise.
"""
- func = self.get_dbus_method("deregisterGlobalEventListenerAll")
+ func = self.get_dbus_method("deleteText")
return func(*args, **kwargs)
- def getDesktop(self, *args, **kwargs):
+ def insertText(self, *args, **kwargs):
"""
- getDesktop:
- : the index of the requested Desktop.
- Get the nth accessible desktop.
- @return a reference to the requested Desktop.
+ Insert new text contents into an existing text object at a given
+ location, while retaining the old contents.
+ @param : position
+ the character offset into the Text implementor's content at which
+ the new content will be inserted.
+ @param : text
+ a UTF-8 string of which length characters will be inserted into
+ the text object's text buffer.
+ @param : length
+ the number of characters of text to insert. If the character
+ count of text is less than or equal to length, the entire contents
+ of text will be inserted.
+ @return True if the text content was successfully inserted, False
+ otherwise.
"""
- func = self.get_dbus_method("getDesktop")
+ func = self.get_dbus_method("insertText")
return func(*args, **kwargs)
- def getDesktopCount(self, *args, **kwargs):
+ def pasteText(self, *args, **kwargs):
"""
- event types: "Window" "Desktop" "Window:Create" "Window:Destroy"
- "Window:Iconify" "Window:Restore" "Window:Fullscreen" "Window:Resize"
- "Desktop:Create" "Desktop:Destroy" "Desktop:Focus" "Desktop:Defocus"
- "Desktop:Reorder" "Focus" "GtkWidget:show" "GObject:notify:<propertyname>"
- ( not sure we should allow these last 2 forms, since they are
- toolkit-specific, but they're powerful ) getDesktopCount:
- Get the current number of desktops.
- @return a short integer indicating the current number of Desktops.
+ Copy the text contents of the system clipboard, if any, into
+ a Text object, inserting it at a particular character offset.
+ @param : position
+ the character offset before which the text will be inserted.
+ @return True if the text was successfully pasted into the Text
+ object, False otherwise.
"""
- func = self.get_dbus_method("getDesktopCount")
+ func = self.get_dbus_method("pasteText")
return func(*args, **kwargs)
- def getDesktopList(self, *args, **kwargs):
+ def setAttributes(self, *args, **kwargs):
"""
- Get a list of accessible desktops.
- @return : a sequence containing references to the Desktops.
+ Apply a particular set of attributes to a range of text.
+ @return True if the text attributes were successfully modified,
+ False otherwise.
"""
- func = self.get_dbus_method("getDesktopList")
+ func = self.get_dbus_method("setAttributes")
return func(*args, **kwargs)
- def getDeviceEventController(self, *args, **kwargs):
+ def setTextContents(self, *args, **kwargs):
"""
- Obtain an object which can be used to request device event notifications.
- @return : an object implementing DeviceEventController
+ Replace the text contents with a new string, discarding the old
+ contents.
+ @param : newContents
+ a UTF-8 string with which the text object's contents will be
+ replaced.
+ @return True if the text content was successfully changed, False
+ otherwise.
"""
- func = self.get_dbus_method("getDeviceEventController")
+ func = self.get_dbus_method("setTextContents")
return func(*args, **kwargs)
- def registerApplication(self, *args, **kwargs):
+ def unImplemented10(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented10")
+ return func(*args, **kwargs)
+
+ def unImplemented11(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented11")
+ return func(*args, **kwargs)
+
+ def unImplemented12(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented12")
+ return func(*args, **kwargs)
+
+ def unImplemented5(self, *args, **kwargs):
"""
- Register a new application with the accessibility broker.
- @param : app
- a reference to the requesting Application
+ unImplemented:
+ placeholders for future expansion. Note that these are named
+ 'unimplemented5 and unimplemented6' to avoid conflict with placeholders
+ from Accessibility::Text.
"""
- func = self.get_dbus_method("registerApplication")
+ func = self.get_dbus_method("unImplemented5")
+ return func(*args, **kwargs)
+
+ def unImplemented6(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented6")
+ return func(*args, **kwargs)
+
+ def unImplemented9(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented9")
return func(*args, **kwargs)
+
+class Event(list):
+ def __new__(cls, type, source, detail1, detail2, any_data):
+ list.__new__(cls, (type, source, detail1, detail2, any_data))
+ def __init__(self, type, source, detail1, detail2, any_data):
+ list.__init__(self, (type, source, detail1, detail2, any_data))
+
+ def _get_type(self):
+ return self[0]
+ def _set_type(self, val):
+ self[0] = val
+ type = property(fget=_get_type, fset=_set_type)
+ def _get_source(self):
+ return self[1]
+ def _set_source(self, val):
+ self[1] = val
+ source = property(fget=_get_source, fset=_set_source)
+ def _get_detail1(self):
+ return self[2]
+ def _set_detail1(self, val):
+ self[2] = val
+ detail1 = property(fget=_get_detail1, fset=_set_detail1)
+ def _get_detail2(self):
+ return self[3]
+ def _set_detail2(self, val):
+ self[3] = val
+ detail2 = property(fget=_get_detail2, fset=_set_detail2)
+ def _get_any_data(self):
+ return self[4]
+ def _set_any_data(self, val):
+ self[4] = val
+ any_data = property(fget=_get_any_data, fset=_set_any_data)
+
+
+class EventDetails(list):
+ def __new__(cls, host_application, source_role, source_name, any_data):
+ list.__new__(cls, (host_application, source_role, source_name, any_data))
+ def __init__(self, host_application, source_role, source_name, any_data):
+ list.__init__(self, (host_application, source_role, source_name, any_data))
- def registerGlobalEventListener(self, *args, **kwargs):
+ def _get_host_application(self):
+ return self[0]
+ def _set_host_application(self, val):
+ self[0] = val
+ host_application = property(fget=_get_host_application, fset=_set_host_application)
+ def _get_source_role(self):
+ return self[1]
+ def _set_source_role(self, val):
+ self[1] = val
+ source_role = property(fget=_get_source_role, fset=_set_source_role)
+ def _get_source_name(self):
+ return self[2]
+ def _set_source_name(self, val):
+ self[2] = val
+ source_name = property(fget=_get_source_name, fset=_set_source_name)
+ def _get_any_data(self):
+ return self[3]
+ def _set_any_data(self, val):
+ self[3] = val
+ any_data = property(fget=_get_any_data, fset=_set_any_data)
+
+class EventListener(_BaseProxy):
+ """
+ A generic interface implemented by objects for the receipt of
+ event notifications. EventListener is the interface from which
+ Accessibility::Registry is derived, and via which clients of
+ the Registry receive notification of changes to an application's
+ user interface and content.
+ """
+
+ def notifyEvent(self, *args, **kwargs):
"""
- Register a client's interest in (all) application events of a
- certain type.
- @param : listener
- a reference to the requesting EventListener.
- @param : eventName
- a string which indicates the type of events about which the client
- desires notification.
+ Synchronously notify an EventListener that an event has occurred,
+ by passing it an Event struct.
+ @param : e
+ The Event about which the listener is being notified.
"""
- func = self.get_dbus_method("registerGlobalEventListener")
- return func(*args, **kwargs)
-
- def unImplemented(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented")
- return func(*args, **kwargs)
-
- def unImplemented2(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2")
+ func = self.get_dbus_method("notifyEvent")
return func(*args, **kwargs)
- def unImplemented3(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3")
+ def unImplemented2_(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented2_")
return func(*args, **kwargs)
- def unImplemented4(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented4")
+ def unImplemented3_(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented3_")
return func(*args, **kwargs)
- def unImplemented5(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented5")
+ def unImplemented4_(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented4_")
return func(*args, **kwargs)
- def unImplemented6(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented6")
+ def unImplemented_(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented_")
return func(*args, **kwargs)
-class Relation(BaseProxy):
-
+class EventListenerMode(list):
+ def __new__(cls, synchronous, preemptive, global_):
+ list.__new__(cls, (synchronous, preemptive, global_))
+ def __init__(self, synchronous, preemptive, global_):
+ list.__init__(self, (synchronous, preemptive, global_))
+ def _get_synchronous(self):
+ return self[0]
+ def _set_synchronous(self, val):
+ self[0] = val
+ synchronous = property(fget=_get_synchronous, fset=_set_synchronous)
+ def _get_preemptive(self):
+ return self[1]
+ def _set_preemptive(self, val):
+ self[1] = val
+ preemptive = property(fget=_get_preemptive, fset=_set_preemptive)
+ def _get_global_(self):
+ return self[2]
+ def _set_global_(self, val):
+ self[2] = val
+ global_ = property(fget=_get_global_, fset=_set_global_)
+
+
+class EventType(_Enum):
+ _enum_lookup = {
+ 0:'KEY_PRESSED_EVENT',
+ 1:'KEY_RELEASED_EVENT',
+ 2:'BUTTON_PRESSED_EVENT',
+ 3:'BUTTON_RELEASED_EVENT',
+ }
+
+class Hyperlink(_BaseProxy):
"""
- An interface via which objects' non-hierarchical relationships
- to one another are indicated. An instance of Relations represents
- a "one-to-many" correspondance.
+ Instances of Hyperlink are returned by Hypertext objects, and
+ are the means by which end users and clients interact with linked,
+ and in some cases embedded, content. Hyperlinks may have multiple
+ "anchors", where an anchor corresponds to a reference to a particular
+ resource with a corresponding resource identified (URI). Hyperlinks
+ may be queried for their URIs, or queried for the objects corresponding
+ to their anchors. The objects thus obtained are instances of
+ Accessible, and may be queried, and manipulated via the Action
+ interface.
"""
-
- def getNTargets(self, *args, **kwargs):
- """
- @return the number of objects to which this relationship applies.
- """
- func = self.get_dbus_method("getNTargets")
- return func(*args, **kwargs)
-
- def getRelationType(self, *args, **kwargs):
+ def getObject(self, *args, **kwargs):
"""
- @return the RelationType of this Relation.
+ Gets the i'th object, (where i is an integer between 0 and Hyperlink::numAnchors
+ - 1, inclusive) associated with a Hyperlink. The objects returned
+ are usually actionable (i.e. they should implement Accessibility::Action),
+ and the available actions often include "open", "bookmark", "save
+ link as", etc. They may also implement Accessibility::StreamableContent,
+ although clients can normally use getURI to obtain a resource
+ locator via which the object's data may be accessed.
+ @return an Accessible object instance representing the Hyperlink's
+ ith anchor, or through which the content associated with the
+ ith anchor can be accessed.
"""
- func = self.get_dbus_method("getRelationType")
+ func = self.get_dbus_method("getObject")
return func(*args, **kwargs)
- def getRelationTypeName(self, *args, **kwargs):
+ def getURI(self, *args, **kwargs):
"""
- @return an unlocalized string representing the relation type.
+ Obtain a resource locator ('URI') which can be used to access
+ the content to which this link "points" or is connected.
+ @return a string corresponding to the URI of the Hyperlink's
+ 'ith' anchor, if one exists, or a NIL string otherwise.
"""
- func = self.get_dbus_method("getRelationTypeName")
+ func = self.get_dbus_method("getURI")
return func(*args, **kwargs)
- def getTarget(self, *args, **kwargs):
+ def isValid(self, *args, **kwargs):
"""
- @return an Object which is the 'nth'target of this Relation,
- e.g. the Object at index i in the list of Objects having the
- specified relationship to this Accessible.
+ Check the hyperlink to see if a connection to its backing content
+ can be established, or if its URI is valid.
+ @return True if the object's content is available, or False if
+ the hyperlink's URI is invalid, or a connection to the resource
+ can not be established.
"""
- func = self.get_dbus_method("getTarget")
+ func = self.get_dbus_method("isValid")
return func(*args, **kwargs)
def unImplemented(self, *args, **kwargs):
def unImplemented4(self, *args, **kwargs):
func = self.get_dbus_method("unImplemented4")
return func(*args, **kwargs)
+
+ def get_endIndex(self):
+ self._pgetter(self._dbus_interface, "endIndex")
+ def set_endIndex(self, value):
+ self._psetter(self._dbus_interface, "endIndex", value)
+ _endIndexDoc = \
+ """
+ the ending offset within the containing Hypertext content with
+ which this Hyperlink is associated; that is, the offset of the
+ first element past the range within the Hypertext associated
+ with this Hyperlink.
+ """
+ endIndex = property(fget=get_endIndex, fset=set_endIndex, doc=_endIndexDoc)
+
+ def get_nAnchors(self):
+ self._pgetter(self._dbus_interface, "nAnchors")
+ def set_nAnchors(self, value):
+ self._psetter(self._dbus_interface, "nAnchors", value)
+ _nAnchorsDoc = \
+ """
+ the number of separate anchors associated with this Hyperlink
+ """
+ nAnchors = property(fget=get_nAnchors, fset=set_nAnchors, doc=_nAnchorsDoc)
+
+ def get_startIndex(self):
+ self._pgetter(self._dbus_interface, "startIndex")
+ def set_startIndex(self, value):
+ self._psetter(self._dbus_interface, "startIndex", value)
+ _startIndexDoc = \
+ """
+ the starting offset within the containing Hypertext content with
+ which this Hyperlink is associated
+ """
+ startIndex = property(fget=get_startIndex, fset=set_startIndex, doc=_startIndexDoc)
-class RelationType(Enum):
- _enum_lookup = {
- 0:'RELATION_NULL',
- 1:'RELATION_LABEL_FOR',
- 2:'RELATION_LABELLED_BY',
- 3:'RELATION_CONTROLLER_FOR',
- 4:'RELATION_CONTROLLED_BY',
- 5:'RELATION_MEMBER_OF',
- 6:'RELATION_TOOLTIP_FOR',
- 7:'RELATION_NODE_CHILD_OF',
- 8:'RELATION_EXTENDED',
- 9:'RELATION_FLOWS_TO',
- 10:'RELATION_FLOWS_FROM',
- 11:'RELATION_SUBWINDOW_OF',
- 12:'RELATION_EMBEDS',
- 13:'RELATION_EMBEDDED_BY',
- 14:'RELATION_POPUP_FOR',
- 15:'RELATION_PARENT_WINDOW_OF',
- 16:'RELATION_DESCRIPTION_FOR',
- 17:'RELATION_DESCRIBED_BY',
- 18:'RELATION_LAST_DEFINED',
- }
-
-
-class Role(Enum):
- _enum_lookup = {
- 0:'ROLE_INVALID',
- 1:'ROLE_ACCELERATOR_LABEL',
- 2:'ROLE_ALERT',
- 3:'ROLE_ANIMATION',
- 4:'ROLE_ARROW',
- 5:'ROLE_CALENDAR',
- 6:'ROLE_CANVAS',
- 7:'ROLE_CHECK_BOX',
- 8:'ROLE_CHECK_MENU_ITEM',
- 9:'ROLE_COLOR_CHOOSER',
- 10:'ROLE_COLUMN_HEADER',
- 11:'ROLE_COMBO_BOX',
- 12:'ROLE_DATE_EDITOR',
- 13:'ROLE_DESKTOP_ICON',
- 14:'ROLE_DESKTOP_FRAME',
- 15:'ROLE_DIAL',
- 16:'ROLE_DIALOG',
- 17:'ROLE_DIRECTORY_PANE',
- 18:'ROLE_DRAWING_AREA',
- 19:'ROLE_FILE_CHOOSER',
- 20:'ROLE_FILLER',
- 21:'ROLE_FOCUS_TRAVERSABLE',
- 22:'ROLE_FONT_CHOOSER',
- 23:'ROLE_FRAME',
- 24:'ROLE_GLASS_PANE',
- 25:'ROLE_HTML_CONTAINER',
- 26:'ROLE_ICON',
- 27:'ROLE_IMAGE',
- 28:'ROLE_INTERNAL_FRAME',
- 29:'ROLE_LABEL',
- 30:'ROLE_LAYERED_PANE',
- 31:'ROLE_LIST',
- 32:'ROLE_LIST_ITEM',
- 33:'ROLE_MENU',
- 34:'ROLE_MENU_BAR',
- 35:'ROLE_MENU_ITEM',
- 36:'ROLE_OPTION_PANE',
- 37:'ROLE_PAGE_TAB',
- 38:'ROLE_PAGE_TAB_LIST',
- 39:'ROLE_PANEL',
- 40:'ROLE_PASSWORD_TEXT',
- 41:'ROLE_POPUP_MENU',
- 42:'ROLE_PROGRESS_BAR',
- 43:'ROLE_PUSH_BUTTON',
- 44:'ROLE_RADIO_BUTTON',
- 45:'ROLE_RADIO_MENU_ITEM',
- 46:'ROLE_ROOT_PANE',
- 47:'ROLE_ROW_HEADER',
- 48:'ROLE_SCROLL_BAR',
- 49:'ROLE_SCROLL_PANE',
- 50:'ROLE_SEPARATOR',
- 51:'ROLE_SLIDER',
- 52:'ROLE_SPIN_BUTTON',
- 53:'ROLE_SPLIT_PANE',
- 54:'ROLE_STATUS_BAR',
- 55:'ROLE_TABLE',
- 56:'ROLE_TABLE_CELL',
- 57:'ROLE_TABLE_COLUMN_HEADER',
- 58:'ROLE_TABLE_ROW_HEADER',
- 59:'ROLE_TEAROFF_MENU_ITEM',
- 60:'ROLE_TERMINAL',
- 61:'ROLE_TEXT',
- 62:'ROLE_TOGGLE_BUTTON',
- 63:'ROLE_TOOL_BAR',
- 64:'ROLE_TOOL_TIP',
- 65:'ROLE_TREE',
- 66:'ROLE_TREE_TABLE',
- 67:'ROLE_UNKNOWN',
- 68:'ROLE_VIEWPORT',
- 69:'ROLE_WINDOW',
- 70:'ROLE_EXTENDED',
- 71:'ROLE_HEADER',
- 72:'ROLE_FOOTER',
- 73:'ROLE_PARAGRAPH',
- 74:'ROLE_RULER',
- 75:'ROLE_APPLICATION',
- 76:'ROLE_AUTOCOMPLETE',
- 77:'ROLE_EDITBAR',
- 78:'ROLE_EMBEDDED',
- 79:'ROLE_ENTRY',
- 80:'ROLE_CHART',
- 81:'ROLE_CAPTION',
- 82:'ROLE_DOCUMENT_FRAME',
- 83:'ROLE_HEADING',
- 84:'ROLE_PAGE',
- 85:'ROLE_SECTION',
- 86:'ROLE_REDUNDANT_OBJECT',
- 87:'ROLE_FORM',
- 88:'ROLE_LINK',
- 89:'ROLE_INPUT_METHOD_WINDOW',
- 90:'ROLE_LAST_DEFINED',
- }
-
-
-class Selection(BaseProxy):
-
-
+class Hypertext(_BaseProxy):
"""
- An interface which indicates that an object exposes a 'selection'
- model, allowing the selection of one or more of its children.
- Read-only Selection instances are possible, in which case the
- interface is used to programmatically determine the selected-ness
- of its children. A selected child has State::STATE_SELECTED,
- and a child which may hypothetically be selected (though possibly
- not programmatically selectable) has State::STATE_SELECTABLE.
+ An interface used for objects which implement linking between
+ multiple resource or content locations, or multiple 'markers'
+ within a single document. A Hypertext instance is associated
+ with one or more Hyperlinks, which are associated with particular
+ offsets within the Hypertext's included content.
"""
-
- def clearSelection(self, *args, **kwargs):
+ def getLink(self, *args, **kwargs):
"""
- Attempt to clear all selections (i.e. deselect all children)
- of a Selection. Not all Selection implementations allow the removal
- of all selections.
- @return True if the selections were successfully cleared, False
- otherwise.
+ Get one of the Hyperlinks associated with this Hypertext object,
+ by index.
+ @param : linkIndex
+ an integer from 0 to getNLinks() - 1.
+ @return the Hyperlink in this Hypertext object.
"""
- func = self.get_dbus_method("clearSelection")
+ func = self.get_dbus_method("getLink")
return func(*args, **kwargs)
- def deselectChild(self, *args, **kwargs):
+ def getLinkIndex(self, *args, **kwargs):
"""
- Remove a child from the selected children list of a Selection,
- if the child is currently selected.
- @param : childIndex
- a long integer (the zero offset index into the Accessible object's
- list of children) indicating which child of the Selection is
- to be selected.
- @return True if the child was successfully selected, False otherwise.
+ Get the hyperlink index, if any, associated with a particular
+ character offset in the Hypertext object. For Hypertext implementors
+ without textual content, all hyperlinks are associated with character
+ offset '0'.
+ @return the index of the Hyperlink associated with character
+ offset characterIndex, or -1 if no Hyperlink is associated with
+ that character offset.
"""
- func = self.get_dbus_method("deselectChild")
+ func = self.get_dbus_method("getLinkIndex")
return func(*args, **kwargs)
- def deselectSelectedChild(self, *args, **kwargs):
+ def getNLinks(self, *args, **kwargs):
"""
- Remove a child to the selected children list of a Selection.
- @param : selectedChildIndex
- a long integer indicating which of the selected children of the
- Selection is to be deselected. The index is a zero-offset index
- into the 'selected child list', not a zero-offset index into
- the list of all children of the Selection.
- @return True if the child was successfully deselected, False
- otherwise.
+ Query the hypertext object for the number of Hyperlinks it contains.
+ @return the number of Hyperlinks associated with this Hypertext
+ object, as a long integer.
"""
- func = self.get_dbus_method("deselectSelectedChild")
+ func = self.get_dbus_method("getNLinks")
return func(*args, **kwargs)
- def getSelectedChild(self, *args, **kwargs):
- """
- Get the i-th selected Accessible child of a Selection.
- @param : selectedChildIndex
- a long integer indicating which of the selected children of an
- object is being requested.
- @return a pointer to a selected Accessible child object, specified
- by selectedChildIndex.
- """
- func = self.get_dbus_method("getSelectedChild")
- return func(*args, **kwargs)
+class Image(_BaseProxy):
+ """
+ An interface implemented by objects which render image data or
+ pictorial information to the screen. When onscreen components
+ include graphical information that is not purely intended to
+ enhance "3d effect" or visual layout, but which conveys some
+ semantic or informational content to the sighted user, they should
+ implement Image, and that semantic content should be conveyed
+ textually to the extent possible via the image description, as
+ well as the Accessible::name and Accessible::description properties.
+ """
- def isChildSelected(self, *args, **kwargs):
+ def getImageExtents(self, *args, **kwargs):
"""
- Determine whether a particular child of an Selection implementor
- is currently selected. Note that childIndex is the zero-offset
- index into the standard Accessible container's list of children.
- @param : childIndex
- an index into the Selection's list of children.
- @return True if the specified child is currently selected, False
- otherwise.
+ Obtain a bounding box which entirely contains the image contents,
+ as displayed on screen. The bounds returned do not account for
+ any viewport clipping or the fact that the image may be partially
+ or wholly obscured by other onscreen content.
+ @param : coordType
+ If 0, the returned bounding box position is returned relative
+ to the screen; if 1, the bounding box position is returned relative
+ to the containing window.
+ @return a BoundingBox enclosing the image's onscreen representation.
"""
- func = self.get_dbus_method("isChildSelected")
+ func = self.get_dbus_method("getImageExtents")
return func(*args, **kwargs)
- def selectAll(self, *args, **kwargs):
+ def getImagePosition(self, *args, **kwargs):
"""
- Attempt to select all of the children of a Selection implementor.
- Not all Selection implementors support this operation (for instance,
- implementations which support only "single selection" do not
- support this operation).
- @return True if successful, False otherwise.
+ Get the coordinates of the current image position on screen.
+ @param : x
+ Back-filled with the x coordinate of the onscreen image (i.e.
+ the minimum x coordinate)
+ @param : y
+ Back-filled with the y coordinate of the onscreen image (i.e.
+ the minimum y coordinate)
+ @param : coordType
+ If 0, the returned x and y coordinates are returned relative
+ to the screen; if 1, they are returned relative to the containing
+ window.
"""
- func = self.get_dbus_method("selectAll")
+ func = self.get_dbus_method("getImagePosition")
return func(*args, **kwargs)
- def selectChild(self, *args, **kwargs):
+ def getImageSize(self, *args, **kwargs):
"""
- Add a child to the selected children list of a Selection.
- @param : childIndex
- a long integer indicating which child of the Selection is to
- be selected.
- @return True if the child was successfully selected, False otherwise.
+ Obtain the width and height of the current onscreen view of the
+ image. The extents returned do not account for any viewport clipping
+ or the fact that the image may be partially or wholly obscured
+ by other onscreen content.
+ @param : width
+ Back-filled with the x extents of the onscreen image (i.e. the
+ image width in pixels)
+ @param : height
+ Back-filled with the y extents of the onscreen image (i.e. the
+ image height in pixels)
"""
- func = self.get_dbus_method("selectChild")
+ func = self.get_dbus_method("getImageSize")
return func(*args, **kwargs)
-
- def unImplemented(self, *args, **kwargs):
+
+ def get_imageDescription(self):
+ self._pgetter(self._dbus_interface, "imageDescription")
+ def set_imageDescription(self, value):
+ self._psetter(self._dbus_interface, "imageDescription", value)
+ _imageDescriptionDoc = \
"""
- unImplemented:
- placeholders for future expansion.
+ A UTF-8 string providing a textual description of what is visually
+ depicted in the image.
"""
- func = self.get_dbus_method("unImplemented")
- return func(*args, **kwargs)
-
- def unImplemented2(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2")
- return func(*args, **kwargs)
-
- def unImplemented3(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3")
- return func(*args, **kwargs)
+ imageDescription = property(fget=get_imageDescription, fset=set_imageDescription, doc=_imageDescriptionDoc)
- def get_nSelectedChildren(self):
- self._pgetter(self._dbus_interface, "nSelectedChildren")
- def set_nSelectedChildren(self, value):
- self._psetter(self._dbus_interface, "nSelectedChildren", value)
- _nSelectedChildrenDoc = \
+ def get_imageLocale(self):
+ self._pgetter(self._dbus_interface, "imageLocale")
+ def set_imageLocale(self, value):
+ self._psetter(self._dbus_interface, "imageLocale", value)
+ _imageLocaleDoc = \
"""
- The number of children of a Selection implementor which are currently
- selected.
+ A string corresponding to the POSIX LC_MESSAGES locale used by
+ the imageDescription.
"""
- nSelectedChildren = property(fget=get_nSelectedChildren, fset=set_nSelectedChildren, doc=_nSelectedChildrenDoc)
+ imageLocale = property(fget=get_imageLocale, fset=set_imageLocale, doc=_imageLocaleDoc)
-class Selector(BaseProxy):
-
+class KeyDefinition(list):
+ def __new__(cls, keycode, keysym, keystring, unused):
+ list.__new__(cls, (keycode, keysym, keystring, unused))
+ def __init__(self, keycode, keysym, keystring, unused):
+ list.__init__(self, (keycode, keysym, keystring, unused))
+ def _get_keycode(self):
+ return self[0]
+ def _set_keycode(self, val):
+ self[0] = val
+ keycode = property(fget=_get_keycode, fset=_set_keycode)
+ def _get_keysym(self):
+ return self[1]
+ def _set_keysym(self, val):
+ self[1] = val
+ keysym = property(fget=_get_keysym, fset=_set_keysym)
+ def _get_keystring(self):
+ return self[2]
+ def _set_keystring(self, val):
+ self[2] = val
+ keystring = property(fget=_get_keystring, fset=_set_keystring)
+ def _get_unused(self):
+ return self[3]
+ def _set_unused(self, val):
+ self[3] = val
+ unused = property(fget=_get_unused, fset=_set_unused)
+
+class KeyEventType(_Enum):
+ _enum_lookup = {
+ 0:'KEY_PRESSED',
+ 1:'KEY_RELEASED',
+ }
+
+class KeySynthType(_Enum):
+ _enum_lookup = {
+ 0:'KEY_PRESS',
+ 1:'KEY_RELEASE',
+ 2:'KEY_PRESSRELEASE',
+ 3:'KEY_SYM',
+ 4:'KEY_STRING',
+ }
+
+class LOCALE_TYPE(_Enum):
+ _enum_lookup = {
+ 0:'LOCALE_TYPE_MESSAGES',
+ 1:'LOCALE_TYPE_COLLATE',
+ 2:'LOCALE_TYPE_CTYPE',
+ 3:'LOCALE_TYPE_MONETARY',
+ 4:'LOCALE_TYPE_NUMERIC',
+ 5:'LOCALE_TYPE_TIME',
+ }
+
+class LoginHelper(_BaseProxy):
"""
+ An interface for use by assistive technologies by which they
+ can access system information and services on a 'need to know'
+ basis while the screen is locked, during user authentication,
+ or during other sensitive operations.
This interface is intended for use by assistive technologies
- and related user-agents. Via this interface, an assistive technology
- or user agent may expose a series of choices or selections in
- textual form, which can be activated on demand by a client of
- the Selector interface.
- Examples of the use of this interface include voice-command and
- remote-control applications, in which the user interaction is
- wholly or partly delegated by the implementor to an external
- agent.
+ and related user-enabling services, and by applications and utilities
+ which may wish to restrict access to certain system devices and
+ services during security-sensitive states, e.g. when the screen
+ is locked or during authentication into some secure service.
+ Such 'applications' (for instance, screen lock dialogs and security-enabled
+ web browsers) use the LoginHelper client interfaces, and the
+ bonobo-activation query service, to query for assistive technologies
+ which advertise the LoginHelper service. The client then queries
+ these assistive technologies for their device I/O requirements,
+ via the getDeviceReqs call. The client may then issue the advisory
+ request setSafe (TRUE), which requests that the LoginHelper -implementing
+ service make a best-effort attempt to make itself more secure
+ (for instance, an onscreen keyboard might turn off word prediction,
+ and a screenreader may turn off keyboard echo via speech). The
+ return value of setSafe is an advisory indication of whether
+ this attempt was successful (no specific guarantees are implied).
+ Once the 'security sensitive' state is exited, the client should
+ call setSafe (FALSE).
+ The return values from getDeviceReqs inform the client of which
+ services the LoginHelper service (e. g. assistive technology)
+ needs in order to do its job. The client may use this information
+ to loosen any restrictions on access which it may currently have
+ in place (for instance, keyboard grabs, etc.). If it does not
+ do so, the likely outcome is that the end-user will experience
+ loss of access to the system.
"""
-
- def activateCommand(self, *args, **kwargs):
- """
- Request that the Selector invoke the specified Command.
- @param : cmd
- the Command to activate/invoke.
- @return a CommandResult indicating whether the request was honored,
- and the reason for failure if the Command could not be activated
- or invoked.
- """
- func = self.get_dbus_method("activateCommand")
- return func(*args, **kwargs)
-
- def deregisterChangeListener(self, *args, **kwargs):
+ def getDeviceReqs(self, *args, **kwargs):
"""
- Tell the Selector instance to cease notifying the specified CommandListener
- of changes to the command list.
- @param : listener
- the CommandListener to remove from the notification list.
+ getDeviceReqs:
+ Query a LoginHelper for the types of device I/O it requires,
+ in order to do its job. For instance, a LoginHelper which needs
+ to receive keyboard events will include Accessibility_LoginHelper_CORE_KEYBOARD
+ in this list.
+ @return : A sequence of LoginHelper_DeviceReq indicating the
+ device I/O required in order to facilitate end-user access to
+ the system.
"""
- func = self.get_dbus_method("deregisterChangeListener")
+ func = self.get_dbus_method("getDeviceReqs")
return func(*args, **kwargs)
- def getCommands(self, *args, **kwargs):
+ def getRaiseWindows(self, *args, **kwargs):
"""
- Query the Selector for the current CommandList.
- @return the currently available CommandList
+ getRaiseWindows:
+ Get a list of window IDs that need raising on login.
+ @return : a sequence containing window IDS for toplevels which
+ need to be raised/made visible during user authentication, in
+ order for the LoginHelper to facilitate end-user access to the
+ system.
"""
- func = self.get_dbus_method("getCommands")
+ func = self.get_dbus_method("getRaiseWindows")
return func(*args, **kwargs)
- def refreshCommands(self, *args, **kwargs):
+ def setSafe(self, *args, **kwargs):
"""
- Ask the Selector to re-calculate its CommandList.
- @return TRUE if the CommandList changed.
+ setSafe:
+ @param : safe_mode
+ TRUE if the client is requesting that 'safe mode' be initiated,
+ FALSE if the client is advising that 'safe mode' may be exited,
+ i.e. normal operation may be resumed.
+ Request a LoginHelper to enter "safe" mode, or inform LoginHelper
+ that "safe" mode may be exited. If safe_mode is TRUE, but the
+ return value is FALSE, the requesting client may wish to deny
+ services to the LoginHelper, for instance avoid raising its toplevels.
+ The return value is purely advisory, and no guarantees are intended
+ about what the implementing LoginHelper will do to improve security
+ when in "safe" mode.
+ @return : whether the LoginHelper is now "safe" or not.
"""
- func = self.get_dbus_method("refreshCommands")
+ func = self.get_dbus_method("setSafe")
return func(*args, **kwargs)
- def registerChangeListener(self, *args, **kwargs):
- """
- Register a :CommandListener instance for notification of changes
- to the command set.
- @param : listener
- the CommandListener to be notified of changes.
- """
- func = self.get_dbus_method("registerChangeListener")
- return func(*args, **kwargs)
+ class DeviceReq(_Enum):
+ _enum_lookup = {
+ 0:'GUI_EVENTS',
+ 1:'CORE_KEYBOARD',
+ 2:'CORE_POINTER',
+ 3:'EXT_INPUT',
+ 4:'POST_WINDOWS',
+ 5:'AUDIO_OUT',
+ 6:'AUDIO_IN',
+ 7:'NETWORK',
+ 8:'LOCALHOST',
+ 9:'SERIAL_OUT',
+ 10:'SERIAL_IN',
+ }
- def replaceCommands(self, *args, **kwargs):
- """
- @return TRUE if the replacement request was successful, FALSE
- if the request could not be honored.
- """
- func = self.get_dbus_method("replaceCommands")
- return func(*args, **kwargs)
+ AUDIO_IN = DeviceReq(6)
- def unImplemented(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented")
- return func(*args, **kwargs)
+ AUDIO_OUT = DeviceReq(5)
- def unImplemented2(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2")
- return func(*args, **kwargs)
+ CORE_KEYBOARD = DeviceReq(1)
- def unImplemented3(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3")
- return func(*args, **kwargs)
+ CORE_POINTER = DeviceReq(2)
- def unImplemented4(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented4")
- return func(*args, **kwargs)
+ EXT_INPUT = DeviceReq(3)
- def get_supportsReplace(self):
- self._pgetter(self._dbus_interface, "supportsReplace")
- def set_supportsReplace(self, value):
- self._psetter(self._dbus_interface, "supportsReplace", value)
- _supportsReplaceDoc = \
- """
- This attribute is TRUE if this Selector allows its CommandList
- to be specified by the client
- """
- supportsReplace = property(fget=get_supportsReplace, fset=set_supportsReplace, doc=_supportsReplaceDoc)
+ GUI_EVENTS = DeviceReq(0)
- COMMAND_RESULT_FAILED = Accessibility.CommandResult(2)
+ LOCALHOST = DeviceReq(8)
- COMMAND_RESULT_INVALID = Accessibility.CommandResult(0)
+ NETWORK = DeviceReq(7)
- COMMAND_RESULT_LAST_DEFINED = Accessibility.CommandResult(4)
+ POST_WINDOWS = DeviceReq(4)
- COMMAND_RESULT_OBSOLETE = Accessibility.CommandResult(3)
+ SERIAL_IN = DeviceReq(10)
- COMMAND_RESULT_SUCCESS = Accessibility.CommandResult(1)
+ SERIAL_OUT = DeviceReq(9)
- class CommandResult(Enum):
- """
- A code returned by a call to activateCommand, indicating the
- result of the activation request.
- """
+ class WindowInfo(list):
+ def __new__(cls, winID):
+ list.__new__(cls, (winID))
+ def __init__(self, winID):
+ list.__init__(self, (winID))
+
+ def _get_winID(self):
+ return self[0]
+ def _set_winID(self, val):
+ self[0] = val
+ winID = property(fget=_get_winID, fset=_set_winID)
- _enum_lookup = {
- 0:'COMMAND_RESULT_INVALID',
- 1:'COMMAND_RESULT_SUCCESS',
- 2:'COMMAND_RESULT_FAILED',
- 3:'COMMAND_RESULT_OBSOLETE',
- 4:'COMMAND_RESULT_LAST_DEFINED',
- }
+class ModifierType(_Enum):
+ _enum_lookup = {
+ 0:'MODIFIER_SHIFT',
+ 1:'MODIFIER_SHIFTLOCK',
+ 2:'MODIFIER_CONTROL',
+ 3:'MODIFIER_ALT',
+ 4:'MODIFIER_META',
+ 5:'MODIFIER_META2',
+ 6:'MODIFIER_META3',
+ 7:'MODIFIER_NUMLOCK',
+ }
-class StateSet(BaseProxy):
+class Registry(EventListener):
"""
- The StateSet interface encapsulates a collection of state information.
- It allows comparison of state information between object instances,
- and comparisons of an object's state with some hypothetical collection
- of states.
+ The Registry is a service through which applications providing
+ accessibility services (servers) can rendezvous with consumers
+ of those services (Assistive Technologies). The Registry is the
+ first "port of call" for accessible applications and for assistive
+ technologies wishing to query and interact with those applications.
+ The Registry service provides four basic functions to Assistive
+ Technology (AT) clients:
+ it provides a list of the applications who have registered with
+ the AT-SPI framework, thereby announcing their participation
+ in the AT-SPI framework;
+ it allows AT clients to register for notification of changes
+ in application state (at-spi Events);
+ it dispatches/relays said events from participating applications
+ to the registered listeners;
+ it gives access to system device events via the associated DeviceEventController
+ interface.
+ From the point of view of accessible applications (i.e. AT-SPI
+ service producers), the Registry is primarily a registration
+ and event delivery service. Applications normally only call the
+ registerApplication and deregisterApplication Registry methods,
+ and its inherited EventListener::notifyEvent method.
+ The Registry normally lives in its own process space; communication
+ via Registry and both application services and AT clients takes
+ place via IPC. A process space diagram illustrating the relationship
+ between applications, Registry, and AT is shown below.
"""
- def add(self, *args, **kwargs):
- """
- Add a StateType to an existing StateSet, if not already present.
- """
- func = self.get_dbus_method("add")
- return func(*args, **kwargs)
-
- def compare(self, *args, **kwargs):
- """
- Compare two StateSet instances and obtain their differences.
- @return a 'difference set', i.e. a StateSet consisting of those
- states not shared by the two sets being compared.
- """
- func = self.get_dbus_method("compare")
- return func(*args, **kwargs)
-
- def contains(self, *args, **kwargs):
- """
- Query a StateSet for a specific StateType.
- @param : state
- the StateType being queried for.
- @return TRUE if the StateSet contains StateType state.
- """
- func = self.get_dbus_method("contains")
- return func(*args, **kwargs)
-
- def equals(self, *args, **kwargs):
+ def deregisterApplication(self, *args, **kwargs):
"""
- Compare two statesets for equivalence.
- @param : tarStateSet
- the StateSet to be compared with this one.
- @return TRUE if the two StateSet objects are composed of the
- same StateTypes.
+ De-register an application previously registered with the broker.
+ deregisterApplication:
+ @param : app
+ a reference to the Application to be deregistered.
"""
- func = self.get_dbus_method("equals")
- return func(*args, **kwargs)
-
- def getStates(self, *args, **kwargs):
- func = self.get_dbus_method("getStates")
+ func = self.get_dbus_method("deregisterApplication")
return func(*args, **kwargs)
- def isEmpty(self, *args, **kwargs):
+ def deregisterGlobalEventListener(self, *args, **kwargs):
"""
- @return TRUE if the StateSet contains no states.
+ deregisterGlobalEventListener:
+ @param : listener
+ the requesting EventListener
+ @param : eventName
+ a string indicating the type of events
+ Request that a previously registered client stop receiving global
+ notifications for events of a certain type.
"""
- func = self.get_dbus_method("isEmpty")
+ func = self.get_dbus_method("deregisterGlobalEventListener")
return func(*args, **kwargs)
- def remove(self, *args, **kwargs):
- """
- Remove a StateType to an existing StateSet, if it is present.
+ def deregisterGlobalEventListenerAll(self, *args, **kwargs):
"""
- func = self.get_dbus_method("remove")
- return func(*args, **kwargs)
-
- def unImplemented(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented")
- return func(*args, **kwargs)
-
- def unImplemented2(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2")
- return func(*args, **kwargs)
-
- def unImplemented3(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3")
- return func(*args, **kwargs)
-
- def unImplemented4(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented4")
- return func(*args, **kwargs)
-
-
-class StateType(Enum):
- _enum_lookup = {
- 0:'STATE_INVALID',
- 1:'STATE_ACTIVE',
- 2:'STATE_ARMED',
- 3:'STATE_BUSY',
- 4:'STATE_CHECKED',
- 5:'STATE_COLLAPSED',
- 6:'STATE_DEFUNCT',
- 7:'STATE_EDITABLE',
- 8:'STATE_ENABLED',
- 9:'STATE_EXPANDABLE',
- 10:'STATE_EXPANDED',
- 11:'STATE_FOCUSABLE',
- 12:'STATE_FOCUSED',
- 13:'STATE_HAS_TOOLTIP',
- 14:'STATE_HORIZONTAL',
- 15:'STATE_ICONIFIED',
- 16:'STATE_MODAL',
- 17:'STATE_MULTI_LINE',
- 18:'STATE_MULTISELECTABLE',
- 19:'STATE_OPAQUE',
- 20:'STATE_PRESSED',
- 21:'STATE_RESIZABLE',
- 22:'STATE_SELECTABLE',
- 23:'STATE_SELECTED',
- 24:'STATE_SENSITIVE',
- 25:'STATE_SHOWING',
- 26:'STATE_SINGLE_LINE',
- 27:'STATE_STALE',
- 28:'STATE_TRANSIENT',
- 29:'STATE_VERTICAL',
- 30:'STATE_VISIBLE',
- 31:'STATE_MANAGES_DESCENDANTS',
- 32:'STATE_INDETERMINATE',
- 33:'STATE_REQUIRED',
- 34:'STATE_TRUNCATED',
- 35:'STATE_ANIMATED',
- 36:'STATE_INVALID_ENTRY',
- 37:'STATE_SUPPORTS_AUTOCOMPLETION',
- 38:'STATE_SELECTABLE_TEXT',
- 39:'STATE_IS_DEFAULT',
- 40:'STATE_VISITED',
- 41:'STATE_LAST_DEFINED',
- }
-
-
-class StreamableContent(BaseProxy):
-
-
- """
- An interface whereby an object allows its backing content to
- be streamed to clients. Negotiation of content type is allowed.
- Clients may examine the backing data and transform, convert,
- or parse the content in order to present it in an alternate form
- to end-users.
- """
-
+ deregisterGlobalEventListenerAll:
+ @param : listener
+ the requesting EventListener
+ Request that a previously registered client stop receiving global
+ notifications for all events for which it was registered.
+ """
+ func = self.get_dbus_method("deregisterGlobalEventListenerAll")
+ return func(*args, **kwargs)
- def getContent(self, *args, **kwargs):
+ def getDesktop(self, *args, **kwargs):
"""
- DEPRECATED, use getStream instead. getContent: Retrieve this
- object's content, in a format appropriate to a requested mimetype.
- long Bonobo::Stream:seek (in long offset, in SeekType
- whence)
- raises (NoPermission, IOError)
- void Bonobo::Stream:read (in long count, out iobuf buffer)
- raises (NoPermission, IOError)
-
- @return a Bonobo::Stream whose mimetype matches contentType,
- if available, or NIL.
+ getDesktop:
+ : the index of the requested Desktop.
+ Get the nth accessible desktop.
+ @return a reference to the requested Desktop.
"""
- func = self.get_dbus_method("getContent")
+ func = self.get_dbus_method("getDesktop")
return func(*args, **kwargs)
- def getContentTypes(self, *args, **kwargs):
+ def getDesktopCount(self, *args, **kwargs):
"""
- getContentTypes:
- @return the list of available mimetypes for this object's content.
+ event types: "Window" "Desktop" "Window:Create" "Window:Destroy"
+ "Window:Iconify" "Window:Restore" "Window:Fullscreen" "Window:Resize"
+ "Desktop:Create" "Desktop:Destroy" "Desktop:Focus" "Desktop:Defocus"
+ "Desktop:Reorder" "Focus" "GtkWidget:show" "GObject:notify:<propertyname>"
+ ( not sure we should allow these last 2 forms, since they are
+ toolkit-specific, but they're powerful ) getDesktopCount:
+ Get the current number of desktops.
+ @return a short integer indicating the current number of Desktops.
"""
- func = self.get_dbus_method("getContentTypes")
+ func = self.get_dbus_method("getDesktopCount")
return func(*args, **kwargs)
- def getStream(self, *args, **kwargs):
+ def getDesktopList(self, *args, **kwargs):
"""
- Retrieve this object's content, in a format appropriate to a
- requested mimetype, as a ContentStream instance.
- @param : contentType
- a string specifying the desired mimetype for the content stream.
- @return a Stream whose mimetype matches contentType, if available,
- or NIL.
+ Get a list of accessible desktops.
+ @return : a sequence containing references to the Desktops.
"""
- func = self.get_dbus_method("getStream")
+ func = self.get_dbus_method("getDesktopList")
return func(*args, **kwargs)
- def getURI(self, *args, **kwargs):
+ def getDeviceEventController(self, *args, **kwargs):
"""
- Get a URI pointing to the content of the specified type, if such
- a URI can be obtained. Not all streamable content providers have
- URI representations.
- @param : contentType
- a string specifying the desired mimetype for the content stream.
- If NULL, then a URI for the default content type will be returned,
- if available.
- @return a string which constitutes a URI for a stream of the
- specified content type, or NULL if no such URI can be obtained.
+ Obtain an object which can be used to request device event notifications.
+ @return : an object implementing DeviceEventController
"""
- func = self.get_dbus_method("getURI")
+ func = self.get_dbus_method("getDeviceEventController")
return func(*args, **kwargs)
- def unImplemented(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented")
+ def registerApplication(self, *args, **kwargs):
+ """
+ Register a new application with the accessibility broker.
+ @param : app
+ a reference to the requesting Application
+ """
+ func = self.get_dbus_method("registerApplication")
return func(*args, **kwargs)
- def unImplemented2(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2")
+ def registerGlobalEventListener(self, *args, **kwargs):
+ """
+ Register a client's interest in (all) application events of a
+ certain type.
+ @param : listener
+ a reference to the requesting EventListener.
+ @param : eventName
+ a string which indicates the type of events about which the client
+ desires notification.
+ """
+ func = self.get_dbus_method("registerGlobalEventListener")
return func(*args, **kwargs)
+
-class TEXT_BOUNDARY_TYPE(Enum):
- _enum_lookup = {
- 0:'TEXT_BOUNDARY_CHAR',
- 1:'TEXT_BOUNDARY_WORD_START',
- 2:'TEXT_BOUNDARY_WORD_END',
- 3:'TEXT_BOUNDARY_SENTENCE_START',
- 4:'TEXT_BOUNDARY_SENTENCE_END',
- 5:'TEXT_BOUNDARY_LINE_START',
- 6:'TEXT_BOUNDARY_LINE_END',
- }
-
-
-class TEXT_CLIP_TYPE(Enum):
+class Role(_Enum):
_enum_lookup = {
- 0:'TEXT_CLIP_NONE',
- 1:'TEXT_CLIP_MIN',
- 2:'TEXT_CLIP_MAX',
- 3:'TEXT_CLIP_BOTH',
+ 0:'ROLE_INVALID',
+ 1:'ROLE_ACCELERATOR_LABEL',
+ 2:'ROLE_ALERT',
+ 3:'ROLE_ANIMATION',
+ 4:'ROLE_ARROW',
+ 5:'ROLE_CALENDAR',
+ 6:'ROLE_CANVAS',
+ 7:'ROLE_CHECK_BOX',
+ 8:'ROLE_CHECK_MENU_ITEM',
+ 9:'ROLE_COLOR_CHOOSER',
+ 10:'ROLE_COLUMN_HEADER',
+ 11:'ROLE_COMBO_BOX',
+ 12:'ROLE_DATE_EDITOR',
+ 13:'ROLE_DESKTOP_ICON',
+ 14:'ROLE_DESKTOP_FRAME',
+ 15:'ROLE_DIAL',
+ 16:'ROLE_DIALOG',
+ 17:'ROLE_DIRECTORY_PANE',
+ 18:'ROLE_DRAWING_AREA',
+ 19:'ROLE_FILE_CHOOSER',
+ 20:'ROLE_FILLER',
+ 21:'ROLE_FOCUS_TRAVERSABLE',
+ 22:'ROLE_FONT_CHOOSER',
+ 23:'ROLE_FRAME',
+ 24:'ROLE_GLASS_PANE',
+ 25:'ROLE_HTML_CONTAINER',
+ 26:'ROLE_ICON',
+ 27:'ROLE_IMAGE',
+ 28:'ROLE_INTERNAL_FRAME',
+ 29:'ROLE_LABEL',
+ 30:'ROLE_LAYERED_PANE',
+ 31:'ROLE_LIST',
+ 32:'ROLE_LIST_ITEM',
+ 33:'ROLE_MENU',
+ 34:'ROLE_MENU_BAR',
+ 35:'ROLE_MENU_ITEM',
+ 36:'ROLE_OPTION_PANE',
+ 37:'ROLE_PAGE_TAB',
+ 38:'ROLE_PAGE_TAB_LIST',
+ 39:'ROLE_PANEL',
+ 40:'ROLE_PASSWORD_TEXT',
+ 41:'ROLE_POPUP_MENU',
+ 42:'ROLE_PROGRESS_BAR',
+ 43:'ROLE_PUSH_BUTTON',
+ 44:'ROLE_RADIO_BUTTON',
+ 45:'ROLE_RADIO_MENU_ITEM',
+ 46:'ROLE_ROOT_PANE',
+ 47:'ROLE_ROW_HEADER',
+ 48:'ROLE_SCROLL_BAR',
+ 49:'ROLE_SCROLL_PANE',
+ 50:'ROLE_SEPARATOR',
+ 51:'ROLE_SLIDER',
+ 52:'ROLE_SPIN_BUTTON',
+ 53:'ROLE_SPLIT_PANE',
+ 54:'ROLE_STATUS_BAR',
+ 55:'ROLE_TABLE',
+ 56:'ROLE_TABLE_CELL',
+ 57:'ROLE_TABLE_COLUMN_HEADER',
+ 58:'ROLE_TABLE_ROW_HEADER',
+ 59:'ROLE_TEAROFF_MENU_ITEM',
+ 60:'ROLE_TERMINAL',
+ 61:'ROLE_TEXT',
+ 62:'ROLE_TOGGLE_BUTTON',
+ 63:'ROLE_TOOL_BAR',
+ 64:'ROLE_TOOL_TIP',
+ 65:'ROLE_TREE',
+ 66:'ROLE_TREE_TABLE',
+ 67:'ROLE_UNKNOWN',
+ 68:'ROLE_VIEWPORT',
+ 69:'ROLE_WINDOW',
+ 70:'ROLE_EXTENDED',
+ 71:'ROLE_HEADER',
+ 72:'ROLE_FOOTER',
+ 73:'ROLE_PARAGRAPH',
+ 74:'ROLE_RULER',
+ 75:'ROLE_APPLICATION',
+ 76:'ROLE_AUTOCOMPLETE',
+ 77:'ROLE_EDITBAR',
+ 78:'ROLE_EMBEDDED',
+ 79:'ROLE_ENTRY',
+ 80:'ROLE_CHART',
+ 81:'ROLE_CAPTION',
+ 82:'ROLE_DOCUMENT_FRAME',
+ 83:'ROLE_HEADING',
+ 84:'ROLE_PAGE',
+ 85:'ROLE_SECTION',
+ 86:'ROLE_REDUNDANT_OBJECT',
+ 87:'ROLE_FORM',
+ 88:'ROLE_LINK',
+ 89:'ROLE_INPUT_METHOD_WINDOW',
+ 90:'ROLE_LAST_DEFINED',
}
-
-class Table(BaseProxy):
-
-
+class Selection(_BaseProxy):
"""
- An interface used by containers whose contained data is arranged
- in a "tabular" (i.e. row-column) fashion. Tables may resemble
- a two-dimensional grid, as in a spreadsheet, or may feature objects
- which span multiple rows and/or columns, but whose bounds are
- aligned on a row/column matrix. Thus, the Table interface may
- be used to represent "spreadsheets" as well as "frames".
- Objects within tables are children of the Table instance, and
- they may be referenced either via a child index or via a row/column
- pair. Their role may be ROLE_TABLE_CELL, but table 'cells' may
- have other roles as well. These 'cells' may implement other interfaces,
- such as Text, Action, Image, and Component, and should do so
- as appropriate to their onscreen representation and/or behavior.
+ An interface which indicates that an object exposes a 'selection'
+ model, allowing the selection of one or more of its children.
+ Read-only Selection instances are possible, in which case the
+ interface is used to programmatically determine the selected-ness
+ of its children. A selected child has State::STATE_SELECTED,
+ and a child which may hypothetically be selected (though possibly
+ not programmatically selectable) has State::STATE_SELECTABLE.
"""
+ def clearSelection(self, *args, **kwargs):
+ """
+ Attempt to clear all selections (i.e. deselect all children)
+ of a Selection. Not all Selection implementations allow the removal
+ of all selections.
+ @return True if the selections were successfully cleared, False
+ otherwise.
+ """
+ func = self.get_dbus_method("clearSelection")
+ return func(*args, **kwargs)
- def addColumnSelection(self, *args, **kwargs):
+ def deselectChild(self, *args, **kwargs):
"""
- Select the specified column, adding it to the current column
- selection, if the table's selection model permits it.
- @param : column
- @return True if the specified column was successfully selected,
- False if not.
+ Remove a child from the selected children list of a Selection,
+ if the child is currently selected.
+ @param : childIndex
+ a long integer (the zero offset index into the Accessible object's
+ list of children) indicating which child of the Selection is
+ to be selected.
+ @return True if the child was successfully selected, False otherwise.
"""
- func = self.get_dbus_method("addColumnSelection")
+ func = self.get_dbus_method("deselectChild")
return func(*args, **kwargs)
- def addRowSelection(self, *args, **kwargs):
+ def deselectSelectedChild(self, *args, **kwargs):
"""
- Select the specified row, adding it to the current row selection,
- if the table's selection model permits it.
- @param : row
- @return True if the specified row was successfully selected,
- False if not.
+ Remove a child to the selected children list of a Selection.
+ @param : selectedChildIndex
+ a long integer indicating which of the selected children of the
+ Selection is to be deselected. The index is a zero-offset index
+ into the 'selected child list', not a zero-offset index into
+ the list of all children of the Selection.
+ @return True if the child was successfully deselected, False
+ otherwise.
"""
- func = self.get_dbus_method("addRowSelection")
+ func = self.get_dbus_method("deselectSelectedChild")
return func(*args, **kwargs)
- def getAccessibleAt(self, *args, **kwargs):
+ def getSelectedChild(self, *args, **kwargs):
"""
- Get the table cell at the specified row and column indices.
- @param : row
- the specified table row, zero-indexed.
- @param : column
- the specified table column, zero-indexed.
- @return an Accessible object representing the specified table
- cell.
+ Get the i-th selected Accessible child of a Selection.
+ @param : selectedChildIndex
+ a long integer indicating which of the selected children of an
+ object is being requested.
+ @return a pointer to a selected Accessible child object, specified
+ by selectedChildIndex.
"""
- func = self.get_dbus_method("getAccessibleAt")
+ func = self.get_dbus_method("getSelectedChild")
return func(*args, **kwargs)
- def getColumnAtIndex(self, *args, **kwargs):
+ def isChildSelected(self, *args, **kwargs):
"""
- Get the table column index occupied by the child at a particular
- 1-D child index.
- @param : index
- the specified child index, zero-indexed.
- @return a long integer indicating the first column spanned by
- the child of a table, at the specified 1-D (zero-offset) index.
+ Determine whether a particular child of an Selection implementor
+ is currently selected. Note that childIndex is the zero-offset
+ index into the standard Accessible container's list of children.
+ @param : childIndex
+ an index into the Selection's list of children.
+ @return True if the specified child is currently selected, False
+ otherwise.
"""
- func = self.get_dbus_method("getColumnAtIndex")
+ func = self.get_dbus_method("isChildSelected")
return func(*args, **kwargs)
- def getColumnDescription(self, *args, **kwargs):
+ def selectAll(self, *args, **kwargs):
"""
- Get a text description of a particular table column. This differs
- from AccessibleTable_getColumnHeader, which returns an Accessible.
- @param : column
- the specified table column, zero-indexed.
- @return a UTF-8 string describing the specified table column,
- if available.
+ Attempt to select all of the children of a Selection implementor.
+ Not all Selection implementors support this operation (for instance,
+ implementations which support only "single selection" do not
+ support this operation).
+ @return True if successful, False otherwise.
"""
- func = self.get_dbus_method("getColumnDescription")
+ func = self.get_dbus_method("selectAll")
return func(*args, **kwargs)
- def getColumnExtentAt(self, *args, **kwargs):
+ def selectChild(self, *args, **kwargs):
"""
- Get the number of columns spanned by the table cell at the specific
- row and column. (some tables can have cells which span multiple
- rows and/or columns).
- @param : row
- the specified table row, zero-indexed.
- @param : column
- the specified table column, zero-indexed.
- @return a long integer indicating the number of columns spanned
- by the specified cell.
+ Add a child to the selected children list of a Selection.
+ @param : childIndex
+ a long integer indicating which child of the Selection is to
+ be selected.
+ @return True if the child was successfully selected, False otherwise.
"""
- func = self.get_dbus_method("getColumnExtentAt")
+ func = self.get_dbus_method("selectChild")
return func(*args, **kwargs)
- def getColumnHeader(self, *args, **kwargs):
+ def unImplemented(self, *args, **kwargs):
"""
- Get the header associated with a table column, if available,
- as an instance of Accessible. This differs from getColumnDescription,
- which returns a string.
- @param : column
- the specified table column, zero-indexed.
- @return an Accessible representatin of the specified table column,
- if available.
+ unImplemented:
+ placeholders for future expansion.
"""
- func = self.get_dbus_method("getColumnHeader")
+ func = self.get_dbus_method("unImplemented")
return func(*args, **kwargs)
- def getIndexAt(self, *args, **kwargs):
+ def unImplemented2(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented2")
+ return func(*args, **kwargs)
+
+ def unImplemented3(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented3")
+ return func(*args, **kwargs)
+
+ def get_nSelectedChildren(self):
+ self._pgetter(self._dbus_interface, "nSelectedChildren")
+ def set_nSelectedChildren(self, value):
+ self._psetter(self._dbus_interface, "nSelectedChildren", value)
+ _nSelectedChildrenDoc = \
"""
- Get the 1-D child index corresponding to the specified 2-D row
- and column indices.
- @param : row
- the specified table row, zero-indexed.
- @param : column
- the specified table column, zero-indexed.
- @return a long integer which serves as the index of a specified
- cell in the table, in a form usable by Accessible::getChildAtIndex.
+ The number of children of a Selection implementor which are currently
+ selected.
"""
- func = self.get_dbus_method("getIndexAt")
- return func(*args, **kwargs)
+ nSelectedChildren = property(fget=get_nSelectedChildren, fset=set_nSelectedChildren, doc=_nSelectedChildrenDoc)
+
+
+class Selector(_BaseProxy):
+ """
+ This interface is intended for use by assistive technologies
+ and related user-agents. Via this interface, an assistive technology
+ or user agent may expose a series of choices or selections in
+ textual form, which can be activated on demand by a client of
+ the Selector interface.
+ Examples of the use of this interface include voice-command and
+ remote-control applications, in which the user interaction is
+ wholly or partly delegated by the implementor to an external
+ agent.
+ """
- def getRowAtIndex(self, *args, **kwargs):
+ def activateCommand(self, *args, **kwargs):
"""
- Get the table row index occupied by the child at a particular
- 1-D child index.
- @param : index
- the specified child index, zero-indexed.
- @return a long integer indicating the first row spanned by the
- child of a table, at the specified 1-D (zero-offset) index.
+ Request that the Selector invoke the specified Command.
+ @param : cmd
+ the Command to activate/invoke.
+ @return a CommandResult indicating whether the request was honored,
+ and the reason for failure if the Command could not be activated
+ or invoked.
"""
- func = self.get_dbus_method("getRowAtIndex")
+ func = self.get_dbus_method("activateCommand")
return func(*args, **kwargs)
- def getRowColumnExtentsAtIndex(self, *args, **kwargs):
+ def deregisterChangeListener(self, *args, **kwargs):
"""
- Given a child index, determine the row and column indices and
- extents, and whether the cell is currently selected. If the child
- at index is not a cell (for instance, if it is a summary, caption,
- etc.), False is returned.
- @param : index
- the index of the Table child whose row/column extents are requested.
- @param : row
- back-filled with the first table row associated with the cell
- with child index index.
- @param : col
- back-filled with the first table column associated with the cell
- with child index index.
- @param : row_extents
- back-filled with the number of table rows across which child
- i extends.
- @param : col_extents
- back-filled with the number of table columns across which child
- i extends.
- @param : is_selected
- a boolean which is back-filled with True if the child at index
- i corresponds to a selected table cell, False otherwise.
- Example: If the Table child at index '6' extends across columns
- 5 and 6 of row 2 of a Table instance, and is currently selected,
- then retval=table::getRowColumnExtentsAtIndex(6,row,col,
- row_extents,
- col_extents,
- is_selected);
- will return True, and after the call row, col, row_extents,
- col_extents, and is_selected will contain 2, 5, 1, 2, and True,
- respectively.
- @return True if the index is associated with a valid table cell,
- False if the index does not correspond to a cell. If False is
- returned, the values of the out parameters are undefined.
+ Tell the Selector instance to cease notifying the specified CommandListener
+ of changes to the command list.
+ @param : listener
+ the CommandListener to remove from the notification list.
"""
- func = self.get_dbus_method("getRowColumnExtentsAtIndex")
+ func = self.get_dbus_method("deregisterChangeListener")
return func(*args, **kwargs)
- def getRowDescription(self, *args, **kwargs):
+ def getCommands(self, *args, **kwargs):
"""
- Get a text description of a particular table row. This differs
- from AccessibleTable_getRowHeader, which returns an Accessible.
- @param : row
- the specified table row, zero-indexed.
- @return a UTF-8 string describing the specified table row, if
- available.
+ Query the Selector for the current CommandList.
+ @return the currently available CommandList
"""
- func = self.get_dbus_method("getRowDescription")
+ func = self.get_dbus_method("getCommands")
return func(*args, **kwargs)
- def getRowExtentAt(self, *args, **kwargs):
+ def refreshCommands(self, *args, **kwargs):
"""
- Get the number of rows spanned by the table cell at the specific
- row and column. (some tables can have cells which span multiple
- rows and/or columns).
- @param : row
- the specified table row, zero-indexed.
- @param : column
- the specified table column, zero-indexed.
- @return a long integer indicating the number of rows spanned
- by the specified cell.
+ Ask the Selector to re-calculate its CommandList.
+ @return TRUE if the CommandList changed.
"""
- func = self.get_dbus_method("getRowExtentAt")
+ func = self.get_dbus_method("refreshCommands")
return func(*args, **kwargs)
- def getRowHeader(self, *args, **kwargs):
+ def registerChangeListener(self, *args, **kwargs):
"""
- Get the header associated with a table row, if available. This
- differs from getRowDescription, which returns a string.
- @param : row
- the specified table row, zero-indexed.
- @return an Accessible representatin of the specified table row,
- if available.
+ Register a :CommandListener instance for notification of changes
+ to the command set.
+ @param : listener
+ the CommandListener to be notified of changes.
"""
- func = self.get_dbus_method("getRowHeader")
+ func = self.get_dbus_method("registerChangeListener")
return func(*args, **kwargs)
- def getSelectedColumns(self, *args, **kwargs):
+ def replaceCommands(self, *args, **kwargs):
"""
- Obtain the indices of all columns which are currently selected.
- @return a sequence of integers comprising the indices of columns
- currently selected.
+ @return TRUE if the replacement request was successful, FALSE
+ if the request could not be honored.
"""
- func = self.get_dbus_method("getSelectedColumns")
+ func = self.get_dbus_method("replaceCommands")
return func(*args, **kwargs)
- def getSelectedRows(self, *args, **kwargs):
+ def get_supportsReplace(self):
+ self._pgetter(self._dbus_interface, "supportsReplace")
+ def set_supportsReplace(self, value):
+ self._psetter(self._dbus_interface, "supportsReplace", value)
+ _supportsReplaceDoc = \
"""
- Obtain the indices of all rows which are currently selected.
- @return a sequence of integers comprising the indices of rows
- currently selected.
+ This attribute is TRUE if this Selector allows its CommandList
+ to be specified by the client
"""
- func = self.get_dbus_method("getSelectedRows")
- return func(*args, **kwargs)
+ supportsReplace = property(fget=get_supportsReplace, fset=set_supportsReplace, doc=_supportsReplaceDoc)
+
+ class CommandResult(_Enum):
+ """
+ A code returned by a call to activateCommand, indicating the
+ result of the activation request.
+ """
+ _enum_lookup = {
+ 0:'COMMAND_RESULT_INVALID',
+ 1:'COMMAND_RESULT_SUCCESS',
+ 2:'COMMAND_RESULT_FAILED',
+ 3:'COMMAND_RESULT_OBSOLETE',
+ 4:'COMMAND_RESULT_LAST_DEFINED',
+ }
+
+ COMMAND_RESULT_FAILED = CommandResult(2)
- def isColumnSelected(self, *args, **kwargs):
- """
- Determine whether a table column is selected.
- @param : column
- the column being queried.
- @return True if the specified column is currently selected, False
- if not.
- """
- func = self.get_dbus_method("isColumnSelected")
- return func(*args, **kwargs)
+ COMMAND_RESULT_INVALID = CommandResult(0)
- def isRowSelected(self, *args, **kwargs):
+ COMMAND_RESULT_LAST_DEFINED = CommandResult(4)
+
+ COMMAND_RESULT_OBSOLETE = CommandResult(3)
+
+ COMMAND_RESULT_SUCCESS = CommandResult(1)
+
+class StreamableContent(_BaseProxy):
+ """
+ An interface whereby an object allows its backing content to
+ be streamed to clients. Negotiation of content type is allowed.
+ Clients may examine the backing data and transform, convert,
+ or parse the content in order to present it in an alternate form
+ to end-users.
+ """
+
+ def getContent(self, *args, **kwargs):
"""
- Determine whether a table row is selected.
- @param : row
- the row being queried.
- @return True if the specified row is currently selected, False
- if not.
+ DEPRECATED, use getStream instead. getContent: Retrieve this
+ object's content, in a format appropriate to a requested mimetype.
+ long Bonobo::Stream:seek (in long offset, in SeekType
+ whence)
+ raises (NoPermission, IOError)
+ void Bonobo::Stream:read (in long count, out iobuf buffer)
+ raises (NoPermission, IOError)
+
+ @return a Bonobo::Stream whose mimetype matches contentType,
+ if available, or NIL.
"""
- func = self.get_dbus_method("isRowSelected")
+ func = self.get_dbus_method("getContent")
return func(*args, **kwargs)
- def isSelected(self, *args, **kwargs):
+ def getContentTypes(self, *args, **kwargs):
"""
- Determine whether the cell at a specific row and column is selected.
- @param : row
- a row occupied by the cell whose state is being queried.
- @param : column
- a column occupied by the cell whose state is being queried.
- @return True if the specified cell is currently selected, False
- if not.
+ getContentTypes:
+ @return the list of available mimetypes for this object's content.
"""
- func = self.get_dbus_method("isSelected")
+ func = self.get_dbus_method("getContentTypes")
return func(*args, **kwargs)
- def removeColumnSelection(self, *args, **kwargs):
+ def getStream(self, *args, **kwargs):
"""
- Remove the specified column from current column selection, if
- the table's selection model permits it.
- @param : column
- @return True if the specified column was successfully de-selected,
- False if not.
+ Retrieve this object's content, in a format appropriate to a
+ requested mimetype, as a ContentStream instance.
+ @param : contentType
+ a string specifying the desired mimetype for the content stream.
+ @return a Stream whose mimetype matches contentType, if available,
+ or NIL.
"""
- func = self.get_dbus_method("removeColumnSelection")
+ func = self.get_dbus_method("getStream")
return func(*args, **kwargs)
- def removeRowSelection(self, *args, **kwargs):
+ def getURI(self, *args, **kwargs):
"""
- Remove the specified row from current row selection, if the table's
- selection model permits it.
- @param : row
- @return True if the specified row was successfully de-selected,
- False if not.
+ Get a URI pointing to the content of the specified type, if such
+ a URI can be obtained. Not all streamable content providers have
+ URI representations.
+ @param : contentType
+ a string specifying the desired mimetype for the content stream.
+ If NULL, then a URI for the default content type will be returned,
+ if available.
+ @return a string which constitutes a URI for a stream of the
+ specified content type, or NULL if no such URI can be obtained.
"""
- func = self.get_dbus_method("removeRowSelection")
+ func = self.get_dbus_method("getURI")
return func(*args, **kwargs)
def unImplemented(self, *args, **kwargs):
def unImplemented2(self, *args, **kwargs):
func = self.get_dbus_method("unImplemented2")
return func(*args, **kwargs)
+
+
+class TEXT_BOUNDARY_TYPE(_Enum):
+ _enum_lookup = {
+ 0:'TEXT_BOUNDARY_CHAR',
+ 1:'TEXT_BOUNDARY_WORD_START',
+ 2:'TEXT_BOUNDARY_WORD_END',
+ 3:'TEXT_BOUNDARY_SENTENCE_START',
+ 4:'TEXT_BOUNDARY_SENTENCE_END',
+ 5:'TEXT_BOUNDARY_LINE_START',
+ 6:'TEXT_BOUNDARY_LINE_END',
+ }
+
+class TEXT_CLIP_TYPE(_Enum):
+ _enum_lookup = {
+ 0:'TEXT_CLIP_NONE',
+ 1:'TEXT_CLIP_MIN',
+ 2:'TEXT_CLIP_MAX',
+ 3:'TEXT_CLIP_BOTH',
+ }
+
+class Table(_BaseProxy):
+ """
+ An interface used by containers whose contained data is arranged
+ in a "tabular" (i.e. row-column) fashion. Tables may resemble
+ a two-dimensional grid, as in a spreadsheet, or may feature objects
+ which span multiple rows and/or columns, but whose bounds are
+ aligned on a row/column matrix. Thus, the Table interface may
+ be used to represent "spreadsheets" as well as "frames".
+ Objects within tables are children of the Table instance, and
+ they may be referenced either via a child index or via a row/column
+ pair. Their role may be ROLE_TABLE_CELL, but table 'cells' may
+ have other roles as well. These 'cells' may implement other interfaces,
+ such as Text, Action, Image, and Component, and should do so
+ as appropriate to their onscreen representation and/or behavior.
+ """
- def unImplemented3(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented3")
- return func(*args, **kwargs)
-
- def unImplemented4(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented4")
- return func(*args, **kwargs)
-
- def unImplemented5(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented5")
- return func(*args, **kwargs)
-
- def unImplemented6(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented6")
- return func(*args, **kwargs)
-
- def unImplemented7(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented7")
- return func(*args, **kwargs)
-
- def get_caption(self):
- self._pgetter(self._dbus_interface, "caption")
- def set_caption(self, value):
- self._psetter(self._dbus_interface, "caption", value)
- _captionDoc = \
- """
- An Accessible which represents of a caption for a Table.
- """
- caption = property(fget=get_caption, fset=set_caption, doc=_captionDoc)
-
- def get_nColumns(self):
- self._pgetter(self._dbus_interface, "nColumns")
- def set_nColumns(self, value):
- self._psetter(self._dbus_interface, "nColumns", value)
- _nColumnsDoc = \
- """
- The total number of columns in this table (including empty columns),
- exclusive of columns which are programmatically hidden. Columns
- which are scrolled out of view or clipped by the current viewport
- are included.
- """
- nColumns = property(fget=get_nColumns, fset=set_nColumns, doc=_nColumnsDoc)
-
- def get_nRows(self):
- self._pgetter(self._dbus_interface, "nRows")
- def set_nRows(self, value):
- self._psetter(self._dbus_interface, "nRows", value)
- _nRowsDoc = \
+ def addColumnSelection(self, *args, **kwargs):
"""
- The total number of rows in this table (including empty rows),
- exclusive of any rows which are programmatically hidden. Rows
- which are merely scrolled out of view are included.
+ Select the specified column, adding it to the current column
+ selection, if the table's selection model permits it.
+ @param : column
+ @return True if the specified column was successfully selected,
+ False if not.
"""
- nRows = property(fget=get_nRows, fset=set_nRows, doc=_nRowsDoc)
+ func = self.get_dbus_method("addColumnSelection")
+ return func(*args, **kwargs)
- def get_nSelectedColumns(self):
- self._pgetter(self._dbus_interface, "nSelectedColumns")
- def set_nSelectedColumns(self, value):
- self._psetter(self._dbus_interface, "nSelectedColumns", value)
- _nSelectedColumnsDoc = \
+ def addRowSelection(self, *args, **kwargs):
"""
- The number of columns currently selected. A selected column is
- one in which all included cells are selected.
+ Select the specified row, adding it to the current row selection,
+ if the table's selection model permits it.
+ @param : row
+ @return True if the specified row was successfully selected,
+ False if not.
"""
- nSelectedColumns = property(fget=get_nSelectedColumns, fset=set_nSelectedColumns, doc=_nSelectedColumnsDoc)
+ func = self.get_dbus_method("addRowSelection")
+ return func(*args, **kwargs)
- def get_nSelectedRows(self):
- self._pgetter(self._dbus_interface, "nSelectedRows")
- def set_nSelectedRows(self, value):
- self._psetter(self._dbus_interface, "nSelectedRows", value)
- _nSelectedRowsDoc = \
+ def getAccessibleAt(self, *args, **kwargs):
"""
- The number of rows currently selected. A selected row is one
- in which all included cells are selected.
+ Get the table cell at the specified row and column indices.
+ @param : row
+ the specified table row, zero-indexed.
+ @param : column
+ the specified table column, zero-indexed.
+ @return an Accessible object representing the specified table
+ cell.
"""
- nSelectedRows = property(fget=get_nSelectedRows, fset=set_nSelectedRows, doc=_nSelectedRowsDoc)
+ func = self.get_dbus_method("getAccessibleAt")
+ return func(*args, **kwargs)
- def get_summary(self):
- self._pgetter(self._dbus_interface, "summary")
- def set_summary(self, value):
- self._psetter(self._dbus_interface, "summary", value)
- _summaryDoc = \
- """
- An accessible object which summarizes the contents of a Table.
- This object is frequently itself a Table instance, albeit a simplified
- one.
+ def getColumnAtIndex(self, *args, **kwargs):
"""
- summary = property(fget=get_summary, fset=set_summary, doc=_summaryDoc)
-
-
-class Text(BaseProxy):
-
-
- """
- The text interface should be implemented by objects which place
- textual information onscreen as character strings or glyphs.
- The text interface allows access to textual content, including
- display attributes and semantic hints associated with runs of
- text, and access to bounding box information for glyphs and substrings.
- It also allows portions of textual content to be selected, if
- the object's StateSet includes STATE_SELECTABLE_TEXT.
- In some cases a Text object may have, as its content, an empty
- string. In particular this can occur in the case of Hypertext
- objects which do not display explicitly textual information onscreen,
- as Hypertext is derived from the Text interface.
- Typographic and semantic attributes of onscreen textual content,
- for instance typeface, weight, language, and such qualities as
- 'emphasis' or 'blockquote', are represented as text attributes.
- Contiguous sequences of characters over which these attributes
- are unchanged are referred to as "attribute runs", and are available
- via Text::getAttributeRun. Where possible, implementing clients
- will report textual attributes which are the same over the entire
- text object, for instance those inherited from a default or document-scope
- style, via getDefaultAttributes instead of reporting them explicitly
- for each character. Therefore, for any span of text, the attributes
- in effect are the union of the set returned by Text::getDefaultAttributes,
- and the set returned at a particular character offset via Text::getAttributeRun.
- """
+ Get the table column index occupied by the child at a particular
+ 1-D child index.
+ @param : index
+ the specified child index, zero-indexed.
+ @return a long integer indicating the first column spanned by
+ the child of a table, at the specified 1-D (zero-offset) index.
+ """
+ func = self.get_dbus_method("getColumnAtIndex")
+ return func(*args, **kwargs)
+ def getColumnDescription(self, *args, **kwargs):
+ """
+ Get a text description of a particular table column. This differs
+ from AccessibleTable_getColumnHeader, which returns an Accessible.
+ @param : column
+ the specified table column, zero-indexed.
+ @return a UTF-8 string describing the specified table column,
+ if available.
+ """
+ func = self.get_dbus_method("getColumnDescription")
+ return func(*args, **kwargs)
- def addSelection(self, *args, **kwargs):
+ def getColumnExtentAt(self, *args, **kwargs):
"""
- The result of calling addSelection on objects which already have
- one selection present, and which do not include STATE_MULTISELECTABLE,
- is undefined, other than the return value.
- @return True of the selection was successfully added, False otherwise.
- Selection may fail if the object does not support selection of
- text (see STATE_SELECTABLE_TEXT), if the object does not support
- multiple selections and a selection is already defined, or for
- other reasons (for instance if the user does not have permission
- to copy the text into the relevant selection buffer).
+ Get the number of columns spanned by the table cell at the specific
+ row and column. (some tables can have cells which span multiple
+ rows and/or columns).
+ @param : row
+ the specified table row, zero-indexed.
+ @param : column
+ the specified table column, zero-indexed.
+ @return a long integer indicating the number of columns spanned
+ by the specified cell.
"""
- func = self.get_dbus_method("addSelection")
+ func = self.get_dbus_method("getColumnExtentAt")
return func(*args, **kwargs)
- def getAttributeRun(self, *args, **kwargs):
+ def getColumnHeader(self, *args, **kwargs):
"""
- Query a particular text object for the text attributes defined
- at a given offset, obtaining the start and end of the "attribute
- run" over which these attributes are currently invariant. Text
- attributes are those presentational, typographic, or semantic
- attributes or qualitites which apply to a range of text specifyable
- by starting and ending offsets. Attributes relevant to localization
- should be provided in accordance with the w3c "Internationalization
- and Localization Markup Requirements", http://www.w3.org/TR/2005/WD-itsreq-20051122/
- Other text attributes should choose their names and value semantics
- in accordance with relevant standards such as CSS level 2 (http://www.w3.org/TR/1998/REC-CSS2-19980512),
- XHTML 1.0 (http://www.w3.org/TR/2002/REC-xhtml1-20020801), and
- WICD (http://www.w3.org/TR/2005/WD-WICD-20051121/). Those attributes
- from the aforementioned specifications and recommendations which
- do not concern typographic, presentational, or semantic aspects
- of text should be exposed via the more general Accessible::getAttributes()
- API (if at all).
- For example, CSS attributes which should be exposed on text (either
- as default attributes, or as explicitly-set attributes when non-default
- values are specified in the content view) include the Font attributes
- (i.e. "css2:font-weight", "css2:font-style"), the "css2:color"
- and "css2:background-color" attributes, and "css2:text-decoration"
- attribute.
- If includeDefaults is TRUE, then this AttributeSet should include
- the default attributes as well as those which are explicitly
- assigned to the attribute run in question. startOffset and endOffset
- will be back-filled to indicate the start and end of the attribute
- run which contains 'offset' - an attribute run is a contiguous
- section of text whose attributes are homogeneous.
- @param : offset
- the offset of the character whose attributes will be reported.
- @param : startOffset
- backfilled with the starting offset of the character range over
- which all text attributes match those of offset, i.e. the start
- of the homogeneous attribute run including offset.
- @param : endOffset
- backfilled with the offset of the first character past the character
- range over which all text attributes match those of offset, i.e.
- the character immediately after the homogeneous attribute run
- including offset.
- @param : includeDefaults
- if False, the call should only return those attributes which
- are explicitly set on the current attribute run, omitting any
- attributes which are inherited from the default values. See also
- Text::getDefaultAttributes.
- @return the AttributeSet defined at offset, optionally including
- the 'default' attributes.
+ Get the header associated with a table column, if available,
+ as an instance of Accessible. This differs from getColumnDescription,
+ which returns a string.
+ @param : column
+ the specified table column, zero-indexed.
+ @return an Accessible representatin of the specified table column,
+ if available.
"""
- func = self.get_dbus_method("getAttributeRun")
+ func = self.get_dbus_method("getColumnHeader")
return func(*args, **kwargs)
- def getAttributeValue(self, *args, **kwargs):
+ def getIndexAt(self, *args, **kwargs):
"""
- Get the string value of a named attribute at a given offset,
- if defined.
- @param : offset
- the offset of the character for which the attribute run is to
- be obtained.
- @param : attributeName
- the name of the attribute for which the value is to be returned,
- if defined.
- @param : startOffset
- back-filled with the offset of the first character in the attribute
- run containing the character at offset.
- @param : endOffset
- back-filled with the offset of the first character past the end
- of the attribute run containing the character at offset.
- @param : defined
- back-filled with True if the attributeName has a defined value
- at offset, False otherwise.
- @return the value of attribute (name-value pair) corresponding
- to "name", if defined.
+ Get the 1-D child index corresponding to the specified 2-D row
+ and column indices.
+ @param : row
+ the specified table row, zero-indexed.
+ @param : column
+ the specified table column, zero-indexed.
+ @return a long integer which serves as the index of a specified
+ cell in the table, in a form usable by Accessible::getChildAtIndex.
"""
- func = self.get_dbus_method("getAttributeValue")
+ func = self.get_dbus_method("getIndexAt")
return func(*args, **kwargs)
- def getAttributes(self, *args, **kwargs):
+ def getRowAtIndex(self, *args, **kwargs):
"""
- getAttributes is deprecated in favor of getAttributeRun.
- @return the attributes at offset, as a semicolon-delimited set
- of colon-delimited name-value pairs.
+ Get the table row index occupied by the child at a particular
+ 1-D child index.
+ @param : index
+ the specified child index, zero-indexed.
+ @return a long integer indicating the first row spanned by the
+ child of a table, at the specified 1-D (zero-offset) index.
"""
- func = self.get_dbus_method("getAttributes")
+ func = self.get_dbus_method("getRowAtIndex")
return func(*args, **kwargs)
- def getBoundedRanges(self, *args, **kwargs):
+ def getRowColumnExtentsAtIndex(self, *args, **kwargs):
"""
- Return the text content within a bounding box, as a list of Range
- structures. Depending on the TEXT_CLIP_TYPE parameters, glyphs
- which are clipped by the bounding box (i.e. which lie partially
- inside and partially outside it) may or may not be included in
- the ranges returned.
- @param : x
- the minimum x ( i.e. leftmost) coordinate of the bounding box.
- @param : y
- the minimum y coordinate of the bounding box.
- @param : width
- the horizontal size of the bounding box. The rightmost bound
- of the bounding box is (x + width);
- @param : height
- the vertical size of the bounding box. The maximum y value of
- the bounding box is (y + height);
- @param : coordType
- If 0, the above coordinates are interpreted as pixels relative
- to corner of the screen; if 1, the coordinates are interpreted
- as pixels relative to the corner of the containing toplevel window.
- @param : xClipType
- determines whether text which intersects the bounding box in
- the x direction is included.
- @param : yClipType
- determines whether text which intersects the bounding box in
- the y direction is included.
+ Given a child index, determine the row and column indices and
+ extents, and whether the cell is currently selected. If the child
+ at index is not a cell (for instance, if it is a summary, caption,
+ etc.), False is returned.
+ @param : index
+ the index of the Table child whose row/column extents are requested.
+ @param : row
+ back-filled with the first table row associated with the cell
+ with child index index.
+ @param : col
+ back-filled with the first table column associated with the cell
+ with child index index.
+ @param : row_extents
+ back-filled with the number of table rows across which child
+ i extends.
+ @param : col_extents
+ back-filled with the number of table columns across which child
+ i extends.
+ @param : is_selected
+ a boolean which is back-filled with True if the child at index
+ i corresponds to a selected table cell, False otherwise.
+ Example: If the Table child at index '6' extends across columns
+ 5 and 6 of row 2 of a Table instance, and is currently selected,
+ then retval=table::getRowColumnExtentsAtIndex(6,row,col,
+ row_extents,
+ col_extents,
+ is_selected);
+ will return True, and after the call row, col, row_extents,
+ col_extents, and is_selected will contain 2, 5, 1, 2, and True,
+ respectively.
+ @return True if the index is associated with a valid table cell,
+ False if the index does not correspond to a cell. If False is
+ returned, the values of the out parameters are undefined.
"""
- func = self.get_dbus_method("getBoundedRanges")
+ func = self.get_dbus_method("getRowColumnExtentsAtIndex")
return func(*args, **kwargs)
- def getCharacterAtOffset(self, *args, **kwargs):
+ def getRowDescription(self, *args, **kwargs):
"""
- @return an unsigned long integer whose value corresponds to the
- UCS-4 representation of the character at the specified text offset,
- or 0 if offset is out of range.
+ Get a text description of a particular table row. This differs
+ from AccessibleTable_getRowHeader, which returns an Accessible.
+ @param : row
+ the specified table row, zero-indexed.
+ @return a UTF-8 string describing the specified table row, if
+ available.
"""
- func = self.get_dbus_method("getCharacterAtOffset")
+ func = self.get_dbus_method("getRowDescription")
return func(*args, **kwargs)
- def getCharacterExtents(self, *args, **kwargs):
+ def getRowExtentAt(self, *args, **kwargs):
"""
- Obtain a the bounding box, as x, y, width, and height, of the
- character or glyph at a particular character offset in this object's
- text content. The coordinate system in which the results are
- reported is specified by coordType. If an onscreen glyph corresponds
- to multiple character offsets, for instance if the glyph is a
- ligature, the bounding box reported will include the entire glyph
- and therefore may apply to more than one character offset.
- @param : offset
- the character offset of the character or glyph being queried.
- @param : x
- the minimum horizontal coordinate of the bounding box of the
- glyph representing the character at offset.
- @param : y
- the minimum vertical coordinate of the bounding box of the glyph
- representing the character at offset.
- @param : width
- the horizontal extent of the bounding box of the glyph representing
- the character at offset.
- @param : height
- the vertical extent of the bounding box of the glyph representing
- the character at offset.
- @param : coordType
- If 0, the results will be reported in screen coordinates, i.e.
- in pixels relative to the upper-left corner of the screen, with
- the x axis pointing right and the y axis pointing down. If 1,
- the results will be reported relative to the containing toplevel
- window, with the x axis pointing right and the y axis pointing
- down.
+ Get the number of rows spanned by the table cell at the specific
+ row and column. (some tables can have cells which span multiple
+ rows and/or columns).
+ @param : row
+ the specified table row, zero-indexed.
+ @param : column
+ the specified table column, zero-indexed.
+ @return a long integer indicating the number of rows spanned
+ by the specified cell.
"""
- func = self.get_dbus_method("getCharacterExtents")
+ func = self.get_dbus_method("getRowExtentAt")
return func(*args, **kwargs)
- def getDefaultAttributeSet(self, *args, **kwargs):
+ def getRowHeader(self, *args, **kwargs):
"""
- Return an AttributeSet containing the text attributes which apply
- to all text in the object by virtue of the default settings of
- the document, view, or user agent; e.g. those attributes which
- are implied rather than explicitly applied to the text object.
- For instance, an object whose entire text content has been explicitly
- marked as 'bold' will report the 'bold' attribute via getAttributeRun(),
- whereas an object whose text weight is inspecified may report
- the default or implied text weight in the default AttributeSet.
+ Get the header associated with a table row, if available. This
+ differs from getRowDescription, which returns a string.
+ @param : row
+ the specified table row, zero-indexed.
+ @return an Accessible representatin of the specified table row,
+ if available.
"""
- func = self.get_dbus_method("getDefaultAttributeSet")
+ func = self.get_dbus_method("getRowHeader")
return func(*args, **kwargs)
- def getDefaultAttributes(self, *args, **kwargs):
+ def getSelectedColumns(self, *args, **kwargs):
"""
- Deprecated in favor of getDefaultAttributeSet.
- @return the attributes which apply to the entire text content,
- but which were not explicitly specified by the content creator.
+ Obtain the indices of all columns which are currently selected.
+ @return a sequence of integers comprising the indices of columns
+ currently selected.
"""
- func = self.get_dbus_method("getDefaultAttributes")
+ func = self.get_dbus_method("getSelectedColumns")
return func(*args, **kwargs)
- def getNSelections(self, *args, **kwargs):
+ def getSelectedRows(self, *args, **kwargs):
"""
- Obtain the number of separate, contiguous selections in the current
- Text object. Text objects which do not implement selection of
- discontiguous text regions will always return '0' or '1'. Note
- that "contiguous" is defined by continuity of the offsets, i.e.
- a text 'selection' is defined by a start/end offset pair. In
- the case of bidirectional text, this means that a continguous
- selection may appear visually discontiguous, and vice-versa.
- @return the number of contiguous selections in the current Text
- object.
+ Obtain the indices of all rows which are currently selected.
+ @return a sequence of integers comprising the indices of rows
+ currently selected.
"""
- func = self.get_dbus_method("getNSelections")
+ func = self.get_dbus_method("getSelectedRows")
return func(*args, **kwargs)
- def getOffsetAtPoint(self, *args, **kwargs):
+ def isColumnSelected(self, *args, **kwargs):
"""
- Get the offset of the character at a given onscreen coordinate.
- The coordinate system used to interpret x and y is determined
- by parameter coordType.
- @param : x
- @param : y
- @param : coordType
- if 0, the input coordinates are interpreted relative to the entire
- screen, if 1, they are relative to the toplevel window containing
- this Text object.
- @return the text offset (as an offset into the character array)
- of the glyph whose onscreen bounds contain the point x,y, or
- -1 if the point is outside the bounds of any glyph.
+ Determine whether a table column is selected.
+ @param : column
+ the column being queried.
+ @return True if the specified column is currently selected, False
+ if not.
"""
- func = self.get_dbus_method("getOffsetAtPoint")
+ func = self.get_dbus_method("isColumnSelected")
return func(*args, **kwargs)
- def getRangeExtents(self, *args, **kwargs):
+ def isRowSelected(self, *args, **kwargs):
"""
- Obtain the bounding box which entirely contains a given text
- range. Negative values may be returned for the bounding box parameters
- in the event that all or part of the text range is offscreen
- or not mapped to the screen.
- @param : startOffset
- the offset of the first character in the specified range.
- @param : endOffset
- the offset of the character immediately after the last character
- in the specified range.
- @param : x
- an integer parameter which is back-filled with the minimum horizontal
- coordinate of the resulting bounding box.
- @param : y
- an integer parameter which is back-filled with the minimum vertical
- coordinate of the resulting bounding box.
- @param : width
- an integer parameter which is back-filled with the horizontal
- extent of the bounding box.
- @param : height
- an integer parameter which is back-filled with the vertical extent
- of the bounding box.
- @param : coordType
- If 0, the above coordinates are reported in pixels relative to
- corner of the screen; if 1, the coordinates are reported relative
- to the corner of the containing toplevel window.
+ Determine whether a table row is selected.
+ @param : row
+ the row being queried.
+ @return True if the specified row is currently selected, False
+ if not.
"""
- func = self.get_dbus_method("getRangeExtents")
+ func = self.get_dbus_method("isRowSelected")
return func(*args, **kwargs)
- def getSelection(self, *args, **kwargs):
+ def isSelected(self, *args, **kwargs):
"""
- The result of calling getSelection with an out-of-range selectionNum
- (i.e. for a selection which does not exist) is not strictly defined,
- but should set endOffset equal to startOffset.
+ Determine whether the cell at a specific row and column is selected.
+ @param : row
+ a row occupied by the cell whose state is being queried.
+ @param : column
+ a column occupied by the cell whose state is being queried.
+ @return True if the specified cell is currently selected, False
+ if not.
"""
- func = self.get_dbus_method("getSelection")
+ func = self.get_dbus_method("isSelected")
return func(*args, **kwargs)
- def getText(self, *args, **kwargs):
+ def removeColumnSelection(self, *args, **kwargs):
"""
- Obtain all or part of the onscreen textual content of a Text
- object. If endOffset is specified as "-1", then this method will
- return the entire onscreen textual contents of the Text object.
- @return the textual content of the current Text object beginning
- startOffset (inclusive) up to but not including the character
- at endOffset.
+ Remove the specified column from current column selection, if
+ the table's selection model permits it.
+ @param : column
+ @return True if the specified column was successfully de-selected,
+ False if not.
"""
- func = self.get_dbus_method("getText")
+ func = self.get_dbus_method("removeColumnSelection")
return func(*args, **kwargs)
- def getTextAfterOffset(self, *args, **kwargs):
+ def removeRowSelection(self, *args, **kwargs):
"""
- Obtain a subset of the text content of an object which entirely
- follows offset, delimited by character, word, line, or sentence
- boundaries as specified by type. The starting and ending offsets
- of the resulting substring are returned in startOffset and endOffset.
- By definition, if such a substring exists, startOffset must be
- greater than offset.
- @param : offset
- the offset from which the substring search begins, and which
- must lie before the returned substring.
- @param : type
- the text-boundary delimiter which determines whether the returned
- text constitures a character, word, line, or sentence (and possibly
- attendant whitespace), and whether the start or ending of such
- a substring forms the boundary condition.
- @param : startOffset
- back-filled with the starting offset of the resulting substring,
- if one exists.
- @param : endOffset
- back-filled with the offset of the character immediately following
- the resulting substring, if one exists.
- @return a string which is a substring of the text content of
- the object, delimited by the specified boundary condition.
+ Remove the specified row from current row selection, if the table's
+ selection model permits it.
+ @param : row
+ @return True if the specified row was successfully de-selected,
+ False if not.
"""
- func = self.get_dbus_method("getTextAfterOffset")
+ func = self.get_dbus_method("removeRowSelection")
return func(*args, **kwargs)
- def getTextAtOffset(self, *args, **kwargs):
- """
- Obtain a subset of the text content of an object which includes
- the specified offset, delimited by character, word, line, or
- sentence boundaries as specified by type. The starting and ending
- offsets of the resulting substring are returned in startOffset
- and endOffset.
- @param : offset
- the offset from which the substring search begins, and which
- must lie within the returned substring.
- @param : type
- the text-boundary delimiter which determines whether the returned
- text constitures a character, word, line, or sentence (and possibly
- attendant whitespace), and whether the start or ending of such
- a substring forms the boundary condition.
- @param : startOffset
- back-filled with the starting offset of the resulting substring,
- if one exists.
- @param : endOffset
- back-filled with the offset of the character immediately following
- the resulting substring, if one exists.
- @return a string which is a substring of the text content of
- the object, delimited by the specified boundary condition.
- """
- func = self.get_dbus_method("getTextAtOffset")
+ def unImplemented(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented")
return func(*args, **kwargs)
- def getTextBeforeOffset(self, *args, **kwargs):
- """
- Obtain a subset of the text content of an object which entirely
- precedes offset, delimited by character, word, line, or sentence
- boundaries as specified by type. The starting and ending offsets
- of the resulting substring are returned in startOffset and endOffset.
- By definition, if such a substring exists, endOffset is less
- than or equal to offset.
- @param : offset
- the offset from which the substring search begins.
- @param : type
- the text-boundary delimiter which determines whether the returned
- text constitures a character, word, line, or sentence (and possibly
- attendant whitespace), and whether the start or ending of such
- a substring forms the boundary condition.
- @param : startOffset
- back-filled with the starting offset of the resulting substring,
- if one exists.
- @param : endOffset
- back-filled with the offset of the character immediately following
- the resulting substring, if one exists.
- @return a string which is a substring of the text content of
- the object, delimited by the specified boundary condition.
- """
- func = self.get_dbus_method("getTextBeforeOffset")
+ def unImplemented2(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented2")
return func(*args, **kwargs)
- def removeSelection(self, *args, **kwargs):
- """
- Deselect the text contained in the specified selectionNum, if
- such a selection exists, otherwise do nothing. Removal of a non-existant
- selectionNum has no effect.
- @return True if the selection was successfully removed, False
- otherwise.
- """
- func = self.get_dbus_method("removeSelection")
+ def unImplemented3(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented3")
return func(*args, **kwargs)
- def setCaretOffset(self, *args, **kwargs):
- """
- Programmatically move the text caret (visible or virtual, as
- above) to a given position.
- @param : offset
- a long int indicating the desired character offset. Not all implementations
- of Text will honor setCaretOffset requests, so the return value
- below should be checked by the client.
- @return TRUE if the request was carried out, or FALSE if the
- caret could not be moved to the requested position.
- """
- func = self.get_dbus_method("setCaretOffset")
+ def unImplemented4(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented4")
return func(*args, **kwargs)
- def setSelection(self, *args, **kwargs):
- """
- Modify an existing selection's start or ending offset.
- Calling setSelection for a selectionNum that is not already defined
- has no effect. The result of calling setSelection with a selectionNum
- greater than 0 for objects that do not include STATE_MULTISELECTABLE
- is undefined.
- @param : selectionNum
- indicates which of a set of non-contiguous selections to modify.
- @param : startOffset
- the new starting offset for the selection
- @param : endOffset
- the new ending offset for the selection
- @return True if the selection corresponding to selectionNum is
- successfully modified, False otherwise.
- """
- func = self.get_dbus_method("setSelection")
+ def unImplemented5(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented5")
return func(*args, **kwargs)
- def unImplemented(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented")
+ def unImplemented6(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented6")
return func(*args, **kwargs)
- def unImplemented2(self, *args, **kwargs):
- func = self.get_dbus_method("unImplemented2")
+ def unImplemented7(self, *args, **kwargs):
+ func = self.get_dbus_method("unImplemented7")
return func(*args, **kwargs)
- def get_caretOffset(self):
- self._pgetter(self._dbus_interface, "caretOffset")
- def set_caretOffset(self, value):
- self._psetter(self._dbus_interface, "caretOffset", value)
- _caretOffsetDoc = \
+ def get_caption(self):
+ self._pgetter(self._dbus_interface, "caption")
+ def set_caption(self, value):
+ self._psetter(self._dbus_interface, "caption", value)
+ _captionDoc = \
"""
- The current offset of the text caret in the Text object. This
- caret may be virtual, e.g. non-visual and notional-only, but
- if an onscreen representation of the caret position is visible,
- it will correspond to this offset. The caret offset is given
- as a character offset, as opposed to a byte offset into a text
- buffer or a column offset.
+ An Accessible which represents of a caption for a Table.
"""
- caretOffset = property(fget=get_caretOffset, fset=set_caretOffset, doc=_caretOffsetDoc)
+ caption = property(fget=get_caption, fset=set_caption, doc=_captionDoc)
- def get_characterCount(self):
- self._pgetter(self._dbus_interface, "characterCount")
- def set_characterCount(self, value):
- self._psetter(self._dbus_interface, "characterCount", value)
- _characterCountDoc = \
+ def get_nColumns(self):
+ self._pgetter(self._dbus_interface, "nColumns")
+ def set_nColumns(self, value):
+ self._psetter(self._dbus_interface, "nColumns", value)
+ _nColumnsDoc = \
"""
- The total current number of characters in the Text object, including
- whitespace and non-spacing characters.
+ The total number of columns in this table (including empty columns),
+ exclusive of columns which are programmatically hidden. Columns
+ which are scrolled out of view or clipped by the current viewport
+ are included.
"""
- characterCount = property(fget=get_characterCount, fset=set_characterCount, doc=_characterCountDoc)
+ nColumns = property(fget=get_nColumns, fset=set_nColumns, doc=_nColumnsDoc)
- class Range(list):
- def __new__(cls, startOffset, endOffset, content, data):
- list.__new__(cls, (startOffset, endOffset, content, data)
- def __init__(self, startOffset, endOffset, content, data):
- list.__init__(self, (startOffset, endOffset, content, data))
-
- startOffset = property(fget=_get_startOffset, fset=_set_startOffset)
- def _get_startOffset(self):
- return self[0]
- def _set_startOffset(self, val):
- self[0] = val
- endOffset = property(fget=_get_endOffset, fset=_set_endOffset)
- def _get_endOffset(self):
- return self[1]
- def _set_endOffset(self, val):
- self[1] = val
- content = property(fget=_get_content, fset=_set_content)
- def _get_content(self):
- return self[2]
- def _set_content(self, val):
- self[2] = val
- data = property(fget=_get_data, fset=_set_data)
- def _get_data(self):
- return self[3]
- def _set_data(self, val):
- self[3] = val
-
-
-class Value(BaseProxy):
+ def get_nRows(self):
+ self._pgetter(self._dbus_interface, "nRows")
+ def set_nRows(self, value):
+ self._psetter(self._dbus_interface, "nRows", value)
+ _nRowsDoc = \
+ """
+ The total number of rows in this table (including empty rows),
+ exclusive of any rows which are programmatically hidden. Rows
+ which are merely scrolled out of view are included.
+ """
+ nRows = property(fget=get_nRows, fset=set_nRows, doc=_nRowsDoc)
+
+ def get_nSelectedColumns(self):
+ self._pgetter(self._dbus_interface, "nSelectedColumns")
+ def set_nSelectedColumns(self, value):
+ self._psetter(self._dbus_interface, "nSelectedColumns", value)
+ _nSelectedColumnsDoc = \
+ """
+ The number of columns currently selected. A selected column is
+ one in which all included cells are selected.
+ """
+ nSelectedColumns = property(fget=get_nSelectedColumns, fset=set_nSelectedColumns, doc=_nSelectedColumnsDoc)
+ def get_nSelectedRows(self):
+ self._pgetter(self._dbus_interface, "nSelectedRows")
+ def set_nSelectedRows(self, value):
+ self._psetter(self._dbus_interface, "nSelectedRows", value)
+ _nSelectedRowsDoc = \
+ """
+ The number of rows currently selected. A selected row is one
+ in which all included cells are selected.
+ """
+ nSelectedRows = property(fget=get_nSelectedRows, fset=set_nSelectedRows, doc=_nSelectedRowsDoc)
+ def get_summary(self):
+ self._pgetter(self._dbus_interface, "summary")
+ def set_summary(self, value):
+ self._psetter(self._dbus_interface, "summary", value)
+ _summaryDoc = \
+ """
+ An accessible object which summarizes the contents of a Table.
+ This object is frequently itself a Table instance, albeit a simplified
+ one.
+ """
+ summary = property(fget=get_summary, fset=set_summary, doc=_summaryDoc)
+
+
+
+class Value(_BaseProxy):
"""
An interface supporting controls which allow a one-dimensional,
scalar quantity to be modified or which reflect a scalar quantity.
"read only".
"""
-
def unImplemented(self, *args, **kwargs):
func = self.get_dbus_method("unImplemented")
return func(*args, **kwargs)
"""
minimumValue = property(fget=get_minimumValue, fset=set_minimumValue, doc=_minimumValueDoc)
+BUTTON_PRESSED_EVENT = EventType(2)
+
+BUTTON_RELEASED_EVENT = EventType(3)
+
+KEY_PRESS = KeySynthType(0)
+
+KEY_PRESSED = KeyEventType(0)
+
+KEY_PRESSED_EVENT = EventType(0)
+
+KEY_PRESSRELEASE = KeySynthType(2)
+
+KEY_RELEASE = KeySynthType(1)
+
+KEY_RELEASED = KeyEventType(1)
+
+KEY_RELEASED_EVENT = EventType(1)
+
+KEY_STRING = KeySynthType(4)
+
+KEY_SYM = KeySynthType(3)
+
+LAYER_BACKGROUND = ComponentLayer(1)
+
+LAYER_CANVAS = ComponentLayer(2)
+
+LAYER_INVALID = ComponentLayer(0)
+
+LAYER_LAST_DEFINED = ComponentLayer(8)
+
+LAYER_MDI = ComponentLayer(4)
+
+LAYER_OVERLAY = ComponentLayer(6)
+
+LAYER_POPUP = ComponentLayer(5)
+
+LAYER_WIDGET = ComponentLayer(3)
+
+LAYER_WINDOW = ComponentLayer(7)
+
+LOCALE_TYPE_COLLATE = LOCALE_TYPE(1)
+
+LOCALE_TYPE_CTYPE = LOCALE_TYPE(2)
+
+LOCALE_TYPE_MESSAGES = LOCALE_TYPE(0)
+
+LOCALE_TYPE_MONETARY = LOCALE_TYPE(3)
+
+LOCALE_TYPE_NUMERIC = LOCALE_TYPE(4)
+
+LOCALE_TYPE_TIME = LOCALE_TYPE(5)
+
+MODIFIER_ALT = ModifierType(3)
+
+MODIFIER_CONTROL = ModifierType(2)
+
+MODIFIER_META = ModifierType(4)
+
+MODIFIER_META2 = ModifierType(5)
+
+MODIFIER_META3 = ModifierType(6)
+
+MODIFIER_NUMLOCK = ModifierType(7)
+
+MODIFIER_SHIFT = ModifierType(0)
+
+MODIFIER_SHIFTLOCK = ModifierType(1)
+
+
+ROLE_ACCELERATOR_LABEL = Role(1)
+
+ROLE_ALERT = Role(2)
+
+ROLE_ANIMATION = Role(3)
+
+ROLE_APPLICATION = Role(75)
+
+ROLE_ARROW = Role(4)
+
+ROLE_AUTOCOMPLETE = Role(76)
+
+ROLE_CALENDAR = Role(5)
+
+ROLE_CANVAS = Role(6)
+
+ROLE_CAPTION = Role(81)
+
+ROLE_CHART = Role(80)
+
+ROLE_CHECK_BOX = Role(7)
+
+ROLE_CHECK_MENU_ITEM = Role(8)
+
+ROLE_COLOR_CHOOSER = Role(9)
+
+ROLE_COLUMN_HEADER = Role(10)
+
+ROLE_COMBO_BOX = Role(11)
+
+ROLE_DATE_EDITOR = Role(12)
+
+ROLE_DESKTOP_FRAME = Role(14)
+
+ROLE_DESKTOP_ICON = Role(13)
+
+ROLE_DIAL = Role(15)
+
+ROLE_DIALOG = Role(16)
+
+ROLE_DIRECTORY_PANE = Role(17)
+
+ROLE_DOCUMENT_FRAME = Role(82)
+
+ROLE_DRAWING_AREA = Role(18)
+
+ROLE_EDITBAR = Role(77)
+
+ROLE_EMBEDDED = Role(78)
+
+ROLE_ENTRY = Role(79)
+
+ROLE_EXTENDED = Role(70)
+
+ROLE_FILE_CHOOSER = Role(19)
+
+ROLE_FILLER = Role(20)
+
+ROLE_FOCUS_TRAVERSABLE = Role(21)
+
+ROLE_FONT_CHOOSER = Role(22)
+
+ROLE_FOOTER = Role(72)
+
+ROLE_FORM = Role(87)
+
+ROLE_FRAME = Role(23)
+
+ROLE_GLASS_PANE = Role(24)
+
+ROLE_HEADER = Role(71)
+
+ROLE_HEADING = Role(83)
+
+ROLE_HTML_CONTAINER = Role(25)
+
+ROLE_ICON = Role(26)
+
+ROLE_IMAGE = Role(27)
+
+ROLE_INPUT_METHOD_WINDOW = Role(89)
+
+ROLE_INTERNAL_FRAME = Role(28)
+
+ROLE_INVALID = Role(0)
+
+ROLE_LABEL = Role(29)
+
+ROLE_LAST_DEFINED = Role(90)
+
+ROLE_LAYERED_PANE = Role(30)
+
+ROLE_LINK = Role(88)
+
+ROLE_LIST = Role(31)
+
+ROLE_LIST_ITEM = Role(32)
+
+ROLE_MENU = Role(33)
+
+ROLE_MENU_BAR = Role(34)
+
+ROLE_MENU_ITEM = Role(35)
+
+ROLE_OPTION_PANE = Role(36)
+
+ROLE_PAGE = Role(84)
+
+ROLE_PAGE_TAB = Role(37)
+
+ROLE_PAGE_TAB_LIST = Role(38)
+
+ROLE_PANEL = Role(39)
+
+ROLE_PARAGRAPH = Role(73)
+
+ROLE_PASSWORD_TEXT = Role(40)
+
+ROLE_POPUP_MENU = Role(41)
+
+ROLE_PROGRESS_BAR = Role(42)
+
+ROLE_PUSH_BUTTON = Role(43)
+
+ROLE_RADIO_BUTTON = Role(44)
+
+ROLE_RADIO_MENU_ITEM = Role(45)
+
+ROLE_REDUNDANT_OBJECT = Role(86)
+
+ROLE_ROOT_PANE = Role(46)
+
+ROLE_ROW_HEADER = Role(47)
+
+ROLE_RULER = Role(74)
+
+ROLE_SCROLL_BAR = Role(48)
+
+ROLE_SCROLL_PANE = Role(49)
+
+ROLE_SECTION = Role(85)
+
+ROLE_SEPARATOR = Role(50)
+
+ROLE_SLIDER = Role(51)
+
+ROLE_SPIN_BUTTON = Role(52)
+
+ROLE_SPLIT_PANE = Role(53)
+
+ROLE_STATUS_BAR = Role(54)
+
+ROLE_TABLE = Role(55)
+
+ROLE_TABLE_CELL = Role(56)
+
+ROLE_TABLE_COLUMN_HEADER = Role(57)
+
+ROLE_TABLE_ROW_HEADER = Role(58)
+
+ROLE_TEAROFF_MENU_ITEM = Role(59)
+
+ROLE_TERMINAL = Role(60)
+
+ROLE_TEXT = Role(61)
+
+ROLE_TOGGLE_BUTTON = Role(62)
+
+ROLE_TOOL_BAR = Role(63)
+
+ROLE_TOOL_TIP = Role(64)
+
+ROLE_TREE = Role(65)
+
+ROLE_TREE_TABLE = Role(66)
+
+ROLE_UNKNOWN = Role(67)
+
+ROLE_VIEWPORT = Role(68)
+
+ROLE_WINDOW = Role(69)
+
+TEXT_BOUNDARY_CHAR = TEXT_BOUNDARY_TYPE(0)
+
+TEXT_BOUNDARY_LINE_END = TEXT_BOUNDARY_TYPE(6)
+
+TEXT_BOUNDARY_LINE_START = TEXT_BOUNDARY_TYPE(5)
+
+TEXT_BOUNDARY_SENTENCE_END = TEXT_BOUNDARY_TYPE(4)
+
+TEXT_BOUNDARY_SENTENCE_START = TEXT_BOUNDARY_TYPE(3)
+
+TEXT_BOUNDARY_WORD_END = TEXT_BOUNDARY_TYPE(2)
+
+TEXT_BOUNDARY_WORD_START = TEXT_BOUNDARY_TYPE(1)
+
+TEXT_CLIP_BOTH = TEXT_CLIP_TYPE(3)
+
+TEXT_CLIP_MAX = TEXT_CLIP_TYPE(2)
+
+TEXT_CLIP_MIN = TEXT_CLIP_TYPE(1)
+
+TEXT_CLIP_NONE = TEXT_CLIP_TYPE(0)
projects / platform / core / uifw / at-spi2-atk.git / blobdiff