← Back to branch summary

~ubuntu-branches/ubuntu/saucy/atkmm1.6/saucy-proposed

« back to all changes in this revision

Viewing changes to atk/atkmm/document.h

  • Committer: Bazaar Package Importer
  • Author(s): Krzysztof Klimonda
  • Date: 2010-11-02 20:35:53 UTC
  • Revision ID: james.westby@ubuntu.com-20101102203553-syno2w6yedmcdgk8
Import upstream version 2.22.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
atk/atkmm/document.h
 
1
// -*- c++ -*-
 
2
// Generated by gtkmmproc -- DO NOT MODIFY!
 
3
#ifndef _ATKMM_DOCUMENT_H
 
4
#define _ATKMM_DOCUMENT_H
 
5
 
 
6
 
 
7
#include <glibmm.h>
 
8
 
 
9
/* $Id: document.hg,v 1.3 2004/01/19 19:48:36 murrayc Exp $ */
 
10
 
 
11
/* Copyright (C) 2003 The gtkmm Development Team
 
12
 *
 
13
 * This library is free software; you can redistribute it and/or
 
14
 * modify it under the terms of the GNU Lesser General Public
 
15
 * License as published by the Free Software Foundation; either
 
16
 * version 2.1 of the License, or (at your option) any later version.
 
17
 *
 
18
 * This library is distributed in the hope that it will be useful,
 
19
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
20
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
21
 * Lesser General Public License for more details.
 
22
 *
 
23
 * You should have received a copy of the GNU Lesser General Public
 
24
 * License along with this library; if not, write to the Free
 
25
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
26
 */
 
27
 
 
28
 
 
29
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
30
extern "C"
 
31
{
 
32
  typedef struct _AtkDocumentIface AtkDocumentIface;
 
33
  typedef struct _AtkDocument      AtkDocument;
 
34
}
 
35
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
36
 
 
37
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
38
typedef struct _AtkDocument AtkDocument;
 
39
typedef struct _AtkDocumentClass AtkDocumentClass;
 
40
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
41
 
 
42
 
 
43
namespace Atk
 
44
{ class Document_Class; } // namespace Atk
 
45
namespace Atk
 
46
{
 
47
 
 
48
class Object;
 
49
 
 
50
/** The ATK interface which allows access to a DOM associated with on object.
 
51
 * This interface should be supported by any object that has an associated document object model (DOM). This interface
 
52
 * provides the standard mechanism allowing an assistive technology access to the DOM.
 
53
 */
 
54
 
 
55
class Document : public Glib::Interface
 
56
{
 
57
  
 
58
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
59
 
 
60
public:
 
61
  typedef Document CppObjectType;
 
62
  typedef Document_Class CppClassType;
 
63
  typedef AtkDocument BaseObjectType;
 
64
  typedef AtkDocumentIface BaseClassType;
 
65
 
 
66
private:
 
67
  friend class Document_Class;
 
68
  static CppClassType document_class_;
 
69
 
 
70
  // noncopyable
 
71
  Document(const Document&);
 
72
  Document& operator=(const Document&);
 
73
 
 
74
protected:
 
75
  Document(); // you must derive from this class
 
76
 
 
77
  /** Called by constructors of derived classes. Provide the result of 
 
78
   * the Class init() function to ensure that it is properly 
 
79
   * initialized.
 
80
   * 
 
81
   * @param interface_class The Class object for the derived type.
 
82
   */
 
83
  explicit Document(const Glib::Interface_Class& interface_class);
 
84
 
 
85
public:
 
86
  // This is public so that C++ wrapper instances can be
 
87
  // created for C instances of unwrapped types.
 
88
  // For instance, if an unexpected C type implements the C interface. 
 
89
  explicit Document(AtkDocument* castitem);
 
90
 
 
91
protected:
 
92
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
93
 
 
94
public:
 
95
  virtual ~Document();
 
96
 
 
97
  static void add_interface(GType gtype_implementer);
 
98
 
 
99
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
100
  static GType get_type()      G_GNUC_CONST;
 
101
  static GType get_base_type() G_GNUC_CONST;
 
102
#endif
 
103
 
 
104
  ///Provides access to the underlying C GObject.
 
105
  AtkDocument*       gobj()       { return reinterpret_cast<AtkDocument*>(gobject_); }
 
106
 
 
107
  ///Provides access to the underlying C GObject.  
 
108
  const AtkDocument* gobj() const { return reinterpret_cast<AtkDocument*>(gobject_); }
 
109
 
 
110
private:
 
111
 
 
112
public:
 
113
 
 
114
  
 
115
  /** Gets a string indicating the document type.
 
116
   * @return A string indicating the document type.
 
117
   */
 
118
  Glib::ustring get_document_type() const;
 
119
  
 
120
  /** Gets a %gpointer that points to an instance of the DOM.  It is
 
121
   * up to the caller to check atk_document_get_type to determine
 
122
   * how to cast this pointer.
 
123
   * @return A %gpointer that points to an instance of the DOM.
 
124
   */
 
125
  gpointer get_document();
 
126
 
 
127
protected:
 
128
    virtual const gchar* get_document_type_vfunc();
 
129
 
 
130
    virtual gpointer get_document_vfunc() const;
 
131
 
 
132
 
 
133
public:
 
134
 
 
135
public:
 
136
  //C++ methods used to invoke GTK+ virtual functions:
 
137
 
 
138
protected:
 
139
  //GTK+ Virtual Functions (override these to change behaviour):
 
140
 
 
141
  //Default Signal Handlers::
 
142
 
 
143
 
 
144
};
 
145
 
 
146
} // namespace Atk
 
147
 
 
148
 
 
149
namespace Glib
 
150
{
 
151
  /** A Glib::wrap() method for this object.
 
152
   * 
 
153
   * @param object The C instance.
 
154
   * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
 
155
   * @result A C++ instance that wraps this C instance.
 
156
   *
 
157
   * @relates Atk::Document
 
158
   */
 
159
  Glib::RefPtr<Atk::Document> wrap(AtkDocument* object, bool take_copy = false);
 
160
 
 
161
} // namespace Glib
 
162
 
 
163
 
 
164
#endif /* _ATKMM_DOCUMENT_H */
 
165