kexipart.h

/* This file is part of the KDE project
   Copyright (C) 2003 Lucijan Busch <lucijan@kde.org>
   Copyright (C) 2003-2005 Jaroslaw Staniek <js@iidea.pl>
 
   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 KEXIPART_H
#define KEXIPART_H
 
#include <tqobject.h>
#include <tqmap.h>
 
#include <kexiutils/tristate.h>
#include "kexi.h"
#include "keximainwindow.h"
 
class TDEActionCollection;
class KexiDialogBase;
class KexiDialogTempData;
class KexiViewBase;
class KexiMainWindowImpl;
class TDEAction;
class TDEShortcut;
class KTabWidget;
 
namespace KexiPart
{
    class Info;
    class Item;
    class GUIClient;
    class PartPrivate;
    class StaticInfo;

enum ObjectTypes {
    TableObjectType = KexiDB::TableObjectType, 
    QueryObjectType = KexiDB::QueryObjectType, 
    FormObjectType = 3,
    ReportObjectType = 4,
    ScriptObjectType = 5,
    WebObjectType = 6,
    MacroObjectType = 7,
    LastObjectType = 7, //ALWAYS UPDATE THIS
 
    UserObjectType = 100 
};

class KEXICORE_EXPORT Part : public TQObject
{
    TQ_OBJECT
  
 
    public:
        Part(TQObject *parent, const char *name, const TQStringList &);
        virtual ~Part();


        virtual bool execute(KexiPart::Item* item, TQObject* sender = 0) {
            Q_UNUSED(item);
            Q_UNUSED(sender);
            return false;
        }

        inline int supportedViewModes() const { return m_supportedViewModes; }

        inline int supportedUserViewModes() const { return m_supportedUserViewModes; }


        KexiDialogBase* openInstance(KexiMainWindow *win, KexiPart::Item &item, 
            int viewMode = Kexi::DataViewMode, TQMap<TQString,TQString>* staticObjectArgs = 0);


        virtual bool remove(KexiMainWindow *win, KexiPart::Item & item);

        virtual tristate rename(KexiMainWindow *win, KexiPart::Item &item, const TQString& newName);

        virtual KexiDialogTempData* createTempData(KexiDialogBase* dialog);

        virtual KexiViewBase* createView(TQWidget *parent, KexiDialogBase* dialog, 
            KexiPart::Item &item, int viewMode = Kexi::DataViewMode, TQMap<TQString,TQString>* staticObjectArgs = 0) = 0;

        TQCString instanceName() const;

        TQString instanceCaption() const;
 
        inline Info *info() const { return m_info; }

        inline GUIClient *guiClient() const { return m_guiClient; }

        inline GUIClient *instanceGuiClient(int mode = 0) const
            { return m_instanceGuiClients[mode]; }
 
#if 0
        virtual DataSource *dataSource() { return 0; }
#endif

        TDEActionCollection* actionCollectionForMode(int viewMode) const;
 
        const Kexi::ObjectStatus& lastOperationStatus() const { return m_status; }

        virtual TQString i18nMessage(const TQCString& englishMessage, 
            KexiDialogBase* dlg) const;
 
    signals: 
        void newObjectRequest( KexiPart::Info *info );
 
    protected slots:
        void slotCreate();
 
    protected:
        Part(TQObject* parent, StaticInfo *info);
 
//      virtual KexiDialogBase* createInstance(KexiMainWindow *win, const KexiPart::Item &item, int viewMode = Kexi::DataViewMode) = 0;

        void createGUIClients(KexiMainWindow *win);
 
#if 0
        virtual void initPartActions( TDEActionCollection * ) {};

        virtual void initInstanceActions( int mode, TDEActionCollection *col ) {};
#endif
 
        virtual void initPartActions();
        virtual void initInstanceActions();
 
        virtual KexiDB::SchemaData* loadSchemaData(KexiDialogBase *dlg, 
            const KexiDB::SchemaData& sdata, int viewMode);
 
        bool loadDataBlock( KexiDialogBase *dlg, TQString &dataString, const TQString& dataID = TQString());

        TDEAction* createSharedAction(int mode, const TQString &text, 
            const TQString &pix_name, const TDEShortcut &cut, const char *name, 
            const char *subclassName = 0);

        TDEAction* createSharedToggleAction(int mode, const TQString &text,
            const TQString &pix_name, const TDEShortcut &cut, const char *name);

        TDEAction* createSharedPartAction(const TQString &text, 
            const TQString &pix_name, const TDEShortcut &cut, const char *name,
            const char *subclassName = 0);

        TDEAction* createSharedPartToggleAction(const TQString &text,
            const TQString &pix_name, const TDEShortcut &cut, const char *name);
 
        void setActionAvailable(const char *action_name, bool avail);
 
        inline void setInfo(Info *info) { m_info = info; }

        virtual void setupCustomPropertyPanelTabs(KTabWidget *tab, KexiMainWindow* mainWin);

        TQMap<TQString,TQString> m_names;

        int m_supportedViewModes;

        int m_supportedUserViewModes;
 
        Info *m_info;
        GUIClient *m_guiClient;
        TQIntDict<GUIClient> m_instanceGuiClients;
        KexiMainWindow* m_mainWin;
        Kexi::ObjectStatus m_status;

        int m_registeredPartID;

        bool m_newObjectsAreDirty : 1;
 
        PartPrivate *d;
 
    friend class Manager;
    friend class ::KexiMainWindow;
    friend class ::KexiMainWindowImpl;
    friend class GUIClient;
};
 
}
 
#endif