1/* $Id: document.hg,v 1.3 2004/01/19 19:48:36 murrayc Exp $ */
2
3/* Copyright (C) 2003 The gtkmm Development Team
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free
17 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20
21_DEFS(atkmm,atk)
22_PINCLUDE(glibmm/private/object_p.h)
23
24#include <glibmm/interface.h>
25
26#ifndef DOXYGEN_SHOULD_SKIP_THIS
27extern "C"
28{
29  typedef struct _AtkDocumentIface AtkDocumentIface;
30  typedef struct _AtkDocument      AtkDocument;
31}
32#endif /* DOXYGEN_SHOULD_SKIP_THIS */
33
34namespace Atk
35{
36
37class Object;
38
39/** The ATK interface which allows access to a DOM associated with on object.
40 * This interface should be supported by any object that has an associated document object model (DOM). This interface
41 * provides the standard mechanism allowing an assistive technology access to the DOM.
42 */
43class Document : public Glib::Interface
44{
45  _CLASS_INTERFACE(Document, AtkDocument, ATK_DOCUMENT, AtkDocumentIface)
46public:
47
48  _WRAP_METHOD(Glib::ustring get_document_type() const, atk_document_get_document_type, deprecated "Please use get_attribute() to ask for the document type if it applies.")
49  _WRAP_METHOD(gpointer get_document(), atk_document_get_document, deprecated "Document is already a representation of the document. Use it directly, or one of its children, as an instance of the DOM.")
50
51  _IGNORE(atk_document_get_locale)
52
53//TODO: AtkAttributeSet*      atk_document_get_attributes (AtkDocument *document);
54  _WRAP_METHOD(Glib::ustring get_attribute_value(const Glib::ustring& attribute_name) const, atk_document_get_attribute_value)
55  _WRAP_METHOD(bool set_attribute_value(const Glib::ustring& attribute_name, const Glib::ustring& attribute_value), atk_document_set_attribute_value)
56
57protected:
58  _WRAP_VFUNC(const gchar* get_document_type(), get_document_type)
59  _WRAP_VFUNC(gpointer get_document() const, get_document)
60};
61
62} // namespace Atk
63
64