summaryrefslogtreecommitdiffstats
path: root/lib/kross/api/module.h
diff options
context:
space:
mode:
authortpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-01-20 01:29:50 +0000
committertpearson <tpearson@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2010-01-20 01:29:50 +0000
commit8362bf63dea22bbf6736609b0f49c152f975eb63 (patch)
tree0eea3928e39e50fae91d4e68b21b1e6cbae25604 /lib/kross/api/module.h
downloadkoffice-8362bf63dea22bbf6736609b0f49c152f975eb63.tar.gz
koffice-8362bf63dea22bbf6736609b0f49c152f975eb63.zip
Added old abandoned KDE3 version of koffice
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/applications/koffice@1077364 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'lib/kross/api/module.h')
-rw-r--r--lib/kross/api/module.h80
1 files changed, 80 insertions, 0 deletions
diff --git a/lib/kross/api/module.h b/lib/kross/api/module.h
new file mode 100644
index 00000000..127609e0
--- /dev/null
+++ b/lib/kross/api/module.h
@@ -0,0 +1,80 @@
+/***************************************************************************
+ * module.h
+ * This file is part of the KDE project
+ * copyright (C)2004-2005 by Sebastian Sauer (mail@dipe.org)
+ *
+ * This program 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 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
+ * Library General Public License for more details.
+ * You should have received a copy of the GNU Library General Public License
+ * along with this program; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ ***************************************************************************/
+
+#ifndef KROSS_API_MODULE_H
+#define KROSS_API_MODULE_H
+
+#include <qstring.h>
+
+#include "class.h"
+
+namespace Kross { namespace Api {
+
+ /**
+ * The Module class. Modules are managed in the \a Manager singleton
+ * instance and are implemented as in scripting plugins as main
+ * entry point to load and work with them.
+ */
+ class Module : public Class<Module>
+ {
+ public:
+
+ /**
+ * Shared pointer to implement reference-counting.
+ */
+ typedef KSharedPtr<Module> Ptr;
+
+ /**
+ * Constructor.
+ *
+ * \param name The name of this module.
+ * Each module needs a unique name cause
+ * the application using Kross identifies
+ * modules with there names.
+ */
+ explicit Module(const QString& name)
+ : Class<Module>(name)
+ {
+ krossdebug( QString("Kross::Api::Module %1 created").arg(name) );
+ }
+
+ /**
+ * Destructor.
+ */
+ virtual ~Module()
+ {
+ krossdebug( QString("Kross::Api::Module %1 destroyed").arg(getName()) );
+ }
+
+ /**
+ * Method to load from \a Kross::Api::Object inherited classes
+ * this module implements from within other modules.
+ */
+ virtual Kross::Api::Object::Ptr get(const QString& /*name*/, void* /*pointer*/ = 0)
+ {
+ return 0;
+ }
+
+ };
+
+
+}}
+
+#endif
+