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