gtkmm 4.14.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Symbols | List of all members
Gtk::ATContext Class Reference

Gtk::ATContext is an abstract class provided by GTK to communicate to platform-specific assistive technologies API. More...

#include <gtkmm/atcontext.h>

Inheritance diagram for Gtk::ATContext:
Inheritance graph
[legend]

Public Member Functions

 ATContext (ATContext &&src) noexcept
 
ATContextoperator= (ATContext &&src) noexcept
 
 ~ATContext () noexcept override
 
GtkATContextgobj ()
 Provides access to the underlying C GObject.
 
const GtkATContextgobj () const
 Provides access to the underlying C GObject.
 
GtkATContextgobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
 
Glib::RefPtr< Accessibleget_accessible ()
 Retrieves the Gtk::Accessible using this context.
 
Glib::RefPtr< const Accessibleget_accessible () const
 Retrieves the Gtk::Accessible using this context.
 
Accessible::Role get_accessible_role () const
 Retrieves the accessible role of this context.
 
Glib::PropertyProxy< Accessible::Roleproperty_accessible_role ()
 The accessible role used by the AT context.
 
Glib::PropertyProxy_ReadOnly< Accessible::Roleproperty_accessible_role () const
 The accessible role used by the AT context.
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Accessible > > property_accessible () const
 The Gtk::Accessible that created the Gtk::ATContext instance.
 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Display > > property_display ()
 The Gdk::Display for the Gtk::ATContext.
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Display > > property_display () const
 The Gdk::Display for the Gtk::ATContext.
 
Glib::SignalProxy< void()> signal_state_change ()
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
 
static Glib::RefPtr< ATContextcreate (Accessible::Role accessible_role, const Glib::RefPtr< Accessible > &accessible, const Glib::RefPtr< Gdk::Display > &display)
 Creates a new Gtk::ATContext instance for the given accessible role, accessible instance, and display connection.
 

Protected Member Functions

 ATContext ()
 

Related Symbols

(Note that these are not member symbols.)

Glib::RefPtr< Gtk::ATContextwrap (GtkATContext *object, bool take_copy=false)
 A Glib::wrap() method for this object.
 

Detailed Description

Gtk::ATContext is an abstract class provided by GTK to communicate to platform-specific assistive technologies API.

Each platform supported by GTK implements a GtkATContext subclass, and is responsible for updating the accessible state in response to state changes in Gtk::Accessible.

Since gtkmm 4.10:

Constructor & Destructor Documentation

◆ ATContext() [1/2]

Gtk::ATContext::ATContext ( ATContext &&  src)
noexcept

◆ ~ATContext()

Gtk::ATContext::~ATContext ( )
overridenoexcept

◆ ATContext() [2/2]

Gtk::ATContext::ATContext ( )
protected

Member Function Documentation

◆ create()

static Glib::RefPtr< ATContext > Gtk::ATContext::create ( Accessible::Role  accessible_role,
const Glib::RefPtr< Accessible > &  accessible,
const Glib::RefPtr< Gdk::Display > &  display 
)
static

Creates a new Gtk::ATContext instance for the given accessible role, accessible instance, and display connection.

The Gtk::ATContext implementation being instantiated will depend on the platform.

Parameters
accessible_roleThe accessible role used by the Gtk::ATContext.
accessibleThe Gtk::Accessible implementation using the Gtk::ATContext.
displayThe Gdk::Display used by the Gtk::ATContext.
Returns
The Gtk::ATContext.

◆ get_accessible() [1/2]

Glib::RefPtr< Accessible > Gtk::ATContext::get_accessible ( )

Retrieves the Gtk::Accessible using this context.

Returns
A Gtk::Accessible.

◆ get_accessible() [2/2]

Glib::RefPtr< const Accessible > Gtk::ATContext::get_accessible ( ) const

Retrieves the Gtk::Accessible using this context.

Returns
A Gtk::Accessible.

◆ get_accessible_role()

Accessible::Role Gtk::ATContext::get_accessible_role ( ) const

Retrieves the accessible role of this context.

Returns
A Gtk::Accessible::Role.

◆ get_type()

static GType Gtk::ATContext::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GtkATContext * Gtk::ATContext::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkATContext * Gtk::ATContext::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkATContext * Gtk::ATContext::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ operator=()

ATContext & Gtk::ATContext::operator= ( ATContext &&  src)
noexcept

◆ property_accessible()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Accessible > > Gtk::ATContext::property_accessible ( ) const

The Gtk::Accessible that created the Gtk::ATContext instance.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_accessible_role() [1/2]

Glib::PropertyProxy< Accessible::Role > Gtk::ATContext::property_accessible_role ( )

The accessible role used by the AT context.

Depending on the given role, different states and properties can be set or retrieved.

Default value: Gtk::Accessible::Role::NONE

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_accessible_role() [2/2]

Glib::PropertyProxy_ReadOnly< Accessible::Role > Gtk::ATContext::property_accessible_role ( ) const

The accessible role used by the AT context.

Depending on the given role, different states and properties can be set or retrieved.

Default value: Gtk::Accessible::Role::NONE

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_display() [1/2]

Glib::PropertyProxy< Glib::RefPtr< Gdk::Display > > Gtk::ATContext::property_display ( )

The Gdk::Display for the Gtk::ATContext.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_display() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Display > > Gtk::ATContext::property_display ( ) const

The Gdk::Display for the Gtk::ATContext.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ signal_state_change()

Glib::SignalProxy< void()> Gtk::ATContext::signal_state_change ( )
Slot Prototype:
void on_my_state_change()

Flags: Run First

Emitted when the attributes of the accessible for the Gtk::ATContext instance change.

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gtk::ATContext > wrap ( GtkATContext object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.