LP-567 improve treeitem const correcteness

filnet · filnet · commit 6ded0d0b7a95 · 2018-04-12T09:19:05.000+02:00
diff --git a/ground/gcs/src/plugins/uavobjectbrowser/fieldtreeitem.h b/ground/gcs/src/plugins/uavobjectbrowser/fieldtreeitem.h
@@ -60,16 +60,15 @@ class FieldTreeItem : public TreeItem {
         TreeItem(data, parent), m_index(index), m_field(field)
     {}
 
-    bool isEditable()
+    bool isEditable() const
     {
         return true;
     }
 
-    virtual QWidget *createEditor(QWidget *parent)   = 0;
-    virtual QVariant getEditorValue(QWidget *editor) = 0;
-    virtual void setEditorValue(QWidget *editor, QVariant value) = 0;
-    virtual void apply() {}
-    virtual bool isKnown()
+    virtual QWidget *createEditor(QWidget *parent) const   = 0;
+    virtual QVariant getEditorValue(QWidget *editor) const = 0;
+    virtual void setEditorValue(QWidget *editor, QVariant value) const = 0;
+    virtual bool isKnown() const
     {
         return parent()->isKnown();
     }
@@ -130,7 +129,7 @@ class EnumFieldTreeItem : public FieldTreeItem {
         }
     }
 
-    QWidget *createEditor(QWidget *parent)
+    QWidget *createEditor(QWidget *parent) const
     {
         QComboBox *editor = new QComboBox(parent);
 
@@ -142,14 +141,14 @@ class EnumFieldTreeItem : public FieldTreeItem {
         return editor;
     }
 
-    QVariant getEditorValue(QWidget *editor)
+    QVariant getEditorValue(QWidget *editor) const
     {
         QComboBox *comboBox = static_cast<QComboBox *>(editor);
 
         return comboBox->currentIndex();
     }
 
-    void setEditorValue(QWidget *editor, QVariant value)
+    void setEditorValue(QWidget *editor, QVariant value) const
     {
         QComboBox *comboBox = static_cast<QComboBox *>(editor);
 
@@ -208,7 +207,7 @@ class IntFieldTreeItem : public FieldTreeItem {
         }
     }
 
-    QWidget *createEditor(QWidget *parent)
+    QWidget *createEditor(QWidget *parent) const
     {
         QSpinBox *editor = new QSpinBox(parent);
 
@@ -217,15 +216,15 @@ class IntFieldTreeItem : public FieldTreeItem {
         return editor;
     }
 
-    QVariant getEditorValue(QWidget *editor)
+    QVariant getEditorValue(QWidget *editor) const
     {
         QSpinBox *spinBox = static_cast<QSpinBox *>(editor);
 
         spinBox->interpretText();
         return spinBox->value();
     }
 
-    void setEditorValue(QWidget *editor, QVariant value)
+    void setEditorValue(QWidget *editor, QVariant value) const
     {
         QSpinBox *spinBox = static_cast<QSpinBox *>(editor);
 
@@ -290,7 +289,7 @@ class FloatFieldTreeItem : public FieldTreeItem {
         }
     }
 
-    QWidget *createEditor(QWidget *parent)
+    QWidget *createEditor(QWidget *parent) const
     {
         if (m_useScientificNotation) {
             QScienceSpinBox *editor = new QScienceSpinBox(parent);
@@ -307,7 +306,7 @@ class FloatFieldTreeItem : public FieldTreeItem {
         }
     }
 
-    QVariant getEditorValue(QWidget *editor)
+    QVariant getEditorValue(QWidget *editor) const
     {
         if (m_useScientificNotation) {
             QScienceSpinBox *spinBox = static_cast<QScienceSpinBox *>(editor);
@@ -320,7 +319,7 @@ class FloatFieldTreeItem : public FieldTreeItem {
         }
     }
 
-    void setEditorValue(QWidget *editor, QVariant value)
+    void setEditorValue(QWidget *editor, QVariant value) const
     {
         if (m_useScientificNotation) {
             QScienceSpinBox *spinBox = static_cast<QScienceSpinBox *>(editor);
@@ -346,7 +345,7 @@ class HexFieldTreeItem : public FieldTreeItem {
         FieldTreeItem(index, data, field, parent)
     {}
 
-    QWidget *createEditor(QWidget *parent)
+    QWidget *createEditor(QWidget *parent) const
     {
         QLineEdit *lineEdit = new QLineEdit(parent);
 
@@ -355,14 +354,14 @@ class HexFieldTreeItem : public FieldTreeItem {
         return lineEdit;
     }
 
-    QVariant getEditorValue(QWidget *editor)
+    QVariant getEditorValue(QWidget *editor) const
     {
         QLineEdit *lineEdit = static_cast<QLineEdit *>(editor);
 
         return lineEdit->text();
     }
 
-    void setEditorValue(QWidget *editor, QVariant value)
+    void setEditorValue(QWidget *editor, QVariant value) const
     {
         QLineEdit *lineEdit = static_cast<QLineEdit *>(editor);
 
@@ -392,15 +391,15 @@ class HexFieldTreeItem : public FieldTreeItem {
     }
 
 private:
-    QVariant toHexString(QVariant value)
+    QVariant toHexString(QVariant value) const
     {
         QString str;
         bool ok;
 
         return str.setNum(value.toUInt(&ok), 16).toUpper();
     }
 
-    QVariant toUInt(QVariant str)
+    QVariant toUInt(QVariant str) const
     {
         bool ok;
 
@@ -419,7 +418,7 @@ class CharFieldTreeItem : public FieldTreeItem {
         FieldTreeItem(index, data, field, parent)
     {}
 
-    QWidget *createEditor(QWidget *parent)
+    QWidget *createEditor(QWidget *parent) const
     {
         QLineEdit *lineEdit = new QLineEdit(parent);
 
@@ -428,14 +427,14 @@ class CharFieldTreeItem : public FieldTreeItem {
         return lineEdit;
     }
 
-    QVariant getEditorValue(QWidget *editor)
+    QVariant getEditorValue(QWidget *editor) const
     {
         QLineEdit *lineEdit = static_cast<QLineEdit *>(editor);
 
         return lineEdit->text();
     }
 
-    void setEditorValue(QWidget *editor, QVariant value)
+    void setEditorValue(QWidget *editor, QVariant value) const
     {
         QLineEdit *lineEdit = static_cast<QLineEdit *>(editor);
 
@@ -463,14 +462,13 @@ class CharFieldTreeItem : public FieldTreeItem {
             setHighlight(true);
         }
     }
-
 private:
-    QVariant toChar(QVariant value)
+    QVariant toChar(QVariant value) const
     {
         return value.toChar();
     }
 
-    QVariant toUInt(QVariant str)
+    QVariant toUInt(QVariant str) const
     {
         return QVariant(str.toString().at(0).toLatin1());
     }
diff --git a/ground/gcs/src/plugins/uavobjectbrowser/treeitem.cpp b/ground/gcs/src/plugins/uavobjectbrowser/treeitem.cpp
@@ -161,7 +161,7 @@ void TreeItem::insertChild(TreeItem *child)
     child->setParentTree(this);
 }
 
-TreeItem *TreeItem::getChild(int index)
+TreeItem *TreeItem::getChild(int index) const
 {
     return m_children.value(index);
 }
@@ -250,7 +250,7 @@ void TreeItem::setHighlightManager(HighLightManager *mgr)
     m_highlightManager = mgr;
 }
 
-QTime TreeItem::getHiglightExpires()
+QTime TreeItem::getHiglightExpires() const
 {
     return m_highlightExpires;
 }
diff --git a/ground/gcs/src/plugins/uavobjectbrowser/treeitem.h b/ground/gcs/src/plugins/uavobjectbrowser/treeitem.h
@@ -99,20 +99,21 @@ class TreeItem : public QObject {
     void appendChild(TreeItem *child);
     void insertChild(TreeItem *child);
 
-    TreeItem *getChild(int index);
+    TreeItem *getChild(int index) const;
     inline QList<TreeItem *> treeChildren() const
     {
         return m_children;
     }
     int childCount() const;
     int columnCount() const;
     virtual QVariant data(int column = 1) const;
-    QString description()
+    QString description() const
     {
         return m_description;
     }
-    void setDescription(QString d) // Split around 40 characters
+    void setDescription(QString d)
     {
+        // Split around 40 characters
         int idx = d.indexOf(" ", 40);
 
         d.insert(idx, QString("<br>"));
@@ -123,22 +124,22 @@ class TreeItem : public QObject {
     // other columns are initialized in constructor
     virtual void setData(QVariant value, int column = 1);
     int row() const;
-    TreeItem *parent()
+    TreeItem *parent() const
     {
         return m_parent;
     }
     void setParentTree(TreeItem *parent)
     {
         m_parent = parent;
     }
-    inline virtual bool isEditable()
+    inline virtual bool isEditable() const
     {
         return false;
     }
     virtual void update();
     virtual void apply();
 
-    inline bool highlighted()
+    inline bool highlighted() const
     {
         return m_highlight;
     }
@@ -148,7 +149,7 @@ class TreeItem : public QObject {
         m_highlightTimeMs = time;
     }
 
-    inline bool changed()
+    inline bool changed() const
     {
         return m_changed;
     }
@@ -159,11 +160,11 @@ class TreeItem : public QObject {
 
     virtual void setHighlightManager(HighLightManager *mgr);
 
-    QTime getHiglightExpires();
+    QTime getHiglightExpires() const;
 
     virtual void removeHighlight();
 
-    int nameIndex(QString name)
+    int nameIndex(QString name) const
     {
         for (int i = 0; i < childCount(); ++i) {
             if (name < getChild(i)->data(0).toString()) {
@@ -173,7 +174,7 @@ class TreeItem : public QObject {
         return childCount();
     }
 
-    TreeItem *findChildByName(QString name)
+    TreeItem *findChildByName(QString name) const
     {
         foreach(TreeItem * child, m_children) {
             if (name == child->data(0).toString()) {
@@ -219,7 +220,7 @@ class TreeItem : public QObject {
             emit updateIsKnown(this);
         }
     }
-    virtual bool isKnown()
+    virtual bool isKnown() const
     {
         return true;
     }

Original file line number	Diff line number	Diff line change
`@@ -60,16 +60,15 @@ class FieldTreeItem : public TreeItem {`
`60`	`60`	`TreeItem(data, parent), m_index(index), m_field(field)`
`61`	`61`	`{}`
`62`	`62`
`63`		`- bool isEditable()`
	`63`	`+ bool isEditable() const`
`64`	`64`	`{`
`65`	`65`	`return true;`
`66`	`66`	`}`
`67`	`67`
`68`		`- virtual QWidget createEditor(QWidget parent) = 0;`
`69`		`- virtual QVariant getEditorValue(QWidget *editor) = 0;`
`70`		`- virtual void setEditorValue(QWidget *editor, QVariant value) = 0;`
`71`		`- virtual void apply() {}`
`72`		`- virtual bool isKnown()`
	`68`	`+ virtual QWidget createEditor(QWidget parent) const = 0;`
	`69`	`+ virtual QVariant getEditorValue(QWidget *editor) const = 0;`
	`70`	`+ virtual void setEditorValue(QWidget *editor, QVariant value) const = 0;`
	`71`	`+ virtual bool isKnown() const`
`73`	`72`	`{`
`74`	`73`	`return parent()->isKnown();`
`75`	`74`	`}`
`@@ -130,7 +129,7 @@ class EnumFieldTreeItem : public FieldTreeItem {`
`130`	`129`	`}`
`131`	`130`	`}`
`132`	`131`
`133`		`- QWidget createEditor(QWidget parent)`
	`132`	`+ QWidget createEditor(QWidget parent) const`
`134`	`133`	`{`
`135`	`134`	`QComboBox *editor = new QComboBox(parent);`
`136`	`135`
`@@ -142,14 +141,14 @@ class EnumFieldTreeItem : public FieldTreeItem {`
`142`	`141`	`return editor;`
`143`	`142`	`}`
`144`	`143`
`145`		`- QVariant getEditorValue(QWidget *editor)`
	`144`	`+ QVariant getEditorValue(QWidget *editor) const`
`146`	`145`	`{`
`147`	`146`	`QComboBox comboBox = static_cast<QComboBox >(editor);`
`148`	`147`
`149`	`148`	`return comboBox->currentIndex();`
`150`	`149`	`}`
`151`	`150`
`152`		`- void setEditorValue(QWidget *editor, QVariant value)`
	`151`	`+ void setEditorValue(QWidget *editor, QVariant value) const`
`153`	`152`	`{`
`154`	`153`	`QComboBox comboBox = static_cast<QComboBox >(editor);`
`155`	`154`
`@@ -208,7 +207,7 @@ class IntFieldTreeItem : public FieldTreeItem {`
`208`	`207`	`}`
`209`	`208`	`}`
`210`	`209`
`211`		`- QWidget createEditor(QWidget parent)`
	`210`	`+ QWidget createEditor(QWidget parent) const`
`212`	`211`	`{`
`213`	`212`	`QSpinBox *editor = new QSpinBox(parent);`
`214`	`213`
`@@ -217,15 +216,15 @@ class IntFieldTreeItem : public FieldTreeItem {`
`217`	`216`	`return editor;`
`218`	`217`	`}`
`219`	`218`
`220`		`- QVariant getEditorValue(QWidget *editor)`
	`219`	`+ QVariant getEditorValue(QWidget *editor) const`
`221`	`220`	`{`
`222`	`221`	`QSpinBox spinBox = static_cast<QSpinBox >(editor);`
`223`	`222`
`224`	`223`	`spinBox->interpretText();`
`225`	`224`	`return spinBox->value();`
`226`	`225`	`}`
`227`	`226`
`228`		`- void setEditorValue(QWidget *editor, QVariant value)`
	`227`	`+ void setEditorValue(QWidget *editor, QVariant value) const`
`229`	`228`	`{`
`230`	`229`	`QSpinBox spinBox = static_cast<QSpinBox >(editor);`
`231`	`230`
`@@ -290,7 +289,7 @@ class FloatFieldTreeItem : public FieldTreeItem {`
`290`	`289`	`}`
`291`	`290`	`}`
`292`	`291`
`293`		`- QWidget createEditor(QWidget parent)`
	`292`	`+ QWidget createEditor(QWidget parent) const`
`294`	`293`	`{`
`295`	`294`	`if (m_useScientificNotation) {`
`296`	`295`	`QScienceSpinBox *editor = new QScienceSpinBox(parent);`
`@@ -307,7 +306,7 @@ class FloatFieldTreeItem : public FieldTreeItem {`
`307`	`306`	`}`
`308`	`307`	`}`
`309`	`308`
`310`		`- QVariant getEditorValue(QWidget *editor)`
	`309`	`+ QVariant getEditorValue(QWidget *editor) const`
`311`	`310`	`{`
`312`	`311`	`if (m_useScientificNotation) {`
`313`	`312`	`QScienceSpinBox spinBox = static_cast<QScienceSpinBox >(editor);`
`@@ -320,7 +319,7 @@ class FloatFieldTreeItem : public FieldTreeItem {`
`320`	`319`	`}`
`321`	`320`	`}`
`322`	`321`
`323`		`- void setEditorValue(QWidget *editor, QVariant value)`
	`322`	`+ void setEditorValue(QWidget *editor, QVariant value) const`
`324`	`323`	`{`
`325`	`324`	`if (m_useScientificNotation) {`
`326`	`325`	`QScienceSpinBox spinBox = static_cast<QScienceSpinBox >(editor);`
`@@ -346,7 +345,7 @@ class HexFieldTreeItem : public FieldTreeItem {`
`346`	`345`	`FieldTreeItem(index, data, field, parent)`
`347`	`346`	`{}`
`348`	`347`
`349`		`- QWidget createEditor(QWidget parent)`
	`348`	`+ QWidget createEditor(QWidget parent) const`
`350`	`349`	`{`
`351`	`350`	`QLineEdit *lineEdit = new QLineEdit(parent);`
`352`	`351`
`@@ -355,14 +354,14 @@ class HexFieldTreeItem : public FieldTreeItem {`
`355`	`354`	`return lineEdit;`
`356`	`355`	`}`
`357`	`356`
`358`		`- QVariant getEditorValue(QWidget *editor)`
	`357`	`+ QVariant getEditorValue(QWidget *editor) const`
`359`	`358`	`{`
`360`	`359`	`QLineEdit lineEdit = static_cast<QLineEdit >(editor);`
`361`	`360`
`362`	`361`	`return lineEdit->text();`
`363`	`362`	`}`
`364`	`363`
`365`		`- void setEditorValue(QWidget *editor, QVariant value)`
	`364`	`+ void setEditorValue(QWidget *editor, QVariant value) const`
`366`	`365`	`{`
`367`	`366`	`QLineEdit lineEdit = static_cast<QLineEdit >(editor);`
`368`	`367`
`@@ -392,15 +391,15 @@ class HexFieldTreeItem : public FieldTreeItem {`
`392`	`391`	`}`
`393`	`392`
`394`	`393`	`private:`
`395`		`- QVariant toHexString(QVariant value)`
	`394`	`+ QVariant toHexString(QVariant value) const`
`396`	`395`	`{`
`397`	`396`	`QString str;`
`398`	`397`	`bool ok;`
`399`	`398`
`400`	`399`	`return str.setNum(value.toUInt(&ok), 16).toUpper();`
`401`	`400`	`}`
`402`	`401`
`403`		`- QVariant toUInt(QVariant str)`
	`402`	`+ QVariant toUInt(QVariant str) const`
`404`	`403`	`{`
`405`	`404`	`bool ok;`
`406`	`405`
`@@ -419,7 +418,7 @@ class CharFieldTreeItem : public FieldTreeItem {`
`419`	`418`	`FieldTreeItem(index, data, field, parent)`
`420`	`419`	`{}`
`421`	`420`
`422`		`- QWidget createEditor(QWidget parent)`
	`421`	`+ QWidget createEditor(QWidget parent) const`
`423`	`422`	`{`
`424`	`423`	`QLineEdit *lineEdit = new QLineEdit(parent);`
`425`	`424`
`@@ -428,14 +427,14 @@ class CharFieldTreeItem : public FieldTreeItem {`
`428`	`427`	`return lineEdit;`
`429`	`428`	`}`
`430`	`429`
`431`		`- QVariant getEditorValue(QWidget *editor)`
	`430`	`+ QVariant getEditorValue(QWidget *editor) const`
`432`	`431`	`{`
`433`	`432`	`QLineEdit lineEdit = static_cast<QLineEdit >(editor);`
`434`	`433`
`435`	`434`	`return lineEdit->text();`
`436`	`435`	`}`
`437`	`436`
`438`		`- void setEditorValue(QWidget *editor, QVariant value)`
	`437`	`+ void setEditorValue(QWidget *editor, QVariant value) const`
`439`	`438`	`{`
`440`	`439`	`QLineEdit lineEdit = static_cast<QLineEdit >(editor);`
`441`	`440`
`@@ -463,14 +462,13 @@ class CharFieldTreeItem : public FieldTreeItem {`
`463`	`462`	`setHighlight(true);`
`464`	`463`	`}`
`465`	`464`	`}`
`466`		`-`
`467`	`465`	`private:`
`468`		`- QVariant toChar(QVariant value)`
	`466`	`+ QVariant toChar(QVariant value) const`
`469`	`467`	`{`
`470`	`468`	`return value.toChar();`
`471`	`469`	`}`
`472`	`470`
`473`		`- QVariant toUInt(QVariant str)`
	`471`	`+ QVariant toUInt(QVariant str) const`
`474`	`472`	`{`
`475`	`473`	`return QVariant(str.toString().at(0).toLatin1());`
`476`	`474`	`}`
Original file line number	Diff line number	Diff line change
`@@ -161,7 +161,7 @@ void TreeItem::insertChild(TreeItem *child)`
`161`	`161`	`child->setParentTree(this);`
`162`	`162`	`}`
`163`	`163`
`164`		`-TreeItem *TreeItem::getChild(int index)`
	`164`	`+TreeItem *TreeItem::getChild(int index) const`
`165`	`165`	`{`
`166`	`166`	`return m_children.value(index);`
`167`	`167`	`}`
`@@ -250,7 +250,7 @@ void TreeItem::setHighlightManager(HighLightManager *mgr)`
`250`	`250`	`m_highlightManager = mgr;`
`251`	`251`	`}`
`252`	`252`
`253`		`-QTime TreeItem::getHiglightExpires()`
	`253`	`+QTime TreeItem::getHiglightExpires() const`
`254`	`254`	`{`
`255`	`255`	`return m_highlightExpires;`
`256`	`256`	`}`
Original file line number	Diff line number	Diff line change
`@@ -99,20 +99,21 @@ class TreeItem : public QObject {`
`99`	`99`	`void appendChild(TreeItem *child);`
`100`	`100`	`void insertChild(TreeItem *child);`
`101`	`101`
`102`		`- TreeItem *getChild(int index);`
	`102`	`+ TreeItem *getChild(int index) const;`
`103`	`103`	`inline QList<TreeItem *> treeChildren() const`
`104`	`104`	`{`
`105`	`105`	`return m_children;`
`106`	`106`	`}`
`107`	`107`	`int childCount() const;`
`108`	`108`	`int columnCount() const;`
`109`	`109`	`virtual QVariant data(int column = 1) const;`
`110`		`- QString description()`
	`110`	`+ QString description() const`
`111`	`111`	`{`
`112`	`112`	`return m_description;`
`113`	`113`	`}`
`114`		`- void setDescription(QString d) // Split around 40 characters`
	`114`	`+ void setDescription(QString d)`
`115`	`115`	`{`
	`116`	`+ // Split around 40 characters`
`116`	`117`	`int idx = d.indexOf(" ", 40);`
`117`	`118`
`118`	`119`	`d.insert(idx, QString("<br>"));`
`@@ -123,22 +124,22 @@ class TreeItem : public QObject {`
`123`	`124`	`// other columns are initialized in constructor`
`124`	`125`	`virtual void setData(QVariant value, int column = 1);`
`125`	`126`	`int row() const;`
`126`		`- TreeItem *parent()`
	`127`	`+ TreeItem *parent() const`
`127`	`128`	`{`
`128`	`129`	`return m_parent;`
`129`	`130`	`}`
`130`	`131`	`void setParentTree(TreeItem *parent)`
`131`	`132`	`{`
`132`	`133`	`m_parent = parent;`
`133`	`134`	`}`
`134`		`- inline virtual bool isEditable()`
	`135`	`+ inline virtual bool isEditable() const`
`135`	`136`	`{`
`136`	`137`	`return false;`
`137`	`138`	`}`
`138`	`139`	`virtual void update();`
`139`	`140`	`virtual void apply();`
`140`	`141`
`141`		`- inline bool highlighted()`
	`142`	`+ inline bool highlighted() const`
`142`	`143`	`{`
`143`	`144`	`return m_highlight;`
`144`	`145`	`}`
`@@ -148,7 +149,7 @@ class TreeItem : public QObject {`
`148`	`149`	`m_highlightTimeMs = time;`
`149`	`150`	`}`
`150`	`151`
`151`		`- inline bool changed()`
	`152`	`+ inline bool changed() const`
`152`	`153`	`{`
`153`	`154`	`return m_changed;`
`154`	`155`	`}`
`@@ -159,11 +160,11 @@ class TreeItem : public QObject {`
`159`	`160`
`160`	`161`	`virtual void setHighlightManager(HighLightManager *mgr);`
`161`	`162`
`162`		`- QTime getHiglightExpires();`
	`163`	`+ QTime getHiglightExpires() const;`
`163`	`164`
`164`	`165`	`virtual void removeHighlight();`
`165`	`166`
`166`		`- int nameIndex(QString name)`
	`167`	`+ int nameIndex(QString name) const`
`167`	`168`	`{`
`168`	`169`	`for (int i = 0; i < childCount(); ++i) {`
`169`	`170`	`if (name < getChild(i)->data(0).toString()) {`
`@@ -173,7 +174,7 @@ class TreeItem : public QObject {`
`173`	`174`	`return childCount();`
`174`	`175`	`}`
`175`	`176`
`176`		`- TreeItem *findChildByName(QString name)`
	`177`	`+ TreeItem *findChildByName(QString name) const`
`177`	`178`	`{`
`178`	`179`	`foreach(TreeItem * child, m_children) {`
`179`	`180`	`if (name == child->data(0).toString()) {`
`@@ -219,7 +220,7 @@ class TreeItem : public QObject {`
`219`	`220`	`emit updateIsKnown(this);`
`220`	`221`	`}`
`221`	`222`	`}`
`222`		`- virtual bool isKnown()`
	`223`	`+ virtual bool isKnown() const`
`223`	`224`	`{`
`224`	`225`	`return true;`
`225`	`226`	`}`