objecttree.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) 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 KFORMDESIGNEROBJECTTREE_H
#define KFORMDESIGNEROBJECTTREE_H
 
#include <tqptrlist.h>
#include <tqmap.h>
#include <tqdict.h>
#include <tqvariant.h>
#include <tqstring.h>
#include <tqguardedptr.h>
 
class TQWidget;
class TQDomElement;
 
namespace KFormDesigner {
 
class ObjectTreeItem;
class Container;
class EventEater;

typedef TQPtrList<ObjectTreeItem> ObjectTreeList;

typedef TQPtrListIterator<ObjectTreeItem> ObjectTreeListIterator;

typedef TQDict<ObjectTreeItem> ObjectTreeDict;

typedef TQDictIterator<ObjectTreeItem> ObjectTreeDictIterator;

class KFORMEDITOR_EXPORT ObjectTreeItem
{
    public:
        ObjectTreeItem(const TQString &className, const TQString &name, TQWidget *widget, Container *parentContainer, Container *container=0);
        virtual ~ObjectTreeItem();
 
        TQString name() const { return m_name; }
        TQString className() const { return m_className; }
        TQWidget* widget() const { return m_widget; }
        EventEater* eventEater() const { return m_eater; }
        ObjectTreeItem* parent() const { return m_parent; }
        ObjectTreeList* children() { return &m_children; }

        const TQStringVariantMap* modifiedProperties() const { return &m_props;}

        Container* container() const { return m_container;}
 
        void setWidget(TQWidget *w) { m_widget = w; }
        void setParent(ObjectTreeItem *parent)  { m_parent = parent;}
 
        void debug(int ident);
        void rename(const TQString &name);
 
        void addChild(ObjectTreeItem *it);
        void removeChild(ObjectTreeItem *it);

        void addModifiedProperty(const TQCString &property, const TQVariant &oldValue);
        void storeUnknownProperty(TQDomElement &el);

        void addSubproperty(const TQCString &property, const TQVariant& value);

        TQStringVariantMap* subproperties() const { return m_subprops; }
 
        void setPixmapName(const TQCString &property, const TQString &name);
        TQString pixmapName(const TQCString &property);
 
        void setEnabled(bool enabled)  { m_enabled = enabled; }
        bool isEnabled() const { return m_enabled; }
 
        int gridRow() const { return m_row; }
        int gridCol() const { return m_col; }
        int gridRowSpan() const { return m_rowspan; }
        int gridColSpan() const { return m_colspan; }
        bool spanMultipleCells() const { return m_span; }
        void setGridPos(int row, int col, int rowspan, int colspan);
 
    protected:
        TQString m_className;
        TQString m_name;
        ObjectTreeList  m_children;
        TQGuardedPtr<Container> m_container;
        TQStringVariantMap m_props;
        TQStringVariantMap *m_subprops;
        TQString  m_unknownProps;
        TQMap<TQCString, TQString> m_pixmapNames;
        ObjectTreeItem* m_parent;
        TQGuardedPtr<TQWidget> m_widget;
        TQGuardedPtr<EventEater> m_eater;
 
        bool  m_enabled;
 
        int m_row, m_col, m_rowspan, m_colspan;
        bool m_span;
 
        friend class ObjectTree;
        friend class FormIO;
};

class KFORMEDITOR_EXPORT ObjectTree : public ObjectTreeItem
{
    public:
        ObjectTree(const TQString &className=TQString(), const TQString &name=TQString(),
            TQWidget *widget=0, Container *container=0);
        virtual ~ObjectTree();

        bool rename(const TQString &oldname, const TQString &newname );
        bool reparent(const TQString &name, const TQString &newparent);

        ObjectTreeItem* lookup(const TQString &name);

        ObjectTreeDict* dict() { return &m_treeDict; }
 
        void addItem(ObjectTreeItem *parent, ObjectTreeItem *c);
        void removeItem(const TQString &name);
        void removeItem(ObjectTreeItem *c);

        TQCString generateUniqueName(const TQCString &prefix, bool numberSuffixRequired = true);
 
    private:
        ObjectTreeDict m_treeDict;
};
 
}
 
#endif