Developer Documentation
PropertyModel.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 
43 
44 #pragma once
45 
46 #include "Utils.hh"
47 #include <QAbstractListModel>
48 
49 class QMouseEvent;
50 class PropertyVisualizer;
51 
52 class PropertyModel: public QAbstractListModel
53 {
54  Q_OBJECT
55 
56 public:
57  virtual void pickModeChanged(const std::string& _mode) {}
58  virtual void mouseEvent(QMouseEvent* _event) {}
59 
60  explicit PropertyModel(QObject *parent = 0) : QAbstractListModel(parent) {}
61  virtual ~PropertyModel() {}
62 
63  virtual int rowCount(const QModelIndex & parent = QModelIndex()) const = 0;
64  virtual QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const = 0;
65  virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const = 0;
66 
68  virtual void objectUpdated() = 0;
69 
71  virtual void visualize(QModelIndexList selectedIndices, QWidgetList widgets = QWidgetList()) = 0;
72 
74  virtual void removeProperty(QModelIndexList selectedIndices) = 0;
75 
77  virtual void duplicateProperty(QModelIndexList selectedIndices) = 0;
78 
80  virtual void gatherProperties() = 0;
81 
83  virtual void clear(QModelIndexList selectedIndices) = 0;
84 
86  virtual void hideWidget() = 0;
87 
89  virtual QWidget* getWidget() = 0;
90 
92  virtual void updateWidget(const QModelIndexList& selectedIndices) = 0;
93 
95  virtual void connectLogs(PropertyVisualizer* propViz) = 0;
96 
98  virtual PropertyInfo getPropertyInfo(const QModelIndex index) const = 0;
99 
101  QModelIndex indexFromFancyPropName(const QString& propName) const;
102 
104  QModelIndex indexFromPlainPropName(const QString& propName) const;
105 };
106 
107 
virtual void clear(QModelIndexList selectedIndices)=0
Clears the selected property visualization.
virtual void duplicateProperty(QModelIndexList selectedIndices)=0
Duplicates the selected properties.
virtual void connectLogs(PropertyVisualizer *propViz)=0
Connects the PropertyVisualizer log signals with the log slot.
virtual void updateWidget(const QModelIndexList &selectedIndices)=0
Updates the widget.
virtual void visualize(QModelIndexList selectedIndices, QWidgetList widgets=QWidgetList())=0
Visualizes the selected properties.
virtual QWidget * getWidget()=0
Returns the widget.
QModelIndex indexFromPlainPropName(const QString &propName) const
Returns the index of the property with the given name.
This class vizualizes a property.
virtual PropertyInfo getPropertyInfo(const QModelIndex index) const =0
Returns the property info for the property with the given index.
virtual void hideWidget()=0
Hides the widget.
virtual void objectUpdated()=0
Revisualizes visualized properties.
Cellection of information about a property.
Definition: Utils.hh:109
QModelIndex indexFromFancyPropName(const QString &propName) const
Returns the index of the property with the given name.
virtual void gatherProperties()=0
Searches for properties and creates PropertyVisualizers.
virtual void removeProperty(QModelIndexList selectedIndices)=0
Removes the selected properties.