Document
Object Hierarchy:
Atk.Document
Atk.Document
Atk.Document
GLib.Object
GLib.Object
GLib.Object->Atk.Document
Description:
[ CCode ( type_id = "atk_document_get_type ()" ) ]public interface Document : Object
The AtkDocument interface should be supported by any object whose content is a representation or view of a document.
The AtkDocument interface should appear on the toplevel container for the document content; however AtkDocument instances may be nested
(i.e. an AtkDocument may be a descendant of another AtkDocument) in those cases where one document contains "embedded content" which can
reasonably be considered a document in its own right.
All known implementing classes:
Content:
Methods:
public virtual unowned string ? get_attribute_value (string attribute_name)
Retrieves the value of the given attribute_name
inside
this .
public virtual unowned AttributeSet get_attributes ()
Gets an AtkAttributeSet which describes document-wide attributes as
name-value pairs.
public virtual int get_current_page_number ()
Retrieves the current page number inside
this .
public virtual void * get_document ()
Gets a pointer that points to an instance
of the DOM.
public virtual unowned string get_document_type ()
Gets a string indicating the document type.
public virtual unowned string get_locale ()
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale of
the content of this document instance.
public virtual int get_page_count ()
Retrieves the total number of pages inside
this .
public virtual bool set_attribute_value (string attribute_name, string attribute_value)
Sets the value for the given attribute_name
inside
this .
Signals:
public signal void load_complete ()
The 'load-complete' signal is emitted when a pending load of a static
document has completed.
public signal void load_stopped ()
The 'load-stopped' signal is emitted when a pending load of document
contents is cancelled, paused, or otherwise interrupted by the user or application logic.
public signal void page_changed (int page_number)
The 'page-changed' signal is emitted when the current page of a
document changes, e.g. pressing page up/down in a document viewer.
public signal void reload ()
The 'reload' signal is emitted when the contents of a document is
refreshed from its source.
Inherited Members:
All known members inherited from class GLib.Object
@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data
get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer
replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref