State Class

Header: #include <State>
qmake: QT += gui

Public Functions


Detailed Description

This structure defines bit flags that indicate the state of an accessible object. The values are:

activeThe object is the active window or the active sub-element in a container (that would get focus when focusing the container).
adjustableThe object represents an adjustable value, e.g. sliders.
animatedThe object's appearance changes frequently.
busyThe object cannot accept input at the moment.
checkableThe object is checkable.
checkedThe object's check box is checked.
checkStateMixedThe third state of checkboxes (half checked in tri-state check boxes).
collapsedThe object is collapsed, e.g. a closed listview item, or an iconified window.
defaultButtonThe object represents the default button in a dialog.
defunctThe object no longer exists.
editableThe object has a text carret (and often implements the text interface).
expandableThe object is expandable, mostly used for cells in a tree view.
expandedThe object is expanded, currently its children are visible.
extSelectableThe object supports extended selection.
focusableThe object can receive focus. Only objects in the active window can receive focus.
focusedThe object has keyboard focus.
hasPopupThe object opens a popup.
hotTrackedThe object's appearance is sensitive to the mouse cursor position.
invalidThe object is no longer valid (because it has been deleted).
invalidEntryInput validation current input invalid.
invisibleThe object is not visible to the user.
linkedThe object is linked to another object, e.g. a hyperlink.
marqueedThe object displays scrolling contents, e.g. a log view.
modalThe object blocks input from other objects.
movableThe object can be moved.
multiLineThe object has multiple lines of text (word wrap), as opposed to a single line.
multiSelectableThe object supports multiple selected items.
offscreenThe object is clipped by the visible area. Objects that are off screen are also invisible.
passwordEditThe object is a password field, e.g. a line edit for entering a Password.
playsSoundThe object produces sound when interacted with.
pressedThe object is pressed.
readOnlyThe object can usually be edited, but is explicitly set to read-only.
searchEditThe object is a line edit that is the input for search queries.
selectableThe object is selectable.
selectableTextThe object has text which can be selected. This is different from selectable which refers to the object's children.
selectedThe object is selected, this is independent of text selection.
selfVoicingThe object describes itself through speech or sound.
sizeableThe object can be resized, e.g. top-level windows.
summaryElementThe object summarizes the state of the window and should be treated with priority.
supportsAutoCompletionThe object has auto-completion, for example in line edits or combo boxes.
traversedThe object is linked and has been visited.
updatesFrequentlyThe object changes frequently and needs to be refreshed when accessing it.
disabledThe object is unavailable to the user, e.g. a disabled widget.

Implementations of QAccessibleInterface::state() return a combination of these flags.

Member Function Documentation


Constructs a new QAccessible::State with all states set to false.

© 2016 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.