widgetlibrary.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 KFORMDESIGNERWIDGETLIBRARY_H
#define KFORMDESIGNERWIDGETLIBRARY_H
 
#include <tqobject.h>
#include <tqmap.h>
#include <tqdict.h>
 
#include "widgetfactory.h"
 
template<class type> class TQPtrList;
template<class type> class TQValueVector;
class TDEActionCollection;
class TDEAction;
class TQWidget;
class TQPopupMenu;
class TQVariant;
class TQDomDocument;
class TQDomElement;
 
namespace KFormDesigner {
 
class Container;
class ObjectTreeItem;
class WidgetLibraryPrivate;
class WidgetPropertySet;
 
typedef TQPtrList<TDEAction> ActionList;

class KFORMEDITOR_EXPORT WidgetLibrary : public TQObject
{
    TQ_OBJECT
  
 
    public:
        WidgetLibrary(TQObject *parent=0, const TQStringList& supportedFactoryGroups = TQStringList());
 
        virtual ~WidgetLibrary();

        ActionList createWidgetActions(KXMLGUIClient* client, TDEActionCollection *parent, 
            TQObject *receiver, const char *slot);
 
        void addCustomWidgetActions(TDEActionCollection *col);
 
//old       /**
//old        * creates the XML for widget actions
//old        */
//old       TQString createXML();

        TQWidget *createWidget(const TQCString &classname, TQWidget *parent, const char *name, Container *c,
            int options = WidgetFactory::DefaultOptions);
 
        bool createMenuActions(const TQCString &c, TQWidget *w, TQPopupMenu *menu,
            KFormDesigner::Container *container);

        WidgetFactory::CreateWidgetOptions showOrientationSelectionPopup(
            const TQCString &classname, TQWidget* parent, const TQPoint& pos);
 
        TQString internalProperty(const TQCString& classname, const TQCString& property);
 
        TQString displayName(const TQCString &classname);
        TQString namePrefix(const TQCString &classname);
        TQString textForWidgetName(const TQCString &name, const TQCString &className);

        TQCString classNameForAlternate(const TQCString &classname);
        TQString iconName(const TQCString &classname);
        TQString includeFileName(const TQCString &classname);
        TQString savingName(const TQCString &classname);
 
        bool startEditing(const TQCString &classname, TQWidget *w, Container *container);
        bool previewWidget(const TQCString &classname, TQWidget *widget, Container *container);
        bool clearWidgetContent(const TQCString &classname, TQWidget *w);
 
        bool saveSpecialProperty(const TQCString &classname, const TQString &name,
            const TQVariant &value, TQWidget *w, TQDomElement &parentNode, TQDomDocument &parent);
        bool readSpecialProperty(const TQCString &classname, TQDomElement &node, TQWidget *w,
            ObjectTreeItem *item);
        bool isPropertyVisible(const TQCString &classname, TQWidget *w,
            const TQCString &property, bool multiple = false, bool isTopLevel = false);
 
        TQValueList<TQCString> autoSaveProperties(const TQCString &classname);
 
        WidgetInfo* widgetInfoForClassName(const char* classname);
 
        WidgetFactory* factoryForClassName(const char* className);
 
        WidgetFactory* factory(const char* factoryName) const;

        bool advancedPropertiesVisible() const;

        void setAdvancedPropertiesVisible(bool set);

        TQString propertyDescForName(WidgetInfo *winfo, const TQCString& propertyName);

        TQString propertyDescForValue(WidgetInfo *winfo, const TQCString& name);

        void setPropertyOptions( WidgetPropertySet &list, const WidgetInfo& winfo, TQWidget* w );

        bool propertySetShouldBeReloadedAfterPropertyChange(const TQCString& classname, TQWidget *w, 
            const TQCString& property);
 
    signals:
        void prepareInsert(const TQCString &c);

        void widgetCreated(TQWidget *widget);
 
    protected:
        void loadFactoryWidgets(WidgetFactory *f);
 
#if 0 //UNIMPLEMENTED
        void setFilter(const TQRegExp &expr);
#endif

        void lookupFactories();

        void loadFactories();
 
        WidgetLibraryPrivate *d;
};
 
}
#endif