Interface

AtkDocument

Description [src]

interface Atk.Document : GObject.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.

Prerequisite

In order to implement Document, your type must inherit from GObject.

Instance methods

atk_document_get_attribute_value

Retrieves the value of the given attribute_name inside document.

Available since: 1.12

atk_document_get_attributes

Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs.

Available since: 1.12

atk_document_get_current_page_number

Retrieves the current page number inside document.

Available since: 2.12

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.

atk_document_get_document_type

Gets a string indicating the document type.

atk_document_get_locale

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.

Deprecated since: 2.7.90

atk_document_get_page_count

Retrieves the total number of pages inside document.

Available since: 2.12

atk_document_set_attribute_value

Sets the value for the given attribute_name inside document.

Available since: 1.12

Signals

Atk.Document::load-complete

The ‘load-complete’ signal is emitted when a pending load of a static document has completed. This signal is to be expected by ATK clients if and when AtkDocument implementors expose ATK_STATE_BUSY. If the state of an AtkObject which implements AtkDocument does not include ATK_STATE_BUSY, it should be safe for clients to assume that the AtkDocument’s static contents are fully loaded into the container. (Dynamic document contents should be exposed via other signals.)

Atk.Document::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. It should not however be emitted while waiting for a resource (for instance while blocking on a file or network read) unless a user-significant timeout has occurred.

Atk.Document::page-changed

The ‘page-changed’ signal is emitted when the current page of a document changes, e.g. pressing page up/down in a document viewer.

Available since: 2.12

Atk.Document::reload

The ‘reload’ signal is emitted when the contents of a document is refreshed from its source. Once ‘reload’ has been emitted, a matching ‘load-complete’ or ‘load-stopped’ signal should follow, which clients may await before interrogating ATK for the latest document content.

Interface structure

struct AtkDocumentIface {
  GTypeInterface parent;
  const gchar* (* get_document_type) (
    AtkDocument* document
  );
  gpointer (* get_document) (
    AtkDocument* document
  );
  const gchar* (* get_document_locale) (
    AtkDocument* document
  );
  AtkAttributeSet* (* get_document_attributes) (
    AtkDocument* document
  );
  const gchar* (* get_document_attribute_value) (
    AtkDocument* document,
    const gchar* attribute_name
  );
  gboolean (* set_document_attribute) (
    AtkDocument* document,
    const gchar* attribute_name,
    const gchar* attribute_value
  );
  gint (* get_current_page_number) (
    AtkDocument* document
  );
  gint (* get_page_count) (
    AtkDocument* document
  );
  
}
Interface members
parent
GTypeInterface
 No description available.
get_document_type
const gchar* (* get_document_type) (
    AtkDocument* document
  )
 No description available.
get_document
gpointer (* get_document) (
    AtkDocument* document
  )
 No description available.
get_document_locale
const gchar* (* get_document_locale) (
    AtkDocument* document
  )
 No description available.
get_document_attributes
AtkAttributeSet* (* get_document_attributes) (
    AtkDocument* document
  )
 No description available.
get_document_attribute_value
const gchar* (* get_document_attribute_value) (
    AtkDocument* document,
    const gchar* attribute_name
  )
 No description available.
set_document_attribute
gboolean (* set_document_attribute) (
    AtkDocument* document,
    const gchar* attribute_name,
    const gchar* attribute_value
  )
 No description available.
get_current_page_number
gint (* get_current_page_number) (
    AtkDocument* document
  )
 No description available.
get_page_count
gint (* get_page_count) (
    AtkDocument* document
  )
 No description available.

Virtual methods

Atk.Document.get_current_page_number

Retrieves the current page number inside document.

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.

Atk.Document.get_document_attribute_value

Retrieves the value of the given attribute_name inside document.

Atk.Document.get_document_attributes

Gets an AtkAttributeSet which describes document-wide attributes as name-value pairs.

Atk.Document.get_document_locale

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.

Deprecated since:

Atk.Document.get_document_type

Gets a string indicating the document type.

Atk.Document.get_page_count

Retrieves the total number of pages inside document.

Atk.Document.set_document_attribute

Sets the value for the given attribute_name inside document.