Constants' Group AccessibleEventId

+ + + + + + + + + + + + +

Devguide

Index

+ + + + + +

Constants

Constants' Details

+ + + + + + + + + + +

:: drafts :: com :: sun :: star :: accessibility ::

constants group AccessibleEventId

Description: These constants identify the type of AccessibleEventObject + objects. + +; The AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain, where + applicable and not otherwise stated, the old and new value of the + property in question.
+ +
See also: AccessibleEventObject
+ +
See also: XAccessibleEventListener
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Constants
ACCESSIBLE_ACTION_EVENT	The change of the number or attributes of actions of an accessible + object is signaled by events of this type. +
ACCESSIBLE_ACTIVE_DESCENDANT_EVENT	Constant used to determine when the active descendant of a component + has changed. The active descendant is used in objects with + transient children. The AccessibleEventObject::NewValue + contains the now active object. The + AccessibleEventObject::OldValue contains the + previously active child. Empty references indicate that no child + has been respectively is currently active. +
ACCESSIBLE_CARET_EVENT	Events of this type are sent when the caret has moved to a new + position. The old and new position can be found in the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields. +
ACCESSIBLE_CHILD_EVENT	A child event indicates the addition of a new or the removal of an + existing child. The contents of the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields determines + which of both has taken place. + +
ACCESSIBLE_DESCRIPTION_EVENT	Use this event type to indicate a change of the description string + of an accessible object. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + description before and after the change. +
ACCESSIBLE_HYPERTEXT_EVENT	Constant used to indicate that a hypertext element has received + focus. The AccessibleEventObject::OldValue field + contains the start index of previously focused element. The + AccessibleEventObject::NewValue field holds the + start index in the document of the current element that has focus. A + value of -1 indicates that an element does not or did not have + focus. +
ACCESSIBLE_NAME_EVENT	Use this event type to indicate a change of the name string + of an accessible object. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + name before and after the change. +
ACCESSIBLE_SELECTION_EVENT	Events of this type indicate changes of the selection. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields remain empty. +
ACCESSIBLE_STATE_EVENT	State changes are signaled with this event type. Use one event for + every state that is set or reset. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new value respectively. To set a state put the state id + into the AccessibleEventObject::NewValue field and + leave AccessibleEventObject::OldValue empty. To + reset a state put the state id into the + AccessibleEventObject::OldValue field and leave + AccessibleEventObject::NewValue empty. +
ACCESSIBLE_TABLE_CAPTION_EVENT	Constant used to indicate that the table caption has changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new accessible objects representing the table caption. +
ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_EVENT	Constant used to indicate that the column description has changed. + The AccessibleEventObject::NewValue field contains + the column index. The + AccessibleEventObject::OldValue is left empty. +
ACCESSIBLE_TABLE_COLUMN_HEADER_EVENT	Constant used to indicate that the column header has changed. The + AccessibleEventObject::OldValue is empty, the + AccessibleEventObject::NewValue field contains an + AccessibleTableModelChange representing the header + change. +
ACCESSIBLE_TABLE_MODEL_EVENT	Constant used to indicate that the table data has changed. The + AccessibleEventObject::OldValue is empty, the + AccessibleEventObject::NewValue field contains an + AccessibleTableModelChange representing the data + change. +
ACCESSIBLE_TABLE_ROW_DESCRIPTION_EVENT	Constant used to indicate that the row description has changed. The + AccessibleEventObject::NewValue field contains the + row index. The AccessibleEventObject::OldValue is + left empty. +
ACCESSIBLE_TABLE_ROW_HEADER_EVENT	Constant used to indicate that the row header has changed. The + AccessibleEventObject::OldValue is empty, the + AccessibleEventObject::NewValue field contains an + AccessibleTableModelChange representing the header + change. +
ACCESSIBLE_TABLE_SUMMARY_EVENT	Constant used to indicate that the table summary has changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new accessible objects representing the table summary. +
ACCESSIBLE_TEXT_EVENT	Use this id to indicate general text changes, i.e. changes to text + that is exposed through the XAccessibleText and + XAccessibleEditableText interfaces. The affected text + ranges are represented by com::sun::star::awt::Selection structures. The type + of text change is expressed by which of the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields are set + respectively remain empty: +
ACCESSIBLE_VALUE_EVENT	This constant indicates changes of the value of an + XAccessibleValue interface. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue field contain the + old and new value as a number. Its exact type is implementation + dependant but has to be the same as is returned by the + XAccessibleValue::getCurrentValue function. +
ACCESSIBLE_VISIBLE_DATA_EVENT	A visibile data event indicates the change of the visual appearance + of an accessible object. This includes for example most of the + attributes available over the XAccessibleComponent and + XAccessibleExtendedComponent interfaces. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields are left empty. +
CONTROLLED_BY_EVENT	Identifies the change of a relation set: The target object that is + doing the controlling has changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new controlling objects. +
CONTROLLER_FOR_EVENT	Identifies the change of a relation set: The controller for the + target object has changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new number of controlled objects. +
LABEL_FOR_EVENT	Identifies the change of a relation set: The target group for a + label has changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new number labeled objects. +
LABELED_BY_EVENT	Identifies the change of a relation set: The objects that are doing + the labeling have changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new accessible label. +
MEMBER_OF_EVENT	Identifies the change of a relation set: The group membership has + changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new number of members. +
CONTENT_FLOWS_FROM_EVENT	Identifies the change of a relation set: The content flow has + changed. The AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain + refrences to the old and new predecessor. Note that both references + my be NULL to indicate that a flow to the sending object has not + existed or does not exist anymore. +
CONTENT_FLOWS_TO_EVENT	Identifies the change of a relation set: The content flow has + changed. The AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain + refrences to the old and new successor. Note that both references + my be NULL to indicate that a flow from the sending object has not + existed or does not exist anymore. +
ACCESSIBLE_ALL_CHILDREN_CHANGED_EVENT	Use this event to tell the listeners to re-retrieve the whole set of + children. This should be use by a parent who exchanges all or most + of his children. It is a short from of first sending one + ACCESSIBLE_CHILD_EVENT event for every old child + indicating that this child is about to be removed and then sending + one ACCESSIBLE_CHILD_EVENT for every new child + indicating that this child has been added to the list of children. + +
ACCESSIBLE_BOUNDRECT_EVENT	This event indicates a change of the bounding rectangle of an + accessible object with respect only to its size or relative + position. If the absolute position changes but not the relative + position then its is not necessary to send an event. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Constants' Details

ACCESSIBLE_ACTION_EVENT + + + + +

const short ACCESSIBLE_ACTION_EVENT = 1;

Description: The change of the number or attributes of actions of an accessible + object is signaled by events of this type. +; The AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new number of actions. +

ACCESSIBLE_ACTIVE_DESCENDANT_EVENT + + + + +

const short ACCESSIBLE_ACTIVE_DESCENDANT_EVENT = 2;

Description: Constant used to determine when the active descendant of a component + has changed. The active descendant is used in objects with + transient children. The AccessibleEventObject::NewValue + contains the now active object. The + AccessibleEventObject::OldValue contains the + previously active child. Empty references indicate that no child + has been respectively is currently active. +

ACCESSIBLE_CARET_EVENT + + + + +

const short ACCESSIBLE_CARET_EVENT = 3;

Description: Events of this type are sent when the caret has moved to a new + position. The old and new position can be found in the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields. +

ACCESSIBLE_CHILD_EVENT + + + + +

const short ACCESSIBLE_CHILD_EVENT = 4;

Description

A child event indicates the addition of a new or the removal of an + existing child. The contents of the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields determines + which of both has taken place. + +

If a new child has been added then + the AccessibleEventObject::NewValue contains a + reference to this new object and + AccessibleEventObject::OldValue remains empty.

+ +

If a child has been removed then the + AccessibleEventObject::OldValue contains a + reference to this object and + AccessibleEventObject::NewValue remains empty.

+ +

If a child has been added and a another one has been removed + don't set both fields at the same. Send separate events + instead.

+ +

Note that a child event is sent after a child has been added or + removed. Especially in the case of a removal this means that the + removed object does not have a parent anymore.

ACCESSIBLE_DESCRIPTION_EVENT + + + + +

const short ACCESSIBLE_DESCRIPTION_EVENT = 5;

Description: Use this event type to indicate a change of the description string + of an accessible object. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + description before and after the change. +

ACCESSIBLE_HYPERTEXT_EVENT + + + + +

const short ACCESSIBLE_HYPERTEXT_EVENT = 6;

Description: Constant used to indicate that a hypertext element has received + focus. The AccessibleEventObject::OldValue field + contains the start index of previously focused element. The + AccessibleEventObject::NewValue field holds the + start index in the document of the current element that has focus. A + value of -1 indicates that an element does not or did not have + focus. +

ACCESSIBLE_NAME_EVENT + + + + +

const short ACCESSIBLE_NAME_EVENT = 7;

Description: Use this event type to indicate a change of the name string + of an accessible object. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + name before and after the change. +

ACCESSIBLE_SELECTION_EVENT + + + + +

const short ACCESSIBLE_SELECTION_EVENT = 8;

Description: Events of this type indicate changes of the selection. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields remain empty. +

ACCESSIBLE_STATE_EVENT + + + + +

const short ACCESSIBLE_STATE_EVENT = 9;

Description: State changes are signaled with this event type. Use one event for + every state that is set or reset. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new value respectively. To set a state put the state id + into the AccessibleEventObject::NewValue field and + leave AccessibleEventObject::OldValue empty. To + reset a state put the state id into the + AccessibleEventObject::OldValue field and leave + AccessibleEventObject::NewValue empty. +

ACCESSIBLE_TABLE_CAPTION_EVENT + + + + +

const short ACCESSIBLE_TABLE_CAPTION_EVENT = 10;

Description: Constant used to indicate that the table caption has changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new accessible objects representing the table caption. +

ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_EVENT + + + + +

const short ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_EVENT = 11;

Description: Constant used to indicate that the column description has changed. + The AccessibleEventObject::NewValue field contains + the column index. The + AccessibleEventObject::OldValue is left empty. +

ACCESSIBLE_TABLE_COLUMN_HEADER_EVENT + + + + +

const short ACCESSIBLE_TABLE_COLUMN_HEADER_EVENT = 12;

Description: Constant used to indicate that the column header has changed. The + AccessibleEventObject::OldValue is empty, the + AccessibleEventObject::NewValue field contains an + AccessibleTableModelChange representing the header + change. +

ACCESSIBLE_TABLE_MODEL_EVENT + + + + +

const short ACCESSIBLE_TABLE_MODEL_EVENT = 13;

Description: Constant used to indicate that the table data has changed. The + AccessibleEventObject::OldValue is empty, the + AccessibleEventObject::NewValue field contains an + AccessibleTableModelChange representing the data + change. +

ACCESSIBLE_TABLE_ROW_DESCRIPTION_EVENT + + + + +

const short ACCESSIBLE_TABLE_ROW_DESCRIPTION_EVENT = 14;

Description: Constant used to indicate that the row description has changed. The + AccessibleEventObject::NewValue field contains the + row index. The AccessibleEventObject::OldValue is + left empty. +

ACCESSIBLE_TABLE_ROW_HEADER_EVENT + + + + +

const short ACCESSIBLE_TABLE_ROW_HEADER_EVENT = 15;

Description: Constant used to indicate that the row header has changed. The + AccessibleEventObject::OldValue is empty, the + AccessibleEventObject::NewValue field contains an + AccessibleTableModelChange representing the header + change. +

ACCESSIBLE_TABLE_SUMMARY_EVENT + + + + +

const short ACCESSIBLE_TABLE_SUMMARY_EVENT = 16;

Description: Constant used to indicate that the table summary has changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new accessible objects representing the table summary. +

ACCESSIBLE_TEXT_EVENT + + + + +

const short ACCESSIBLE_TEXT_EVENT = 17;

Description

Use this id to indicate general text changes, i.e. changes to text + that is exposed through the XAccessibleText and + XAccessibleEditableText interfaces. The affected text + ranges are represented by com::sun::star::awt::Selection structures. The type + of text change is expressed by which of the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields are set + respectively remain empty: +

Insertion: the + AccessibleEventObject::NewValue field specifies the + inserted text after the insertion, the + AccessibleEventObject::OldValue field remains empty.
Deletion: the + AccessibleEventObject::OldValue field specifies the + deleted text before the deletion, the + AccessibleEventObject::NewValue field remains empty.
Update/Replace/Modification: the + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields specify the + modified text before respectively after the modification.
Unknown: when the type of text change or the place where it took + place can not be determined by the event broadcaster then both fields + remain empty. In this case the whole text may have changed and the + listener should refetch the text completely.

When broadcasting an event allways prefer the first three cases + to the last one. Use it only as a last resort.

Text ranges should be as small as possible but, of course, + include all the text that is involved in a modification. That means + that when two or more discontiguous text ranges are inserted, + deleted, or otherwise modified the two fields of the event have to + cover all the effected text ranges as well as the text in + between.

ACCESSIBLE_VALUE_EVENT + + + + +

const short ACCESSIBLE_VALUE_EVENT = 18;

Description: This constant indicates changes of the value of an + XAccessibleValue interface. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue field contain the + old and new value as a number. Its exact type is implementation + dependant but has to be the same as is returned by the + XAccessibleValue::getCurrentValue function. +

ACCESSIBLE_VISIBLE_DATA_EVENT + + + + +

const short ACCESSIBLE_VISIBLE_DATA_EVENT = 19;

Description: A visibile data event indicates the change of the visual appearance + of an accessible object. This includes for example most of the + attributes available over the XAccessibleComponent and + XAccessibleExtendedComponent interfaces. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields are left empty. +

CONTROLLED_BY_EVENT + + + + +

const short CONTROLLED_BY_EVENT = 20;

Description: Identifies the change of a relation set: The target object that is + doing the controlling has changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new controlling objects. +

CONTROLLER_FOR_EVENT + + + + +

const short CONTROLLER_FOR_EVENT = 21;

Description: Identifies the change of a relation set: The controller for the + target object has changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new number of controlled objects. +

LABEL_FOR_EVENT + + + + +

const short LABEL_FOR_EVENT = 22;

Description: Identifies the change of a relation set: The target group for a + label has changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new number labeled objects. +

LABELED_BY_EVENT + + + + +

const short LABELED_BY_EVENT = 23;

Description: Identifies the change of a relation set: The objects that are doing + the labeling have changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new accessible label. +

MEMBER_OF_EVENT + + + + +

const short MEMBER_OF_EVENT = 24;

Description: Identifies the change of a relation set: The group membership has + changed. The + AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain the + old and new number of members. +

CONTENT_FLOWS_FROM_EVENT + + + + +

const short CONTENT_FLOWS_FROM_EVENT = 25;

Description: Identifies the change of a relation set: The content flow has + changed. The AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain + refrences to the old and new predecessor. Note that both references + my be NULL to indicate that a flow to the sending object has not + existed or does not exist anymore. +

CONTENT_FLOWS_TO_EVENT + + + + +

const short CONTENT_FLOWS_TO_EVENT = 26;

Description: Identifies the change of a relation set: The content flow has + changed. The AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue fields contain + refrences to the old and new successor. Note that both references + my be NULL to indicate that a flow from the sending object has not + existed or does not exist anymore. +

ACCESSIBLE_ALL_CHILDREN_CHANGED_EVENT + + + + +

const short ACCESSIBLE_ALL_CHILDREN_CHANGED_EVENT = 27;

Description: Use this event to tell the listeners to re-retrieve the whole set of + children. This should be use by a parent who exchanges all or most + of his children. It is a short from of first sending one + ACCESSIBLE_CHILD_EVENT event for every old child + indicating that this child is about to be removed and then sending + one ACCESSIBLE_CHILD_EVENT for every new child + indicating that this child has been added to the list of children. + +; When this API is used by Java or Gnome AT-Tools then a bridge can + generate the events described above automatically.
+

ACCESSIBLE_BOUNDRECT_EVENT + + + + +

const short ACCESSIBLE_BOUNDRECT_EVENT = 28;

Description

This event indicates a change of the bounding rectangle of an + accessible object with respect only to its size or relative + position. If the absolute position changes but not the relative + position then its is not necessary to send an event. + +

Use this event rather than the + ACCESSIBLE_VISIBLE_DATA_EVENT when really only the + (relative) bounding box of an accessible object has changed. It is + much more specific than the later one and reduces the number of + calls an AT-Tool has to make to retrieve all affected data.

+ +

The AccessibleEventObject::OldValue and + AccessibleEventObject::NewValue remain empty. Use + a call to the XAccessibleComponent::getBounds() + method to determine the new bounding box.

+Top of Page

+ + +

+ + + + + + + + + + + + +

Devguide

+ + + + + + + +

Included Services

Exported Interfaces

Properties' Summary

Properties' Details

+ + + + + + + + + + +

:: drafts :: com :: sun :: star :: accessibility ::

service AccessibleHyperlink

Description

Support this service to represent a group of hyperlinks. + +

The main interface XAccessibleHyperlink relies on the + interface XAccessibleAction for representing the actions + connected with each link. The interfaces give access to different kinds + of information describing the links.

+ +

The XAccessibleHyperlink references text that contais the + represented links. This is reflected by having a + AccessibleHypertext service that supports the + XAccessibleText interface owning and providing accessible + hyperlinks.

+ +

See also

XAccessibleHyperlink,
+ XAccessibleAction, AccessibleHypertext +

+ + + + + + + + + + + + +

Exported Interfaces
XAccessibleHyperlink	+ Implement this interface to represent a hyperlink or a group of + hyperlinks. + +
XAccessibleAction	+ Implement this interface to give access to actions that can be executed + for accessible objects. + +

+
Top of Page

+ + +

+ + + + + + + + + + + + +

Devguide

+ + + + + + + +

Included Services

Exported Interfaces

Properties' Summary

Properties' Details

+ + + + + + + + + + +

:: drafts :: com :: sun :: star :: accessibility ::

service AccessibleHypertext

Description: Support this service to allow access to a hypertext document. + +; A hypertext is a text represented by the XAccessibleText + that contains a set of hyperlinks as represented by the + ::XAccessibleHyperText interface. The hyperlinks themselves + are represented by AccessibleHyperlink services.
+

+ + + + + + + + + + + + +

Exported Interfaces
XAccessibleText	+ Implement this interface to give read-only access to a text. + +
XAccessibleHypertext	+ Implement this interface to expose the hypertext structure of a document. + +

+
Top of Page

+ + +

Elements' Summary
EventId	specifies the type of this event. + +
NewValue	for events that specifies a value change, this is + the new value. + + Depending on the EventId , this can be void. +
OldValue	for events that specifies a value change, this is + the old value. + + Depending on the EventId , this can be void. +