atkmm  2.36.1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Related Functions | List of all members
Atk::ObjectAccessible Class Reference

This object class is derived from AtkObject and can be used as a basis implementing accessible objects. More...

#include <atkmm/objectaccessible.h>

Inheritance diagram for Atk::ObjectAccessible:
Inheritance graph
[legend]

Public Member Functions

 ObjectAccessible (ObjectAccessible&& src) noexcept
 
ObjectAccessibleoperator= (ObjectAccessible&& src) noexcept
 
 ~ObjectAccessible () noexcept override
 
AtkGObjectAccessible* gobj ()
 Provides access to the underlying C GObject. More...
 
const AtkGObjectAccessible* gobj () const
 Provides access to the underlying C GObject. More...
 
AtkGObjectAccessible* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
- Public Member Functions inherited from Atk::Object
 Object (Object&& src) noexcept
 
Objectoperator= (Object&& src) noexcept
 
 ~Object () noexcept override
 
AtkObject* gobj ()
 Provides access to the underlying C GObject. More...
 
const AtkObject* gobj () const
 Provides access to the underlying C GObject. More...
 
AtkObject* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Glib::ustring get_name () const
 Gets the accessible name of the accessible. More...
 
Glib::ustring get_description () const
 Gets the accessible description of the accessible. More...
 
Glib::RefPtr< Atk::Objectget_parent ()
 Gets the accessible parent of the accessible. More...
 
int get_n_accessible_children () const
 Gets the number of accessible children of the accessible. More...
 
Glib::RefPtr< Atk::Objectget_accessible_child (int i)
 Gets a reference to the specified accessible child of the object. More...
 
Glib::RefPtr< RelationSetget_relation_set ()
 Gets the Atk::RelationSet associated with the object. More...
 
Role get_role () const
 Gets the role of the accessible. More...
 
Glib::RefPtr< StateSetget_state_set ()
 Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed. More...
 
int get_index_in_parent ()
 Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent. More...
 
void set_name (const Glib::ustring& name)
 Sets the accessible name of the accessible. More...
 
void set_description (const Glib::ustring& description)
 Sets the accessible description of the accessible. More...
 
void set_parent (const Glib::RefPtr< Atk::Object >& parent)
 Sets the accessible parent of the accessible. More...
 
void set_role (Role role)
 Sets the role of the accessible. More...
 
void notify_state_change (State state, bool value)
 Emits a state-change signal for the specified state. More...
 
bool add_relationship (Relation::Type relationship, const Glib::RefPtr< Object >& target)
 Adds a relationship of the specified type with the specified target. More...
 
bool remove_relationship (Relation::Type relationship, const Glib::RefPtr< Object >& target)
 Removes a relationship of the specified type with the specified target. More...
 
Glib::ustring get_object_locale () const
 Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of accessible. More...
 
Glib::ustring get_accessible_id () const
 Gets the accessible id of the accessible. More...
 
void set_accessible_id (const Glib::ustring& name)
 Sets the accessible ID of the accessible. More...
 
Glib::SignalProxyDetailed< void(guint, gpointer)> signal_children_changed (const Glib::ustring& add_or_remove={})
 
Glib::SignalProxy< void(bool)> signal_focus_event ()
 
Glib::SignalProxyDetailed< void(AtkPropertyValues*)> signal_property_change (const Glib::ustring& property_name={})
 
Glib::SignalProxyDetailed< void(const Glib::ustring&, bool)> signal_state_change (const Glib::ustring& state_name={})
 
Glib::SignalProxy< void()> signal_visible_data_changed ()
 
Glib::SignalProxy< void(void**)> signal_active_descendant_changed ()
 
Glib::PropertyProxy< Glib::ustring > property_accessible_name ()
 Object instance’s name formatted for assistive technology access. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_accessible_name () const
 Object instance’s name formatted for assistive technology access. More...
 
Glib::PropertyProxy< Glib::ustring > property_accessible_description ()
 Description of an object, formatted for assistive technology access. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_accessible_description () const
 Description of an object, formatted for assistive technology access. More...
 
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > property_accessible_parent ()
 Parent of the current accessible as returned by Atk::Object::get_parent(). More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Atk::Object > > property_accessible_parent () const
 Parent of the current accessible as returned by Atk::Object::get_parent(). More...
 
Glib::PropertyProxy< Roleproperty_accessible_role ()
 The accessible role of this object. More...
 
Glib::PropertyProxy_ReadOnly< Roleproperty_accessible_role () const
 The accessible role of this object. More...
 
Glib::PropertyProxy_ReadOnly< int > property_accessible_component_layer () const
 The accessible layer of this object. More...
 
Glib::PropertyProxy_ReadOnly< int > property_accessible_component_mdi_zorder () const
 The accessible MDI value of this object. More...
 
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > property_accessible_table_summary ()
 Is used to notify that the table summary has changed. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Atk::Object > > property_accessible_table_summary () const
 Is used to notify that the table summary has changed. More...
 
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > property_accessible_table_caption_object ()
 Is used to notify that the table caption has changed. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Atk::Object > > property_accessible_table_caption_object () const
 Is used to notify that the table caption has changed. More...
 
Glib::PropertyProxy_ReadOnly< int > property_accessible_hypertext_nlinks () const
 The number of links which the current AtkHypertext has. More...
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
- Static Public Member Functions inherited from Atk::Object
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Protected Member Functions

Glib::RefPtr< Glib::Object > get_object ()
 Gets the GObject for which obj is the accessible object. More...
 
Glib::RefPtr< const Glib::Object > get_object () const
 Gets the GObject for which obj is the accessible object. More...
 
- Protected Member Functions inherited from Atk::Object
virtual void on_children_changed (guint change_index, gpointer changed_child)
 This is a default handler for the signal signal_children_changed(). More...
 
virtual void on_focus_event (bool focus_in)
 This is a default handler for the signal signal_focus_event(). More...
 
virtual void on_property_change (AtkPropertyValues* values)
 This is a default handler for the signal signal_property_change(). More...
 
virtual void on_state_change (const Glib::ustring& name, bool state_set)
 This is a default handler for the signal signal_state_change(). More...
 
virtual void on_visible_data_changed ()
 This is a default handler for the signal signal_visible_data_changed(). More...
 
virtual void on_active_descendant_changed (void** child)
 This is a default handler for the signal signal_active_descendant_changed(). More...
 

Static Protected Member Functions

static Glib::RefPtr< Atk::Objectfor_object (const Glib::RefPtr< Glib::Object >& obj)
 Gets the accessible object for the specified obj. More...
 
static Glib::RefPtr< const Atk::Objectfor_object (const Glib::RefPtr< const Glib::Object >& obj)
 Gets the accessible object for the specified obj. More...
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Atk::ObjectAccessiblewrap (AtkGObjectAccessible* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

This object class is derived from AtkObject and can be used as a basis implementing accessible objects.

This can be used as a basis for implementing accessible objects for Glib::Objects which are not derived from Gtk::Widget. One example of its use is in providing an accessible object for GnomeCanvasItem in the GAIL library.

Constructor & Destructor Documentation

◆ ObjectAccessible()

Atk::ObjectAccessible::ObjectAccessible ( ObjectAccessible&&  src)
noexcept

◆ ~ObjectAccessible()

Atk::ObjectAccessible::~ObjectAccessible ( )
overridenoexcept

Member Function Documentation

◆ for_object() [1/2]

static Glib::RefPtr<const Atk::Object> Atk::ObjectAccessible::for_object ( const Glib::RefPtr< const Glib::Object > &  obj)
staticprotected

Gets the accessible object for the specified obj.

Parameters
objA Glib::Object.
Returns
A Atk::Object which is the accessible object for the obj.

◆ for_object() [2/2]

static Glib::RefPtr<Atk::Object> Atk::ObjectAccessible::for_object ( const Glib::RefPtr< Glib::Object > &  obj)
staticprotected

Gets the accessible object for the specified obj.

Parameters
objA Glib::Object.
Returns
A Atk::Object which is the accessible object for the obj.

◆ get_object() [1/2]

Glib::RefPtr<Glib::Object> Atk::ObjectAccessible::get_object ( )
protected

Gets the GObject for which obj is the accessible object.

Returns
A Glib::Object which is the object for which obj is the accessible object.

◆ get_object() [2/2]

Glib::RefPtr<const Glib::Object> Atk::ObjectAccessible::get_object ( ) const
protected

Gets the GObject for which obj is the accessible object.

Returns
A Glib::Object which is the object for which obj is the accessible object.

◆ get_type()

static GType Atk::ObjectAccessible::get_type ( )
static

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

◆ gobj() [1/2]

AtkGObjectAccessible* Atk::ObjectAccessible::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const AtkGObjectAccessible* Atk::ObjectAccessible::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

AtkGObjectAccessible* Atk::ObjectAccessible::gobj_copy ( )

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

◆ operator=()

ObjectAccessible& Atk::ObjectAccessible::operator= ( ObjectAccessible&&  src)
noexcept

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Atk::ObjectAccessible > wrap ( AtkGObjectAccessible *  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.