summaryrefslogtreecommitdiffstats
path: root/kexi/plugins/scripting/kexiscripting/kexiscriptpart.h
blob: eca7a00155bd527b6efa01735dfc8a8044589665 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/* This file is part of the KDE project
   Copyright (C) 2004 Lucijan Busch <lucijan@kde.org>
   Copyright (C) 2004 Cedric Pasteur <cedric.pasteur@free.fr>
   Copyright (C) 2005 Sebastian Sauer <mail@dipe.org>

   This library 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 library 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 library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/

#ifndef KEXISCRIPTPART_H
#define KEXISCRIPTPART_H

#include <tqdom.h>
#include <tqcstring.h>

#include <kexi.h>
#include <kexipart.h>
#include <kexidialogbase.h>

/**
 * Kexi Scripting Plugin.
 */
class KexiScriptPart : public KexiPart::Part
{
    Q_OBJECT
  TQ_OBJECT

    public:

        /**
         * Constructor.
         *
         * \param tqparent The tqparent TQObject this part is child of.
         * \param name The name this part has.
         * \param args Optional list of arguments passed to this part.
         */
        KexiScriptPart(TQObject *tqparent, const char *name, const TQStringList& args);

        /**
         * Destructor.
         */
        virtual ~KexiScriptPart();

        /**
         * Implementation of the \a KexiPart::Part::execute method used to
         * execute the passed \p item instance.
         */
        virtual bool execute(KexiPart::Item* item, TQObject* sender = 0);

        /**
         * \return the i18n message for the passed \p englishMessage string.
         */
        virtual TQString i18nMessage(const TQCString& englishMessage) const;

    protected:

        /**
         * Create a new view.
         *
         * \param tqparent The tqparent TQWidget the new view is displayed in.
         * \param dialog The \a KexiDialogBase the view is child of.
         * \param item The \a KexiPart::Item this view is for.
         * \param viewMode The viewmode we like to have a view for.
         */
        virtual KexiViewBase* createView(TQWidget *tqparent,
                                         KexiDialogBase* dialog,
                                         KexiPart::Item& item,
                                         int viewMode = Kexi::DesignViewMode,
                                         TQMap<TQString,TQString>* staticObjectArgs = 0);

        /**
         * Initialize the part's actions.
         */
        virtual void initPartActions();

        /**
         * Initialize the instance actions.
         */
        virtual void initInstanceActions();

    private:
        /// \internal d-pointer class.
        class Private;
        /// \internal d-pointer instance.
        Private* const d;
};

#endif