atk/atkdocument.h

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2001 Sun Microsystems Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef __ATK_DOCUMENT_H__
  21 #define __ATK_DOCUMENT_H__
  22
  23 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  24 #error "Only <atk/atk.h> can be included directly."
  25 #endif
  26
  27 #include <atk/atkobject.h>
  28 #include <atk/atkutil.h>
  29
  30 G_BEGIN_DECLS
  31
  32 /*
  33  * The AtkDocument interface should be supported by any object that is a container
  34  * for 'document content' as opposed to a collection of user interface elements.
  35  *
  36  */
  37
  38 #define ATK_TYPE_DOCUMENT                   (atk_document_get_type ())
  39 #define ATK_IS_DOCUMENT(obj)                G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_DOCUMENT)
  40 #define ATK_DOCUMENT(obj)                   G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_DOCUMENT, AtkDocument)
  41 #define ATK_DOCUMENT_GET_IFACE(obj)         (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_DOCUMENT, AtkDocumentIface))
  42
  43 #ifndef _TYPEDEF_ATK_DOCUMENT_
  44 #define _TYPEDEF_ATK_DOCUMENT_
  45 typedef struct _AtkDocument AtkDocument;
  46 #endif
  47 typedef struct _AtkDocumentIface AtkDocumentIface;
  48
  49 /**
  50  * AtkDocumentIface:
  51  * @get_document_type: gets a string indicating the document
  52  *   type. This virtual function is deprecated since 2.12 and it
  53  *   should not be overriden.
  54  * @get_document: a #GObject instance that implements
  55  *   AtkDocumentIface. This virtual method is deprecated since 2.12
  56  *   and it should not be overriden.
  57  * @get_document_locale: gets locale. This virtual function is
  58  *   deprecated since 2.7.90 and it should not be overriden.
  59  * @get_document_attributes: gets an AtkAttributeSet which describes
  60  *   document-wide attributes as name-value pairs.
  61  * @get_document_attribute_value: returns a string value assocciated
  62  *   with the named attribute for this document, or NULL
  63  * @set_document_attribute: sets the value of an attribute. Returns
  64  *   TRUE on success, FALSE otherwise
  65  * @get_current_page_number: gets the current page number. Since 2.12
  66  * @get_page_count: gets the page count of the document. Since 2.12
  67  */
  68 struct _AtkDocumentIface
  69 {
  70   GTypeInterface parent;
  71   const gchar*          ( *get_document_type) (AtkDocument              *document);
  72   gpointer              ( *get_document)      (AtkDocument              *document);
  73
  74   const gchar*          ( *get_document_locale) (AtkDocument              *document);
  75   AtkAttributeSet *     ( *get_document_attributes) (AtkDocument        *document);
  76   const gchar*          ( *get_document_attribute_value) (AtkDocument   *document,
  77                                                           const gchar   *attribute_name);
  78   gboolean              ( *set_document_attribute) (AtkDocument         *document,
  79                                                     const gchar         *attribute_name,
  80                                                     const gchar         *attribute_value);
  81   gint                  ( *get_current_page_number) (AtkDocument *document);
  82   gint                  ( *get_page_count) (AtkDocument *document);
  83 };
  84
  85 ATK_AVAILABLE_IN_ALL
  86 GType  atk_document_get_type             (void);
  87
  88 ATK_DEPRECATED_IN_2_12
  89 const gchar*          atk_document_get_document_type (AtkDocument   *document);
  90
  91 ATK_DEPRECATED_IN_2_12
  92 gpointer atk_document_get_document (AtkDocument   *document);
  93
  94 ATK_DEPRECATED_IN_2_8_FOR(atk_object_get_object_locale)
  95 const gchar*          atk_document_get_locale (AtkDocument *document);
  96
  97 ATK_AVAILABLE_IN_ALL
  98 AtkAttributeSet*      atk_document_get_attributes (AtkDocument *document);
  99 ATK_AVAILABLE_IN_ALL
 100 const gchar*          atk_document_get_attribute_value (AtkDocument *document,
 101                                                         const gchar *attribute_name);
 102 ATK_AVAILABLE_IN_ALL
 103 gboolean              atk_document_set_attribute_value (AtkDocument *document,
 104                                                         const gchar *attribute_name,
 105                                                         const gchar *attribute_value);
 106 ATK_AVAILABLE_IN_2_12
 107 gint                  atk_document_get_current_page_number (AtkDocument *document);
 108 ATK_AVAILABLE_IN_2_12
 109 gint                  atk_document_get_page_count      (AtkDocument *document);
 110
 111 G_END_DECLS
 112
 113 #endif /* __ATK_DOCUMENT_H__ */