documentation additions
[glib.git] / gobject / gtypemodule.h
blob7809c95996ec43857181d45ef78a62dd4f65ee7a
1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 2000 Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser 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.
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 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser 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.
19 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
20 #error "Only <glib-object.h> can be included directly."
21 #endif
23 #ifndef __G_TYPE_MODULE_H__
24 #define __G_TYPE_MODULE_H__
26 #include <gobject/gobject.h>
27 #include <gobject/genums.h>
29 G_BEGIN_DECLS
31 typedef struct _GTypeModule GTypeModule;
32 typedef struct _GTypeModuleClass GTypeModuleClass;
34 #define G_TYPE_TYPE_MODULE (g_type_module_get_type ())
35 #define G_TYPE_MODULE(module) (G_TYPE_CHECK_INSTANCE_CAST ((module), G_TYPE_TYPE_MODULE, GTypeModule))
36 #define G_TYPE_MODULE_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_TYPE_MODULE, GTypeModuleClass))
37 #define G_IS_TYPE_MODULE(module) (G_TYPE_CHECK_INSTANCE_TYPE ((module), G_TYPE_TYPE_MODULE))
38 #define G_IS_TYPE_MODULE_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_TYPE_MODULE))
39 #define G_TYPE_MODULE_GET_CLASS(module) (G_TYPE_INSTANCE_GET_CLASS ((module), G_TYPE_TYPE_MODULE, GTypeModuleClass))
41 struct _GTypeModule
43 GObject parent_instance;
45 guint use_count;
46 GSList *type_infos;
47 GSList *interface_infos;
49 /*< public >*/
50 gchar *name;
53 struct _GTypeModuleClass
55 GObjectClass parent_class;
57 /*< public >*/
58 gboolean (* load) (GTypeModule *module);
59 void (* unload) (GTypeModule *module);
61 /*< private >*/
62 /* Padding for future expansion */
63 void (*reserved1) (void);
64 void (*reserved2) (void);
65 void (*reserved3) (void);
66 void (*reserved4) (void);
69 GType g_type_module_get_type (void) G_GNUC_CONST;
70 gboolean g_type_module_use (GTypeModule *module);
71 void g_type_module_unuse (GTypeModule *module);
72 void g_type_module_set_name (GTypeModule *module,
73 const gchar *name);
74 GType g_type_module_register_type (GTypeModule *module,
75 GType parent_type,
76 const gchar *type_name,
77 const GTypeInfo *type_info,
78 GTypeFlags flags);
79 void g_type_module_add_interface (GTypeModule *module,
80 GType instance_type,
81 GType interface_type,
82 const GInterfaceInfo *interface_info);
83 GType g_type_module_register_enum (GTypeModule *module,
84 const gchar *name,
85 const GEnumValue *const_static_values);
86 GType g_type_module_register_flags (GTypeModule *module,
87 const gchar *name,
88 const GFlagsValue *const_static_values);
90 G_END_DECLS
92 #endif /* __G_TYPE_MODULE_H__ */