
@c %start of fragment

@deffn Function atk-document-get-document-type  (self@tie{}@code{<atk-document*>}) @result{}@tie{} (ret@tie{}@code{mchars})
Gets a string indicating the document type.

@table @var
@item document
a @code{<gobject>} instance that implements AtkDocumentIface

@item ret
a string indicating the document type

@end table

@end deffn

@deffn Function atk-document-get-document  (self@tie{}@code{<atk-document*>}) @result{}@tie{} (ret@tie{}@code{<gpointer>})
Gets a @samp{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.

@table @var
@item document
a @code{<gobject>} instance that implements AtkDocumentIface

@item ret
a @samp{gpointer} that points to an instance of the DOM.

@end table

@end deffn

@deffn Function atk-document-get-attribute-value  (self@tie{}@code{<atk-document*>}) (attribute_name@tie{}@code{mchars}) @result{}@tie{} (ret@tie{}@code{mchars})
Returns:

@table @var
@item document
a @code{<gobject>} instance that implements AtkDocumentIface

@item attribute-name
a character string representing the name of the attribute whose value is being
queried.

@item ret
a string value associated with the named attribute for this document, or NULL if
a value for @code{<attribute-name>} has not been specified for this document.

@end table

Since ATK 1.12

@end deffn

@deffn Function atk-document-set-attribute-value  (self@tie{}@code{<atk-document*>}) (attribute_name@tie{}@code{mchars}) (attribute_value@tie{}@code{mchars}) @result{}@tie{} (ret@tie{}@code{bool})
Returns:

@table @var
@item document
a @code{<gobject>} instance that implements AtkDocumentIface

@item attribute-name
a character string representing the name of the attribute whose value is being
set.

@item attribute-value
a string value to be associated with @code{<attribute-name>}.

@item ret
TRUE if @code{<value>} is successfully associated with @code{<attribute-name>}
for this document, FALSE otherwise (e.g. if the document does not allow the
attribute to be modified).

@end table

Since ATK 1.12

@end deffn

@deffn Function atk-document-get-attributes  (self@tie{}@code{<atk-document*>}) @result{}@tie{} (ret@tie{}@code{<atk-attribute-set*>})
Gets an AtkAttributeSet which describes document-wide attributes as name-value
pairs.

Returns:

@table @var
@item document
a @code{<gobject>} instance that implements AtkDocumentIface

@item ret
An AtkAttributeSet containing the explicitly set name-value-pair attributes
associated with this document as a whole.

@end table

Since ATK 1.12

@end deffn

@deffn Function atk-document-get-locale  (self@tie{}@code{<atk-document*>}) @result{}@tie{} (ret@tie{}@code{mchars})
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the content
of this document instance. Individual text substrings or images within this
document may have a different locale, see atk_text_get_attributes and
atk_image_get_image_locale.

@table @var
@item document
a @code{<gobject>} instance that implements AtkDocumentIface

@item ret
a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of the document
content as a whole, or NULL if the document content does not specify a locale.

@end table

@end deffn


@c %end of fragment
