Struct qt_gui::q_accessible::State

#[repr(C)]
pub struct State { /* fields omitted */ }

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:

Constant	Description
active	The object is the active window or the active sub-element in a container (that would get focus when focusing the container).
adjustable	The object represents an adjustable value, e.g. sliders.
animated	The object's appearance changes frequently.
busy	The object cannot accept input at the moment.
checkable	The object is checkable.
checked	The object's check box is checked.
checkStateMixed	The third state of checkboxes (half checked in tri-state check boxes).
collapsed	The object is collapsed, e.g. a closed listview item, or an iconified window.
defaultButton	The object represents the default button in a dialog.
defunct	The object no longer exists.
editable	The object has a text carret (and often implements the text interface).
expandable	The object is expandable, mostly used for cells in a tree view.
expanded	The object is expanded, currently its children are visible.
extSelectable	The object supports extended selection.
focusable	The object can receive focus. Only objects in the active window can receive focus.
focused	The object has keyboard focus.
hasPopup	The object opens a popup.
hotTracked	The object's appearance is sensitive to the mouse cursor position.
invalid	The object is no longer valid (because it has been deleted).
invalidEntry	Input validation current input invalid.
invisible	The object is not visible to the user.
linked	The object is linked to another object, e.g. a hyperlink.
marqueed	The object displays scrolling contents, e.g. a log view.
modal	The object blocks input from other objects.
movable	The object can be moved.
multiLine	The object has multiple lines of text (word wrap), as opposed to a single line.
multiSelectable	The object supports multiple selected items.
offscreen	The object is clipped by the visible area. Objects that are off screen are also invisible.
passwordEdit	The object is a password field, e.g. a line edit for entering a Password.
playsSound	The object produces sound when interacted with.
pressed	The object is pressed.
readOnly	The object can usually be edited, but is explicitly set to read-only.
searchEdit	The object is a line edit that is the input for search queries.
selectable	The object is selectable.
selectableText	The object has text which can be selected. This is different from selectable which refers to the object's children.
selected	The object is selected, this is independent of text selection.
selfVoicing	The object describes itself through speech or sound.
sizeable	The object can be resized, e.g. top-level windows.
summaryElement	The object summarizes the state of the window and should be treated with priority.
supportsAutoCompletion	The object has auto-completion, for example in line edits or combo boxes.
traversed	The object is linked and has been visited.
updatesFrequently	The object changes frequently and needs to be refreshed when accessing it.
disabled	The object is unavailable to the user, e.g. a disabled widget.

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

Methods

impl State

pub unsafe fn active(&self) -> u64

Returns the value of the active field.

pub unsafe fn animated(&self) -> u64

Returns the value of the animated field.

pub unsafe fn busy(&self) -> u64

Returns the value of the busy field.

pub unsafe fn check_state_mixed(&self) -> u64

Returns the value of the checkStateMixed field.

pub unsafe fn checkable(&self) -> u64

Returns the value of the checkable field.

pub unsafe fn checked(&self) -> u64

Returns the value of the checked field.

pub unsafe fn collapsed(&self) -> u64

Returns the value of the collapsed field.

pub unsafe fn copy_from(
    &mut self,
    other: impl CastInto<Ref<State>>
) -> MutRef<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:

Constant	Description
active	The object is the active window or the active sub-element in a container (that would get focus when focusing the container).
adjustable	The object represents an adjustable value, e.g. sliders.
animated	The object's appearance changes frequently.
busy	The object cannot accept input at the moment.
checkable	The object is checkable.
checked	The object's check box is checked.
checkStateMixed	The third state of checkboxes (half checked in tri-state check boxes).
collapsed	The object is collapsed, e.g. a closed listview item, or an iconified window.
defaultButton	The object represents the default button in a dialog.
defunct	The object no longer exists.
editable	The object has a text carret (and often implements the text interface).
expandable	The object is expandable, mostly used for cells in a tree view.
expanded	The object is expanded, currently its children are visible.
extSelectable	The object supports extended selection.
focusable	The object can receive focus. Only objects in the active window can receive focus.
focused	The object has keyboard focus.
hasPopup	The object opens a popup.
hotTracked	The object's appearance is sensitive to the mouse cursor position.
invalid	The object is no longer valid (because it has been deleted).
invalidEntry	Input validation current input invalid.
invisible	The object is not visible to the user.
linked	The object is linked to another object, e.g. a hyperlink.
marqueed	The object displays scrolling contents, e.g. a log view.
modal	The object blocks input from other objects.
movable	The object can be moved.
multiLine	The object has multiple lines of text (word wrap), as opposed to a single line.
multiSelectable	The object supports multiple selected items.
offscreen	The object is clipped by the visible area. Objects that are off screen are also invisible.
passwordEdit	The object is a password field, e.g. a line edit for entering a Password.
playsSound	The object produces sound when interacted with.
pressed	The object is pressed.
readOnly	The object can usually be edited, but is explicitly set to read-only.
searchEdit	The object is a line edit that is the input for search queries.
selectable	The object is selectable.
selectableText	The object has text which can be selected. This is different from selectable which refers to the object's children.
selected	The object is selected, this is independent of text selection.
selfVoicing	The object describes itself through speech or sound.
sizeable	The object can be resized, e.g. top-level windows.
summaryElement	The object summarizes the state of the window and should be treated with priority.
supportsAutoCompletion	The object has auto-completion, for example in line edits or combo boxes.
traversed	The object is linked and has been visited.
updatesFrequently	The object changes frequently and needs to be refreshed when accessing it.
disabled	The object is unavailable to the user, e.g. a disabled widget.

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

pub unsafe fn default_button(&self) -> u64

Returns the value of the defaultButton field.

pub unsafe fn disabled(&self) -> u64

Returns the value of the disabled field.

pub unsafe fn editable(&self) -> u64

Returns the value of the editable field.

pub unsafe fn expandable(&self) -> u64

Returns the value of the expandable field.

pub unsafe fn expanded(&self) -> u64

Returns the value of the expanded field.

pub unsafe fn ext_selectable(&self) -> u64

Returns the value of the extSelectable field.

pub unsafe fn focusable(&self) -> u64

Returns the value of the focusable field.

pub unsafe fn focused(&self) -> u64

Returns the value of the focused field.

pub unsafe fn has_popup(&self) -> u64

Returns the value of the hasPopup field.

pub unsafe fn hot_tracked(&self) -> u64

Returns the value of the hotTracked field.

pub unsafe fn invalid(&self) -> u64

Returns the value of the invalid field.

pub unsafe fn invisible(&self) -> u64

Returns the value of the invisible field.

pub unsafe fn linked(&self) -> u64

Returns the value of the linked field.

pub unsafe fn marqueed(&self) -> u64

Returns the value of the marqueed field.

pub unsafe fn modal(&self) -> u64

Returns the value of the modal field.

pub unsafe fn movable(&self) -> u64

Returns the value of the movable field.

pub unsafe fn multi_line(&self) -> u64

Returns the value of the multiLine field.

pub unsafe fn multi_selectable(&self) -> u64

Returns the value of the multiSelectable field.

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.

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:

Constant	Description
active	The object is the active window or the active sub-element in a container (that would get focus when focusing the container).
adjustable	The object represents an adjustable value, e.g. sliders.
animated	The object's appearance changes frequently.
busy	The object cannot accept input at the moment.
checkable	The object is checkable.
checked	The object's check box is checked.
checkStateMixed	The third state of checkboxes (half checked in tri-state check boxes).
collapsed	The object is collapsed, e.g. a closed listview item, or an iconified window.
defaultButton	The object represents the default button in a dialog.
defunct	The object no longer exists.
editable	The object has a text carret (and often implements the text interface).
expandable	The object is expandable, mostly used for cells in a tree view.
expanded	The object is expanded, currently its children are visible.
extSelectable	The object supports extended selection.
focusable	The object can receive focus. Only objects in the active window can receive focus.
focused	The object has keyboard focus.
hasPopup	The object opens a popup.
hotTracked	The object's appearance is sensitive to the mouse cursor position.
invalid	The object is no longer valid (because it has been deleted).
invalidEntry	Input validation current input invalid.
invisible	The object is not visible to the user.
linked	The object is linked to another object, e.g. a hyperlink.
marqueed	The object displays scrolling contents, e.g. a log view.
modal	The object blocks input from other objects.
movable	The object can be moved.
multiLine	The object has multiple lines of text (word wrap), as opposed to a single line.
multiSelectable	The object supports multiple selected items.
offscreen	The object is clipped by the visible area. Objects that are off screen are also invisible.
passwordEdit	The object is a password field, e.g. a line edit for entering a Password.
playsSound	The object produces sound when interacted with.
pressed	The object is pressed.
readOnly	The object can usually be edited, but is explicitly set to read-only.
searchEdit	The object is a line edit that is the input for search queries.
selectable	The object is selectable.
selectableText	The object has text which can be selected. This is different from selectable which refers to the object's children.
selected	The object is selected, this is independent of text selection.
selfVoicing	The object describes itself through speech or sound.
sizeable	The object can be resized, e.g. top-level windows.
summaryElement	The object summarizes the state of the window and should be treated with priority.
supportsAutoCompletion	The object has auto-completion, for example in line edits or combo boxes.
traversed	The object is linked and has been visited.
updatesFrequently	The object changes frequently and needs to be refreshed when accessing it.
disabled	The object is unavailable to the user, e.g. a disabled widget.

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

pub unsafe fn offscreen(&self) -> u64

Returns the value of the offscreen field.

pub unsafe fn password_edit(&self) -> u64

Returns the value of the passwordEdit field.

pub unsafe fn pressed(&self) -> u64

Returns the value of the pressed field.

pub unsafe fn read_only(&self) -> u64

Returns the value of the readOnly field.

pub unsafe fn search_edit(&self) -> u64

Returns the value of the searchEdit field.

pub unsafe fn selectable(&self) -> u64

Returns the value of the selectable field.

pub unsafe fn selectable_text(&self) -> u64

Returns the value of the selectableText field.

pub unsafe fn selected(&self) -> u64

Returns the value of the selected field.

pub unsafe fn self_voicing(&self) -> u64

Returns the value of the selfVoicing field.

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

Sets the value of the active field.

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

Sets the value of the animated field.

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

Sets the value of the busy field.

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

Sets the value of the checkStateMixed field.

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

Sets the value of the checkable field.

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

Sets the value of the checked field.

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

Sets the value of the collapsed field.

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

Sets the value of the defaultButton field.

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

Sets the value of the disabled field.

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

Sets the value of the editable field.

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

Sets the value of the expandable field.

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

Sets the value of the expanded field.

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

Sets the value of the extSelectable field.

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

Sets the value of the focusable field.

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

Sets the value of the focused field.

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

Sets the value of the hasPopup field.

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

Sets the value of the hotTracked field.

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

Sets the value of the invalid field.

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

Sets the value of the invisible field.

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

Sets the value of the linked field.

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

Sets the value of the marqueed field.

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

Sets the value of the modal field.

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

Sets the value of the movable field.

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

Sets the value of the multiLine field.

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

Sets the value of the multiSelectable field.

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

Sets the value of the offscreen field.

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

Sets the value of the passwordEdit field.

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

Sets the value of the pressed field.

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

Sets the value of the readOnly field.

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

Sets the value of the searchEdit field.

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

Sets the value of the selectable field.

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

Sets the value of the selectableText field.

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

Sets the value of the selected field.

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

Sets the value of the selfVoicing field.

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

Sets the value of the sizeable field.

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

Sets the value of the supportsAutoCompletion field.

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

Sets the value of the traversed field.

pub unsafe fn sizeable(&self) -> u64

Returns the value of the sizeable field.

pub unsafe fn supports_auto_completion(&self) -> u64

Returns the value of the supportsAutoCompletion field.

pub unsafe fn traversed(&self) -> u64

Returns the value of the traversed field.

Trait Implementations

impl CppDeletable for State

unsafe fn delete(&mut 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:

Constant	Description
active	The object is the active window or the active sub-element in a container (that would get focus when focusing the container).
adjustable	The object represents an adjustable value, e.g. sliders.
animated	The object's appearance changes frequently.
busy	The object cannot accept input at the moment.
checkable	The object is checkable.
checked	The object's check box is checked.
checkStateMixed	The third state of checkboxes (half checked in tri-state check boxes).
collapsed	The object is collapsed, e.g. a closed listview item, or an iconified window.
defaultButton	The object represents the default button in a dialog.
defunct	The object no longer exists.
editable	The object has a text carret (and often implements the text interface).
expandable	The object is expandable, mostly used for cells in a tree view.
expanded	The object is expanded, currently its children are visible.
extSelectable	The object supports extended selection.
focusable	The object can receive focus. Only objects in the active window can receive focus.
focused	The object has keyboard focus.
hasPopup	The object opens a popup.
hotTracked	The object's appearance is sensitive to the mouse cursor position.
invalid	The object is no longer valid (because it has been deleted).
invalidEntry	Input validation current input invalid.
invisible	The object is not visible to the user.
linked	The object is linked to another object, e.g. a hyperlink.
marqueed	The object displays scrolling contents, e.g. a log view.
modal	The object blocks input from other objects.
movable	The object can be moved.
multiLine	The object has multiple lines of text (word wrap), as opposed to a single line.
multiSelectable	The object supports multiple selected items.
offscreen	The object is clipped by the visible area. Objects that are off screen are also invisible.
passwordEdit	The object is a password field, e.g. a line edit for entering a Password.
playsSound	The object produces sound when interacted with.
pressed	The object is pressed.
readOnly	The object can usually be edited, but is explicitly set to read-only.
searchEdit	The object is a line edit that is the input for search queries.
selectable	The object is selectable.
selectableText	The object has text which can be selected. This is different from selectable which refers to the object's children.
selected	The object is selected, this is independent of text selection.
selfVoicing	The object describes itself through speech or sound.
sizeable	The object can be resized, e.g. top-level windows.
summaryElement	The object summarizes the state of the window and should be treated with priority.
supportsAutoCompletion	The object has auto-completion, for example in line edits or combo boxes.
traversed	The object is linked and has been visited.
updatesFrequently	The object changes frequently and needs to be refreshed when accessing it.
disabled	The object is unavailable to the user, e.g. a disabled widget.

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

impl PartialEq<Ref<State>> for State

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().

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.