summaryrefslogtreecommitdiff
path: root/offapi
diff options
context:
space:
mode:
authorNiklas Johansson <sleeping.pillow@gmail.com>2015-01-21 19:18:01 +0100
committerCaolán McNamara <caolanm@redhat.com>2015-01-23 15:28:07 +0000
commitfcecc1fcb4a971a08d1e1fa5767bc5d93393a504 (patch)
tree505d730e0728547890d45fb00dbadc107c185b04 /offapi
parente753d31d5d2338da35b69b0a3b7742420c7562d2 (diff)
Document some accessible events in AccessibleEventId.idl
Add some documentation to a few undocumented functions. I'm a bit unsure of ACTIVE_DECENDANT_CHANGED_NOFOCUS but to me it seems to be a work around for windows that maps ACTIVE_DECENDANT_CHANGED to event object focus. See the note for IA2_EVENT_ACTIVE_DESCENDANT_CHANGED in the IA2 documentation: http://accessibility.linuxfoundation.org/a11yspecs/ia2/docs/html/_accessible_event_i_d_8idl.html#ae26846b6d521727ab696d20c3f43c0b5ac1379bc85d7afda57be018a7a44dc918 Change-Id: I99afc804731ad62e95c013682dc605abfc382646 Reviewed-on: https://gerrit.libreoffice.org/14137 Reviewed-by: Caolán McNamara <caolanm@redhat.com> Tested-by: Caolán McNamara <caolanm@redhat.com>
Diffstat (limited to 'offapi')
-rw-r--r--offapi/com/sun/star/accessibility/AccessibleEventId.idl64
1 files changed, 58 insertions, 6 deletions
diff --git a/offapi/com/sun/star/accessibility/AccessibleEventId.idl b/offapi/com/sun/star/accessibility/AccessibleEventId.idl
index 20d0d0553e58..741e55c38c78 100644
--- a/offapi/com/sun/star/accessibility/AccessibleEventId.idl
+++ b/offapi/com/sun/star/accessibility/AccessibleEventId.idl
@@ -373,13 +373,65 @@ constants AccessibleEventId
*/
const short LISTBOX_ENTRY_COLLAPSED = 33;
+ /** Constant used to determine when the active descendant of a component
+ has been removed but unlike ACTIVE_DECENDANT_CHANGED the decendant
+ that is to be removed does not have focus. The active descendant
+ is used in objects with transient children.
+
+ <p>AccessibleEventObject::OldValue contains the item to be removed.</p>
+ <p>AccessibleEventObject::NewValue is empty.</p>
+
+ @since LibreOffice 4.3
+ */
const short ACTIVE_DESCENDANT_CHANGED_NOFOCUS = 34;
- const short SELECTION_CHANGED_ADD =35;
- const short SELECTION_CHANGED_REMOVE =36;
- const short SELECTION_CHANGED_WITHIN =37;
- const short PAGE_CHANGED =38;
- const short SECTION_CHANGED =39;
- const short COLUMN_CHANGED =40;
+
+ /** An item in a container has been added to a already present selection
+
+ Example: a second list item has been selected in a listbox.
+
+ <p>AccessibleEventObject::OldValue is empty.</p>
+ <p>AccessibleEventObject::NewValue contains the item to be added.</p>
+
+ @since LibreOffice 4.3
+ */
+ const short SELECTION_CHANGED_ADD = 35;
+
+ /** An item in a container has been removed from the selection.
+
+ <p>AccessibleEventObject::OldValue contains the item to be removed.</p>
+ <p>AccessibleEventObject::NewValue is empty.</p>
+
+ @since LibreOffice 4.3
+ */
+ const short SELECTION_CHANGED_REMOVE = 36;
+
+ /** Multiple items in a container object have been added or removed
+ from the selection.
+
+ <p>AccessibleEventObject::OldValue and
+ AccessibleEventObject::NewValue is empty.</p>
+
+ @since LibreOffice 4.3
+ */
+ const short SELECTION_CHANGED_WITHIN = 37;
+
+ /** A change of page or slide.
+
+ @since LibreOffice 4.3
+ */
+ const short PAGE_CHANGED = 38;
+
+ /** The cursor has moved to/from a section
+
+ @since LibreOffice 4.3
+ */
+ const short SECTION_CHANGED = 39;
+
+ /** The cursor has moved to/from a section
+
+ @since LibreOffice 4.3
+ */
+ const short COLUMN_CHANGED = 40;
/** Constant used to indicate that the role of an accessible object has
changed.