Struct qt_gui::q_accessible::State

source ·
#[repr(C)]
pub struct State { /* private fields */ }
Expand description

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

C++ class: QAccessible::State.

C++ documentation:

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

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

Implementations§

source§

impl State

source

pub unsafe fn active(&self) -> u64

Returns the value of the active field.

source

pub unsafe fn animated(&self) -> u64

Returns the value of the animated field.

source

pub unsafe fn busy(&self) -> u64

Returns the value of the busy field.

source

pub unsafe fn check_state_mixed(&self) -> u64

Returns the value of the checkStateMixed field.

source

pub unsafe fn checkable(&self) -> u64

Returns the value of the checkable field.

source

pub unsafe fn checked(&self) -> u64

Returns the value of the checked field.

source

pub unsafe fn collapsed(&self) -> u64

Returns the value of the collapsed field.

source

pub unsafe fn copy_from(&self, other: impl CastInto<Ref<State>>) -> Ref<State>

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

Calls C++ function: QAccessible::State& QAccessible::State::operator=(const QAccessible::State& other).

C++ documentation:

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

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

source

pub unsafe fn default_button(&self) -> u64

Returns the value of the defaultButton field.

source

pub unsafe fn disabled(&self) -> u64

Returns the value of the disabled field.

source

pub unsafe fn editable(&self) -> u64

Returns the value of the editable field.

source

pub unsafe fn expandable(&self) -> u64

Returns the value of the expandable field.

source

pub unsafe fn expanded(&self) -> u64

Returns the value of the expanded field.

source

pub unsafe fn ext_selectable(&self) -> u64

Returns the value of the extSelectable field.

source

pub unsafe fn focusable(&self) -> u64

Returns the value of the focusable field.

source

pub unsafe fn focused(&self) -> u64

Returns the value of the focused field.

source

pub unsafe fn has_popup(&self) -> u64

Returns the value of the hasPopup field.

source

pub unsafe fn hot_tracked(&self) -> u64

Returns the value of the hotTracked field.

source

pub unsafe fn invalid(&self) -> u64

Returns the value of the invalid field.

source

pub unsafe fn invisible(&self) -> u64

Returns the value of the invisible field.

source

pub unsafe fn linked(&self) -> u64

Returns the value of the linked field.

source

pub unsafe fn marqueed(&self) -> u64

Returns the value of the marqueed field.

source

pub unsafe fn modal(&self) -> u64

Returns the value of the modal field.

source

pub unsafe fn movable(&self) -> u64

Returns the value of the movable field.

source

pub unsafe fn multi_line(&self) -> u64

Returns the value of the multiLine field.

source

pub unsafe fn multi_selectable(&self) -> u64

Returns the value of the multiSelectable field.

source

pub unsafe fn new() -> CppBox<State>

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

Calls C++ function: [constructor] void QAccessible::State::State().

C++ documentation:

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

source

pub unsafe fn new_copy(other: impl CastInto<Ref<State>>) -> CppBox<State>

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

Calls C++ function: [constructor] void QAccessible::State::State(const QAccessible::State& other).

C++ documentation:

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

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

source

pub unsafe fn offscreen(&self) -> u64

Returns the value of the offscreen field.

source

pub unsafe fn password_edit(&self) -> u64

Returns the value of the passwordEdit field.

source

pub unsafe fn pressed(&self) -> u64

Returns the value of the pressed field.

source

pub unsafe fn read_only(&self) -> u64

Returns the value of the readOnly field.

source

pub unsafe fn search_edit(&self) -> u64

Returns the value of the searchEdit field.

source

pub unsafe fn selectable(&self) -> u64

Returns the value of the selectable field.

source

pub unsafe fn selectable_text(&self) -> u64

Returns the value of the selectableText field.

source

pub unsafe fn selected(&self) -> u64

Returns the value of the selected field.

source

pub unsafe fn self_voicing(&self) -> u64

Returns the value of the selfVoicing field.

source

pub unsafe fn set_active(&self, value: u64)

Sets the value of the active field.

source

pub unsafe fn set_animated(&self, value: u64)

Sets the value of the animated field.

source

pub unsafe fn set_busy(&self, value: u64)

Sets the value of the busy field.

source

pub unsafe fn set_check_state_mixed(&self, value: u64)

Sets the value of the checkStateMixed field.

source

pub unsafe fn set_checkable(&self, value: u64)

Sets the value of the checkable field.

source

pub unsafe fn set_checked(&self, value: u64)

Sets the value of the checked field.

source

pub unsafe fn set_collapsed(&self, value: u64)

Sets the value of the collapsed field.

source

pub unsafe fn set_default_button(&self, value: u64)

Sets the value of the defaultButton field.

source

pub unsafe fn set_disabled(&self, value: u64)

Sets the value of the disabled field.

source

pub unsafe fn set_editable(&self, value: u64)

Sets the value of the editable field.

source

pub unsafe fn set_expandable(&self, value: u64)

Sets the value of the expandable field.

source

pub unsafe fn set_expanded(&self, value: u64)

Sets the value of the expanded field.

source

pub unsafe fn set_ext_selectable(&self, value: u64)

Sets the value of the extSelectable field.

source

pub unsafe fn set_focusable(&self, value: u64)

Sets the value of the focusable field.

source

pub unsafe fn set_focused(&self, value: u64)

Sets the value of the focused field.

source

pub unsafe fn set_has_popup(&self, value: u64)

Sets the value of the hasPopup field.

source

pub unsafe fn set_hot_tracked(&self, value: u64)

Sets the value of the hotTracked field.

source

pub unsafe fn set_invalid(&self, value: u64)

Sets the value of the invalid field.

source

pub unsafe fn set_invisible(&self, value: u64)

Sets the value of the invisible field.

source

pub unsafe fn set_linked(&self, value: u64)

Sets the value of the linked field.

source

pub unsafe fn set_marqueed(&self, value: u64)

Sets the value of the marqueed field.

source

pub unsafe fn set_modal(&self, value: u64)

Sets the value of the modal field.

source

pub unsafe fn set_movable(&self, value: u64)

Sets the value of the movable field.

source

pub unsafe fn set_multi_line(&self, value: u64)

Sets the value of the multiLine field.

source

pub unsafe fn set_multi_selectable(&self, value: u64)

Sets the value of the multiSelectable field.

source

pub unsafe fn set_offscreen(&self, value: u64)

Sets the value of the offscreen field.

source

pub unsafe fn set_password_edit(&self, value: u64)

Sets the value of the passwordEdit field.

source

pub unsafe fn set_pressed(&self, value: u64)

Sets the value of the pressed field.

source

pub unsafe fn set_read_only(&self, value: u64)

Sets the value of the readOnly field.

source

pub unsafe fn set_search_edit(&self, value: u64)

Sets the value of the searchEdit field.

source

pub unsafe fn set_selectable(&self, value: u64)

Sets the value of the selectable field.

source

pub unsafe fn set_selectable_text(&self, value: u64)

Sets the value of the selectableText field.

source

pub unsafe fn set_selected(&self, value: u64)

Sets the value of the selected field.

source

pub unsafe fn set_self_voicing(&self, value: u64)

Sets the value of the selfVoicing field.

source

pub unsafe fn set_sizeable(&self, value: u64)

Sets the value of the sizeable field.

source

pub unsafe fn set_supports_auto_completion(&self, value: u64)

Sets the value of the supportsAutoCompletion field.

source

pub unsafe fn set_traversed(&self, value: u64)

Sets the value of the traversed field.

source

pub unsafe fn sizeable(&self) -> u64

Returns the value of the sizeable field.

source

pub unsafe fn supports_auto_completion(&self) -> u64

Returns the value of the supportsAutoCompletion field.

source

pub unsafe fn traversed(&self) -> u64

Returns the value of the traversed field.

Trait Implementations§

source§

impl CppDeletable for State

source§

unsafe fn delete(&self)

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

Calls C++ function: [destructor] void QAccessible::State::~State().

C++ documentation:

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

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

source§

impl PartialEq<Ref<State>> for State

source§

fn eq(&self, second: &Ref<State>) -> bool

Returns true if page layout lhs is equal to page layout rhs, i.e. if all the attributes are exactly equal.

Calls C++ function: bool operator==(const QAccessible::State& first, const QAccessible::State& second).

Warning: no exact match found in C++ documentation. Below is the C++ documentation for bool operator==(const QPageLayout &lhs, const QPageLayout &rhs):

Returns true if page layout lhs is equal to page layout rhs, i.e. if all the attributes are exactly equal.

Note that this is a strict equality, especially for page size where the QPageSize ID, name and size must exactly match, and the margins where the units must match.

See also QPageLayout::isEquivalentTo().

1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Auto Trait Implementations§

§

impl RefUnwindSafe for State

§

impl Send for State

§

impl Sync for State

§

impl Unpin for State

§

impl UnwindSafe for State

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T, U> CastInto<U> for T
where U: CastFrom<T>,

source§

unsafe fn cast_into(self) -> U

Performs the conversion. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> StaticUpcast<T> for T

source§

unsafe fn static_upcast(ptr: Ptr<T>) -> Ptr<T>

Convert type of a const pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.