Logo Search packages:      
Sourcecode: ardour version File versions  Download package

Atk::Object Class Reference

#include <object.h>

Inheritance diagram for Atk::Object:

sigc::trackable Atk::NoOpObject Atk::ObjectAccessible

List of all members.


Detailed Description

The base object class for the Accessibility Toolkit API. This class is the primary class for accessibility support via the Accessibility ToolKit (ATK). Objects which are instances of Atk::Object (or instances of Atk::Object-derived types) are queried for properties which relate basic (and generic) properties of a UI component such as name and description. Instances of Atk::Object may also be queried as to whether they implement other ATK interfaces (e.g. Atk::Action, Atk::Component, etc.), as appropriate to the role which a given UI component plays in a user interface.

All UI components in an application which provide useful information or services to the user must provide corresponding Atk::Object instances on request (in GTK+, for instance, usually on a call to Gtk::Widget::get_accessible()), either via ATK support built into the toolkit for the widget class or ancestor class, or in the case of custom widgets, if the inherited Atk::Object implementation is insufficient, via instances of a new Atk::Object subclass.

Definition at line 176 of file object.h.


Public Types

typedef AtkObjectClass BaseClassType
typedef AtkObject BaseObjectType
typedef Object_Class CppClassType
typedef Object CppObjectType
typedef void(* DestroyNotify )(gpointer data)

Public Member Functions

bool _cpp_destruction_is_in_progress () const
bool add_relationship (RelationType relationship, const Glib::RefPtr< Object > &target)
Glib::RefPtr< Atk::Objectget_accessible_child (int i)
void * get_data (const QueryQuark &key)
Glib::ustring get_description () const
int get_index_in_parent ()
int get_n_accessible_children () const
Glib::ustring get_name () const
Glib::RefPtr< Atk::Objectget_parent ()
template<class PropertyType>
void get_property (const Glib::ustring &property_name, PropertyType &value) const
 You probably want to use a specific property_*() accessor method instead.
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
 You probably want to use a specific property_*() accessor method instead.
Glib::RefPtr< RelationSetget_relation_set ()
Role get_role () const
Glib::RefPtr< StateSetget_state_set ()
const AtkObject * gobj () const
 Provides access to the underlying C GObject.
AtkObject * gobj ()
 Provides access to the underlying C GObject.
GObject * gobj_copy () const
AtkObject * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void notify_state_change (State state, bool value)
Glib::PropertyProxy_ReadOnly< int > property_accessible_component_layer () const
Glib::PropertyProxy_ReadOnly< int > property_accessible_component_mdi_zorder () const
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_accessible_description () const
Glib::PropertyProxy
< Glib::ustring
property_accessible_description ()
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_accessible_name () const
Glib::PropertyProxy
< Glib::ustring
property_accessible_name ()
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< Atk::Object > > 
property_accessible_parent () const
Glib::PropertyProxy
< Glib::RefPtr< Atk::Object > > 
property_accessible_parent ()
Glib::PropertyProxy_ReadOnly< int > property_accessible_role () const
Glib::PropertyProxy< int > property_accessible_role ()
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_accessible_table_caption () const
Glib::PropertyProxy
< Glib::ustring
property_accessible_table_caption ()
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_accessible_table_column_description () const
Glib::PropertyProxy
< Glib::ustring
property_accessible_table_column_description ()
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< Atk::Object > > 
property_accessible_table_column_header () const
Glib::PropertyProxy
< Glib::RefPtr< Atk::Object > > 
property_accessible_table_column_header ()
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_accessible_table_row_description () const
Glib::PropertyProxy
< Glib::ustring
property_accessible_table_row_description ()
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< Atk::Object > > 
property_accessible_table_row_header () const
Glib::PropertyProxy
< Glib::RefPtr< Atk::Object > > 
property_accessible_table_row_header ()
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< Atk::Object > > 
property_accessible_table_summary () const
Glib::PropertyProxy
< Glib::RefPtr< Atk::Object > > 
property_accessible_table_summary ()
Glib::PropertyProxy_ReadOnly
< double > 
property_accessible_value () const
Glib::PropertyProxy< double > property_accessible_value ()
virtual void reference () const
void remove_data (const QueryQuark &quark)
bool remove_relationship (RelationType relationship, const Glib::RefPtr< Object > &target)
void set_data (const Quark &key, void *data, DestroyNotify notify)
void set_data (const Quark &key, void *data)
void set_description (const Glib::ustring &description)
void set_name (const Glib::ustring &name)
void set_parent (const Glib::RefPtr< Atk::Object > &parent)
template<class PropertyType>
void set_property (const Glib::ustring &property_name, const PropertyType &value)
 You probably want to use a specific property_*() accessor method instead.
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
 You probably want to use a specific property_*() accessor method instead.
void set_role (Role role)
Glib::SignalProxy1< void, void ** > signal_active_descendant_changed ()
Glib::SignalProxy2< void,
guint, gpointer > 
signal_children_changed ()
Glib::SignalProxy1< void, bool > signal_focus_event ()
Glib::SignalProxy1< void,
AtkPropertyValues * > 
signal_property_change ()
Glib::SignalProxy2< void,
const Glib::ustring &, bool > 
signal_state_change ()
Glib::SignalProxy0< void > signal_visible_data_changed ()
void * steal_data (const QueryQuark &quark)
virtual void unreference () const

Static Public Member Functions

static ObjectBase * _get_current_wrapper (GObject *object)
static GType get_base_type () G_GNUC_CONST
static GType get_type () G_GNUC_CONST

Protected Member Functions

void _set_current_wrapper (GObject *object)
virtual void destroy_notify_ ()
void initialize (GObject *castitem)
bool is_anonymous_custom_ () const
bool is_derived_ () const
 Object (AtkObject *castitem)
 Object (const Glib::ConstructParams &construct_params)
virtual void on_active_descendant_changed (void **child)
virtual void on_children_changed (guint change_index, gpointer changed_child)
virtual void on_focus_event (bool focus_in)
virtual void on_property_change (AtkPropertyValues *values)
virtual void on_state_change (const Glib::ustring &name, bool state_set)
virtual void on_visible_data_changed ()

Static Protected Member Functions

static void destroy_notify_callback_ (void *data)

Protected Attributes

bool cpp_destruction_in_progress_
const char * custom_type_name_
GObject * gobject_

Package Functions

void add_destroy_notify_callback (void *data, func_destroy_notify func) const
void notify_callbacks ()
 Execute and remove all previously installed callbacks.
void remove_destroy_notify_callback (void *data) const

Package Attributes

 __pad0__:func_destroy_notify func_destroy_notify

Private Member Functions

 Object (const Object &)
Objectoperator= (const Object &)

Static Private Attributes

static CppClassType object_class_

Friends

class Glib::GSigConnectionNode
class Glib::Object_Class
class Object_Class

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Glib::Object > wrap (GObject *object, bool take_copy=false)
Glib::RefPtr< Atk::Objectwrap (AtkObject *object, bool take_copy=false)

The documentation for this class was generated from the following files:

Generated by  Doxygen 1.6.0   Back to index