summaryrefslogtreecommitdiff
path: root/libs/gtkmm2/atk/atkmm/objectaccessible.h
blob: d266f9a97e7ce757789d172bd25e700a973f5801 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _ATKMM_OBJECTACCESSIBLE_H
#define _ATKMM_OBJECTACCESSIBLE_H

#include <glibmm.h>

/* $Id$ */

/* Copyright (C) 1998-2002 The gtkmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
#include <atkmm/object.h>


#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _AtkGObjectAccessible AtkGObjectAccessible;
typedef struct _AtkGObjectAccessibleClass AtkGObjectAccessibleClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */


namespace Atk
{ class ObjectAccessible_Class; } // namespace Atk
namespace Atk
{

/** This object class is derived from AtkObject and can be used as a basis implementing accessible objects.
 * This can be used as a basis for implementing accessible objects for Glib::Objects which are not derived from
 * Gtk::Widget. One example of its use is in providing an accessible object for GnomeCanvasItem in the GAIL library.
 */

class ObjectAccessible : public Atk::Object
{
   
#ifndef DOXYGEN_SHOULD_SKIP_THIS

public:
  typedef ObjectAccessible CppObjectType;
  typedef ObjectAccessible_Class CppClassType;
  typedef AtkGObjectAccessible BaseObjectType;
  typedef AtkGObjectAccessibleClass BaseClassType;

private:  friend class ObjectAccessible_Class;
  static CppClassType objectaccessible_class_;

private:
  // noncopyable
  ObjectAccessible(const ObjectAccessible&);
  ObjectAccessible& operator=(const ObjectAccessible&);

protected:
  explicit ObjectAccessible(const Glib::ConstructParams& construct_params);
  explicit ObjectAccessible(AtkGObjectAccessible* castitem);

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

public:
  virtual ~ObjectAccessible();

#ifndef DOXYGEN_SHOULD_SKIP_THIS
  static GType get_type()      G_GNUC_CONST;
  static GType get_base_type() G_GNUC_CONST;
#endif

  ///Provides access to the underlying C GObject.
  AtkGObjectAccessible*       gobj()       { return reinterpret_cast<AtkGObjectAccessible*>(gobject_); }

  ///Provides access to the underlying C GObject.
  const AtkGObjectAccessible* gobj() const { return reinterpret_cast<AtkGObjectAccessible*>(gobject_); }

  ///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
  AtkGObjectAccessible* gobj_copy();

private:

protected:

  
  /** Gets the GObject for which @a obj  is the accessible object.
   * @return A G::Object which is the object for which @a obj  is the accessible objedct.
   */
  Glib::RefPtr<Glib::Object> get_object();
  
  /** Gets the GObject for which @a obj  is the accessible object.
   * @return A G::Object which is the object for which @a obj  is the accessible objedct.
   */
  Glib::RefPtr<const Glib::Object> get_object() const;

  
  /** Gets the accessible object for the specified @a obj .
   * @param obj A G::Object.
   * @return A Atk::Object which is the accessible object for the @a obj .
   */
  static Glib::RefPtr<Atk::Object> for_object(const Glib::RefPtr<Glib::Object>& obj);
  
  /** Gets the accessible object for the specified @a obj .
   * @param obj A G::Object.
   * @return A Atk::Object which is the accessible object for the @a obj .
   */
  static Glib::RefPtr<const Atk::Object> for_object(const Glib::RefPtr<const Glib::Object>& obj);


public:

public:
  //C++ methods used to invoke GTK+ virtual functions:

protected:
  //GTK+ Virtual Functions (override these to change behaviour):

  //Default Signal Handlers::


};

} // namespace Atk


namespace Glib
{
  /** @relates Atk::ObjectAccessible
   * @param object The C instance
   * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
   * @result A C++ instance that wraps this C instance.
   */
  Glib::RefPtr<Atk::ObjectAccessible> wrap(AtkGObjectAccessible* object, bool take_copy = false);
}


#endif /* _ATKMM_OBJECTACCESSIBLE_H */