abstractpropertywidget.h 3.78 KB
Newer Older
1
2
// ================================================================================================
// 
schultezub's avatar
schultezub committed
3
// This file is part of the CAMPVis Software Framework.
4
// 
5
// If not explicitly stated otherwise: Copyright (C) 2012-2013, all rights reserved,
schultezub's avatar
schultezub committed
6
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
7
//      Chair for Computer Aided Medical Procedures
8
9
//      Technische Universität München
//      Boltzmannstr. 3, 85748 Garching b. München, Germany
10
// 
schultezub's avatar
schultezub committed
11
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
12
// 
13
14
15
16
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file 
// except in compliance with the License. You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0
17
// 
18
19
20
21
// Unless required by applicable law or agreed to in writing, software distributed under the 
// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
// either express or implied. See the License for the specific language governing permissions 
// and limitations under the License.
22
23
24
// 
// ================================================================================================

schultezub's avatar
schultezub committed
25
26
27
28
#ifndef ABSTRACTPROPERTYWIDGET_H__
#define ABSTRACTPROPERTYWIDGET_H__

#include "sigslot/sigslot.h"
schultezub's avatar
schultezub committed
29
#include "tbb/atomic.h"
schultezub's avatar
schultezub committed
30
#include <QBoxLayout>
31
32
#include <QLabel>
#include <QWidget>
schultezub's avatar
schultezub committed
33

schultezub's avatar
schultezub committed
34
namespace campvis {
schultezub's avatar
schultezub committed
35
36
37
38
39
40
41
42
43
44
45
    class AbstractProperty;

    /**
     * Abstract base class for property widgets.
     */
    class AbstractPropertyWidget : public QWidget, public sigslot::has_slots<> {
        Q_OBJECT;

    public:
        /**
         * Creates a new PropertyWidget for the property \a property.
46
47
48
49
50
51
         *
         * If displayBoxed is true, the widget is displayed vertically in a QGroupBox.
         *
         * \param   property        The property the widget shall handle
         * \param   displayBoxed    Should the widget be displayed in a group box?
         * \param   parent          Parent Qt widget
schultezub's avatar
schultezub committed
52
         */
53
        AbstractPropertyWidget(AbstractProperty* property, bool displayBoxed = false, QWidget* parent = 0);
schultezub's avatar
schultezub committed
54
55
56
57
58
59
60
61
62
63
64
65

        /**
         * Destructor
         */
        virtual ~AbstractPropertyWidget();

    protected:
        /**
         * Adds a widget to the local Qt layout.
         */
        void addWidget(QWidget* widget);

66
67
68
69
70
71
        AbstractProperty* _property;    ///< The property this widget handles

        /// Semaphore acts as flag whether the widget shall ignore incoming signals from properties being updated.
        tbb::atomic<int> _ignorePropertyUpdates;

    protected slots:
schultezub's avatar
schultezub committed
72
73
74
75
76
        /**
         * Gets called when the property has changed, so that widget can update its state.
         */
        virtual void updateWidgetFromProperty() = 0;

77
78
79
80
81
82
83
84
85
86
87
    signals:
        /**
         * Internal signal used to update the property widget in a thread-safe way.
         *
         * This class' \ref onPropertyChanged() slot is invoked from non-GUI threads. As a result,
         * \ref updateWidgetFromProperty() couldn't access any Qt widgets safely if it was called from there directly,
         * because it would execute in a non-GUI thread. However, if we invoke \ref updateWidgetFromProperty() via
         * a signal-slot connection with \ref s_propertyChanged(), Qt takes care of queueing slot accesses in the GUI
         * thread for us.
         */
        void s_propertyChanged(const AbstractProperty* property);
schultezub's avatar
schultezub committed
88
89
90
91
92
93

    private:
        /// Slot getting called when the property has changed, so that the widget can be updated.
        virtual void onPropertyChanged(const AbstractProperty* property);

        QBoxLayout* _layout;
94
        QLabel* _titleLabel;
schultezub's avatar
schultezub committed
95
96
97
98
    };
}

#endif // ABSTRACTPROPERTYWIDGET_H__