Struct gtk4::Accessible

#[repr(transparent)]
pub struct Accessible { /* private fields */ }

Accessible is an interface for describing UI elements for Assistive Technologies.

Every accessible implementation has:

• a “role”, represented by a value of the AccessibleRole enumeration
• an “attribute”, represented by a set of AccessibleState, AccessibleProperty and AccessibleRelation values

The role cannot be changed after instantiating a Accessible implementation.

The attributes are updated every time a UI element’s state changes in a way that should be reflected by assistive technologies. For instance, if a Widget visibility changes, the AccessibleState::Hidden state will also change to reflect the visible property.

Every accessible implementation is part of a tree of accessible objects. Normally, this tree corresponds to the widget tree, but can be customized by reimplementing the vfunc::Gtk::Accessible::get_accessible_parent, vfunc::Gtk::Accessible::get_first_accessible_child and vfunc::Gtk::Accessible::get_next_accessible_sibling virtual functions. Note that you can not create a top-level accessible object as of now, which means that you must always have a parent accessible object. Also note that when an accessible object does not correspond to a widget, and it has children, whose implementation you don’t control, it is necessary to ensure the correct shape of the a11y tree by calling AccessibleExt::set_accessible_parent() and updating the sibling by AccessibleExt::update_next_accessible_sibling().

Properties

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Implements

AccessibleExt, AccessibleExtManual

Implementations

impl Accessible

pub const NONE: Option<&'static Accessible> = None

Trait Implementations

impl Clone for Accessible

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Accessible

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Accessible

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Accessible

type ParamSpec = ParamSpecObject

type SetValue = Accessible

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Accessible>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Accessible

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: AccessibleImpl> IsImplementable<T> for Accessible

Available on crate feature v4_10 only.

fn interface_init(iface: &mut Interface<Self>)

Override the virtual methods of this interface for the given subclass and do other interface initialization.

fn instance_init(_instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for Accessible

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<OT: ObjectType> PartialEq<OT> for Accessible

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

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.

impl<OT: ObjectType> PartialOrd<OT> for Accessible

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Accessible

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Accessible

impl IsA<Accessible> for AboutDialog

impl IsA<Accessible> for AccessibleRange

Available on crate feature v4_10 only.

impl IsA<Accessible> for ActionBar

impl IsA<Accessible> for Actionable

impl IsA<Accessible> for AppChooser

impl IsA<Accessible> for AppChooserButton

impl IsA<Accessible> for AppChooserDialog

impl IsA<Accessible> for AppChooserWidget

impl IsA<Accessible> for ApplicationWindow

impl IsA<Accessible> for AspectFrame

impl IsA<Accessible> for Assistant

impl IsA<Accessible> for Box

impl IsA<Accessible> for Button

impl IsA<Accessible> for Calendar

impl IsA<Accessible> for CellEditable

impl IsA<Accessible> for CellView

impl IsA<Accessible> for CenterBox

impl IsA<Accessible> for CheckButton

impl IsA<Accessible> for ColorButton

impl IsA<Accessible> for ColorChooserDialog

impl IsA<Accessible> for ColorChooserWidget

impl IsA<Accessible> for ColorDialogButton

Available on crate feature v4_10 only.

impl IsA<Accessible> for ColumnView

impl IsA<Accessible> for ComboBox

impl IsA<Accessible> for ComboBoxText

impl IsA<Accessible> for Dialog

impl IsA<Accessible> for DragIcon

impl IsA<Accessible> for DrawingArea

impl IsA<Accessible> for DropDown

impl IsA<Accessible> for Editable

impl IsA<Accessible> for EditableLabel

impl IsA<Accessible> for EmojiChooser

impl IsA<Accessible> for Entry

impl IsA<Accessible> for Expander

impl IsA<Accessible> for FileChooserDialog

impl IsA<Accessible> for FileChooserWidget

impl IsA<Accessible> for Fixed

impl IsA<Accessible> for FlowBox

impl IsA<Accessible> for FlowBoxChild

impl IsA<Accessible> for FontButton

impl IsA<Accessible> for FontChooserDialog

impl IsA<Accessible> for FontChooserWidget

impl IsA<Accessible> for FontDialogButton

Available on crate feature v4_10 only.

impl IsA<Accessible> for Frame

impl IsA<Accessible> for GLArea

impl IsA<Accessible> for Grid

impl IsA<Accessible> for GridView

impl IsA<Accessible> for HeaderBar

impl IsA<Accessible> for IconView

impl IsA<Accessible> for Image

impl IsA<Accessible> for InfoBar

impl IsA<Accessible> for Inscription

Available on crate feature v4_8 only.

impl IsA<Accessible> for Label

impl IsA<Accessible> for LevelBar

impl IsA<Accessible> for LinkButton

impl IsA<Accessible> for ListBase

impl IsA<Accessible> for ListBox

impl IsA<Accessible> for ListBoxRow

impl IsA<Accessible> for ListView

impl IsA<Accessible> for LockButton

impl IsA<Accessible> for MediaControls

impl IsA<Accessible> for MenuButton

impl IsA<Accessible> for MessageDialog

impl IsA<Accessible> for Native

impl IsA<Accessible> for Notebook

impl IsA<Accessible> for Overlay

impl IsA<Accessible> for PageSetupUnixDialog

Available on Linux only.

impl IsA<Accessible> for Paned

impl IsA<Accessible> for PasswordEntry

impl IsA<Accessible> for Picture

impl IsA<Accessible> for Popover

impl IsA<Accessible> for PopoverMenu

impl IsA<Accessible> for PopoverMenuBar

impl IsA<Accessible> for PrintUnixDialog

Available on Linux only.

impl IsA<Accessible> for ProgressBar

impl IsA<Accessible> for Range

impl IsA<Accessible> for Revealer

impl IsA<Accessible> for Root

impl IsA<Accessible> for Scale

impl IsA<Accessible> for ScaleButton

impl IsA<Accessible> for Scrollbar

impl IsA<Accessible> for ScrolledWindow

impl IsA<Accessible> for SearchBar

impl IsA<Accessible> for SearchEntry

impl IsA<Accessible> for Separator

impl IsA<Accessible> for ShortcutLabel

impl IsA<Accessible> for ShortcutsGroup

impl IsA<Accessible> for ShortcutsSection

impl IsA<Accessible> for ShortcutsShortcut

impl IsA<Accessible> for ShortcutsWindow

impl IsA<Accessible> for SpinButton

impl IsA<Accessible> for Spinner

impl IsA<Accessible> for Stack

impl IsA<Accessible> for StackPage

impl IsA<Accessible> for StackSidebar

impl IsA<Accessible> for StackSwitcher

impl IsA<Accessible> for Statusbar

impl IsA<Accessible> for Switch

impl IsA<Accessible> for Text

impl IsA<Accessible> for TextView

impl IsA<Accessible> for ToggleButton

impl IsA<Accessible> for TreeExpander

impl IsA<Accessible> for TreeView

impl IsA<Accessible> for Video

impl IsA<Accessible> for Viewport

impl IsA<Accessible> for VolumeButton

impl IsA<Accessible> for Widget

impl IsA<Accessible> for Window

impl IsA<Accessible> for WindowControls

impl IsA<Accessible> for WindowHandle