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:
[legend]

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

## 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 | ( |  | ) |

override noexcept

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

Since atkmm 1.12:

Parameters

  attribute_name | A 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()

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.

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.

## get_document_type()

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.

## get_document_type_vfunc()

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

protected virtual

## get_document_vfunc()

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

protected virtual

## 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
| ) |  |

Since atkmm 1.12:

Parameters

  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.

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

## wrap()

Glib::RefPtr< Atk::Document > wrap | ( | AtkDocument * | object,
|  | bool | take_copy = `false`
| ) |  |

related

A Glib::wrap() method for this object.

Parameters

  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.

Returns
  A C++ instance that wraps this C instance.