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

The ATK interface which allows access to a DOM associated with on object. More...

#include <atkmm/document.h>

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

Public Member Functions

 Document (Document&& src) noexcept
 
Documentoperator= (Document&& src) noexcept
 
virtual ~Document () noexcept
 
AtkDocument* gobj ()
 Provides access to the underlying C GObject. More...
 
const AtkDocument* gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::ustring get_document_type () const
 Gets a string indicating the document type. More...
 
gpointer get_document ()
 Gets a gpointer that points to an instance of the DOM. More...
 
Glib::ustring get_attribute_value (const Glib::ustring& attribute_name) const
 
bool set_attribute_value (const Glib::ustring& attribute_name, const Glib::ustring& attribute_value)
 
- Public Member Functions inherited from Glib::Interface
 Interface ()
 
 Interface (Interface &&src) noexcept
 
Interfaceoperator= (Interface &&src) noexcept
 
 Interface (const Glib::Interface_Class &interface_class)
 
 Interface (GObject *castitem)
 
virtual ~Interface () noexcept
 
 Interface (const Interface &)=delete
 
Interfaceoperator= (const Interface &)=delete
 
GObject * gobj ()
 
const GObject * gobj () const
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (const ObjectBase &)=delete
 
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
 
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
 
void set_property (const Glib::ustring &property_name, const PropertyType &value)
 
void get_property (const Glib::ustring &property_name, PropertyType &value) const
 
void connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
 
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
 
void freeze_notify ()
 
void thaw_notify ()
 
virtual void reference () const
 
virtual void unreference () const
 
GObject * gobj ()
 
const GObject * gobj () const
 
GObject * gobj_copy () const
 
- Public Member Functions inherited from sigc::trackable
 trackable ()
 
 trackable (const trackable &src)
 
 trackable (trackable &&src) noexcept
 
 ~trackable ()
 
void add_destroy_notify_callback (void *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src) noexcept
 
void remove_destroy_notify_callback (void *data) const
 

Static Public Member Functions

static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Protected Member Functions

 Document ()
 You should derive from this class to use it. More...
 
virtual const gchar* get_document_type_vfunc ()
 
virtual gpointer get_document_vfunc () const
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 
 ObjectBase (const char *custom_type_name)
 
 ObjectBase (const std::type_info &custom_type_info)
 
 ObjectBase (ObjectBase &&src) noexcept
 
ObjectBaseoperator= (ObjectBase &&src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject *castitem)
 
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
 

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 

Detailed Description

The ATK interface which allows access to a DOM associated with on object.

This interface should be supported by any object that has an associated document object model (DOM). This interface provides the standard mechanism allowing an assistive technology access to the DOM.

Constructor & Destructor Documentation

Atk::Document::Document ( )
protected

You should derive from this class to use it.

Atk::Document::Document ( Document&&  src)
noexcept
virtual Atk::Document::~Document ( )
virtualnoexcept

Member Function Documentation

static void Atk::Document::add_interface ( GType  gtype_implementer)
static
Glib::ustring Atk::Document::get_attribute_value ( const Glib::ustring attribute_name) const
Since atkmm 1.12:
Parameters
attribute_nameA character string representing the name of the attribute whose value is being queried.
Returns
A string value associated with the named attribute for this document, or 0 if a value for #attribute_name has not been specified for this document.
gpointer Atk::Document::get_document ( )

Gets a gpointer that points to an instance of the DOM.

It is up to the caller to check atk_document_get_type to determine how to cast this pointer.

Deprecated: Since 2.12. document is already a representation of the document. Use it directly, or one of his children, as an instance of the DOM.

Deprecated:
Document is already a representation of the document. Use it directly, or one of its children, as an instance of the DOM.
Returns
A gpointer that points to an instance of the DOM.
Glib::ustring Atk::Document::get_document_type ( ) const

Gets a string indicating the document type.

Deprecated: Since 2.12. Please use get_attributes() to ask for the document type if it applies.

Deprecated:
Please use get_attribute() to ask for the document type if it applies.
Returns
A string indicating the document type.
virtual const gchar* Atk::Document::get_document_type_vfunc ( )
protectedvirtual
virtual gpointer Atk::Document::get_document_vfunc ( ) const
protectedvirtual
static GType Atk::Document::get_type ( )
static

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

AtkDocument* Atk::Document::gobj ( )
inline

Provides access to the underlying C GObject.

const AtkDocument* Atk::Document::gobj ( ) const
inline

Provides access to the underlying C GObject.

Document& Atk::Document::operator= ( Document&&  src)
noexcept
bool Atk::Document::set_attribute_value ( const Glib::ustring attribute_name,
const Glib::ustring attribute_value 
)
Since atkmm 1.12:
Parameters
attribute_nameA character string representing the name of the attribute whose value is being set.
attribute_valueA string value to be associated with #attribute_name.
Returns
true if #value is successfully associated with #attribute_name for this document, false otherwise (e.g. if the document does not allow the attribute to be modified).

Friends And Related Function Documentation

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