+2003-04-25 Padraig O'Briain <padraig.obriain@sun.com>
+
+ * cspi/spi-listener.h: Add documentation for AccessibleDeviceEventType,
+ AcccessibleKeyEventType, AccessibleKeyMaskType.
+
+ * cspi/spi-roletypes.h: Update documentation for AccessibleRole.
+
+ * cspi/state-types.h: Add documentation for AccessibleState.
+
+ * cspi/spi.h: Add documentation for AccessibleTextBoundaryType,
+ AccessibleTextClipType, AccessibleRelationType, AccessibleCoordType,
+ AccessibleKeySynthType, AccessibleKeyListenerSyncType,
+ AccessibleComponentLayer.
+
+ * cspi/spi_event.c, cspi/spi_registry.c, cspi/spi_text.c: Fix bugs
+ in documentation.
+
+ * docs/reference/cspi/at-spi-cspi-sections.txt: Add undefined symbols.
+
+ * docs/reference/cspi/tmpl/spi_registry.sgml: Add description of
+ Accessible. Add description of AccessibleEvent,
+ AccessibleEventListenerCB.
+
+ * docs/reference/cspi/tmpl/spi_event.sgml: Update with extra
+ documentation.
+
+ * docs/reference/cspi/tmpl/spi_registry.sgml: Update with extra
+ documentation. Add description of AccessibleKeystrokeListenerCB,
+ AccessibleKeyEventMask, AccessibleModifierMaskType,
+ AccessibleKeyMaskType, AccessibleKeystroke, AccessibleDeviceEvent,
+ AccessibleDeviceEventMask, AccessibleDeviceListenerCB.
+
+ * docs/reference/cspi/tmpl/spi_stateset.sgml: Add description of
+ AccessibleStateSet.
+
+ * docs/reference/cspi/tmpl/spi_text.sgml: Update with extra
+ documentation.
+
+ This fixes bug #104730.
+
2003-04-24 Padraig O'Briain <padraig.obriain@sun.com>
* atk-bridge/bridge.c (spi_init_keystroke_from_atk_key_event):
long detail2;
} AccessibleEvent;
+/**
+ *AccessibleDeviceEventType:
+ *@SPI_KEY_PRESSED:
+ *@SPI_KEY_RELEASED:
+ *@SPI_BUTTON_PRESSED:
+ *@SPI_BUTTON_RELEASED:
+ *
+ *The type of an AccessibleDeviceEvent.
+ **/
typedef enum {
SPI_KEY_PRESSED = 1<<0,
SPI_KEY_RELEASED = 1<<1,
SPI_BUTTON_RELEASED = 1<<3
} AccessibleDeviceEventType;
+/**
+ *AccessibleKeyEventType:
+ *
+ *This is a synonym for AccessibleDeviceEventType
+ **/
typedef AccessibleDeviceEventType AccessibleKeyEventType;
typedef struct {
* @SPI_ROLE_APPLICATION: An object which corresponds to a desktop application,
* which may have children of @SPI_ROLE_FRAME or other type.
* @SPI_ROLE_LAST_DEFINED: Used to determine the end of the role enumeration.
+ *
+ * Describes the role of an object
+ *
+ * These are the built-in enumerated roles that UI components can have.
+ * Other roles may be added at runtime, so an AccessibleRole >=
+ * SPI_ROLE_LAST_DEFINED is not necessarily an error.
**/
typedef enum
{
extern "C" {
#endif
-/* Enumerated type for accessible state */
-
+/**
+ *AccessibleState:
+ *@SPI_STATE_INVALID: Indicates an invalid state
+ *@SPI_STATE_ACTIVE: Indicates a window is currently the active window
+ *@SPI_STATE_ARMED: Indicates that the object is armed
+ *@SPI_STATE_BUSY: Indicates the current object is busy
+ *@SPI_STATE_CHECKED: Indicates this object is currently checked
+ *@SPI_STATE_COLLAPSED: Indicates this object is collapsed
+ *@SPI_STATE_DEFUNCT: Indicates the user interface object corresponding to this object no longer exists
+ *@SPI_STATE_EDITABLE: Indicates the user can change the contents of this object
+ *@SPI_STATE_ENABLED: Indicates that this object is enabled
+ *@SPI_STATE_EXPANDABLE: Indicates this object allows progressive disclosure of its children
+ *@SPI_STATE_EXPANDED: Indicates this object its expanded
+ *@SPI_STATE_FOCUSABLE: Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus
+ *@SPI_STATE_FOCUSED: Indicates this object currently has the keyboard focus
+ *@SPI_STATE_HORIZONTAL: Indicates the orientation of thsi object is horizontal
+ *@SPI_STATE_ICONIFIED: Indicates this object is minimized and is represented only by an icon
+ *@SPI_STATE_MODAL: Indicates something must be done with this object before the user can interact with an object in a different window
+ *@SPI_STATE_MULTI_LINE: Indicates this (text) object can contain multiple lines of text
+ *@SPI_STATE_MULTISELECTABLE: Indicates this object allows more than one of its children to be selected at the same time
+ *@SPI_STATE_OPAQUE: Indicates this object paints every pixel within its rectangular region
+ *@SPI_STATE_PRESSED: Indicates this object is currently pressed
+ *@SPI_STATE_RESIZABLE: Indicates the size of this object is not fixed
+ *@SPI_STATE_SELECTABLE: Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected
+ *@SPI_STATE_SELECTED: Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected
+ *@SPI_STATE_SENSITIVE: Indicates this object is sensitive
+ *@SPI_STATE_SHOWING: Indicates this object, the object's parent, the object's parent's parent, and so on, are all visible
+ *@SPI_STATE_SINGLE_LINE: Indicates this (text) object can contain only a single line of text
+ *@SPI_STATE_STALE: Indicates that the index associated with this object has changed since the user accessed the object
+ *@SPI_STATE_TRANSIENT: Indicates this object is transient
+ *@SPI_STATE_VERTICAL: Indicates the orientation of this object is vertical
+ *@SPI_STATE_VISIBLE: Indicates this object is visible
+ *@SPI_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-changed"
+ * event is sent when children become 'active' (i.e. are selected or navigated
+ * to onscreen). Used to prevent need to enumerate all children in very large
+ * containers, like tables.
+ *@SPI_STATE_LAST_DEFINED: Not a valid state, used for finding end of enumeration
+ *
+ *The possibles states of an object.
+ **/
typedef enum
{
SPI_STATE_INVALID,
- /* Indicates a window is currently the active window */
SPI_STATE_ACTIVE,
- /* Indicates that the object is armed */
SPI_STATE_ARMED,
- /* Indicates the current object is busy */
SPI_STATE_BUSY,
- /* Indicates this object is currently checked */
SPI_STATE_CHECKED,
- /* Indicates this object is collapsed */
SPI_STATE_COLLAPSED,
- /* Indicates the user interface object corresponding to this object no longer exists */
SPI_STATE_DEFUNCT,
- /* Indicates the user can change the contents of this object */
SPI_STATE_EDITABLE,
- /* Indicates that this object is enabled */
SPI_STATE_ENABLED,
- /* Indicates this object allows progressive disclosure of its children */
SPI_STATE_EXPANDABLE,
- /* Indicates this object its expanded */
SPI_STATE_EXPANDED,
- /*
- * Indicates this object can accept keyboard focus, which means all
- * events resulting from typing on the keyboard will normally be passed
- * to it when it has focus
- */
SPI_STATE_FOCUSABLE,
- /* Indicates this object currently has the keyboard focus */
SPI_STATE_FOCUSED,
- /* Indicates the orientation of thsi object is horizontal */
SPI_STATE_HORIZONTAL,
- /* Indicates this object is minimized and is represented only by an icon */
SPI_STATE_ICONIFIED,
- /*
- * Indicates something must be done with this object before the user can
- * interact with an object in a different window.
- */
SPI_STATE_MODAL,
- /* Indicates this (text) object can contain multiple lines of text */
SPI_STATE_MULTI_LINE,
- /*
- * Indicates this object allows more than one of its children to be
- * selected at the same time
- */
SPI_STATE_MULTISELECTABLE,
- /* Indicates this object paints every pixel within its rectangular region. */
SPI_STATE_OPAQUE,
- /* Indicates this object is currently pressed */
SPI_STATE_PRESSED,
- /* Indicates the size of this object is not fixed */
SPI_STATE_RESIZABLE,
- /*
- * Indicates this object is the child of an object that allows its
- * children to be selected and that this child is one of those children
- * that can be selected.
- */
SPI_STATE_SELECTABLE,
- /*
- * Indicates this object is the child of an object that allows its
- * children to be selected and that this child is one of those children
- * that has been selected.
- */
SPI_STATE_SELECTED,
- /* Indicates this object is sensitive */
SPI_STATE_SENSITIVE,
- /*
- * Indicates this object, the object's parent, the object's parent's
- * parent, and so on, are all visible
- */
SPI_STATE_SHOWING,
- /* Indicates this (text) object can contain only a single line of text */
SPI_STATE_SINGLE_LINE,
- /* Indicates that the index associated with this object has changed since the user accessed the object. */
SPI_STATE_STALE,
- /* Indicates this object is transient */
SPI_STATE_TRANSIENT,
- /* Indicates the orientation of this object is vertical */
SPI_STATE_VERTICAL,
- /* Indicates this object is visible */
SPI_STATE_VISIBLE,
- /*
- * Indicates that "active-descendant-changed" event is sent when children
- * become 'active' (i.e. are selected or navigated to onscreen). Used to
- * prevent need to enumerate all children in very large containers, like
- * tables.
- */
SPI_STATE_MANAGES_DESCENDANTS,
SPI_STATE_LAST_DEFINED
} AccessibleState;
extern "C" {
#endif
-/*
- * Enumerated type for text boundary types
- */
+/**
+ *AccessibleTextBoundaryType:
+ *@SPI_TEXT_BOUNDARY_CHAR:
+ *@SPI_TEXT_BOUNDARY_CURSOR_POS:
+ *@SPI_TEXT_BOUNDARY_WORD_START:
+ *@SPI_TEXT_BOUNDARY_WORD_END:
+ *@SPI_TEXT_BOUNDARY_SENTENCE_START:
+ *@SPI_TEXT_BOUNDARY_SENTENCE_END:
+ *@SPI_TEXT_BOUNDARY_LINE_START:
+ *@SPI_TEXT_BOUNDARY_LINE_END:
+ *@SPI_TEXT_BOUNDARY_ATTRIBUTE_RANGE:
+ *
+ *Text boundary types used for specifying boundaries for regions of text
+ **/
typedef enum
{
SPI_TEXT_BOUNDARY_CHAR,
SPI_TEXT_BOUNDARY_ATTRIBUTE_RANGE
} AccessibleTextBoundaryType;
-/*
- * Enumerated type for text bounds clipping types
- */
+/**
+ *AccessibleTextClipType
+ *@SPI_TEXT_CLIP_NONE: No clipping to be done
+ *@SPI_TEXT_CLIP_MIN: Text clipped by min coordinate is omitted
+ *@SPI_TEXT_CLIP_MAX: Text clipped by max coordinate is omitted
+ *@SPI_TEXT_CLIP_BOTH: Only text fully within mix/max bound is retained
+ *
+ *Describes the type of clipping required.
+ **/
typedef enum
{
SPI_TEXT_CLIP_NONE,
SPI_TEXT_CLIP_BOTH
} AccessibleTextClipType;
-/*
- *
- * Enumerated type for relation types
+/**
+ *AccessibleRelationType:
+ *@SPI_RELATION_NULL:
+ *@SPI_RELATION_LABEL_FOR: Indicates an object is a label for one or more target objects.
+ *@SPI_RELATION_LABELED_BY: Indicates an object is labelled by one or more target objects.
+ *@SPI_RELATION_CONTROLLED_BY: Indicates an object controlled by one or more target objects.
+ *@SPI_RELATION_CONTROLLER_FOR: Indicates an object is an controller for one or more target objects.
+ *@SPI_RELATION_MEMBER_OF: Indicates an object is a member of a group of one or
+more target objects.
+ *@SPI_RELATION_NODE_CHILD_OF: Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell.
+ *@SPI_RELATION_EXTENDED:
+ *@SPI_RELATION_FLOWS_TO: Indicates that the object has content that flows logically to another
+ * AtkObject in a sequential way, (for instance text-flow).
+ *@SPI_RELATION_FLOWS_FROM: Indicates that the object has content that flows logically from
+ * another AtkObject in a sequential way, (for instance text-flow).
+ *@SPI_RELATION_SUBWINDOW_OF:
+ *@SPI_RELATION_EMBEDS: Indicates that the object visually embeds
+ * another object's content, i.e. this object's content flows around
+ * another's content.
+ *@SPI_RELATION_EMBEDDED_BY: Inverse of %SPI_RELATION_EMBEDS, indicates that
+ * this object's content is visualy embedded in another object.
+ *@SPI_RELATION_LAST_DEFINED:
*
- */
-
+ *Describes the type of the relation
+ **/
typedef enum
{
SPI_RELATION_NULL,
/* don't change the order of these ! */
+/**
+ *AccessibleCoordType:
+ *@SPI_COORD_TYPE_SCREEN: specifies xy coordinates relative to the screen
+ *@SPI_COORD_TYPE_WINDOW: specifies xy coordinates relative to an object's
+ * top-level window
+ *
+ *Specifies how xy coordinates are to be interpreted. Used by functions such
+ *as AccessibleComponent_getPosition() and AccessibleText_getCharacterExtents()
+ **/
typedef enum {
SPI_COORD_TYPE_SCREEN,
SPI_COORD_TYPE_WINDOW
} AccessibleCoordType;
+/**
+ *AccessibleKeySynthType:
+ *@SPI_KEY_PRESS:
+ *@SPI_KEY_RELEASE:
+ *@SPI_KEY_PRESSRELEASE:
+ *@SPI_KEY_SYM:
+ *@SPI_KEY_STRING:
+ *
+ *Specified the type of a generated event.
+ **/
typedef enum {
SPI_KEY_PRESS,
SPI_KEY_RELEASE,
SPI_KEY_STRING
} AccessibleKeySynthType;
+/**
+ *AccessibleKeyListenerSyncType:
+ *@SPI_KEYLISTENER_NOSYNC:
+ *@SPI_KEYLISTENER_SYNCHRONOUS:
+ *@SPI_KEYLISTENER_CANCONSUME:
+ *@SPI_KEYLISTENER_ALL_WINDOWS:
+ *
+ *Specified the tyupe of a key listener event.
+ **/
typedef enum {
SPI_KEYLISTENER_NOSYNC = 0,
SPI_KEYLISTENER_SYNCHRONOUS = 1,
typedef unsigned long AccessibleDeviceEventMask;
/**
- * AccessibleComponentLayer:
- * @SPI_LAYER_INVALID: The layer cannot be determined or is somehow undefined.
- * @SPI_LAYER_BACKGROUND: Component belongs to the destop background.
- * @SPI_LAYER_CANVAS: Component is a canvas backdrop or drawing area.
- * @SPI_LAYER_WIDGET: Component is a 'normal' widget.
- * @SPI_LAYER_MDI: Component is drawn in the MDI layer and may have valid
- * Z-information relative to other MDI-layer components.
- * @SPI_LAYER_POPUP: Component is in the popup layer, above other widgets and
- * MDI components.
- * @SPI_LAYER_OVERLAY: Component is in the overlay plane - this value is reserved
- * for future use.
- * @SPI_LAYER_WINDOW: Component is in the window layer and have valid Z-information
- * relative to other window-layer components.
- * @SPI_LAYER_LAST_DEFINED: Used to determine the last valid value in the enum,
- * should not be encountered.
+ *AccessibleComponentLayer:
+ *@SPI_LAYER_INVALID: The layer cannot be determined or is somehow undefined.
+ *@SPI_LAYER_BACKGROUND: Component belongs to the destop background.
+ *@SPI_LAYER_CANVAS: Component is a canvas backdrop or drawing area.
+ *@SPI_LAYER_WIDGET: Component is a 'normal' widget.
+ *@SPI_LAYER_MDI: Component is drawn in the MDI layer and may have valid
+ * Z-information relative to other MDI-layer components.
+ *@SPI_LAYER_POPUP: Component is in the popup layer, above other widgets and
+ * MDI components.
+ *@SPI_LAYER_OVERLAY: Component is in the overlay plane - this value is reserved
+ * for future use.
+ *@SPI_LAYER_WINDOW: Component is in the window layer and have valid Z-information
+ * relative to other window-layer components.
+ *@SPI_LAYER_LAST_DEFINED: Used to determine the last valid value in the enum,
+ * should not be encountered.
+ *
+ * Describes the layer of a component.
+ *
+ * These enumerated "layer values" are used when determining which UI
+ * rendering layer a component is drawn into, which can help in making
+ * determinations of when components occlude one another.
**/
typedef enum {
SPI_LAYER_INVALID,
short len;
} AccessibleKeySet;
-/**
- * SPI_KEYSET_ALL_KEYS:
- * @SPI_KEYSET_ALL_KEYS: A special value for an AccessibleKeySet type, which tacitly
- * includes all keycodes and keyvals for the specified modifier set.
- **/
+/*
+ * A special value for an AccessibleKeySet type, which tacitly
+ * includes all keycodes and keyvals for the specified modifier set.
+ */
#define SPI_KEYSET_ALL_KEYS NULL
typedef unsigned long AccessibleModifierMaskType;
+/**
+ *AccessibleKeyMaskType:
+ *
+ *AccessibleKeyMaskType is a mask which is a set of key event modifiers
+ *which is specified in SPI_registerAccessibleKeystrokeListener.
+ **/
+
typedef AccessibleModifierMaskType AccessibleKeyMaskType;
/* Basic SPI initialization and event loop function prototypes */
/**
* AccessibleTextSelectionChangedEvent_getSelectionString:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
*
* Queries an #AccessibleEvent of type "object:text-selection-changed",
* returning the newly added, removed, or modified selection string.
/**
* AccessibleWindowEvent_getTitleString:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
*
* Queries an #AccessibleEvent of type "window:",
* returning the window title.
/**
* AccessibleChildChangedEvent_getChildAccessible:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
*
* Queries an #AccessibleEvent of type "object:children_changed"
* to get a reference to the changed #Accessible.
/**
* AccessibleParentChangedEvent_getParentAccessible:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
*
* Queries an #AccessibleEvent of type "object:property-change:accessible-parent"
* to get a reference to the changed #Accessible.
/**
* AccessibleActiveDescendantChangedEvent_getActiveDescendant:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
*
* Queries an #AccessibleEvent of type "object:active-descendant-changed"
* to get a reference to the changed #Accessible.
/**
* AccessibleTableSummaryChangedEvent_getSummaryAccessible:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
*
* Queries an #AccessibleEvent of type "object:property-changed:accessible-table-summary"
* to get a reference to the changed #Accessible.
/**
* AccessibleTableHeaderChangedEvent_getHeaderAccessible:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * @e: a pointer to the #AccessibleEvent being queried.
*
* Queries an #AccessibleEvent of type
* "object:property-changed:accessible-table-row-header" or
}
/**
- * AccessibleTableRowDescriptionEvent_getDescriptionString:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * AccessibleTableRowDescriptionChangedEvent_getDescriptionString:
+ * @e: a pointer to the #AccessibleEvent being queried.
*
* Queries an #AccessibleEvent of type
* "object:property-changed:accessible-table-row-description"
}
/**
- * AccessibleTableColumnDescriptionEvent_getDescriptionString:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * AccessibleTableColumnDescriptionChangedEvent_getDescriptionString:
+ * @e: a pointer to the #AccessibleEvent being queried.
*
* Queries an #AccessibleEvent of type
* "object:property-changed:accessible-table-column-description"
}
/**
- * AccessibleDescriptionEvent_getDescriptionString:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * AccessibleDescriptionChangedEvent_getDescriptionString:
+ * @e: a pointer to the #AccessibleEvent being queried.
*
* Queries an #AccessibleEvent of type
* "object:property-changed:accessible-description"
}
/**
- * AccessibleNameChangedEvent_getNametring:
- * @event: a pointer to the #AccessibleEvent being queried.
+ * AccessibleNameChangedEvent_getNameString:
+ * @e: a pointer to the #AccessibleEvent being queried.
*
* Queries an #AccessibleEvent of type "object:property-change:accessible_name:",
* returning the name.
return cspi_internal_event_get_text (foo);
}
+/**
+ * AccessibleEvent_ref:
+ * @e: a pointer to the #AccessibleEvent being referenced.
+ *
+ * Increments by 1 the reference count of the event
+ *
+ * Returns: TRUE if the function succeeded; FALSE if the pointer is not a
+ * valid event.
+ **/
SPIBoolean
AccessibleEvent_ref (const AccessibleEvent *e)
{
return FALSE;
}
+/**
+ * AccessibleEvent_unref:
+ * @e: a pointer to the #AccessibleEvent being referenced.
+ *
+ * Decrements by 1 the reference count of the event. The event is destroyed
+ * when the reference count recahes zero.
+ *
+ **/
void
AccessibleEvent_unref (const AccessibleEvent *e)
{
* @listener: a pointer to the #AccessibleKeystrokeListener for which
* keystroke events are requested.
* @keys: a pointer to the #AccessibleKeySet indicating which
- * keystroke events are requested, or #CSPI_KEYSET_ALL_KEYS.
+ * keystroke events are requested, or #CSPI_KEYSET_ALL_KEYS
+ * to indicate that all keycodes and keyvals for the specified
+ * modifier set are to be included.
* @modmask: an #AccessibleKeyMaskType mask indicating which
* key event modifiers must be set in combination with @keys,
* events will only be reported for key events for which all
* the events.
* @eventmask: an #AccessibleDeviceEventMask mask indicating which
* types of key events are requested (#SPI_KEY_PRESSED, etc.).
+ * @filter: Unused parameter.
*
* Register a listener for device events, for instance button events.
*
* SPI_deregisterDeviceEventListener:
* @listener: a pointer to the #AccessibleDeviceListener for which
* device events are requested.
+ * @filter: Unused parameter.
*
* Removes a device event listener from the registry's listener queue,
* ceasing notification of events of the specified type.
*
* Get the bounding box for text within a range in an #AccessibleText object.
*
- * Returns: the bounding-box extents of the specified text range,
- * in the specified coordinate system.
- *
**/
void
AccessibleText_getRangeExtents (AccessibleText *obj,
<TITLE>Event Listener Support</TITLE>
AccessibleEvent
AccessibleEventListenerCB
+AccessibleEvent_ref
+AccessibleEvent_unref
SPI_createAccessibleEventListener
AccessibleEventListener_unref
AccessibleEventListener_addCallback
AccessibleEventListener_removeCallback
+<SUBSECTION Specific Event Support>
+AccessibleActiveDescendantChangedEvent_getActiveDescendant
+AccessibleChildChangedEvent_getChildAccessible
+AccessibleDescriptionChangedEvent_getDescriptionString
+AccessibleNameChangedEvent_getNameString
+AccessibleParentChangedEvent_getParentAccessible
+AccessibleTableCaptionChangedEvent_getCaptionString
+AccessibleTableColumnDescriptionChangedEvent_getDescriptionString
+AccessibleTableHeaderChangedEvent_getHeaderAccessible
+AccessibleTableRowDescriptionChangedEvent_getDescriptionString
+AccessibleTableSummaryChangedEvent_getSummaryAccessible
+AccessibleTextChangedEvent_getChangeString
+AccessibleTextSelectionChangedEvent_getSelectionString
+AccessibleWindowEvent_getTitleString
</SECTION>
<SECTION>
<SUBSECTION Event Registration>
AccessibleKeystrokeListenerCB
AccessibleKeyEventMask
+AccessibleModifierMaskType
AccessibleKeyMaskType
AccessibleKeyEventType
AccessibleKeyListenerSyncType
AccessibleKeystroke
-SPI_KEYSET_ALL_KEYS
SPI_createAccessibleKeySet
SPI_freeAccessibleKeySet
SPI_createAccessibleKeystrokeListener
AccessibleKeystrokeListener_addCallback
SPI_generateKeyboardEvent
SPI_generateMouseEvent
+AccessibleDeviceEvent
+AccessibleDeviceEventMask
+AccessibleDeviceEventType
+AccessibleDeviceListenerCB
+SPI_createAccessibleDeviceListener
+SPI_registerDeviceEventListener
+SPI_deregisterDeviceEventListener
+AccessibleDeviceListener_addCallback
+AccessibleDeviceListener_removeCallback
+AccessibleDeviceListener_unref
+<SUBSECTION Private>
+SPI_KEYSET_ALL_KEYS
</SECTION>
<SECTION>
<SUBSECTION Auxiliary types>
AccessibleRole
AccessibleRole_getName
+<SUBSECTION Private>
+InternalEvent
+SPI_INTERNAL_EVENT_MAGIC
+CSPI_OBJREF
+cspi_ev
+cspi_exception
+cspi_registry
+cspi_object_add
+cspi_object_ref
+cspi_object_unref
+cspi_object_borrow
+cspi_object_take
+cspi_object_return
+cspi_accessible_is_a
+cspi_return_if_fail
+cspi_return_val_if_fail
+cspi_return_if_ev
+cspi_return_val_if_ev
+cspi_check_ev
+cspi_dup_ref
+cspi_release_unref
+cspi_exception_get_text
+cspi_init
+cspi_ping
+cspi_main
+cspi_main_quit
+cspi_event_listener_get_type
+cspi_event_listener_new
+cspi_event_listener_get_corba
+cspi_event_listener_add_cb
+cspi_event_listener_remove_cb
+cspi_event_listener_unref
+cspi_keystroke_listener_new
+cspi_keystroke_listener_unref
+cspi_keystroke_listener_get_corba
+cspi_keystroke_listener_add_cb
+cspi_keystroke_listener_remove_cb
+cspi_device_listener_get_type
+cspi_device_listener_new
+cspi_device_listener_add_cb
+cspi_device_listener_remove_cb
+cspi_device_listener_unref
+CSpiEventListener
+CSpiEventListenerClass
+CSPI_EVENT_LISTENER_TYPE
+CSPI_EVENT_LISTENER
+CSPI_EVENT_LISTENER_CLASS
+CSPI_IS_EVENT_LISTENER
+CSPI_IS_EVENT_LISTENER_CLASS
+CSpiDeviceListener
+CSpiDeviceListenerClass
+CSPI_DEVICE_LISTENER_TYPE
+CSPI_DEVICE_LISTENER
+CSPI_DEVICE_LISTENER_CLASS
+CSPI_IS_DEVICE_LISTENER
+CSPI_IS_DEVICE_LISTENER_CLASS
</SECTION>
<SECTION>
<FILE>spi_text</FILE>
<TITLE>AccessibleText Interface</TITLE>
AccessibleTextBoundaryType
+AccessibleTextClipType
AccessibleText_ref
AccessibleText_unref
AccessibleText_addSelection
AccessibleText_getAttributes
+AccessibleText_getBoundedRanges
AccessibleText_getCaretOffset
AccessibleText_getCharacterCount
AccessibleText_getCharacterExtents
AccessibleText_getNSelections
AccessibleText_getOffsetAtPoint
+AccessibleText_getRangeExtents
AccessibleText_getSelection
AccessibleText_getText
AccessibleText_getTextBeforeOffset
AccessibleText_removeSelection
AccessibleText_setCaretOffset
AccessibleText_setSelection
+AccessibleTextRange_freeRanges
</SECTION>
<SECTION>
<FILE>spi_stateset</FILE>
<TITLE>State and StateSets</TITLE>
AccessibleState
+AccessibleStateSet
AccessibleStateSet_ref
AccessibleStateSet_unref
AccessibleStateSet_add
<!-- ##### STRUCT Accessible ##### -->
<para>
-
+An Accessible object is an opaque object used to refer to an accessible
+object corresponding to an user interface element.
</para>
@objref:
<!-- ##### TYPEDEF AccessibleEvent ##### -->
<para>
-
+AccessibleEvent is a struct used to encapsulate event information.
</para>
<!-- ##### USER_FUNCTION AccessibleEventListenerCB ##### -->
<para>
-
+This is a function which is specified when creating a EventListener.
+It is called when an event being listened for occurs.
</para>
@event:
@user_data:
+<!-- ##### FUNCTION AccessibleEvent_ref ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleEvent_unref ##### -->
+<para>
+
+</para>
+
+@e:
+
+
<!-- ##### FUNCTION SPI_createAccessibleEventListener ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION AccessibleActiveDescendantChangedEvent_getActiveDescendant ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleChildChangedEvent_getChildAccessible ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleDescriptionChangedEvent_getDescriptionString ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleNameChangedEvent_getNameString ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleParentChangedEvent_getParentAccessible ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleTableCaptionChangedEvent_getCaptionString ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleTableColumnDescriptionChangedEvent_getDescriptionString ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleTableHeaderChangedEvent_getHeaderAccessible ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleTableRowDescriptionChangedEvent_getDescriptionString ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleTableSummaryChangedEvent_getSummaryAccessible ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleTextChangedEvent_getChangeString ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleTextSelectionChangedEvent_getSelectionString ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleWindowEvent_getTitleString ##### -->
+<para>
+
+</para>
+
+@e:
+@Returns:
+
+
<!-- ##### USER_FUNCTION AccessibleKeystrokeListenerCB ##### -->
<para>
-
+This is a function which is specified when creating a KeystrokeListener.
+It is called when an event being listened for occurs.
</para>
@stroke:
<!-- ##### TYPEDEF AccessibleKeyEventMask ##### -->
<para>
+AccessibleKeyEventMask is a set of types of key events. It is used
+in SPI_registerAccessibleKeystroketListener to specify the events to be
+listener for.
+</para>
+
+<!-- ##### TYPEDEF AccessibleModifierMaskType ##### -->
+<para>
+AccessibleModifierMaskType is a synonym for AccessibleKeymaskType.
</para>
<!-- ##### TYPEDEF AccessibleKeystroke ##### -->
<para>
-
+This is a synonym for AccessibleDeviceEvent.
</para>
-<!-- ##### MACRO SPI_KEYSET_ALL_KEYS ##### -->
-<para>
-
-</para>
-
-
-
<!-- ##### FUNCTION SPI_createAccessibleKeySet ##### -->
<para>
@Returns:
+<!-- ##### TYPEDEF AccessibleDeviceEvent ##### -->
+<para>
+AccessibleDeviceEvent is a struct which encapsulates a device event.
+</para>
+
+
+<!-- ##### TYPEDEF AccessibleDeviceEventMask ##### -->
+<para>
+AccessibleDeviceEventMask is a set of types of key events. It is used
+in SPI_registerDeviceEventListener to specify the events to be listener for.
+</para>
+
+
+<!-- ##### ENUM AccessibleDeviceEventType ##### -->
+<para>
+
+</para>
+
+@SPI_KEY_PRESSED:
+@SPI_KEY_RELEASED:
+@SPI_BUTTON_PRESSED:
+@SPI_BUTTON_RELEASED:
+
+<!-- ##### USER_FUNCTION AccessibleDeviceListenerCB ##### -->
+<para>
+This is a function which is specified when creating a DeviceListener.
+It is called when an event being listened for occurs.
+</para>
+
+@stroke:
+@user_data:
+@Returns:
+
+
+<!-- ##### FUNCTION SPI_createAccessibleDeviceListener ##### -->
+<para>
+
+</para>
+
+@callback:
+@user_data:
+@Returns:
+
+
+<!-- ##### FUNCTION SPI_registerDeviceEventListener ##### -->
+<para>
+
+</para>
+
+@listener:
+@eventmask:
+@filter:
+@Returns:
+
+
+<!-- ##### FUNCTION SPI_deregisterDeviceEventListener ##### -->
+<para>
+
+</para>
+
+@listener:
+@filter:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleDeviceListener_addCallback ##### -->
+<para>
+
+</para>
+
+@listener:
+@callback:
+@user_data:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleDeviceListener_removeCallback ##### -->
+<para>
+
+</para>
+
+@listener:
+@callback:
+@Returns:
+
+
+<!-- ##### FUNCTION AccessibleDeviceListener_unref ##### -->
+<para>
+
+</para>
+
+@listener:
+
+
<!-- ##### SECTION Long_Description ##### -->
<para>
-
</para>
<!-- ##### SECTION See_Also ##### -->
@SPI_STATE_MANAGES_DESCENDANTS:
@SPI_STATE_LAST_DEFINED:
+<!-- ##### STRUCT AccessibleStateSet ##### -->
+<para>
+An AccessibleStateSet determines a component's state set. It is composed of
+a set of AccessibleState values.
+
+</para>
+
+@ref_count:
+@states:
+
<!-- ##### FUNCTION AccessibleStateSet_ref ##### -->
<para>
@SPI_TEXT_BOUNDARY_LINE_END:
@SPI_TEXT_BOUNDARY_ATTRIBUTE_RANGE:
+<!-- ##### ENUM AccessibleTextClipType ##### -->
+<para>
+
+</para>
+
+@SPI_TEXT_CLIP_NONE:
+@SPI_TEXT_CLIP_MIN:
+@SPI_TEXT_CLIP_MAX:
+@SPI_TEXT_CLIP_BOTH:
+
<!-- ##### FUNCTION AccessibleText_ref ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION AccessibleText_getBoundedRanges ##### -->
+<para>
+
+</para>
+
+@obj:
+@x:
+@y:
+@width:
+@height:
+@type:
+@clipTypeX:
+@clipTypeY:
+@Returns:
+
+
<!-- ##### FUNCTION AccessibleText_getCaretOffset ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION AccessibleText_getRangeExtents ##### -->
+<para>
+
+</para>
+
+@obj:
+@startOffset:
+@endOffset:
+@x:
+@y:
+@width:
+@height:
+@type:
+
+
<!-- ##### FUNCTION AccessibleText_getSelection ##### -->
<para>
@Returns:
+<!-- ##### FUNCTION AccessibleTextRange_freeRanges ##### -->
+<para>
+
+</para>
+
+@ranges:
+
+
projects / platform / core / uifw / at-spi2-atk.git / commitdiff