aboutsummaryrefslogtreecommitdiffstats
path: root/e-util/e-extensible.h
diff options
context:
space:
mode:
authorMatthew Barnes <mbarnes@redhat.com>2010-03-20 05:18:19 +0800
committerMichael Meeks <michael.meeks@novell.com>2010-04-07 19:08:59 +0800
commit3fb2b21c08556d04770fb585ca303c4044e3c9bc (patch)
tree66fe4b4cdf90092147d508a02f7075863cee9662 /e-util/e-extensible.h
parent4cc6bd4673115dff52a403d31e9613deea402d0e (diff)
downloadgsoc2013-evolution-3fb2b21c08556d04770fb585ca303c4044e3c9bc.tar.gz
gsoc2013-evolution-3fb2b21c08556d04770fb585ca303c4044e3c9bc.tar.zst
gsoc2013-evolution-3fb2b21c08556d04770fb585ca303c4044e3c9bc.zip
Introduce a simple extension system for objects.
This introduces a simple means of extending Evolution objects. Any GObject subclass wishing to be extensible need only call g_type_add_interface_static (type, E_TYPE_EXTENSIBLE, NULL); when registering its GType, and then at some point during initialization call e_extensible_load_extensions() to load extensions for that subclass. Extensions are implemented by subclassing EExtension, setting the GType being extended in EExtensionClass, and making sure its own GType gets registered at startup. This usually done while loading a GTypeModule. e_extension_get_extensible() provides extensions access to the object being extended.
Diffstat (limited to 'e-util/e-extensible.h')
-rw-r--r--e-util/e-extensible.h57
1 files changed, 57 insertions, 0 deletions
diff --git a/e-util/e-extensible.h b/e-util/e-extensible.h
new file mode 100644
index 0000000000..a72ea71611
--- /dev/null
+++ b/e-util/e-extensible.h
@@ -0,0 +1,57 @@
+/*
+ * e-extensible.h
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) version 3.
+ *
+ * This program 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with the program; if not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+#ifndef E_EXTENSIBLE_H
+#define E_EXTENSIBLE_H
+
+#include <glib-object.h>
+
+/* Standard GObject macros */
+#define E_TYPE_EXTENSIBLE \
+ (e_extensible_get_type ())
+#define E_EXTENSIBLE(obj) \
+ (G_TYPE_CHECK_INSTANCE_CAST \
+ ((obj), E_TYPE_EXTENSIBLE, EExtensible))
+#define E_EXTENSIBLE_INTERFACE(cls) \
+ (G_TYPE_CHECK_CLASS_CAST \
+ ((cls), E_TYPE_EXTENSIBLE, EExtensibleInterface))
+#define E_IS_EXTENSIBLE(obj) \
+ (G_TYPE_CHECK_INSTANCE_TYPE \
+ ((obj), E_TYPE_EXTENSIBLE))
+#define E_IS_EXTENSIBLE_INTERFACE(cls) \
+ (G_TYPE_CHECK_CLASS_TYPE \
+ ((cls), E_TYPE_EXTENSIBLE))
+#define E_EXTENSIBLE_GET_INTERFACE(obj) \
+ (G_TYPE_INSTANCE_GET_INTERFACE \
+ ((obj), E_TYPE_EXTENSIBLE, EExtensibleInterface))
+
+G_BEGIN_DECLS
+
+typedef struct _EExtensible EExtensible;
+typedef struct _EExtensibleInterface EExtensibleInterface;
+
+struct _EExtensibleInterface {
+ GTypeInterface parent_interface;
+};
+
+GType e_extensible_get_type (void);
+void e_extensible_load_extensions (EExtensible *extensible);
+
+G_END_DECLS
+
+#endif /* E_EXTENSIBLE_H */