atkmm  2.36.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
 
 ~Document () noexcept override
 
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_attribute_value (const Glib::ustring& attribute_name) const
 Retrieves the value of the given attribute_name inside document. More...
 
bool set_attribute_value (const Glib::ustring& attribute_name, const Glib::ustring& attribute_value)
 Sets the value for the given attribute_name inside document. More...
 

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
 

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...
 

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

◆ Document() [1/2]

Atk::Document::Document ( )
protected

You should derive from this class to use it.

◆ Document() [2/2]

Atk::Document::Document ( Document&&  src)
noexcept

◆ ~Document()

Atk::Document::~Document ( )
overridenoexcept

Member Function Documentation

◆ add_interface()

static void Atk::Document::add_interface ( GType  gtype_implementer)
static

◆ get_attribute_value()

Glib::ustring Atk::Document::get_attribute_value ( const Glib::ustring &  attribute_name) const

Retrieves the value of the given attribute_name inside document.

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 nullptr if a value for attribute_name has not been specified for this document.

◆ get_document_type_vfunc()

virtual const gchar* Atk::Document::get_document_type_vfunc ( )
protectedvirtual

◆ get_document_vfunc()

virtual gpointer Atk::Document::get_document_vfunc ( ) const
protectedvirtual

◆ get_type()

static GType Atk::Document::get_type ( )
static

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

◆ gobj() [1/2]

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

Provides access to the underlying C GObject.

◆ gobj() [2/2]

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

Provides access to the underlying C GObject.

◆ operator=()

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

◆ set_attribute_value()

bool Atk::Document::set_attribute_value ( const Glib::ustring &  attribute_name,
const Glib::ustring &  attribute_value 
)

Sets the value for the given attribute_name inside document.

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 attribute_value is successfully associated with attribute_name for this document, and false if if the document does not allow the attribute to be modified.

Friends And Related Function Documentation

◆ wrap()

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.