/* 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"

#include "atkmarshal.h"

/**

 * AtkDocument:

 *

 * The ATK interface which represents the toplevel

 *  container for document content.

 *

 * 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,

  DOCUMENT_ATTRIBUTE_CHANGED,

  LAST_SIGNAL

};

static void atk_document_base_init (AtkDocumentIface *class);

static guint atk_document_signals[LAST_SIGNAL] = { 0 };

GType

{

  static GType type = 0;

    {

      static const GTypeInfo tinfo = {

        sizeof (AtkDocumentIface),

        (GBaseInitFunc) atk_document_base_init,

        (GBaseFinalizeFunc) NULL,

      };

    }

}

static void

{

  static gboolean initialized = FALSE;

    {

      /**

       * 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_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_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_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_TYPE_DOCUMENT,

                        G_SIGNAL_RUN_LAST,

                        0,

                        (GSignalAccumulator) NULL, NULL,

                        g_cclosure_marshal_VOID__INT,

                        G_TYPE_NONE, 1, G_TYPE_INT);

      /**

       * AtkDocument::document-attribute-changed

       * @atkdocument: the object which received the signal.

       * @arg1: the name of the attribute being modified, or %NULL if not

       *          available.

       * @arg2: the attribute's new value, or %null if not available.

       *

       * The "document-attribute-changed" signal should be emitted when there is a

       * change to one of the document attributes returned by

       * atk_document_get_attributes.

       *

       * Since: 2.52

       */

                        ATK_TYPE_DOCUMENT,

                        G_SIGNAL_RUN_LAST,

                        0,

                        NULL, NULL,

                        atk_marshal_VOID__STRING_STRING,

                        G_TYPE_NONE,

                        2, G_TYPE_STRING, G_TYPE_STRING);

    }

/**

 * atk_document_get_document_type: (virtual 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 *

{

  AtkDocumentIface *iface;

    {

    }

  else

    {

    }

}

/**

 * atk_document_get_document: (virtual 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

{

  AtkDocumentIface *iface;

    {

    }

  else

    {

    }

}

/**

 * atk_document_get_locale: (virtual get_document_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 *

{

  AtkDocumentIface *iface;

    {

    }

  else

    {

    }

}

/**

 * atk_document_get_attributes: (virtual get_document_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 *

{

  AtkDocumentIface *iface;

    {

    }

  else

    {

    }

}

/**

 * atk_document_get_attribute_value: (virtual get_document_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.

 *

 * Retrieves the value of the given @attribute_name inside @document.

 *

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

 *

 * Since: 1.12

 */

const gchar *

                                  const gchar *attribute_name)

{

  AtkDocumentIface *iface;

    {

    }

  else

    {

    }

}

/**

 * atk_document_set_attribute_value: (virtual set_document_attribute)

 * @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.

 *

 * Sets the value for the given @attribute_name inside @document.

 *

 * Since: 1.12

 *

 * Returns: %TRUE if @attribute_value is successfully associated

 *   with @attribute_name for this @document, and %FALSE if if the

 *   document does not allow the attribute to be modified

 */

gboolean

                                  const gchar *attribute_name,

                                  const gchar *attribute_value)

{

  AtkDocumentIface *iface;

    {

    }

  else

    {

    }

}

/**

 * atk_document_get_current_page_number:

 * @document: the #AtkDocument

 *

 * Retrieves the current page number inside @document.

 *

 * Returns: the current page number inside @document, or -1 if

 *   not implemented, not know by the implementor, or irrelevant.

 *

 * Since: 2.12

 */

gint

{

  AtkDocumentIface *iface;

    {

    }

  else

    {

    }

}

/**

 * atk_document_get_page_count:

 * @document: the #AtkDocument

 *

 * Retrieves the total number of pages inside @document.

 *

 * Returns: total page count of @document, or -1 if not implemented,

 *   not know by the implementor or irrelevant.

 *

 * Since: 2.12

 */

gint

{

  AtkDocumentIface *iface;

    {

    }

  else

    {

    }

}

/**

 * atk_document_get_text_selections:

 * @document: an #AtkDocument

 *

 * Returns an array of AtkTextSelections within this document.

 *

 * Returns: (element-type AtkTextSelection) (transfer full): a GArray of

 * AtkTextSelection structures representing the selection.

 *

 * Since: 2.52

 */

GArray *

{

  AtkDocumentIface *iface;

  else

}

/**

 * atk_document_set_text_selections:

 * @document: an #AtkDocument.

 * @selections: (element-type AtkTextSelection): a GArray of AtkTextSelections

 *              to be selected.

 *

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

 *

 * Returns: TRUE if the selection was made successfully; FALSE otherwise.

 *

 * Since: 2.52

 */

gboolean

                                  GArray *selections)

{

  AtkDocumentIface *iface;

  else

}