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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  19 #error "Only <atk/atk.h> can be included directly."
  20 #endif
  21
  22 #ifndef __ATK_DOCUMENT_H__
  23 #define __ATK_DOCUMENT_H__
  24
  25 #include <atk/atkobject.h>
  26 #include <atk/atkutil.h>
  27
  28 G_BEGIN_DECLS
  29
  30 /*
  31  * The AtkDocument interface should be supported by any object that is a container
  32  * for 'document content' as opposed to a collection of user interface elements.
  33  *
  34  */
  35
  36 #define ATK_TYPE_DOCUMENT                   (atk_document_get_type ())
  37 #define ATK_IS_DOCUMENT(obj)                G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_DOCUMENT)
  38 #define ATK_DOCUMENT(obj)                   G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_DOCUMENT, AtkDocument)
  39 #define ATK_DOCUMENT_GET_IFACE(obj)         (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_DOCUMENT, AtkDocumentIface))
  40
  41 #ifndef _TYPEDEF_ATK_DOCUMENT_
  42 #define _TYPEDEF_ATK_DOCUMENT_
  43 typedef struct _AtkDocument AtkDocument;
  44 #endif
  45 typedef struct _AtkDocumentIface AtkDocumentIface;
  46
  47 /**
  48  * AtkDocumentIface:
  49  * @get_document_type: gets a string indicating the document
  50  *   type. This virtual function is deprecated since 2.12 and it
  51  *   should not be overriden.
  52  * @get_document: a #GObject instance that implements
  53  *   AtkDocumentIface. This virtual method is deprecated since 2.12
  54  *   and it should not be overriden.
  55  * @get_document_locale: gets locale. This virtual function is
  56  *   deprecated since 2.7.90 and it should not be overriden.
  57  * @get_document_attributes: gets an AtkAttributeSet which describes
  58  *   document-wide attributes as name-value pairs.
  59  * @get_document_attribute_value: returns a string value assocciated
  60  *   with the named attribute for this document, or NULL
  61  * @set_document_attribute: sets the value of an attribute. Returns
  62  *   TRUE on success, FALSE otherwise
  63  * @get_current_page_number: gets the current page number. Since 2.12
  64  * @get_page_count: gets the page count of the document. Since 2.12
  65  */
  66 struct _AtkDocumentIface
  67 {
  68   GTypeInterface parent;
  69   const gchar*          ( *get_document_type) (AtkDocument              *document);
  70   gpointer              ( *get_document)      (AtkDocument              *document);
  71
  72   const gchar*          ( *get_document_locale) (AtkDocument              *document);
  73   AtkAttributeSet *     ( *get_document_attributes) (AtkDocument        *document);
  74   const gchar*          ( *get_document_attribute_value) (AtkDocument   *document,
  75                                                           const gchar   *attribute_name);
  76   gboolean              ( *set_document_attribute) (AtkDocument         *document,
  77                                                     const gchar         *attribute_name,
  78                                                     const gchar         *attribute_value);
  79   gint                  ( *get_current_page_number) (AtkDocument *document);
  80   gint                  ( *get_page_count) (AtkDocument *document);
  81 };
  82
  83 GType  atk_document_get_type             (void);
  84
  85 G_DEPRECATED
  86 const gchar*          atk_document_get_document_type (AtkDocument   *document);
  87
  88 G_DEPRECATED
  89 gpointer atk_document_get_document (AtkDocument   *document);
  90
  91 G_DEPRECATED
  92 const gchar*          atk_document_get_locale (AtkDocument *document);
  93
  94 AtkAttributeSet*      atk_document_get_attributes (AtkDocument *document);
  95 const gchar*          atk_document_get_attribute_value (AtkDocument *document,
  96                                                         const gchar *attribute_name);
  97 gboolean              atk_document_set_attribute_value (AtkDocument *document,
  98                                                         const gchar *attribute_name,
  99                                                         const gchar *attribute_value);
 100 gint                  atk_document_get_current_page_number (AtkDocument *document);
 101 gint                  atk_document_get_page_count      (AtkDocument *document);
 102
 103 G_END_DECLS
 104
 105 #endif /* __ATK_DOCUMENT_H__ */