A11yStateHolder

Since: BlackBerry 10.2.0

#include <bb/cascades/A11yStateHolder>

Holds the state of an accessibility object.

The state is represented by the properties of this object.


Overview

Inheritance

bb::cascades::BaseObject
bb::cascades::A11yStateHolder

QML properties

active: bool
animated: bool
busy: bool
checkable: bool
checked: bool
defaultControl: bool
defunct: bool
disabled: bool
expandable: bool
expanded: bool
focusable: bool
focused: bool
hasPopup: bool
hidden: bool
iconified: bool
invalid: bool
managedChild: bool
managesDescendants: bool
mixed: bool
modal: bool
multiLine: bool
multiSelectable: bool
offScreen: bool
orientationHorizontal: bool
orientationVertical: bool
passwordProtected: bool
pinned: bool
readOnly: bool
required: bool
selectable: bool
selectableText: bool
selected: bool
supportsAutocompletion: bool
truncated: bool
visited: bool
objectName: QStringInherited
parent: QObject [read-only]Inherited

Public Functions Index

boolhasPopup () const
boolisActive () const
boolisAnimated () const
boolisBusy () const
boolisCheckable () const
boolisChecked () const
boolisDefaultControl () const
boolisDefunct () const
boolisDisabled () const
boolisExpandable () const
boolisExpanded () const
boolisFocusable () const
boolisFocused () const
boolisHidden () const
boolisIconified () const
boolisInvalid () const
boolisManagedChild () const
boolisMixed () const
boolisModal () const
boolisMultiLine () const
boolisMultiSelectable () const
boolisOffScreen () const
boolisOrientationHorizontal () const
boolisOrientationVertical () const
boolisPasswordProtected () const
boolisPinned () const
boolisReadOnly () const
boolisRequired () const
boolisSelectable () const
boolisSelectableText () const
boolisSelected () const
Q_INVOKABLE boolisStateSet (bb::cascades::A11yState::Type state) const
boolisTruncated () const
boolisVisited () const
boolmanagesDescendants () const
Q_SLOT voidresetActive ()
Q_SLOT voidresetAnimated ()
Q_SLOT voidresetBusy ()
Q_SLOT voidresetCheckable ()
Q_SLOT voidresetChecked ()
Q_SLOT voidresetDefaultControl ()
Q_SLOT voidresetDefunct ()
Q_SLOT voidresetDisabled ()
Q_SLOT voidresetExpandable ()
Q_SLOT voidresetExpanded ()
Q_SLOT voidresetFocusable ()
Q_SLOT voidresetFocused ()
Q_SLOT voidresetHasPopup ()
Q_SLOT voidresetHidden ()
Q_SLOT voidresetIconified ()
Q_SLOT voidresetInvalid ()
Q_SLOT voidresetManagedChild ()
Q_SLOT voidresetManagesDescendants ()
Q_SLOT voidresetMixed ()
Q_SLOT voidresetModal ()
Q_SLOT voidresetMultiLine ()
Q_SLOT voidresetMultiSelectable ()
Q_SLOT voidresetOffScreen ()
Q_SLOT voidresetOrientationHorizontal ()
Q_SLOT voidresetOrientationVertical ()
Q_SLOT voidresetPasswordProtected ()
Q_SLOT voidresetPinned ()
Q_SLOT voidresetReadOnly ()
Q_SLOT voidresetRequired ()
Q_SLOT voidresetSelectable ()
Q_SLOT voidresetSelectableText ()
Q_SLOT voidresetSelected ()
Q_SLOT voidresetSupportsAutocompletion ()
Q_SLOT voidresetTruncated ()
Q_SLOT voidresetVisited ()
Q_SLOT voidsetActive (bool active)
Q_SLOT voidsetAnimated (bool animated)
Q_SLOT voidsetBusy (bool busy)
Q_SLOT voidsetCheckable (bool checkable)
Q_SLOT voidsetChecked (bool checked)
Q_SLOT voidsetDefaultControl (bool defaultControl)
Q_SLOT voidsetDefunct (bool defunct)
Q_SLOT voidsetDisabled (bool disabled)
Q_SLOT voidsetExpandable (bool expandable)
Q_SLOT voidsetExpanded (bool expanded)
Q_SLOT voidsetFocusable (bool focusable)
Q_SLOT voidsetFocused (bool focused)
Q_SLOT voidsetHasPopup (bool hasPopup)
Q_SLOT voidsetHidden (bool hidden)
Q_SLOT voidsetIconified (bool iconified)
Q_SLOT voidsetInvalid (bool invalid)
Q_SLOT voidsetManagedChild (bool managedChild)
Q_SLOT voidsetManagesDescendants (bool managesDescendants)
Q_SLOT voidsetMixed (bool mixed)
Q_SLOT voidsetModal (bool modal)
Q_SLOT voidsetMultiLine (bool multiLine)
Q_SLOT voidsetMultiSelectable (bool multiSelectable)
Q_SLOT voidsetOffScreen (bool offScreen)
Q_SLOT voidsetOrientationHorizontal (bool orientationHorizontal)
Q_SLOT voidsetOrientationVertical (bool orientationVertical)
Q_SLOT voidsetPasswordProtected (bool passwordProtected)
Q_SLOT voidsetPinned (bool pinned)
Q_SLOT voidsetReadOnly (bool readOnly)
Q_SLOT voidsetRequired (bool required)
Q_SLOT voidsetSelectable (bool selectable)
Q_SLOT voidsetSelectableText (bool selectableText)
Q_SLOT voidsetSelected (bool selected)
Q_INVOKABLE voidsetState (bb::cascades::A11yState::Type state, bool value)
Q_SLOT voidsetSupportsAutocompletion (bool supportsAutocompletion)
Q_SLOT voidsetTruncated (bool truncated)
Q_SLOT voidsetVisited (bool visited)
boolsupportsAutocompletion () const
voidsetObjectName (const QString &name)Inherited
virtual Q_INVOKABLE QStringtoDebugString () const Inherited

Protected Functions Index

Only has inherited protected functions

BaseObject (QObject *parent=0)Inherited

Signals Index

voidactiveChanged (bool active)
voidanimatedChanged (bool animated)
voidbusyChanged (bool busy)
voidcheckableChanged (bool checkable)
voidcheckedChanged (bool checked)
voiddefaultControlChanged (bool defaultControl)
voiddefunctChanged (bool defunct)
voiddisabledChanged (bool disabled)
voidexpandableChanged (bool expandable)
voidexpandedChanged (bool expanded)
voidfocusableChanged (bool focusable)
voidfocusedChanged (bool focused)
voidhasPopupChanged (bool hasPopup)
voidhiddenChanged (bool hidden)
voidiconifiedChanged (bool iconified)
voidinvalidChanged (bool invalid)
voidmanagedChildChanged (bool managedChild)
voidmanagesDescendantsChanged (bool managesDescendants)
voidmixedChanged (bool mixed)
voidmodalChanged (bool modal)
voidmultiLineChanged (bool multiLine)
voidmultiSelectableChanged (bool multiSelectable)
voidoffScreenChanged (bool offScreen)
voidorientationHorizontalChanged (bool orientationHorizontal)
voidorientationVerticalChanged (bool orientationVertical)
voidpasswordProtectedChanged (bool passwordProtected)
voidpinnedChanged (bool pinned)
voidreadOnlyChanged (bool readOnly)
voidrequiredChanged (bool required)
voidselectableChanged (bool selectable)
voidselectableTextChanged (bool selectableText)
voidselectedChanged (bool selected)
voidstateChanged (bb::cascades::A11yState::Type state, bool value)
voidsupportsAutocompletionChanged (bool supportsAutocompletion)
voidtruncatedChanged (bool truncated)
voidvisitedChanged (bool visited)
voidcreationCompleted ()Inherited
voidobjectNameChanged (const QString &objectName)Inherited

Properties

bool active

Specifies whether the accessible object is currently in the A11yState::Active state.

Since:

BlackBerry 10.2.0

bool animated

Specifies whether the accessible object is currently in the A11yState::Animated state.

Since:

BlackBerry 10.2.0

bool busy

Specifies whether the accessible object is currently in the A11yState::Busy state.

Since:

BlackBerry 10.2.0

bool checkable

Specifies whether the accessible object is currently in the A11yState::Checkable state.

Since:

BlackBerry 10.2.0

bool checked

Specifies whether the accessible object is currently in the A11yState::Checked state.

Since:

BlackBerry 10.2.0

bool defaultControl

Specifies whether the accessible object is currently in the A11yState::DefaultControl state.

Since:

BlackBerry 10.2.0

bool defunct

Specifies whether the accessible object is currently in the A11yState::Defunct state.

Since:

BlackBerry 10.2.0

bool disabled

Specifies whether the accessible object is currently in the A11yState::Disabled state.

Since:

BlackBerry 10.2.0

bool expandable

Specifies whether the accessible object is currently in the A11yState::Expandable state.

Since:

BlackBerry 10.2.0

bool expanded

Specifies whether the accessible object is currently in the A11yState::Expanded state.

Since:

BlackBerry 10.2.0

bool focusable

Specifies whether the accessible object is currently in the A11yState::Focusable state.

Since:

BlackBerry 10.2.0

bool focused

Specifies whether the accessible object is currently in the A11yState::Focused state.

Since:

BlackBerry 10.2.0

bool hasPopup

Specifies whether the accessible object is currently in the A11yState::Haspopup state.

Since:

BlackBerry 10.2.0

bool hidden

Specifies whether the accessible object is currently in the A11yState::Hidden state.

Since:

BlackBerry 10.2.0

bool iconified

Specifies whether the accessible object is currently in the A11yState::Iconified state.

Since:

BlackBerry 10.2.0

bool invalid

Specifies whether the accessible object is currently in the A11yState::Invalid state.

Since:

BlackBerry 10.2.0

bool managedChild

Specifies whether the accessible object is currently in the A11yState::ManagedChild state.

Since:

BlackBerry 10.2.0

bool managesDescendants

Specifies whether the accessible object is currently in the A11yState::ManagesDescendants state.

Since:

BlackBerry 10.2.0

bool mixed

Specifies whether the accessible object is currently in the A11yState::Mixed state.

Since:

BlackBerry 10.2.0

bool modal

Specifies whether the accessible object is currently in the A11yState::Modal state.

Since:

BlackBerry 10.2.0

bool multiLine

Specifies whether the accessible object is currently in the A11yState::MultiLine state.

Since:

BlackBerry 10.2.0

bool multiSelectable

Specifies whether the accessible object is currently in the A11yState::MultiSelectable state.

Since:

BlackBerry 10.2.0

bool offScreen

Specifies whether the accessible object is currently in the A11yState::OffScreen state.

Since:

BlackBerry 10.2.0

bool orientationHorizontal

Specifies whether the accessible object is currently in the A11yState::OrientationHorizontal state.

Since:

BlackBerry 10.2.0

bool orientationVertical

Specifies whether the accessible object is currently in the A11yState::OrientationVertical state.

Since:

BlackBerry 10.2.0

bool passwordProtected

Specifies whether the accessible object is currently in the A11yState::PasswordProtected state.

Since:

BlackBerry 10.2.0

bool pinned

Specifies whether the accessible object is currently in the A11yState::Pinned state.

Since:

BlackBerry 10.2.0

bool readOnly

Specifies whether the accessible object is currently in the A11yState::ReadOnly state.

Since:

BlackBerry 10.2.0

bool required

Specifies whether the accessible object is currently in the A11yState::Required state.

Since:

BlackBerry 10.2.0

bool selectable

Specifies whether the accessible object is currently in the A11yState::Selectable state.

Since:

BlackBerry 10.2.0

bool selectableText

Specifies whether the accessible object is currently in the A11yState::SelectableText state.

Since:

BlackBerry 10.2.0

bool selected

Specifies whether the accessible object is currently in the A11yState::Selected state.

Since:

BlackBerry 10.2.0

bool supportsAutocompletion

Specifies whether the accessible object is currently in the A11yState::SupportsAutocompletion state.

Since:

BlackBerry 10.2.0

bool truncated

Specifies whether the accessible object is currently in the A11yState::Truncated state.

Since:

BlackBerry 10.2.0

bool visited

Specifies whether the accessible object is currently in the A11yState::Visited state.

Since:

BlackBerry 10.2.0

QString objectNameInherited

This property is overridden from QObject.

See also:

QObject::objectName().

Since:

BlackBerry 10.0.0

QObject parentInherited[read-only]

A read-only property that represents this object's parent.

The parent of an object is specified using QObject::setParent(QObject*). The purpose of the property is to expose the object's parent to QML.

This property is read-only to prevent modifications from QML, where typically the parent is declaratively set. In C++ code, the parent can be explicitly set using QObject::setParent(QObject*), or implicitly set by adding it to a visual container.

The default value of this property is 0.

Since:

BlackBerry 10.0.0

Public Functions

bool hasPopup ()

Indicates whether the object is in the A11yState::HasPopup state, or not.

Return:

true if the accessible object is in A11yState::HasPopup state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isActive ()

Indicates whether the object is in the A11yState::Active state, or not.

Return:

true if the accessible object is in A11yState::Active state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isAnimated ()

Indicates whether the object is in the A11yState::Animated state, or not.

Return:

true if the accessible object is in A11yState::Animated state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isBusy ()

Indicates whether the object is in the A11yState::Busy state, or not.

Return:

true if the accessible object is in A11yState::Busy state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isCheckable ()

Indicates whether the object is in the A11yState::Checkable state, or not.

Return:

true if the accessible object is in A11yState::Checkable state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isChecked ()

Indicates whether the object is in the A11yState::Checked state, or not.

Return:

true if the accessible object is in A11yState::Checked state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isDefaultControl ()

Indicates whether the object is in the A11yState::DefaultControl state, or not.

Return:

true if the accessible object is in A11yState::DefaultControl state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isDefunct ()

Indicates whether the object is in the A11yState::Defunct state, or not.

Return:

true if the accessible object is in A11yState::Defunct state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isDisabled ()

Indicates whether the object is in the A11yState::Disabled state, or not.

Return:

true if the accessible object is in A11yState::Disabled state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isExpandable ()

Indicates whether the object is in the A11yState::Expandable state, or not.

Return:

true if the accessible object is in A11yState::Expandable state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isExpanded ()

Indicates whether the object is in the A11yState::Expanded state, or not.

Return:

true if the accessible object is in A11yState::Expanded state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isFocusable ()

Indicates whether the object is in the A11yState::Focusable state, or not.

Return:

true if the accessible object is in A11yState::Focusable state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isFocused ()

Indicates whether the object is in the A11yState::Focused state, or not.

Return:

true if the accessible object is in A11yState::Focused state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isHidden ()

Indicates whether the object is in the A11yState::Hidden state, or not.

Return:

true if the accessible object is in A11yState::Hidden state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isIconified ()

Indicates whether the object is in the A11yState::Iconified state, or not.

Return:

true if the accessible object is in A11yState::Iconified state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isInvalid ()

Indicates whether the object is in the A11yState::Invalid state, or not.

Return:

true if the accessible object is in A11yState::Invalid state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isManagedChild ()

Indicates whether the object is in the A11yState::ManagedChild state, or not.

Return:

true if the accessible object is in A11yState::ManagedChild state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isMixed ()

Indicates whether the object is in the A11yState::Mixed state, or not.

Return:

true if the accessible object is in A11yState::Mixed state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isModal ()

Indicates whether the object is in the A11yState::Modal state, or not.

Return:

true if the accessible object is in A11yState::Modal state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isMultiLine ()

Indicates whether the object is in the A11yState::MultiLine state, or not.

Return:

true if the accessible object is in A11yState::MultiLine state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isMultiSelectable ()

Indicates whether the object is in the A11yState::MultiSelectable state, or not.

Return:

true if the accessible object is in A11yState::MultiSelectable state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isOffScreen ()

Indicates whether the object is in the A11yState::OffScreen state, or not.

Return:

true if the accessible object is in A11yState::OffScreen state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isOrientationHorizontal ()

Indicates whether the object is in the A11yState::OrientationHorizontal state, or not.

Return:

true if the accessible object is in A11yState::OrientationHorizontal state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isOrientationVertical ()

Indicates whether the object is in the A11yState::OrientationVertical state, or not.

Return:

true if the accessible object is in A11yState::OrientationVertical state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isPasswordProtected ()

Indicates whether the object is in the A11yState::PasswordProtected state, or not.

Return:

true if the accessible object is in A11yState::PasswordProtected state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isPinned ()

Indicates whether the object is in the A11yState::Pinned state, or not.

Return:

true if the accessible object is in A11yState::Pinned state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isReadOnly ()

Indicates whether the object is in the A11yState::ReadOnly state, or not.

Return:

true if the accessible object is in A11yState::ReadOnly state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isRequired ()

Indicates whether the object is in the A11yState::Required state, or not.

Return:

true if the accessible object is in A11yState::Required state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isSelectable ()

Indicates whether the object is in the A11yState::Selectable state, or not.

Return:

true if the accessible object is in A11yState::Selectable state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isSelectableText ()

Indicates whether the object is in the A11yState::SelectableText state, or not.

Return:

true if the accessible object is in A11yState::SelectableText state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isSelected ()

Indicates whether the object is in the A11yState::Selected state, or not.

Return:

true if the accessible object is in A11yState::Selected state, and false otherwise.

Since:

BlackBerry 10.2.0

Q_INVOKABLE bool isStateSet (

Indicates whether a particular state is set.

Parameters
state

The type of the state to get.

Return:

true if the state is set, and false otherwise.

Since:

BlackBerry 10.2.0

bool isTruncated ()

Indicates whether the object is in the A11yState::Truncated state, or not.

Return:

true if the accessible object is in A11yState::Truncated state, and false otherwise.

Since:

BlackBerry 10.2.0

bool isVisited ()

Indicates whether the object is in the A11yState::Visited state, or not.

Return:

true if the accessible object is in A11yState::Visited state, and false otherwise.

Since:

BlackBerry 10.2.0

bool managesDescendants ()

Indicates whether the object is in the A11yState::ManagesDescendants state, or not.

Return:

true if the accessible object is in A11yState::ManagesDescendants state, and false otherwise.

Since:

BlackBerry 10.2.0

Q_SLOT void resetActive ()

Resets the A11yState::Active state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetAnimated ()

Resets the A11yState::Animated state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetBusy ()

Resets the A11yState::Busy state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetCheckable ()

Resets the A11yState::Checkable state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetChecked ()

Resets the A11yState::Checked state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetDefaultControl ()

Resets the A11yState::DefaultControl state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetDefunct ()

Resets the A11yState::Defunct state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetDisabled ()

Resets the A11yState::Disabled state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetExpandable ()

Resets the A11yState::Expandable state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetExpanded ()

Resets the A11yState::Expanded state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetFocusable ()

Resets the A11yState::Focusable state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetFocused ()

Resets the A11yState::Focused state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetHasPopup ()

Resets the A11yState::HasPopup state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetHidden ()

Resets the A11yState::Hidden state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetIconified ()

Resets the A11yState::Iconified state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetInvalid ()

Resets the A11yState::Invalid state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetManagedChild ()

Resets the A11yState::ManagedChild state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetManagesDescendants ()

Resets the A11yState::ManagesDescendants state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetMixed ()

Resets the A11yState::Mixed state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetModal ()

Resets the A11yState::Modal state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetMultiLine ()

Resets the A11yState::MultiLine state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetMultiSelectable ()

Resets the A11yState::MultiSelectable state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetOffScreen ()

Resets the A11yState::OffScreen state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetOrientationHorizontal ()

Resets the A11yState::OrientationHorizontal state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetOrientationVertical ()

Resets the A11yState::OrientationVertical state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetPasswordProtected ()

Resets the A11yState::PasswordProtected state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetPinned ()

Resets the A11yState::Pinned state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetReadOnly ()

Resets the A11yState::ReadOnly state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetRequired ()

Resets the A11yState::Required state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetSelectable ()

Resets the A11yState::Selectable state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetSelectableText ()

Resets the A11yState::SelectableText state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetSelected ()

Resets the A11yState::Selected state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetSupportsAutocompletion ()

Resets the A11yState::SupportsAutocompletion state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetTruncated ()

Resets the A11yState::Truncated state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void resetVisited ()

Resets the A11yState::Visited state of the accessible object to false.

Since:

BlackBerry 10.2.0

Q_SLOT void setActive (
  • boolactive)

Sets the A11yState::Active state of the accessible object.

Parameters
active

If true the accessible object is in A11yState::Active state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setAnimated (
  • boolanimated)

Sets the A11yState::Animated state of the accessible object.

Parameters
animated

If true the accessible object is in A11yState::Animated state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setBusy (
  • boolbusy)

Sets the A11yState::Busy state of the accessible object.

Parameters
busy

If true the accessible object is in A11yState::Busy state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setCheckable (
  • boolcheckable)

Sets the A11yState::Checkable state of the accessible object.

Parameters
checkable

If true the accessible object is in A11yState::Checkable state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setChecked (
  • boolchecked)

Sets the A11yState::Checked state of the accessible object.

Parameters
checked

If true the accessible object is in A11yState::Checked state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setDefaultControl (
  • booldefaultControl)

Sets the A11yState::DefaultControl state of the accessible object.

Parameters
defaultControl

If true the accessible object is in A11yState::DefaultControl state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setDefunct (
  • booldefunct)

Sets the A11yState::Defunct state of the accessible object.

Parameters
defunct

If true the accessible object is in A11yState::Defunct state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setDisabled (
  • booldisabled)

Sets the A11yState::Disabled state of the accessible object.

Parameters
disabled

If true the accessible object is in A11yState::Disabled state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setExpandable (
  • boolexpandable)

Sets the A11yState::Expandable state of the accessible object.

Parameters
expandable

If true the accessible object is in A11yState::Expandable state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setExpanded (
  • boolexpanded)

Sets the A11yState::Expanded state of the accessible object.

Parameters
expanded

If true the accessible object is in A11yState::Expanded state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setFocusable (
  • boolfocusable)

Sets the A11yState::Focusable state of the accessible object.

Parameters
focusable

If true the accessible object is in A11yState::Focusable state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setFocused (
  • boolfocused)

Sets the A11yState::Focused state of the accessible object.

Parameters
focused

If true the accessible object is in A11yState::Focused state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setHasPopup (
  • boolhasPopup)

Sets the A11yState::HasPopup state of the accessible object.

Parameters
hasPopup

If true the accessible object is in A11yState::HasPopup state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setHidden (
  • boolhidden)

Sets the A11yState::Hidden state of the accessible object.

Parameters
hidden

If true the accessible object is in A11yState::Hidden state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setIconified (
  • booliconified)

Sets the A11yState::Iconified state of the accessible object.

Parameters
iconified

If true the accessible object is in A11yState::Iconified state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setInvalid (
  • boolinvalid)

Sets the A11yState::Invalid state of the accessible object.

Parameters
invalid

If true the accessible object is in A11yState::Invalid state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setManagedChild (
  • boolmanagedChild)

Sets the A11yState::ManagedChild state of the accessible object.

Parameters
managedChild

If true the accessible object is in A11yState::ManagedChild state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setManagesDescendants (
  • boolmanagesDescendants)

Sets the A11yState::ManagesDescendants state of the accessible object.

Parameters
managesDescendants

If true the accessible object is in A11yState::ManagesDescendants state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setMixed (
  • boolmixed)

Sets the A11yState::Mixed state of the accessible object.

Parameters
mixed

If true the accessible object is in A11yState::Mixed state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setModal (
  • boolmodal)

Sets the A11yState::Modal state of the accessible object.

Parameters
modal

If true the accessible object is in A11yState::Modal state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setMultiLine (
  • boolmultiLine)

Sets the A11yState::MultiLine state of the accessible object.

Parameters
multiLine

If true the accessible object is in A11yState::MultiLine state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setMultiSelectable (
  • boolmultiSelectable)

Sets the A11yState::MultiSelectable state of the accessible object.

Parameters
multiSelectable

If true the accessible object is in A11yState::MultiSelectable state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setOffScreen (
  • booloffScreen)

Sets the A11yState::OffScreen state of the accessible object.

Parameters
offScreen

If true the accessible object is in A11yState::OffScreen state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setOrientationHorizontal (
  • boolorientationHorizontal)

Sets the A11yState::OrientationHorizontal state of the accessible object.

Parameters
orientationHorizontal

If true the accessible object is in A11yState::OrientationHorizontal state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setOrientationVertical (
  • boolorientationVertical)

Sets the A11yState::OrientationVertical state of the accessible object.

Parameters
orientationVertical

If true the accessible object is in A11yState::OrientationVertical state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setPasswordProtected (
  • boolpasswordProtected)

Sets the A11yState::PasswordProtected state of the accessible object.

Parameters
passwordProtected

If true the accessible object is in A11yState::PasswordProtected state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setPinned (
  • boolpinned)

Sets the A11yState::Pinned state of the accessible object.

Parameters
pinned

If true the accessible object is in A11yState::Pinned state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setReadOnly (
  • boolreadOnly)

Sets the A11yState::ReadOnly state of the accessible object.

Parameters
readOnly

If true the accessible object is in A11yState::ReadOnly state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setRequired (
  • boolrequired)

Sets the A11yState::Required state of the accessible object.

Parameters
required

If true the accessible object is in A11yState::Required state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setSelectable (
  • boolselectable)

Sets the A11yState::Selectable state of the accessible object.

Parameters
selectable

If true the accessible object is in A11yState::Selectable state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setSelectableText (
  • boolselectableText)

Sets the A11yState::SelectableText state of the accessible object.

Parameters
selectableText

If true the accessible object is in A11yState::SelectableText state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setSelected (
  • boolselected)

Sets the A11yState::Selected state of the accessible object.

Parameters
selected

If true the accessible object is in A11yState::Selected state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_INVOKABLE void setState (

Sets the specified state of the accessible control.

Parameters
state

The state type to set.

value

The new value for the state.

Since:

BlackBerry 10.2.0

Q_SLOT void setSupportsAutocompletion (
  • boolsupportsAutocompletion)

Sets the A11yState::SupportsAutocompletion state of the accessible object.

Parameters
supportsAutocompletion

If true the accessible object is in A11yState::SupportsAutocompletion state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setTruncated (
  • booltruncated)

Sets the A11yState::Truncated state of the accessible object.

Parameters
truncated

If true the accessible object is in A11yState::Truncated state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

Q_SLOT void setVisited (
  • boolvisited)

Sets the A11yState::Visited state of the accessible object.

Parameters
visited

If true the accessible object is in A11yState::Visited state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

bool supportsAutocompletion ()

Indicates whether the object is in the A11yState::SupportsAutocompletion state, or not.

Return:

true if the accessible object is in A11yState::SupportsAutocompletion state, and false otherwise.

Since:

BlackBerry 10.2.0

void setObjectName (Inherited

Sets the objectName property.

Parameters
name

The new name for the object.

Since:

BlackBerry 10.0.0

virtual Q_INVOKABLE QString toDebugString ()Inherited

Returns a debug string representing this object.

Return:

A debug string for the object.

Since:

BlackBerry 10.0.0

Protected Functions

(Only has inherited protected functions)

BaseObject (Inherited

Constructs an instance of BaseObject's subclass.

Parameters
parent

An optional parent, defaults to 0.

Since:

BlackBerry 10.0.0

Signals

void activeChanged (
  • boolactive)

Emitted when the A11yState::Active state of the accessible object changes.

Parameters
active

If true the accessible object is in Active state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void animatedChanged (
  • boolanimated)

Emitted when the A11yState::Animated state of the accessible object changes.

Parameters
animated

If true the accessible object is in Animated state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void busyChanged (
  • boolbusy)

Emitted when the A11yState::Busy state of the accessible object changes.

Parameters
busy

If true the accessible object is in A11yState::Busy state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void checkableChanged (
  • boolcheckable)

Emitted when the A11yState::Checkable state of the accessible object changes.

Parameters
checkable

If true the accessible object is in A11yState::Checkable state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void checkedChanged (
  • boolchecked)

Emitted when the A11yState::Checked state of the accessible object changes.

Parameters
checked

If true the accessible object is in A11yState::Checked state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void defaultControlChanged (
  • booldefaultControl)

Emitted when the A11yState::DefaultControl state of the accessible object changes.

Parameters
defaultControl

If true the accessible object is in A11yState::DefaultControl state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void defunctChanged (
  • booldefunct)

Emitted when the A11yState::Defunct state of the accessible object changes.

Parameters
defunct

If true the accessible object is in A11yState::Defunct state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void disabledChanged (
  • booldisabled)

Emitted when the A11yState::Disabled state of the accessible object changes.

Parameters
disabled

If true the accessible object is in A11yState::Disabled state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void expandableChanged (
  • boolexpandable)

Emitted when the A11yState::Expandable state of the accessible object changes.

Parameters
expandable

If true the accessible object is in A11yState::Expandable state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void expandedChanged (
  • boolexpanded)

Emitted when the A11yState::Expanded state of the accessible object changes.

Parameters
expanded

If true the accessible object is in A11yState::Expanded state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void focusableChanged (
  • boolfocusable)

Emitted when the A11yState::Focusable state of the accessible object changes.

Parameters
focusable

If true the accessible object is in A11yState::Focusable state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void focusedChanged (
  • boolfocused)

Emitted when the A11yState::Focused state of the accessible object changes.

Parameters
focused

If true the accessible object is in A11yState::Focused state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void hasPopupChanged (
  • boolhasPopup)

Emitted when the A11yState::HasPopup state of the accessible object changes.

Parameters
hasPopup

If true the accessible object is in A11yState::HasPopup state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void hiddenChanged (
  • boolhidden)

Emitted when the A11yState::Hidden state of the accessible object changes.

Parameters
hidden

If true the accessible object is in A11yState::Hidden state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void iconifiedChanged (
  • booliconified)

Emitted when the A11yState::Iconified state of the accessible object changes.

Parameters
iconified

If true the accessible object is in A11yState::Iconified state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void invalidChanged (
  • boolinvalid)

Emitted when the A11yState::Invalid state of the accessible object changes.

Parameters
invalid

If true the accessible object is in A11yState::Invalid state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void managedChildChanged (
  • boolmanagedChild)

Emitted when the A11yState::ManagedChild state of the accessible object changes.

Parameters
managedChild

If true the accessible object is in A11yState::ManagedChild state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void managesDescendantsChanged (
  • boolmanagesDescendants)

Emitted when the A11yState::ManagesDescendants state of the accessible object changes.

Parameters
managesDescendants

If true the accessible object is in A11yState::ManagesDescendants state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void mixedChanged (
  • boolmixed)

Emitted when the A11yState::Mixed state of the accessible object changes.

Parameters
mixed

If true the accessible object is in A11yState::Mixed state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void modalChanged (
  • boolmodal)

Emitted when the A11yState::Modal state of the accessible object changes.

Parameters
modal

If true the accessible object is in A11yState::Modal state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void multiLineChanged (
  • boolmultiLine)

Emitted when the A11yState::Multiline state of the accessible object changes.

Parameters
multiLine

If true the accessible object is in A11yState::Multiline state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void multiSelectableChanged (
  • boolmultiSelectable)

Emitted when the A11yState::MultiSelectable state of the accessible object changes.

Parameters
multiSelectable

If true the accessible object is in A11yState::MultiSelectable state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void offScreenChanged (
  • booloffScreen)

Emitted when the A11yState::Offscreen state of the accessible object changes.

Parameters
offScreen

If true the accessible object is in A11yState::Offscreen state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void orientationHorizontalChanged (
  • boolorientationHorizontal)

Emitted when the A11yState::OrientationHorizontal state of the accessible object changes.

Parameters
orientationHorizontal

If true the accessible object is in A11yState::OrientationHorizontal state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void orientationVerticalChanged (
  • boolorientationVertical)

Emitted when the A11yState::OrientationVertical state of the accessible object changes.

Parameters
orientationVertical

If true the accessible object is in A11yState::OrientationVertical state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void passwordProtectedChanged (
  • boolpasswordProtected)

Emitted when the A11yState::PasswordProtected state of the accessible object changes.

Parameters
passwordProtected

If true the accessible object is in A11yState::PasswordProtected state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void pinnedChanged (
  • boolpinned)

Emitted when the A11yState::Pinned state of the accessible object changes.

Parameters
pinned

If true the accessible object is in A11yState::Pinned state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void readOnlyChanged (
  • boolreadOnly)

Emitted when the A11yState::ReadOnly state of the accessible object changes.

Parameters
readOnly

If true the accessible object is in A11yState::ReadOnly state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void requiredChanged (
  • boolrequired)

Emitted when the A11yState::Required state of the accessible object changes.

Parameters
required

If true the accessible object is in A11yState::Required state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void selectableChanged (
  • boolselectable)

Emitted when the A11yState::Selectable state of the accessible object changes.

Parameters
selectable

If true the accessible object is in A11yState::Selectable state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void selectableTextChanged (
  • boolselectableText)

Emitted when the A11yState::SelectableText state of the accessible object changes.

Parameters
selectableText

If true the accessible object is in A11yState::SelectableText state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void selectedChanged (
  • boolselected)

Emitted when the A11yState::Selected state of the accessible object changes.

Parameters
selected

If true the accessible object is in A11yState::Selected state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void stateChanged (

Emitted whenever a state of the accessible object changes.

Parameters
state

The type of the state that has changed.

value

If true the accessible object's state defined by state is currently set, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void supportsAutocompletionChanged (
  • boolsupportsAutocompletion)

Emitted when the A11yState::SupportsAutocompletion state of the accessible object changes.

Parameters
supportsAutocompletion

If true the accessible object is in A11yState::SupportsAutocompletion state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void truncatedChanged (
  • booltruncated)

Emitted when the A11yState::Truncated state of the accessible object changes.

Parameters
truncated

If true the accessible object is in A11yState::Truncated state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void visitedChanged (
  • boolvisited)

Emitted when the A11yState::Visited state of the accessible object changes.

Parameters
visited

If true the accessible object is in A11yState::Visited state, and if false the accessible object is not in this state.

Since:

BlackBerry 10.2.0

void creationCompleted ()Inherited

Emitted when this object is instantiated as a result of loading a QML document and creating the root node (only after the root component that caused this instantiation has completed construction), or when the object is being constructed from its builder class.

This signal indicates that the construction and initialization of the object has been completed, the properties are initialized, and any QML binding values have been assigned to the object.

This signal is not emitted when the object is constructed from C++ using the constructor. If the object is constructed using its builder class, the signal is emitted when the the builder class returns the fully constructed object.

This signal can be used when there is an activity that needs to be performed, such as a property state integrity verification after the object is instantiated from a QML document or a builder, but before control is returned to the application.

See also:

QmlDocument

Since:

BlackBerry 10.0.0

void objectNameChanged (Inherited

This signal is emitted when the objectName property is changed.

Since:

BlackBerry 10.0.0

Last modified: 2014-09-29



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus