Interface

Atk-1.0 ▶ Atk ▶ Document ▶ Interface

Interface for implementing Document. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_get_current_page_number(): number;
    vfunc_get_document(): null;
    vfunc_get_document_attribute_value(attribute_name: string): string;
    vfunc_get_document_attributes(): SList;
    vfunc_get_document_locale(): string;
    vfunc_get_document_type(): string;
    vfunc_get_page_count(): number;
    vfunc_get_text_selections(): Atk.TextSelection[];
    vfunc_set_document_attribute(
        attribute_name: string,
        attribute_value: string,
    ): boolean;
    vfunc_set_text_selections(selections: Atk.TextSelection[]): boolean;
}

Hierarchy (View Summary)

Index
vfunc_get_current_page_number vfunc_get_document vfunc_get_document_attribute_value vfunc_get_document_attributes vfunc_get_document_locale vfunc_get_document_type vfunc_get_page_count vfunc_get_text_selections vfunc_set_document_attribute vfunc_set_text_selections

Virtualvfunc_get_current_page_number

  • vfunc_get_current_page_number(): number

    Retrieves the current page number inside document.

    Returns number

    2.12

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

    Returns null

    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.

  • Retrieves the value of the given attribute_name inside document.

    Parameters

    • attribute_name: string

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

    Returns string

    1.12

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

    Returns SList

    1.12

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

    Returns string

    since 2.7.90: Please use atk_object_get_object_locale() instead.

  • Gets a string indicating the document type.

    Returns string

    Since 2.12. Please use atk_document_get_attributes() to ask for the document type if it applies.

Virtualvfunc_get_page_count

  • vfunc_get_page_count(): number

    Retrieves the total number of pages inside document.

    Returns number

    2.12

Virtualvfunc_get_text_selections

  • Sets the value for the given attribute_name inside document.

    Parameters

    • attribute_name: string

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

    • attribute_value: string

      a string value to be associated with attribute_name.

    Returns boolean

    1.12

Virtualvfunc_set_text_selections

  • vfunc_set_text_selections(selections: Atk.TextSelection[]): boolean

    Makes 1 or more selections within this document denoted by the given array of AtkTextSelections. Any existing physical selection (inside or outside this document) is replaced by the new selections. All objects within the given selection ranges must be descendants of this document. Otherwise FALSE will be returned.

    Parameters

    Returns boolean

    2.52