summaryrefslogtreecommitdiffstats
path: root/src/Authoring/Studio/Controls/ButtonControl.h
blob: 4baf71dc3b0274902fd244545fb988663664f615 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/****************************************************************************
**
** Copyright (C) 2002 NVIDIA Corporation.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

//==============================================================================
//	Prefix
//==============================================================================
#ifndef INCLUDED_BUTTON_CONTROL_H
#define INCLUDED_BUTTON_CONTROL_H 1

//==============================================================================
//	Includes
//==============================================================================
#include "Control.h"
#include "Multicaster.h"

#include <QPixmap>

#include <boost/signals.hpp>

//==============================================================================
//	Forwards
//==============================================================================

//=============================================================================
/**
 * Base class for creating button controls.
 */
class CButtonControl : public CControl
{
public:
    /// States for procedural buttons that might result in drawing changes
    enum EButtonState {
        EBUTTONSTATE_UP, ///< Indicates that the button is currently in the up position
        EBUTTONSTATE_DOWN, ///< Indicates that the button is currently in the up position
        EBUTTONSTATE_INDETERMINATE ///< Not used yet; provided for sub-classes to implement a
                                   ///tri-state functionality
    };

protected:
    EButtonState m_State; ///< Specifies what state the button is currently in; state changes as the
                          ///button is clicked on
    QPixmap m_ImageUp; ///< The image for the button in its normal state
    QPixmap m_ImageDown; ///< The image for the button while it is being clicked
    QPixmap m_ImageOver; ///< The image for the button while the mouse is over
    QPixmap m_ImageUpDisabled; ///< The image for the button when it is disabled and unavailable
                                  ///to the user
    QPixmap m_ImageDownDisabled; ///< The image for the button when it is disabled and unavailable
                                    ///to the user
    bool m_AutoSize; ///< true if the button will automatically resize itself
    bool m_MouseEnter; ///< Flag for determining mouse enter/exit status so that the number of
                       ///invalidations is minimized.  See OnMouseOver and OnMouseOut.
    bool m_IsMouseDown;
    bool m_VCenterImage;
    bool m_HCenterImage;
    long m_Margin;

public:
    CButtonControl();
    virtual ~CButtonControl();

    EButtonState GetButtonState() const;
    virtual void SetButtonState(EButtonState inState);

    void SetUpImage(const QPixmap &inImage);
    void SetUpImage(const QString &inImageName);
    void SetDownImage(const QPixmap &inImage);
    void SetDownImage(const QString &inImageName);
    void SetOverImage(const QPixmap &inImage);
    void SetOverImage(const QString &inImageName);
    void SetDisabledImage(const QPixmap &inImage);
    void SetDisabledImage(const QString &inImageName);
    void SetUpDisabledImage(const QString &inImageName);
    QSize GetImageSize() const;

    void SetAutoSize(bool inEnableAutoSize);
    bool GetAutoSize();

    void SetCenterImage(bool inVCenter, bool inHCenter);
    void SetMarginImage(long inMargin);

    void Draw(CRenderer *inRenderer) override;
    bool OnMouseDown(CPt inPoint, Qt::KeyboardModifiers inFlags) override;
    void OnMouseUp(CPt inPoint, Qt::KeyboardModifiers inFlags) override;
    void OnMouseOver(CPt inPoint, Qt::KeyboardModifiers inFlags) override;
    void OnMouseOut(CPt inPoint, Qt::KeyboardModifiers inFlags) override;
    void Invalidate(bool inIsInvalidated = true)  override;

    boost::signal1<void, CControl *> SigButtonDown;
    boost::signal1<void, CControl *> SigButtonUp;
    boost::signal1<void, CControl *> SigClicked;

protected:
    virtual void Render(CRenderer *inRenderer);
    virtual QPixmap GetCurrentImage() const;
    virtual void Resize();
};

#endif // INCLUDED_BUTTON_CONTROL_H