pythonmodule.h

00001 /***************************************************************************
00002  * pythonmodule.h
00003  * This file is part of the KDE project
00004  * copyright (C)2004-2005 by Sebastian Sauer (mail@dipe.org)
00005  *
00006  * This program is free software; you can redistribute it and/or
00007  * modify it under the terms of the GNU Library General Public
00008  * License as published by the Free Software Foundation; either
00009  * version 2 of the License, or (at your option) any later version.
00010  * This program is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013  * Library General Public License for more details.
00014  * You should have received a copy of the GNU Library General Public License
00015  * along with this program; see the file COPYING.  If not, write to
00016  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00017  * Boston, MA 02110-1301, USA.
00018  ***************************************************************************/
00019 
00020 #ifndef KROSS_PYTHON_MODULE_H
00021 #define KROSS_PYTHON_MODULE_H
00022 
00023 #include "pythonconfig.h"
00024 #include "../api/object.h"
00025 #include "../api/script.h"
00026 #include "pythonextension.h"
00027 
00028 #include <qstring.h>
00029 
00030 namespace Kross { namespace Python {
00031 
00032     // Forward declaration.
00033     class PythonInterpreter;
00034     class PythonModulePrivate;
00035 
00036     /**
00037      * The PythonModule is the __main__ python environment
00038      * used as global object namespace.
00039      *
00040      * The module also spends access to the whole Kross
00041      * functionality and manages all the PythonExtension
00042      * modules.
00043      */
00044     class PythonModule : public Py::ExtensionModule<PythonModule>
00045     {
00046         public:
00047 
00048             /**
00049              * Constructor.
00050              *
00051              * \param interpreter The \a PythonInterpreter instance
00052              *        used to create this PythonModule.
00053              */
00054             PythonModule(PythonInterpreter* interpreter);
00055 
00056             /**
00057              * Destructor.
00058              */
00059             virtual ~PythonModule();
00060 
00061             /**
00062              * \return the dictonary this PythonModule has.
00063              */
00064             Py::Dict getDict();
00065 
00066         private:
00067             /// Internal d-pointer class.
00068             PythonModulePrivate* d;
00069 
00070             /// Import hook used to load external kross libs on demand.
00071             Py::Object import(const Py::Tuple&);
00072     };
00073 
00074 }}
00075 
00076 #endif

Generated on Thu Feb 9 17:59:10 2006 for Kross by  doxygen 1.4.6