Warning, file /office/calligra/libs/kross/KoScriptingModule.h was not indexed or was modified since last indexation (in which case cross-reference links may be missing, inaccurate or erroneous).

0001 /***************************************************************************
0002  * KoScriptingModule.h
0003  * This file is part of the KDE project
0004  * copyright (C) 2006-2007 Sebastian Sauer <mail@dipe.org>
0005  *
0006  * This program is free software; you can redistribute it and/or
0007  * modify it under the terms of the GNU Library General Public
0008  * License as published by the Free Software Foundation; either
0009  * version 2 of the License, or (at your option) any later version.
0010  *
0011  * This program is distributed in the hope that it will be useful,
0012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0014  * Library General Public License for more details.
0015  *
0016  * You should have received a copy of the GNU Library General Public License
0017  * along with this program; see the file COPYING.  If not, write to
0018  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0019  * Boston, MA 02110-1301, USA.
0020  ***************************************************************************/
0021 
0022 #ifndef KOKROSS_KOSCRIPTINGMODULE_H
0023 #define KOKROSS_KOSCRIPTINGMODULE_H
0024 
0025 #include <QObject>
0026 
0027 #include "kokross_export.h"
0028 
0029 class KoView;
0030 class KoDocument;
0031 class QWidget;
0032 
0033 /**
0034 * The KoScriptingModule provides the base class for Kross
0035 * module functionality for Calligra applications.
0036 *
0037 * Each Calligra-application does provide an own implementation for
0038 * this one to extend those module with additional own functionality.
0039 */
0040 class KOKROSS_EXPORT KoScriptingModule : public QObject
0041 {
0042     Q_OBJECT
0043 public:
0044     KoScriptingModule(QObject *parent, const QString &name);
0045     ~KoScriptingModule() override;
0046 
0047     KoView *view() const;
0048     virtual KoDocument *doc() = 0;
0049 
0050 public Q_SLOTS:
0051 
0052     /** Return the \a KoApplicationAdaptor object. */
0053     virtual QObject *application();
0054 
0055     /** Return the \a KoMainWindow object. */
0056     virtual QWidget *mainWindow();
0057 
0058     /** Return the \a KoPartAdaptor object. */
0059     virtual QObject *document();
0060 
0061     /** Return a \a KoScriptingOdfStore object. */
0062     virtual QObject *store();
0063 
0064 private:
0065     /// \internal d-pointer class.
0066     class Private;
0067     /// \internal d-pointer instance.
0068     Private* const d;
0069 };
0070 
0071 #endif