module Gtk::Accessible
Overview
An interface for describing UI elements for Assistive Technologies.
Every accessible implementation has:
- a “role”, represented by a value of the
Gtk::AccessibleRoleenumeration - “attributes”, represented by a set of
Gtk::AccessibleState,Gtk::AccessiblePropertyandGtk::AccessibleRelationvalues
The role cannot be changed after instantiating a Gtk::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 Gtk::Widget visibility changes, the %GTK_ACCESSIBLE_STATE_HIDDEN
state will also change to reflect the Gtk::Widget#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 Gtk::Accessible#accessible_parent,
Gtk::Accessible#first_accessible_child and
Gtk::Accessible#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 Gtk::Accessible#accessible_parent= and
updating the sibling by Gtk::Accessible#update_next_accessible_sibling.
Direct including types
- Adw::AboutDialog
- Adw::AboutWindow
- Adw::ActionRow
- Adw::AlertDialog
- Adw::ApplicationWindow
- Adw::Avatar
- Adw::Banner
- Adw::Bin
- Adw::BottomSheet
- Adw::BreakpointBin
- Adw::ButtonContent
- Adw::ButtonRow
- Adw::Carousel
- Adw::CarouselIndicatorDots
- Adw::CarouselIndicatorLines
- Adw::Clamp
- Adw::ClampScrollable
- Adw::ComboRow
- Adw::Dialog
- Adw::EntryRow
- Adw::ExpanderRow
- Adw::Flap
- Adw::HeaderBar
- Adw::InlineViewSwitcher
- Adw::LayoutSlot
- Adw::Leaflet
- Adw::MessageDialog
- Adw::MultiLayoutView
- Adw::NavigationPage
- Adw::NavigationSplitView
- Adw::NavigationView
- Adw::OverlaySplitView
- Adw::PasswordEntryRow
- Adw::PreferencesDialog
- Adw::PreferencesGroup
- Adw::PreferencesPage
- Adw::PreferencesRow
- Adw::PreferencesWindow
- Adw::Spinner
- Adw::SpinRow
- Adw::SplitButton
- Adw::Squeezer
- Adw::StatusPage
- Adw::SwitchRow
- Adw::TabBar
- Adw::TabButton
- Adw::TabOverview
- Adw::TabPage
- Adw::TabView
- Adw::ToastOverlay
- Adw::ToggleGroup
- Adw::ToolbarView
- Adw::ViewStack
- Adw::ViewStackPage
- Adw::ViewSwitcher
- Adw::ViewSwitcherBar
- Adw::ViewSwitcherTitle
- Adw::Window
- Adw::WindowTitle
- Adw::WrapBox
- Gtk::AboutDialog
- Gtk::ActionBar
- Gtk::AppChooserButton
- Gtk::AppChooserDialog
- Gtk::AppChooserWidget
- Gtk::ApplicationWindow
- Gtk::AspectFrame
- Gtk::Assistant
- Gtk::Box
- Gtk::Button
- Gtk::Calendar
- Gtk::CellView
- Gtk::CenterBox
- Gtk::CheckButton
- Gtk::ColorButton
- Gtk::ColorChooserDialog
- Gtk::ColorChooserWidget
- Gtk::ColorDialogButton
- Gtk::ColumnView
- Gtk::ComboBox
- Gtk::ComboBoxText
- Gtk::Dialog
- Gtk::DragIcon
- Gtk::DrawingArea
- Gtk::DropDown
- Gtk::EditableLabel
- Gtk::EmojiChooser
- Gtk::Entry
- Gtk::Expander
- Gtk::FileChooserDialog
- Gtk::FileChooserWidget
- Gtk::Fixed
- Gtk::FlowBox
- Gtk::FlowBoxChild
- Gtk::FontButton
- Gtk::FontChooserDialog
- Gtk::FontChooserWidget
- Gtk::FontDialogButton
- Gtk::Frame
- Gtk::GLArea
- Gtk::GraphicsOffload
- Gtk::Grid
- Gtk::GridView
- Gtk::HeaderBar
- Gtk::IconView
- Gtk::Image
- Gtk::InfoBar
- Gtk::Inscription
- Gtk::Label
- Gtk::LevelBar
- Gtk::LinkButton
- Gtk::ListBase
- Gtk::ListBox
- Gtk::ListBoxRow
- Gtk::ListView
- Gtk::LockButton
- Gtk::MediaControls
- Gtk::MenuButton
- Gtk::MessageDialog
- Gtk::Notebook
- Gtk::Overlay
- Gtk::PageSetupUnixDialog
- Gtk::Paned
- Gtk::PasswordEntry
- Gtk::Picture
- Gtk::Popover
- Gtk::PopoverMenu
- Gtk::PopoverMenuBar
- Gtk::PrintUnixDialog
- Gtk::ProgressBar
- Gtk::Range
- Gtk::Revealer
- Gtk::Scale
- Gtk::ScaleButton
- Gtk::Scrollbar
- Gtk::ScrolledWindow
- Gtk::SearchBar
- Gtk::SearchEntry
- Gtk::Separator
- Gtk::ShortcutLabel
- Gtk::ShortcutsGroup
- Gtk::ShortcutsSection
- Gtk::ShortcutsShortcut
- Gtk::ShortcutsWindow
- Gtk::SpinButton
- Gtk::Spinner
- Gtk::Stack
- Gtk::StackPage
- Gtk::StackSidebar
- Gtk::StackSwitcher
- Gtk::Statusbar
- Gtk::Switch
- Gtk::Text
- Gtk::TextView
- Gtk::ToggleButton
- Gtk::TreeExpander
- Gtk::TreeView
- Gtk::Video
- Gtk::Viewport
- Gtk::VolumeButton
- Gtk::Widget
- Gtk::Window
- Gtk::WindowControls
- Gtk::WindowHandle
Defined in:
lib/gi-crystal/src/auto/gtk-4.0/accessible.crConstructors
-
.cast(obj : GObject::Object) : self
Cast a
GObject::Objecttoself, throws aTypeCastErrorif the cast can't be made.
Class Method Summary
Instance Method Summary
- #accessible_parent : Gtk::Accessible | Nil
- #accessible_role : Gtk::AccessibleRole
- #accessible_role=(value : Gtk::AccessibleRole) : Gtk::AccessibleRole
- #announce(message : String, priority : Gtk::AccessibleAnnouncementPriority) : Nil
- #at_context : Gtk::ATContext
- #bounds(x : Int32, y : Int32, width : Int32, height : Int32) : Bool
- #first_accessible_child : Gtk::Accessible | Nil
- #next_accessible_sibling : Gtk::Accessible | Nil
- #platform_state(state : Gtk::AccessiblePlatformState) : Bool
- #reset_property(property : Gtk::AccessibleProperty) : Nil
- #reset_relation(relation : Gtk::AccessibleRelation) : Nil
- #reset_state(state : Gtk::AccessibleState) : Nil
- #set_accessible_parent(parent : Gtk::Accessible | Nil, next_sibling : Gtk::Accessible | Nil) : Nil
- #to_unsafe
- #update_next_accessible_sibling(new_sibling : Gtk::Accessible | Nil) : Nil
- #update_platform_state(state : Gtk::AccessiblePlatformState) : Nil
- #update_property(properties : Enumerable(Gtk::AccessibleProperty), values : Enumerable(_)) : Nil
- #update_relation(relations : Enumerable(Gtk::AccessibleRelation), values : Enumerable(_)) : Nil
- #update_state(states : Enumerable(Gtk::AccessibleState), values : Enumerable(_)) : Nil