widgetfactory.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-2006 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 KFORMDESIGNERWIDGETFACTORY_H
#define KFORMDESIGNERWIDGETFACTORY_H
 
 
#include <tqobject.h>
#include <tqguardedptr.h>
#include <tqpixmap.h>
#include <tqpopupmenu.h>
#include <tqasciidict.h>
 
#include <kexiutils/tristate.h>
 
// class TQPixmap;
template<class type> class TQValueVector;
template<class type> class TQPtrList;
template<class type> class TQDict;
class TQWidget;
class TQDomElement;
class TQDomDocument;
class TQVariant;
class TQListView;
class TDEActionCollection;
class KTextEdit;
class KLineEdit;
class KXMLGUIClient;
 
namespace KoProperty {
    class Set;
}
 
namespace KFormDesigner {
 
class WidgetFactory;
class WidgetLibrary;
class Container;
class ResizeHandleSet;
class ObjectTreeItem;
class WidgetPropertySet;
class Form;

class KFORMEDITOR_EXPORT WidgetInfo
{
    public:
        typedef TQPtrList<WidgetInfo> List;
        typedef TQAsciiDict<WidgetInfo> Dict;
 
        WidgetInfo(WidgetFactory *f);
 
        WidgetInfo(WidgetFactory *f, const char* parentFactoryName, const char* inheritedClassName = 0);
 
        virtual ~WidgetInfo();

        TQString pixmap() const { return m_pixmap; }

        TQCString className() const { return m_class; }

        TQString namePrefix() const { return m_prefixName; }

        TQString name() const { return m_name; }
 
        TQString description() const { return m_desc; }
        TQString includeFileName() const { return m_include; }
        TQValueList<TQCString> alternateClassNames() const { return m_alternateNames; }
        TQString savingName() const { return m_saveName; }
        WidgetFactory *factory() const { return m_factory; }
 
        void setPixmap(const TQString &p) { m_pixmap = p; }
        void setClassName(const TQCString &s) { m_class = s; }
        void setName(const TQString &n) { m_name = n; }
        void setNamePrefix(const TQString &n) { m_prefixName = n; }
        void setDescription(const TQString &desc) { m_desc = desc;}

        void setIncludeFileName(const TQString &name) { m_include = name;}

        void addAlternateClassName(const TQCString& alternateName, bool override = false);

        bool isOverriddenClassName(const TQCString& alternateName) const;

        void setSavingName(const TQString &saveName) { m_saveName = saveName; }

        void setAutoSyncForProperty(const char *propertyName, tristate flag);

        tristate autoSyncForProperty(const char *propertyName) const;
 
        TQCString parentFactoryName() const { return m_parentFactoryName; }
 
        WidgetInfo* inheritedClass() const { return m_inheritedClass; }

        void setCustomTypeForProperty(const char *propertyName, int type);

        int customTypeForProperty(const char *propertyName) const;
 
    protected:
        TQCString m_parentFactoryName, m_inheritedClassName; 
        WidgetInfo* m_inheritedClass;
 
    private:
        TQString m_pixmap;
        TQCString m_class;
        TQString m_name;
        TQString m_prefixName;
        TQString m_desc;
        TQString m_include;
        TQValueList<TQCString> m_alternateNames;
        TQAsciiDict<char> *m_overriddenAlternateNames;
        TQString m_saveName;
        TQGuardedPtr<WidgetFactory> m_factory;
        TQAsciiDict<char> *m_propertiesWithDisabledAutoSync;
        TQMap<TQCString,int> *m_customTypesForProperty;
 
    friend class WidgetLibrary;
};


class KFORMEDITOR_EXPORT WidgetFactory : public TQObject
{
    TQ_OBJECT
 
    public:
        enum CreateWidgetOptions {
            AnyOrientation = 1, 
            HorizontalOrientation = 2,  
            VerticalOrientation = 4, 
            DesignViewMode = 8, 
            DefaultOptions = AnyOrientation | DesignViewMode
        };
 
        WidgetFactory(TQObject *parent=0, const char *name=0);
        virtual ~WidgetFactory();

        void addClass(WidgetInfo *w);

        void hideClass(const char *classname);

        const WidgetInfo::Dict classes() const { return m_classesByName; }

        virtual TQWidget* createWidget(const TQCString &classname, TQWidget *parent, const char *name,
            KFormDesigner::Container *container,
            int options = DefaultOptions) = 0;

        virtual void createCustomActions(TDEActionCollection *col) { Q_UNUSED(col); };

        virtual bool createMenuActions(const TQCString &classname, TQWidget *w, TQPopupMenu *menu,
            KFormDesigner::Container *container)=0;

        virtual bool startEditing(const TQCString &classname, TQWidget *w, Container *container)=0;

        virtual bool previewWidget(const TQCString &classname, TQWidget *widget, Container *container)=0;
 
        virtual bool clearWidgetContent(const TQCString &classname, TQWidget *w);

        virtual bool saveSpecialProperty(const TQCString &classname, const TQString &name,
            const TQVariant &value, TQWidget *w,
            TQDomElement &parentNode, TQDomDocument &parent);

        virtual bool readSpecialProperty(const TQCString &classname, TQDomElement &node,
            TQWidget *w, ObjectTreeItem *item);

        bool isPropertyVisible(const TQCString &classname, TQWidget *w,
            const TQCString &property, bool multiple, bool isTopLevel);

        virtual TQValueList<TQCString> autoSaveProperties(const TQCString &classname)=0;

        inline TQString propertyDescForName(const TQCString &name) { return m_propDesc[name]; };

        inline TQString propertyDescForValue(const TQCString &name) { return m_propValDesc[name]; };

        virtual void setPropertyOptions( WidgetPropertySet& buf, const WidgetInfo& info, TQWidget *w );

        inline TQString internalProperty(const TQCString& classname, const TQCString& property) const {
            return m_internalProp[classname+":"+property];
        }
 
    protected:
        virtual bool isPropertyVisibleInternal(const TQCString &classname, TQWidget *w,
            const TQCString &property, bool isTopLevel);

        virtual bool propertySetShouldBeReloadedAfterPropertyChange(const TQCString& classname, TQWidget *w,
            const TQCString& property);

        void createEditor(const TQCString &classname, const TQString &text,
            TQWidget *w, Container *container, TQRect geometry,
            int align, bool useFrame=false, bool multiLine = false,
            BackgroundMode background = TQt::NoBackground);

        void disableFilter(TQWidget *w, Container *container);

        bool editList(TQWidget *w, TQStringList &list);

        bool editRichText(TQWidget *w, TQString &text);

        void editListView(TQListView *listview);

        virtual bool  eventFilter(TQObject *obj, TQEvent *ev);

        void changeProperty(const char *name, const TQVariant &value, Form *form);

        virtual void resizeEditor(TQWidget *editor, TQWidget *widget, const TQCString &classname);
 
//      /*! Adds the i18n'ed description of a property, which will be shown in PropertyEditor. */
//      void  addPropertyDescription(Container *container, const char *prop, const TQString &desc);
 
//      /*! Adds the i18n'ed description of a property value, which will be shown in PropertyEditor. */
//      void  addValueDescription(Container *container, const char *value, const TQString &desc);

        bool inheritsFactories();
 
    public slots:

        void resetEditor();
 
    protected slots:
        virtual bool changeText(const TQString &newText);
 
        void changeTextInternal(const TQString& text);
 
        void slotTextChanged();

        void editorDeleted();
        void widgetDestroyed();
 
    protected:
        TQString editorText() const;
        void setEditorText(const TQString& text);
        void setEditor(TQWidget *widget, TQWidget *editor);
        TQWidget *editor(TQWidget *widget) const;
        void setWidget(TQWidget *widget, Container *container);
        TQWidget *widget() const;

        void setInternalProperty(const TQCString& classname, const TQCString& property, const TQString& value);
 
        WidgetLibrary *m_library;
        TQCString m_editedWidgetClass;
//#ifdef KEXI_KTEXTEDIT
//      TQGuardedPtr<KTextEdit>  m_editor;
//#else
//      TQGuardedPtr<KLineEdit>  m_editor;
//#endif
        TQString m_firstText;
        TQGuardedPtr<ResizeHandleSet> m_handles;
        TQGuardedPtr<Container> m_container;
//      WidgetInfo::List m_classes;
        WidgetInfo::Dict m_classesByName;
        TQAsciiDict<char>* m_hiddenClasses;

        TQMap<TQCString, TQString> m_propDesc;
        TQMap<TQCString, TQString> m_propValDesc;
        TQMap<TQCString, TQString> m_internalProp;

        bool m_showAdvancedProperties;

        TQString m_xmlGUIFileName;
 
        KXMLGUIClient *m_guiClient;
 
        TQGuardedPtr<TQWidget> m_widget;
        TQGuardedPtr<TQWidget> m_editor;
 
    friend class WidgetLibrary;
};

#define KFORMDESIGNER_WIDGET_FACTORY(factoryClassName, libraryName) \
    K_EXPORT_COMPONENT_FACTORY(kformdesigner_ ## libraryName, KGenericFactory<factoryClassName>("kformdesigner_" # libraryName))
 
}
#endif