RootItem.h

/***************************************************************************
 *   Copyright (C) 2006 by Graeme Foster                                   *
 *   email    foster.graeme@gmail.com                                      *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef __ROOT_ITEM_H
#define __ROOT_ITEM_H

#include <QList>
#include <QVariant>
#include <QColor>

#include "GUIPref.h"
#include "DataClass.h"

class RootItem;

typedef bool (*CompareRI)(const RootItem*, const RootItem*);

class RootItem : virtual public QObject
{
        Q_OBJECT
        
        public: // Data Types
                // When adding a new class also modify getClassName() in RootItem.cpp
                enum ObjClass {ABSTRACT_ITEM
                                                  ,INST_ITEM
                                                  ,PROG_ITEM
                                                  ,MODULE_ITEM
                                                  ,FACULTY_ITEM
                                                  ,DEPT_ITEM
                                                  ,STAFF_ITEM
                                                  ,ROOM_ITEM
                                                  ,ML_ALLOC_ITEM
                                                  ,TIME_SLOT_ITEM
                                                  ,DAILY_TIME_SLOT_ITEM
                                                  };
        public: // Constants
                static const int UNKNOWN;
                
        protected: // Properties
                QList<RootItem*> childItems;
                RootItem *parentItem;
                DataClass * itemData;
                int RTTI;
                int col_count;
                QVector<int> col_order;
                QVector<QColor> txtColour;
                QVector<QColor> backgroundColour;
        public: // Methods
        // Constructors
                RootItem(RootItem *parent = 0, int cc =0);
                RootItem(RootItem & ii);
        
        // Get Methods
                // Abstract Methods
                virtual QString getDescription()const=0;
                virtual QVariant data(int column) const =0;
                virtual DataClass * getItemData()const =0;
                // inline virtual Methods
                inline virtual int getParentID() {return UNKNOWN;}
                inline int columnCount() const {return col_count;}
                // inline Methods
                inline int getID() const {return itemData->getID();}
                inline RootItem *parent(){return parentItem;}
                inline int childCount() const {return childItems.count();}
                inline RootItem *child(int row) const {return dynamic_cast<RootItem *>(childItems.value(row));}
                // Methods
                QString getClassName();
                int row() const;
                RootItem * findItem(DataClass * dc);
                int findChildPos(int id);
        
        // Set Methods
                // Abstract Methods
                virtual bool setData(int column, const QVariant & value) =0;
                // inline  Methods
                inline void setParent(RootItem* pi){parentItem = pi;}
                inline void clearAllChildren(){childItems.clear();}
                inline void setColumnCount(int cc) {col_count = cc;}
                // Methods
                void setColumnOrder(int count, ...);
                void setTextColour(int count, ...);
                void setBGColour(int count, ...);
                void insertChild(RootItem *child);
                void appendChild(RootItem *item);
                void deleteChild(RootItem *child);
                static bool riCompareCI(const RootItem *p1, const RootItem * p2);
                static bool riCompareCS(const RootItem *p1, const RootItem * p2);
                void sort(CompareRI compare) {qSort(childItems.begin(), childItems.end(), compare);}
        
        // Data display
                // inline virtual Methods
                inline virtual QColor textColour(int ){return txtColour[row()%2];}
                inline virtual QColor bgColour(int )  {return backgroundColour[row()%2];}
        // database manipulation
                // Abstract Methods
                virtual void dbSave()=0;
                virtual void dbDelete()=0;
        
        // diagnostic
                // inline Methods
                inline int rtti(){return RTTI;}
                RootItem * clone();
                // Methods
                void dump();
};

#endif

---