atkmm 2.28.3
|
The ATK interface which allows access to a DOM associated with on object. More...
#include <atkmm/document.h>
Public Member Functions | |
Document (Document && src) noexcept | |
Document & | operator= (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_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) |
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::Document > | wrap (AtkDocument * object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
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.
|
protected |
You should derive from this class to use it.
|
noexcept |
|
overridenoexcept |
|
static |
Glib::ustring Atk::Document::get_attribute_value | ( | const Glib::ustring & | attribute_name | ) | const |
attribute_name | A character string representing the name of the attribute whose value is being queried. |
nullptr
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 its children, as 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.
|
protectedvirtual |
|
protectedvirtual |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
bool Atk::Document::set_attribute_value | ( | const Glib::ustring & | attribute_name, |
const Glib::ustring & | attribute_value | ||
) |
attribute_name | A character string representing the name of the attribute whose value is being set. |
attribute_value | A string value to be associated with #attribute_name. |
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).
|
related |
A Glib::wrap() method for this object.
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |