Struct gtk4::Accessible

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

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

Every accessible implementation has:

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.

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§

source§

impl Accessible

source

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

Trait Implementations§

source§

impl Clone for Accessible

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Accessible

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Accessible

source§

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

Formats the value using the given formatter. Read more
source§

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>

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for Accessible

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Accessible

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

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

source§

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

This method tests for self and other values to be equal, and is used by ==.
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.
source§

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

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl StaticType for Accessible

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for Accessible

source§

impl IsA<Accessible> for AboutDialog

source§

impl IsA<Accessible> for AccessibleRange

Available on crate feature v4_10 only.
source§

impl IsA<Accessible> for ActionBar

source§

impl IsA<Accessible> for Actionable

source§

impl IsA<Accessible> for AppChooser

source§

impl IsA<Accessible> for AppChooserButton

source§

impl IsA<Accessible> for AppChooserDialog

source§

impl IsA<Accessible> for AppChooserWidget

source§

impl IsA<Accessible> for ApplicationWindow

source§

impl IsA<Accessible> for AspectFrame

source§

impl IsA<Accessible> for Assistant

source§

impl IsA<Accessible> for Box

source§

impl IsA<Accessible> for Button

source§

impl IsA<Accessible> for Calendar

source§

impl IsA<Accessible> for CellEditable

source§

impl IsA<Accessible> for CellView

source§

impl IsA<Accessible> for CenterBox

source§

impl IsA<Accessible> for CheckButton

source§

impl IsA<Accessible> for ColorButton

source§

impl IsA<Accessible> for ColorChooserDialog

source§

impl IsA<Accessible> for ColorChooserWidget

source§

impl IsA<Accessible> for ColorDialogButton

Available on crate feature v4_10 only.
source§

impl IsA<Accessible> for ColumnView

source§

impl IsA<Accessible> for ComboBox

source§

impl IsA<Accessible> for ComboBoxText

source§

impl IsA<Accessible> for Dialog

source§

impl IsA<Accessible> for DragIcon

source§

impl IsA<Accessible> for DrawingArea

source§

impl IsA<Accessible> for DropDown

source§

impl IsA<Accessible> for Editable

source§

impl IsA<Accessible> for EditableLabel

source§

impl IsA<Accessible> for EmojiChooser

source§

impl IsA<Accessible> for Entry

source§

impl IsA<Accessible> for Expander

source§

impl IsA<Accessible> for FileChooserDialog

source§

impl IsA<Accessible> for FileChooserWidget

source§

impl IsA<Accessible> for Fixed

source§

impl IsA<Accessible> for FlowBox

source§

impl IsA<Accessible> for FlowBoxChild

source§

impl IsA<Accessible> for FontButton

source§

impl IsA<Accessible> for FontChooserDialog

source§

impl IsA<Accessible> for FontChooserWidget

source§

impl IsA<Accessible> for FontDialogButton

Available on crate feature v4_10 only.
source§

impl IsA<Accessible> for Frame

source§

impl IsA<Accessible> for GLArea

source§

impl IsA<Accessible> for Grid

source§

impl IsA<Accessible> for GridView

source§

impl IsA<Accessible> for HeaderBar

source§

impl IsA<Accessible> for IconView

source§

impl IsA<Accessible> for Image

source§

impl IsA<Accessible> for InfoBar

source§

impl IsA<Accessible> for Inscription

Available on crate feature v4_8 only.
source§

impl IsA<Accessible> for Label

source§

impl IsA<Accessible> for LevelBar

source§

impl IsA<Accessible> for LinkButton

source§

impl IsA<Accessible> for ListBase

source§

impl IsA<Accessible> for ListBox

source§

impl IsA<Accessible> for ListBoxRow

source§

impl IsA<Accessible> for ListView

source§

impl IsA<Accessible> for LockButton

source§

impl IsA<Accessible> for MediaControls

source§

impl IsA<Accessible> for MenuButton

source§

impl IsA<Accessible> for MessageDialog

source§

impl IsA<Accessible> for Native

source§

impl IsA<Accessible> for Notebook

source§

impl IsA<Accessible> for Overlay

source§

impl IsA<Accessible> for PageSetupUnixDialog

Available on Linux only.
source§

impl IsA<Accessible> for Paned

source§

impl IsA<Accessible> for PasswordEntry

source§

impl IsA<Accessible> for Picture

source§

impl IsA<Accessible> for Popover

source§

impl IsA<Accessible> for PopoverMenu

source§

impl IsA<Accessible> for PopoverMenuBar

source§

impl IsA<Accessible> for PrintUnixDialog

Available on Linux only.
source§

impl IsA<Accessible> for ProgressBar

source§

impl IsA<Accessible> for Range

source§

impl IsA<Accessible> for Revealer

source§

impl IsA<Accessible> for Root

source§

impl IsA<Accessible> for Scale

source§

impl IsA<Accessible> for ScaleButton

source§

impl IsA<Accessible> for Scrollbar

source§

impl IsA<Accessible> for ScrolledWindow

source§

impl IsA<Accessible> for SearchEntry

source§

impl IsA<Accessible> for Separator

source§

impl IsA<Accessible> for ShortcutLabel

source§

impl IsA<Accessible> for ShortcutsGroup

source§

impl IsA<Accessible> for ShortcutsSection

source§

impl IsA<Accessible> for ShortcutsShortcut

source§

impl IsA<Accessible> for ShortcutsWindow

source§

impl IsA<Accessible> for SpinButton

source§

impl IsA<Accessible> for Spinner

source§

impl IsA<Accessible> for Stack

source§

impl IsA<Accessible> for StackPage

source§

impl IsA<Accessible> for StackSidebar

source§

impl IsA<Accessible> for StackSwitcher

source§

impl IsA<Accessible> for Statusbar

source§

impl IsA<Accessible> for Switch

source§

impl IsA<Accessible> for Text

source§

impl IsA<Accessible> for TextView

source§

impl IsA<Accessible> for ToggleButton

source§

impl IsA<Accessible> for TreeExpander

source§

impl IsA<Accessible> for TreeView

source§

impl IsA<Accessible> for Video

source§

impl IsA<Accessible> for Viewport

source§

impl IsA<Accessible> for VolumeButton

source§

impl IsA<Accessible> for Widget

source§

impl IsA<Accessible> for Window

source§

impl IsA<Accessible> for WindowControls

source§

impl IsA<Accessible> for WindowHandle

Auto Trait Implementations§

Blanket Implementations§

source§

impl<O> AccessibleExtManual for Owhere
    O: IsA<Accessible>,

source§

fn update_property(&self, properties: &[Property<'_>])

Updates an array of accessible properties. Read more
source§

fn update_relation(&self, relations: &[Relation<'_>])

Updates an array of accessible relations. Read more
source§

fn update_state(&self, states: &[State])

Updates an array of accessible states. Read more
source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> Cast for Twhere
    T: ObjectType,

source§

fn upcast<T>(self) -> Twhere
    T: ObjectType,
    Self: IsA<T>,

Upcasts an object to a superclass or interface T. Read more
source§

fn upcast_ref<T>(&self) -> &Twhere
    T: ObjectType,
    Self: IsA<T>,

Upcasts an object to a reference of its superclass or interface T. Read more
source§

fn downcast<T>(self) -> Result<T, Self>where
    T: ObjectType,
    Self: CanDowncast<T>,

Tries to downcast to a subclass or interface implementor T. Read more
source§

fn downcast_ref<T>(&self) -> Option<&T>where
    T: ObjectType,
    Self: CanDowncast<T>,

Tries to downcast to a reference of its subclass or interface implementor T. Read more
source§

fn dynamic_cast<T>(self) -> Result<T, Self>where
    T: ObjectType,

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more
source§

fn dynamic_cast_ref<T>(&self) -> Option<&T>where
    T: ObjectType,

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more
source§

unsafe fn unsafe_cast<T>(self) -> Twhere
    T: ObjectType,

Casts to T unconditionally. Read more
source§

unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
    T: ObjectType,

Casts to &T unconditionally. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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> IntoClosureReturnValue for Twhere
    T: Into<Value>,

source§

impl<T> ObjectExt for Twhere
    T: ObjectType,

source§

fn is<U>(&self) -> boolwhere
    U: StaticType,

Returns true if the object is an instance of (can be cast to) T.
source§

fn type_(&self) -> Type

Returns the type of the object.
source§

fn object_class(&self) -> &Class<Object>

Returns the ObjectClass of the object. Read more
source§

fn class(&self) -> &Class<T>where
    T: IsClass,

Returns the class of the object.
source§

fn class_of<U>(&self) -> Option<&Class<U>>where
    U: IsClass,

Returns the class of the object in the given type T. Read more
source§

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where
    U: IsInterface,

Returns the interface T of the object. Read more
source§

fn set_property(&self, property_name: &str, value: impl Into<Value>)

Sets the property property_name of the object to value value. Read more
source§

fn set_property_from_value(&self, property_name: &str, value: &Value)

Sets the property property_name of the object to value value. Read more
source§

fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])

Sets multiple properties of the object at once. Read more
source§

fn set_properties_from_value(&self, property_values: &[(&str, Value)])

Sets multiple properties of the object at once. Read more
source§

fn property<V>(&self, property_name: &str) -> Vwhere
    V: for<'b> FromValue<'b> + 'static,

Gets the property property_name of the object and cast it to the type V. Read more
source§

fn property_value(&self, property_name: &str) -> Value

Gets the property property_name of the object. Read more
source§

fn has_property(&self, property_name: &str, type_: Option<Type>) -> bool

Check if the object has a property property_name of the given type_. Read more
source§

fn property_type(&self, property_name: &str) -> Option<Type>

Get the type of the property property_name of this object. Read more
source§

fn find_property(&self, property_name: &str) -> Option<ParamSpec>

Get the ParamSpec of the property property_name of this object.
source§

fn list_properties(&self) -> PtrSlice<ParamSpec>

Return all ParamSpec of the properties of this object.
source§

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

Freeze all property notifications until the return guard object is dropped. Read more
source§

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where
    QD: 'static,

Set arbitrary data on this object with the given key. Read more
source§

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where
    QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where
    QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn set_data<QD>(&self, key: &str, value: QD)where
    QD: 'static,

Set arbitrary data on this object with the given key. Read more
source§

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>where
    QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>where
    QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more
source§

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.
source§

fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)

Stop emission of the currently emitted signal.
source§

fn stop_signal_emission_by_name(&self, signal_name: &str)

Stop emission of the currently emitted signal by the (possibly detailed) signal name.
source§

fn connect<F>(
    &self,
    signal_name: &str,
    after: bool,
    callback: F
) -> SignalHandlerIdwhere
    F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_name on this object. Read more
source§

fn connect_id<F>(
    &self,
    signal_id: SignalId,
    details: Option<Quark>,
    after: bool,
    callback: F
) -> SignalHandlerIdwhere
    F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_id on this object. Read more
source§

fn connect_local<F>(
    &self,
    signal_name: &str,
    after: bool,
    callback: F
) -> SignalHandlerIdwhere
    F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_name on this object. Read more
source§

fn connect_local_id<F>(
    &self,
    signal_id: SignalId,
    details: Option<Quark>,
    after: bool,
    callback: F
) -> SignalHandlerIdwhere
    F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_id on this object. Read more
source§

unsafe fn connect_unsafe<F>(
    &self,
    signal_name: &str,
    after: bool,
    callback: F
) -> SignalHandlerIdwhere
    F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_name on this object. Read more
source§

unsafe fn connect_unsafe_id<F>(
    &self,
    signal_id: SignalId,
    details: Option<Quark>,
    after: bool,
    callback: F
) -> SignalHandlerIdwhere
    F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_id on this object. Read more
source§

fn connect_closure(
    &self,
    signal_name: &str,
    after: bool,
    closure: RustClosure
) -> SignalHandlerId

Connect a closure to the signal signal_name on this object. Read more
source§

fn connect_closure_id(
    &self,
    signal_id: SignalId,
    details: Option<Quark>,
    after: bool,
    closure: RustClosure
) -> SignalHandlerId

Connect a closure to the signal signal_id on this object. Read more
source§

fn watch_closure(&self, closure: &impl AsRef<Closure>)

Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures.
source§

fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> Rwhere
    R: TryFromClosureReturnValue,

Emit signal by signal id. Read more
source§

fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>

Same as Self::emit but takes Value for the arguments.
source§

fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> Rwhere
    R: TryFromClosureReturnValue,

Emit signal by its name. Read more
source§

fn emit_by_name_with_values(
    &self,
    signal_name: &str,
    args: &[Value]
) -> Option<Value>

Emit signal by its name. Read more
source§

fn emit_by_name_with_details<R>(
    &self,
    signal_name: &str,
    details: Quark,
    args: &[&dyn ToValue]
) -> Rwhere
    R: TryFromClosureReturnValue,

Emit signal by its name with details. Read more
source§

fn emit_by_name_with_details_and_values(
    &self,
    signal_name: &str,
    details: Quark,
    args: &[Value]
) -> Option<Value>

Emit signal by its name with details. Read more
source§

fn emit_with_details<R>(
    &self,
    signal_id: SignalId,
    details: Quark,
    args: &[&dyn ToValue]
) -> Rwhere
    R: TryFromClosureReturnValue,

Emit signal by signal id with details. Read more
source§

fn emit_with_details_and_values(
    &self,
    signal_id: SignalId,
    details: Quark,
    args: &[Value]
) -> Option<Value>

Emit signal by signal id with details. Read more
source§

fn disconnect(&self, handler_id: SignalHandlerId)

Disconnect a previously connected signal handler.
source§

fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
    F: Fn(&T, &ParamSpec) + Send + Sync + 'static,

Connect to the notify signal of the object. Read more
source§

fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
    F: Fn(&T, &ParamSpec) + 'static,

Connect to the notify signal of the object. Read more
source§

unsafe fn connect_notify_unsafe<F>(
    &self,
    name: Option<&str>,
    f: F
) -> SignalHandlerIdwhere
    F: Fn(&T, &ParamSpec),

Connect to the notify signal of the object. Read more
source§

fn notify(&self, property_name: &str)

Notify that the given property has changed its value. Read more
source§

fn notify_by_pspec(&self, pspec: &ParamSpec)

Notify that the given property has changed its value. Read more
source§

fn downgrade(&self) -> WeakRef<T>

Downgrade this object to a weak reference.
source§

fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>where
    F: FnOnce() + Send + 'static,

Add a callback to be notified when the Object is disposed.
source§

fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>where
    F: FnOnce() + 'static,

Add a callback to be notified when the Object is disposed. Read more
source§

fn bind_property<'f, 't, O, 'a>(
    &'a self,
    source_property: &'a str,
    target: &'a O,
    target_property: &'a str
) -> BindingBuilder<'a, 'f, 't>where
    O: ObjectType,

Bind property source_property on this object to the target_property on the target object. Read more
source§

fn ref_count(&self) -> u32

Returns the strong reference count of this object.
source§

unsafe fn run_dispose(&self)

Runs the dispose mechanism of the object. Read more
source§

impl<T> Property for Twhere
    T: HasParamSpec,

§

type Value = T

source§

impl<T> StaticTypeExt for Twhere
    T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for Twhere
    T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for Twhere
    T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T> TransparentType for Twhere
    T: TransparentPtrType,

source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

impl<T> TryFromClosureReturnValue for Twhere
    T: for<'a> FromValue<'a> + StaticType + 'static,

source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

impl<Super, Sub> CanDowncast<Sub> for Superwhere
    Super: IsA<Super>,
    Sub: IsA<Super>,

source§

impl<'a, T, C, E> FromValueOptional<'a> for Twhere
    T: FromValue<'a, Checker = C>,
    C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError<E>>,
    E: Error + Send + 'static,