form.h

/* This file is part of the KDE project
   Copyright (C) 2003 Lucijan Busch <lucijan@gmx.at>
   Copyright (C) 2004 Cedric Pasteur <cedric.pasteur@free.fr>
   Copyright (C) 2004-2007 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 KFORMDESIGNERFORM_H
#define KFORMDESIGNERFORM_H
 
#include <tqobject.h>
#include <tqptrlist.h>
 
#include "resizehandle.h"
#include "utils.h"
#include "objecttree.h"
 
class TQWidget;
class TQDomElement;
class TDEActionCollection;
class KCommandHistory;
class KCommand;
class PixmapCollection;
 
namespace KFormDesigner {
 
class Container;
class WidgetPropertySet;
class WidgetLibrary;
class FormManager;
class ObjectTree;
class ObjectTreeItem;
class ConnectionBuffer;


class KFORMEDITOR_EXPORT FormWidget
{
    public:
        FormWidget();
        virtual ~FormWidget();

 
        virtual void drawRects(const TQValueList<TQRect> &list, int type) = 0;
 
        virtual void drawRect(const TQRect &r, int type) = 0;

        virtual void initBuffer() = 0;

        virtual void clearForm() = 0;

        virtual void highlightWidgets(TQWidget *from, TQWidget *to) = 0;
    
    protected:
        Form *m_form;
 
    friend class Form;
};

class FormPrivate
{
    public:
        FormPrivate();
        ~FormPrivate();
 
//      FormManager  *manager;
        TQGuardedPtr<Container>  toplevel;
        ObjectTree  *topTree;
        TQGuardedPtr<TQWidget> widget;
 
        WidgetList  selected;
        ResizeHandleSet::Dict resizeHandles;
 
        bool  dirty;
        bool  interactive;
        bool  design;
        TQString  filename;
 
        KCommandHistory  *history;
        TDEActionCollection  *collection;
 
        ObjectTreeList  tabstops;
        bool  autoTabstops;
        ConnectionBuffer  *connBuffer;
 
        PixmapCollection  *pixcollection;

        TQMap<TQObject*,TQCursor> cursors;

        TQStringList *mouseTrackers;
 
        FormWidget  *formWidget;

        TQMap<TQCString,TQString> headerProperties;

        uint formatVersion;
        uint originalFormatVersion;
};

class KFORMEDITOR_EXPORT Form : public TQObject
{
    TQ_OBJECT
  
 
    public:
        Form(WidgetLibrary* library, const char *name=0, bool designMode = true);
        ~Form();

        WidgetLibrary* library() const { return m_lib; }

        void createToplevel(TQWidget *container, FormWidget *formWidget =0,
            const TQCString &classname="TQWidget");

        Container* toplevelContainer() const { return d->toplevel; }

        FormWidget* formWidget() const { return d->formWidget; }

        ObjectTree* objectTree() const { return d->topTree; }

        TQWidget* widget() const;
 
//      //! \return the FormManager parent of this form.
//      FormManager* manager() const { return d->manager; }

        Container* activeContainer();

        Container* parentContainer(TQWidget *w=0);

        ObjectTreeItem* commonParentContainer(WidgetList *wlist);

        WidgetList* selectedWidgets() const {return &(d->selected);}

        TQWidget* selectedWidget() const { return d->selected.count()==1 ? d->selected.first() : 0; }

        void emitActionSignals(bool withUndoAction=true);

        void  emitSelectionSignals();

        void setInteractiveMode(bool interactive) { d->interactive = interactive; }

        bool interactiveMode() const { return d->interactive; }

        void setDesignMode(bool design);

        bool designMode() const { return d->design; }
 
        bool isModified() { return d->dirty; }

        int gridSize() { return 10; }

        int defaultMargin() { return 11;}

        int defaultSpacing() { return 6;}

        void emitChildAdded(ObjectTreeItem *item);

        void emitChildRemoved(ObjectTreeItem *item);

        TQString filename() const { return d->filename; }

        void setFilename(const TQString &file) { d->filename = file; }
 
        KCommandHistory* commandHistory() const { return d->history; }
        ConnectionBuffer* connectionBuffer() const { return d->connBuffer; }
        PixmapCollection* pixmapCollection() const { return d->pixcollection; }

        void addCommand(KCommand *command, bool execute);

        void clearCommandHistory();

        ObjectTreeList* tabStops() const { return &(d->tabstops); }
 
        inline ObjectTreeListIterator tabStopsIterator() const { return ObjectTreeListIterator(d->tabstops); }

        void updateTabStopsOrder();

        void addWidgetToTabStops(ObjectTreeItem *it);

        bool autoTabStops() const { return d->autoTabstops; }

        void setAutoTabStops(bool autoTab) { d->autoTabstops = autoTab;}

        void autoAssignTabStops();
 
#ifdef KEXI_DEBUG_GUI
        TQString m_recentlyLoadedUICode;
#endif

//      void resizeHandleDraggingStarted(TQWidget *draggedWidget);
 
        ResizeHandleSet* resizeHandlesForWidget(TQWidget* w);

        TQMap<TQCString,TQString>* headerProperties() const { return &d->headerProperties; }

        uint formatVersion() const;
        void setFormatVersion(uint ver);

        uint originalFormatVersion() const;
        void setOriginalFormatVersion(uint ver);
 
    public slots:
        void changeName(const TQCString &oldname, const TQCString &newname);

        void setSelectedWidget(TQWidget *selected, bool add=false, bool dontRaise=false,
            bool moreWillBeSelected = false);

        void unSelectWidget(TQWidget *w);

        void selectFormWidget();
 
        void clearSelection();
 
    protected slots:
        void formDeleted();
 
        void emitUndoEnabled();
        void emitRedoEnabled();

        void slotCommandExecuted();

        void slotFormRestored();
 
    signals:
        void selectionChanged(TQWidget *w, bool add, bool moreWillBeSelected = false);

        void childAdded(ObjectTreeItem *it);

        void childRemoved(ObjectTreeItem *it);

        void destroying();
 
    protected:
        void setConnectionBuffer(ConnectionBuffer *b) { d->connBuffer = b; }
 
        void setFormWidget(FormWidget* w);
    private:
        WidgetLibrary *m_lib;
        FormPrivate *d;
 
        friend class FormManager;
        friend class FormWidget;
        friend class ConnectionDialog;
};
 
}
 
#endif