/* ATK - Accessibility Toolkit
* Copyright 2001 Sun Microsystems Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#include "config.h"
#include "atkdocument.h"
/**
* SECTION:atkdocument
* @Short_description: The ATK interface which represents the toplevel
* container for document content.
* @Title:AtkDocument
*
* 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.
*
*/
enum {
LOAD_COMPLETE,
RELOAD,
LOAD_STOPPED,
PAGE_CHANGED,
LAST_SIGNAL
};
static void atk_document_base_init (AtkDocumentIface *class);
static guint atk_document_signals[LAST_SIGNAL] = {0};
GType
atk_document_get_type (void)
{
static GType type = 0;
if (!type) {
static const GTypeInfo tinfo =
{
sizeof (AtkDocumentIface),
(GBaseInitFunc) atk_document_base_init,
(GBaseFinalizeFunc) NULL,
};
type = g_type_register_static (G_TYPE_INTERFACE, "AtkDocument", &tinfo, 0);
}
return type;
}
static void
atk_document_base_init (AtkDocumentIface *class)
{
static gboolean initialized = FALSE;
if (!initialized)
{
/**
* AtkDocument::load-complete:
* @atkdocument: the object which received the signal.
*
* 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_signals[LOAD_COMPLETE] =
g_signal_new ("load_complete",
ATK_TYPE_DOCUMENT,
G_SIGNAL_RUN_LAST,
0,
(GSignalAccumulator) NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
/**
* AtkDocument::reload:
* @atkdocument: the object which received the signal.
*
* 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.
*/
atk_document_signals[RELOAD] =
g_signal_new ("reload",
ATK_TYPE_DOCUMENT,
G_SIGNAL_RUN_LAST,
0,
(GSignalAccumulator) NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
/**
* AtkDocument::load-stopped:
* @atkdocument: the object which received the signal.
*
* 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_signals[LOAD_STOPPED] =
g_signal_new ("load_stopped",
ATK_TYPE_DOCUMENT,
G_SIGNAL_RUN_LAST,
0,
(GSignalAccumulator) NULL, NULL,
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
/**
* AtkDocument::page-changed:
* @atkdocument: the object on which the signal was emitted
* @page_number: the new page number. If this value is unknown
* or not applicable, -1 should be provided.
*
* The 'page-changed' signal is emitted when the current page of
* a document changes, e.g. pressing page up/down in a document
* viewer.
*
* Since: 2.12
*/
atk_document_signals[PAGE_CHANGED] =
g_signal_new ("page_changed",
ATK_TYPE_DOCUMENT,
G_SIGNAL_RUN_LAST,
0,
(GSignalAccumulator) NULL, NULL,
g_cclosure_marshal_VOID__INT,
G_TYPE_NONE, 1, G_TYPE_INT);
initialized = TRUE;
}
}
/**
* atk_document_get_document_type:
* @document: a #GObject instance that implements AtkDocumentIface
*
* Gets a string indicating the document type.
*
* Deprecated: Since 2.12. Please use atk_document_get_attributes() to
* ask for the document type if it applies.
*
* Returns: a string indicating the document type
**/
const gchar*
atk_document_get_document_type (AtkDocument *document)
{
AtkDocumentIface *iface;
g_return_val_if_fail (ATK_IS_DOCUMENT (document), NULL);
iface = ATK_DOCUMENT_GET_IFACE (document);
if (iface->get_document_type)
{
return (iface->get_document_type) (document);
}
else
{
return NULL;
}
}
/**
* atk_document_get_document:
* @document: a #GObject instance that implements AtkDocumentIface
*
* 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.
*
* Returns: (transfer none): a %gpointer that points to an instance of the DOM.
**/
gpointer
atk_document_get_document (AtkDocument *document)
{
AtkDocumentIface *iface;
g_return_val_if_fail (ATK_IS_DOCUMENT (document), NULL);
iface = ATK_DOCUMENT_GET_IFACE (document);
if (iface->get_document)
{
return (iface->get_document) (document);
}
else
{
return NULL;
}
}
/**
* atk_document_get_locale:
* @document: a #GObject instance that implements AtkDocumentIface
*
* 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: 2.7.90: Please use atk_object_get_object_locale() instead.
*
* Returns: 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.
**/
const gchar *
atk_document_get_locale (AtkDocument *document)
{
AtkDocumentIface *iface;
g_return_val_if_fail (ATK_IS_DOCUMENT (document), NULL);
iface = ATK_DOCUMENT_GET_IFACE (document);
if (iface->get_document_locale)
{
return (iface->get_document_locale) (document);
}
else
{
return NULL;
}
}
/**
* atk_document_get_attributes:
* @document: a #GObject instance that implements AtkDocumentIface
*
* Gets an AtkAttributeSet which describes document-wide
* attributes as name-value pairs.
*
* Since: 1.12
*
* Returns: (transfer none): An AtkAttributeSet containing the explicitly
* set name-value-pair attributes associated with this document
* as a whole.
**/
AtkAttributeSet *
atk_document_get_attributes (AtkDocument *document)
{
AtkDocumentIface *iface;
g_return_val_if_fail (ATK_IS_DOCUMENT (document), NULL);
iface = ATK_DOCUMENT_GET_IFACE (document);
if (iface->get_document_attributes)
{
return (iface->get_document_attributes) (document);
}
else
{
return NULL;
}
}
/**
* atk_document_get_attribute_value:
* @document: a #GObject instance that implements AtkDocumentIface
* @attribute_name: a character string representing the name of the attribute
* whose value is being queried.
*
* Since: 1.12
*
* Returns: (nullable): a string value associated with the named
* attribute for this document, or NULL if a value for
* #attribute_name has not been specified for this document.
*/
const gchar *
atk_document_get_attribute_value (AtkDocument *document,
const gchar *attribute_name)
{
AtkDocumentIface *iface;
g_return_val_if_fail (ATK_IS_DOCUMENT (document), NULL);
iface = ATK_DOCUMENT_GET_IFACE (document);
if (iface->get_document_attribute_value)
{
return (iface->get_document_attribute_value) (document, attribute_name);
}
else
{
return NULL;
}
}
/**
* atk_document_set_attribute_value:
* @document: a #GObject instance that implements AtkDocumentIface
* @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.
*
* Since: 1.12
*
* 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).
*/
gboolean
atk_document_set_attribute_value (AtkDocument *document,
const gchar *attribute_name,
const gchar *attribute_value)
{
AtkDocumentIface *iface;
g_return_val_if_fail (ATK_IS_DOCUMENT (document), FALSE);
iface = ATK_DOCUMENT_GET_IFACE (document);
if (iface->set_document_attribute)
{
return (iface->set_document_attribute) (document, attribute_name, attribute_value);
}
else
{
return FALSE;
}
}
/**
* atk_document_get_current_page_number:
* @document: the #AtkDocument
*
* Since: 2.12
*
* Returns: current page number inside @document. -1 if not
* implemented, not know by the implementor or irrelevant.
*/
gint
atk_document_get_current_page_number (AtkDocument *document)
{
AtkDocumentIface *iface;
g_return_val_if_fail (ATK_IS_DOCUMENT (document), FALSE);
iface = ATK_DOCUMENT_GET_IFACE (document);
if (iface->get_current_page_number)
{
return (iface->get_current_page_number) (document);
}
else
{
return -1;
}
}
/**
* atk_document_get_page_count:
* @document: the #AtkDocument
*
* Since: 2.12
*
* Returns: total page count of @document. -1 if not implemented, not
* know by the implementor or irrelevant.
*/
gint
atk_document_get_page_count (AtkDocument *document)
{
AtkDocumentIface *iface;
g_return_val_if_fail (ATK_IS_DOCUMENT (document), FALSE);
iface = ATK_DOCUMENT_GET_IFACE (document);
if (iface->get_page_count)
{
return (iface->get_page_count) (document);
}
else
{
return -1;
}
}