QGCMapPalette.h 1.95 KB
Newer Older
1 2
/****************************************************************************
 *
Gus Grubba's avatar
Gus Grubba committed
3
 * (c) 2009-2020 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
4 5 6 7 8 9
 *
 * QGroundControl is licensed according to the terms in the file
 * COPYING.md in the root of the source code directory.
 *
 ****************************************************************************/

Don Gagne's avatar
Don Gagne committed
10 11 12 13 14 15 16

#ifndef QGCMapPalette_h
#define QGCMapPalette_h

#include <QObject>
#include <QColor>

Don Gagne's avatar
Don Gagne committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
/*!
 QGCMapPalette is a variant of QGCPalette which is used to hold colors used for display over
 the map control. Since the coloring of a satellite map differs greatly from the coloring of
 a street map you need to be able to switch between sets of color based on map type.

 Usage:

        import QGroundControl.Palette 1.0

        FlightMap {
            id:             map
            anchors.fill:   parent

            QGCMapPalette { id: mapPal: lightColors: map.isSatelliteMap }

            QGCLabel {
                text:   "Text over map"
                color:  mapPal.text
            }
        }
**/

Don Gagne's avatar
Don Gagne committed
39 40 41 42 43 44
class QGCMapPalette : public QObject
{
    Q_OBJECT
    
    Q_PROPERTY(bool lightColors READ lightColors WRITE setLightColors NOTIFY paletteChanged)

Don Gagne's avatar
Don Gagne committed
45
    Q_PROPERTY(QColor text          READ text          NOTIFY paletteChanged)
46
    Q_PROPERTY(QColor textOutline   READ textOutline   NOTIFY paletteChanged)
Don Gagne's avatar
Don Gagne committed
47 48

public:    
49
    QGCMapPalette(QObject* parent = nullptr);
Don Gagne's avatar
Don Gagne committed
50
    
Don Gagne's avatar
Don Gagne committed
51
    /// Text color
Don Gagne's avatar
Don Gagne committed
52
    QColor text(void)           const { return _text[_lightColors ? 0 : 1]; }
53
    QColor textOutline(void)    const { return _textOutline[_lightColors ? 0 : 1]; }
Don Gagne's avatar
Don Gagne committed
54 55 56 57

    bool lightColors(void) const { return _lightColors; }
    void setLightColors(bool lightColors);    

Don Gagne's avatar
Don Gagne committed
58 59
signals:
    void paletteChanged(void);
Don Gagne's avatar
Don Gagne committed
60
    void lightColorsChanged(bool lightColors);
Don Gagne's avatar
Don Gagne committed
61 62
    
private:
63
    bool _lightColors = false;
Don Gagne's avatar
Don Gagne committed
64 65 66

    static const int _cColorGroups = 2;

Don Gagne's avatar
Don Gagne committed
67
    static QColor _text[_cColorGroups];
68
    static QColor _textOutline[_cColorGroups];
Don Gagne's avatar
Don Gagne committed
69 70 71
};

#endif