atk/atkregistry.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_REGISTRY_H__
  23 #define __ATK_REGISTRY_H__
  24
  25 #include <glib-object.h>
  26 #include "atkobjectfactory.h"
  27
  28 /**
  29  * SECTION:atkobjectregistry
  30  * @Short_description: An object used to store the GType of the
  31  * factories used to create an accessible object for an object of a
  32  * particular GType.
  33  * @Title:AtkObjectRegistry
  34  *
  35  * The AtkRegistry is normally used to create appropriate ATK "peers"
  36  * for user interface components.  Application developers usually need
  37  * only interact with the AtkRegistry by associating appropriate ATK
  38  * implementation classes with GObject classes via the
  39  * atk_registry_set_factory_type call, passing the appropriate GType
  40  * for application custom widget classes.
  41  */
  42
  43 G_BEGIN_DECLS
  44
  45 #define ATK_TYPE_REGISTRY                (atk_registry_get_type ())
  46 #define ATK_REGISTRY(obj)                (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_REGISTRY, AtkRegistry))
  47 #define ATK_REGISTRY_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_REGISTRY, AtkRegistryClass))
  48 #define ATK_IS_REGISTRY(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_REGISTRY))
  49 #define ATK_IS_REGISTRY_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_REGISTRY))
  50 #define ATK_REGISTRY_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_REGISTRY, AtkRegistryClass))
  51
  52 struct _AtkRegistry
  53 {
  54   GObject    parent;
  55   GHashTable *factory_type_registry;
  56   GHashTable *factory_singleton_cache;
  57 };
  58
  59 struct _AtkRegistryClass
  60 {
  61   GObjectClass    parent_class;
  62 };
  63
  64 typedef struct _AtkRegistry             AtkRegistry;
  65 typedef struct _AtkRegistryClass        AtkRegistryClass;
  66
  67
  68 GType             atk_registry_get_type         (void);
  69 void              atk_registry_set_factory_type (AtkRegistry *registry,
  70                                                  GType type,
  71                                                  GType factory_type);
  72 GType             atk_registry_get_factory_type (AtkRegistry *registry,
  73                                                  GType type);
  74 AtkObjectFactory* atk_registry_get_factory      (AtkRegistry *registry,
  75                                                  GType type);
  76
  77 AtkRegistry*      atk_get_default_registry      (void);
  78
  79 G_END_DECLS
  80
  81 #endif /* __ATK_REGISTRY_H__ */
  82