English:

The Free and Open Productivity Suite
New: Apache OpenOffice 4.1.1 released!

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: 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.

Since
OOo 1.1.2
See also
AccessibleEventObject, XAccessibleEventListener

Constants
NAME_CHANGED 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.  
DESCRIPTION_CHANGED 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.  
ACTION_CHANGED The change of the number or attributes of actions of an accessible object is signaled by events of this type.  
STATE_CHANGED 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.  
ACTIVE_DESCENDANT_CHANGED 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.  
BOUNDRECT_CHANGED 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.  
CHILD 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.  
INVALIDATE_ALL_CHILDREN Use this event to tell the listeners to re-retrieve the whole set of children. This should be used by a parent object which exchanges all or most of its children. It is a short form of first sending one CHILD event for every old child indicating that this child is about to be removed and then sending one CHILD for every new child indicating that this child has been added to the list of children.  
SELECTION_CHANGED Events of this type indicate changes of the selection. The AccessibleEventObject::OldValue and AccessibleEventObject::NewValue fields remain empty.  
VISIBLE_DATA_CHANGED 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.  
VALUE_CHANGED 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.  
CONTENT_FLOWS_FROM_RELATION_CHANGED Identifies the change of a relation set: The content flow has changed.  
CONTENT_FLOWS_TO_RELATION_CHANGED Identifies the change of a relation set: The content flow has changed.  
CONTROLLED_BY_RELATION_CHANGED 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_RELATION_CHANGED 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_RELATION_CHANGED 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_RELATION_CHANGED 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_RELATION_CHANGED 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.  
SUB_WINDOW_OF_RELATION_CHANGED Identifies the change of a relation set: The sub-window-of relation has changed. The AccessibleEventObject::OldValue and AccessibleEventObject::NewValue fields contain the old and new accessible parent window objects.  
CARET_CHANGED 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.  
TEXT_SELECTION_CHANGED Events of this type signal changes of the selection. The old or new selection is not available through the event object. You have to query the XAccessibleText interface of the event source for this information. The type of content of the AccessibleEventObject::OldValue and AccessibleEventObject::NewValue fields is not specified at the moment. This may change in the future.  
TEXT_CHANGED Use this id to indicate general text changes, i.e. changes to text that is exposed through the XAccessibleText and XAccessibleEditableText interfaces.  
TEXT_ATTRIBUTE_CHANGED This entry is reserved for future extension. Don't use it right now.  
HYPERTEXT_CHANGED 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.  
TABLE_CAPTION_CHANGED 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.  
TABLE_COLUMN_DESCRIPTION_CHANGED Constant used to indicate that the column description has changed. The AccessibleEventObject::NewValue field contains the column index. The AccessibleEventObject::OldValue is left empty.  
TABLE_COLUMN_HEADER_CHANGED 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.  
TABLE_MODEL_CHANGED 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.  
TABLE_ROW_DESCRIPTION_CHANGED Constant used to indicate that the row description has changed. The AccessibleEventObject::NewValue field contains the row index. The AccessibleEventObject::OldValue is left empty.  
TABLE_ROW_HEADER_CHANGED 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.  
TABLE_SUMMARY_CHANGED 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.  
LISTBOX_ENTRY_EXPANDED Constant used to indicate that a list box entry has been expanded. AccessibleEventObject::OldValue is empty. AccessibleEventObject::NewValue contains the expanded list box entry.  
LISTBOX_ENTRY_COLLAPSED Constant used to indicate that a list box entry has been collapsed. AccessibleEventObject::OldValue is empty. AccessibleEventObject::NewValue contains the collapsed list box entry.  
Constants' Details
NAME_CHANGED
const short NAME_CHANGED = 1;
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.
DESCRIPTION_CHANGED
const short DESCRIPTION_CHANGED = 2;
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.
ACTION_CHANGED
const short ACTION_CHANGED = 3;
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.

STATE_CHANGED
const short STATE_CHANGED = 4;
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.
ACTIVE_DESCENDANT_CHANGED
const short ACTIVE_DESCENDANT_CHANGED = 5;
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.
BOUNDRECT_CHANGED
const short BOUNDRECT_CHANGED = 6;
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 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.

CHILD
const short CHILD = 7;
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.

INVALIDATE_ALL_CHILDREN
const short INVALIDATE_ALL_CHILDREN = 8;
Description
Use this event to tell the listeners to re-retrieve the whole set of children. This should be used by a parent object which exchanges all or most of its children. It is a short form of first sending one CHILD event for every old child indicating that this child is about to be removed and then sending one CHILD 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.

SELECTION_CHANGED
const short SELECTION_CHANGED = 9;
Description
Events of this type indicate changes of the selection. The AccessibleEventObject::OldValue and AccessibleEventObject::NewValue fields remain empty.
VISIBLE_DATA_CHANGED
const short VISIBLE_DATA_CHANGED = 10;
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.
VALUE_CHANGED
const short VALUE_CHANGED = 11;
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.
CONTENT_FLOWS_FROM_RELATION_CHANGED
const short CONTENT_FLOWS_FROM_RELATION_CHANGED = 12;
Description
Identifies the change of a relation set: The content flow has changed.

Not used: 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_RELATION_CHANGED
const short CONTENT_FLOWS_TO_RELATION_CHANGED = 13;
Description
Identifies the change of a relation set: The content flow has changed.

Not used: 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.

CONTROLLED_BY_RELATION_CHANGED
const short CONTROLLED_BY_RELATION_CHANGED = 14;
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_RELATION_CHANGED
const short CONTROLLER_FOR_RELATION_CHANGED = 15;
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_RELATION_CHANGED
const short LABEL_FOR_RELATION_CHANGED = 16;
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_RELATION_CHANGED
const short LABELED_BY_RELATION_CHANGED = 17;
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_RELATION_CHANGED
const short MEMBER_OF_RELATION_CHANGED = 18;
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.
SUB_WINDOW_OF_RELATION_CHANGED
const short SUB_WINDOW_OF_RELATION_CHANGED = 19;
Description
Identifies the change of a relation set: The sub-window-of relation has changed. The AccessibleEventObject::OldValue and AccessibleEventObject::NewValue fields contain the old and new accessible parent window objects.
CARET_CHANGED
const short CARET_CHANGED = 20;
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.
TEXT_SELECTION_CHANGED
const short TEXT_SELECTION_CHANGED = 21;
Description
Events of this type signal changes of the selection. The old or new selection is not available through the event object. You have to query the XAccessibleText interface of the event source for this information. The type of content of the AccessibleEventObject::OldValue and AccessibleEventObject::NewValue fields is not specified at the moment. This may change in the future.
TEXT_CHANGED
const short TEXT_CHANGED = 22;
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 TextSegment structures.

The content of the AccessibleEventObject::OldValue and AccessibleEventObject::NewValue expresses the type of text change:

  • 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.

TEXT_ATTRIBUTE_CHANGED
const short TEXT_ATTRIBUTE_CHANGED = 23;
Description
This entry is reserved for future extension. Don't use it right now.
HYPERTEXT_CHANGED
const short HYPERTEXT_CHANGED = 24;
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.
TABLE_CAPTION_CHANGED
const short TABLE_CAPTION_CHANGED = 25;
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.
TABLE_COLUMN_DESCRIPTION_CHANGED
const short TABLE_COLUMN_DESCRIPTION_CHANGED = 26;
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.
TABLE_COLUMN_HEADER_CHANGED
const short TABLE_COLUMN_HEADER_CHANGED = 27;
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.
TABLE_MODEL_CHANGED
const short TABLE_MODEL_CHANGED = 28;
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.
TABLE_ROW_DESCRIPTION_CHANGED
const short TABLE_ROW_DESCRIPTION_CHANGED = 29;
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.
TABLE_ROW_HEADER_CHANGED
const short TABLE_ROW_HEADER_CHANGED = 30;
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.
TABLE_SUMMARY_CHANGED
const short TABLE_SUMMARY_CHANGED = 31;
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.
LISTBOX_ENTRY_EXPANDED
const short LISTBOX_ENTRY_EXPANDED = 32;
Description
Constant used to indicate that a list box entry has been expanded. AccessibleEventObject::OldValue is empty. AccessibleEventObject::NewValue contains the expanded list box entry.
Since
OOo 3.2
LISTBOX_ENTRY_COLLAPSED
const short LISTBOX_ENTRY_COLLAPSED = 33;
Description
Constant used to indicate that a list box entry has been collapsed. AccessibleEventObject::OldValue is empty. AccessibleEventObject::NewValue contains the collapsed list box entry.
Since
OOo 3.2
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.