ground/gcs/src/plugins/uavobjectbrowser/uavobjecttreemodel.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       uavobjecttreemodel.h
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
   6  * @addtogroup GCSPlugins GCS Plugins
   7  * @{
   8  * @addtogroup UAVObjectBrowserPlugin UAVObject Browser Plugin
   9  * @{
  10  * @brief The UAVObject Browser gadget plugin
  11  *****************************************************************************/
  12 /*
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 3 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful, but
  19  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  20  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  21  * for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License along
  24  * with this program; if not, write to the Free Software Foundation, Inc.,
  25  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  26  */
  27
  28 #ifndef UAVOBJECTTREEMODEL_H
  29 #define UAVOBJECTTREEMODEL_H
  30
  31 #include "treeitem.h"
  32
  33 #include <QAbstractItemModel>
  34 #include <QMap>
  35 #include <QList>
  36 #include <QColor>
  37 #include <QSettings>
  38
  39 class TopTreeItem;
  40 class ObjectTreeItem;
  41 class DataObjectTreeItem;
  42 class UAVObject;
  43 class UAVDataObject;
  44 class UAVMetaObject;
  45 class UAVObjectField;
  46 class UAVObjectManager;
  47 class QSignalMapper;
  48 class QTimer;
  49
  50 class UAVObjectTreeModel : public QAbstractItemModel {
  51     Q_OBJECT
  52 public:
  53     explicit UAVObjectTreeModel(QObject *parent);
  54     ~UAVObjectTreeModel();
  55
  56     QVariant data(const QModelIndex &index, int role) const;
  57     bool setData(const QModelIndex &index, const QVariant & value, int role);
  58     Qt::ItemFlags flags(const QModelIndex &index) const;
  59     QVariant headerData(int section, Qt::Orientation orientation,
  60                         int role = Qt::DisplayRole) const;
  61     QModelIndex index(int row, int column,
  62                       const QModelIndex &parent = QModelIndex()) const;
  63     QModelIndex parent(const QModelIndex &index) const;
  64     int rowCount(const QModelIndex &parent = QModelIndex()) const;
  65     int columnCount(const QModelIndex &parent = QModelIndex()) const;
  66
  67     bool showCategories() const;
  68     void setShowCategories(bool show);
  69
  70     bool showMetadata() const;
  71     void setShowMetadata(bool show);
  72
  73     bool useScientificNotation();
  74     void setUseScientificNotation(bool useScientificNotation);
  75
  76     QColor unknownObjectColor() const;
  77     void setUnknownObjectColor(QColor color);
  78
  79     QColor recentlyUpdatedColor() const;
  80     void setRecentlyUpdatedColor(QColor color);
  81
  82     QColor manuallyChangedColor() const;
  83     void setManuallyChangedColor(QColor color);
  84
  85     int recentlyUpdatedTimeout() const;
  86     void setRecentlyUpdatedTimeout(int timeout);
  87
  88     bool onlyHighlightChangedValues() const;
  89     void setOnlyHighlightChangedValues(bool highlight);
  90
  91     bool highlightTopTreeItems() const;
  92     void setHighlightTopTreeItems(bool highlight);
  93
  94 private slots:
  95     void newObject(UAVObject *obj);
  96     void updateObject(UAVObject *obj);
  97     void updateIsKnown(UAVObject *obj);
  98     void refreshHighlight(TreeItem *item);
  99     void refreshIsKnown(TreeItem *item);
 100
 101 private:
 102     QSettings m_settings;
 103
 104     HighlightManager *m_highlightManager;
 105
 106     TreeItem *m_rootItem;
 107     TopTreeItem *m_settingsTree;
 108     TopTreeItem *m_nonSettingsTree;
 109
 110     QHash<quint32, ObjectTreeItem *> m_objectTreeItems;
 111
 112     QModelIndex index(TreeItem *item, int column = 0) const;
 113
 114     void setupModelData();
 115     void resetModelData();
 116
 117     void addObject(UAVDataObject *obj);
 118     void addArrayField(UAVObjectField *field, TreeItem *parent);
 119     void addSingleField(int index, UAVObjectField *field, TreeItem *parent);
 120
 121     DataObjectTreeItem *createDataObject(UAVDataObject *obj);
 122     InstanceTreeItem *createDataObjectInstance(UAVDataObject *obj);
 123     MetaObjectTreeItem *createMetaObject(UAVMetaObject *obj);
 124     TreeItem *getParentItem(UAVDataObject *obj, bool categorize);
 125
 126     void appendItem(TreeItem *parentItem, TreeItem *childItem);
 127     void insertItem(TreeItem *parentItem, TreeItem *childItem, int row = -1);
 128     void removeItem(TreeItem *parentItem, TreeItem *childItem);
 129     void moveItem(TreeItem *newParentItem, TreeItem *oldParentItem, TreeItem *childItem);
 130
 131     void toggleCategoryItems();
 132     void toggleMetaItems();
 133
 134     void addObjectTreeItem(quint32 objectId, ObjectTreeItem *oti);
 135     ObjectTreeItem *findObjectTreeItem(quint32 objectId);
 136
 137     DataObjectTreeItem *findDataObjectTreeItem(UAVObject *obj);
 138 };
 139
 140 #endif // UAVOBJECTTREEMODEL_H