Doc: Added some details to the accessibility events API documentation.

Reviewed-by: Frederik Gladhorn
This commit is contained in:
David Boddie 2011-05-19 14:26:36 +02:00
parent be2b27824a
commit 122d206087

View File

@ -212,42 +212,101 @@ QT_BEGIN_NAMESPACE
This enum type defines accessible event types. This enum type defines accessible event types.
\value AcceleratorChanged \value AcceleratorChanged The keyboard accelerator for an action has been changed.
\value Alert A system alert (e.g., a message from a QMessageBox) \value ActionChanged An action has been changed.
\value ContextHelpEnd Context help (QWhatsThis) for an object is finished. \value ActiveDescendantChanged
\value ContextHelpStart Context help (QWhatsThis) for an object is initiated. \value Alert A system alert (e.g., a message from a QMessageBox)
\value DefaultActionChanged The default QAccessible::Action for the accessible object changed \value AttributeChanged
\value DescriptionChanged The objects QAccessible::Description changed. \value ContextHelpEnd Context help (QWhatsThis) for an object is finished.
\value DialogEnd A dialog (QDialog) is been hidden \value ContextHelpStart Context help (QWhatsThis) for an object is initiated.
\value DialogStart A dialog (QDialog) has been set visible. \value DefaultActionChanged The default QAccessible::Action for the accessible
\value DragDropEnd A Drag & Drop operation is about to finished. object has changed.
\value DragDropStart A Drag & Drop operation is about to be initiated. \value DescriptionChanged The object's QAccessible::Description changed.
\value Focus An object has gained keyboard focus. \value DialogEnd A dialog (QDialog) has been hidden
\value ForegroundChanged A window has been activated (i.e., a new window has gained focus on the desktop) \value DialogStart A dialog (QDialog) has been set visible.
\value HelpChanged The QAccessible::Help text property of an object has changed \value DocumentContentChanged The contents of a text document have changed.
\value LocationChanged An objects location on the screen changed \value DocumentLoadComplete A document has been loaded.
\value MenuCommand A menu item is triggered. \value DocumentLoadStopped A document load has been stopped.
\value MenuEnd A menu has been closed (Qt uses PopupMenuEnd for all menus) \value DocumentReload A document reload has been initiated.
\value MenuStart A menu has been opened on the menubar (Qt uses PopupMenuStart for all menus) \value DragDropEnd A drag and drop operation is about to finished.
\value NameChanged The QAccessible::Name property of an object has changed \value DragDropStart A drag and drop operation is about to be initiated.
\value ObjectCreated A new object is created. \value Focus An object has gained keyboard focus.
\value ObjectDestroyed An object is deleted. \value ForegroundChanged A window has been activated (i.e., a new window has
\value ObjectHide An object is hidden (i.e., with QWidget::hide()). Any children the object that is hidden has do not send this event. gained focus on the desktop).
It is not send when an object is hidden as it is being obcured by others. \value HelpChanged The QAccessible::Help text property of an object has
\value ObjectReorder A layout or item view has added, removed, or moved an object (Qt does not use this event). changed.
\value ObjectShow An object is displayed (i.e., with QWidget::show()). \value HyperlinkEndIndexChanged The end position of the display text for a hypertext
\value ParentChanged An objects parent object changed. link has changed.
\value PopupMenuEnd A popup menu has closed. \value HyperlinkNumberOfAnchorsChanged The number of anchors in a hypertext link has changed,
\value PopupMenuStart A popupmenu has opened. perhaps because the display text has been split to
\value ScrollingEnd A scrollbar scroll operation has ended (the mouse has released the slider handle) provide more than one link.
\value ScrollingStart A scrollbar scroll operation is about to start (i.e., the mouse has pressed on the slider handle) \value HyperlinkSelectedLinkChanged The link for the selected hypertext link has changed.
\value Selection The selection has changed in a menu or item view. \value HyperlinkStartIndexChanged The start position of the display text for a hypertext
\value SelectionAdd An item has been added to the selection in an item view. link has changed.
\value SelectionRemove An item has been removed from an item view selection. \value HypertextChanged The display text for a hypertext link has changed.
\value SelectionWithin Several changes to a selection has occurred in an item view. \value HypertextLinkActivated A hypertext link has been activated, perhaps by being
\value SoundPlayed A sound has been played by an object clicked or via a key press.
\value StateChanged The QAccessible::State of an object has changed. \value HypertextLinkSelected A hypertext link has been selected.
\value ValueChanged The QAccessible::Value of an object has changed. \value HypertextNLinksChanged
\value LocationChanged An object's location on the screen has changed.
\value MenuCommand A menu item is triggered.
\value MenuEnd A menu has been closed (Qt uses PopupMenuEnd for all
menus).
\value MenuStart A menu has been opened on the menubar (Qt uses
PopupMenuStart for all menus).
\value NameChanged The QAccessible::Name property of an object has changed.
\value ObjectAttributeChanged
\value ObjectCreated A new object is created.
\value ObjectDestroyed An object is deleted.
\value ObjectHide An object is hidden; for example, with QWidget::hide().
Any children the object that is hidden has do not send
this event. It is not sent when an object is hidden as
it is being obcured by others.
\value ObjectReorder A layout or item view has added, removed, or moved an
object (Qt does not use this event).
\value ObjectShow An object is displayed; for example, with
QWidget::show().
\value PageChanged
\value ParentChanged An object's parent object changed.
\value PopupMenuEnd A pop-up menu has closed.
\value PopupMenuStart A pop-up menu has opened.
\value ScrollingEnd A scrollbar scroll operation has ended (the mouse has
released the slider handle).
\value ScrollingStart A scrollbar scroll operation is about to start; this may
be caused by a mouse press on the slider handle, for
example.
\value SectionChanged
\value SelectionAdd An item has been added to the selection in an item view.
\value SelectionRemove An item has been removed from an item view selection.
\value Selection The selection has changed in a menu or item view.
\value SelectionWithin Several changes to a selection has occurred in an item
view.
\value SoundPlayed A sound has been played by an object
\value StateChanged The QAccessible::State of an object has changed.
\value TableCaptionChanged A table caption has been changed.
\value TableColumnDescriptionChanged The description of a table column, typically found in
the column's header, has been changed.
\value TableColumnHeaderChanged A table column header has been changed.
\value TableModelChanged The model providing data for a table has been changed.
\value TableRowDescriptionChanged The description of a table row, typically found in the
row's header, has been changed.
\value TableRowHeaderChanged A table row header has been changed.
\value TableSummaryChanged The summary of a table has been changed.
\value TextAttributeChanged
\value TextCaretMoved The caret has moved in an editable widget.
The caret represents the cursor position in an editable
widget with the input focus.
\value TextColumnChanged A text column has been changed.
\value TextInserted Text has been inserted into an editable widget.
\value TextRemoved Text has been removed from an editable widget.
\value TextSelectionChanged The selected text has changed in an editable widget.
\value TextUpdated The text has been update in an editable widget.
\value ValueChanged The QAccessible::Value of an object has changed.
\value VisibleDataChanged
The values for this enum are defined to be the same as those defined in the
\l{AccessibleEventID.idl File Reference}{IAccessible2} and
\l{Microsoft Active Accessibility Event Constants}{MSAA} specifications.
*/ */
/*! /*!