summaryrefslogtreecommitdiff
path: root/src/gui/colour.h
blob: 1648e1e8856ebaf67868e6a84fd6f39e3db08ad5 (plain) (blame)
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
125
126
127
128
129
130
/***************************************************************************
 *   Copyright (C) 2008 by Douglas Boffey                                  *
 *                                                                         *
 *       DougABoffey@netscape.net                                          *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed with The Mana Experiment                  *
 *   in the hope that it will be useful,                                   *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef _COLOUR_H
#define _COLOUR_H

#include <string>
#include <vector>

#include <guichan/listmodel.hpp>

class Colour : public gcn::ListModel
{
    public:
        /**
         * Constructor
         */
        Colour();

        /**
         * Destructor
         */
        ~Colour();

        /**
         * Define the colour replacement for a character
         *
         * @param c charater to be replaced
         * @param rgb colour to replace character
         */
        void setColour(const char c, const int rgb);

        /**
         * Define the colour replacement for a character
         *
         * @param c character to be replaced
         * @param r red component
         * @param g green component
         * @param b blue component
         */
        void setColour(const char c, const int r, const int g, const int b)
        {
            setColour(c, (r << 16) | (g << 8) | b);
        }

        /**
         * Return the colour associated with a character, if exists
         *
         * @param c character requested
         * @param valid indicate whether character is known
         */
        int getColour(const char c, bool &valid) const;

        /**
         * Return the number of colours known
         */
        int getNumberOfElements() {return mColVector.size(); }

        /**
         * Return the name of the ith colour
         *
         * @param i index of colour interested in
         */
        std::string getElementAt(int i);

        /**
         * Get the colour for the element at index i in the current colour
         * model
         */
        int getColourAt(int i);

        /**
         * Set the colour for the element at index i
         */
        void setColourAt(int i, int rgb);

        /**
         * Commit the colours
         */
        void commit();

        /**
         * Rollback the colours
         */
        void rollback();

    private:
        struct ColourElem
        {
            ColourElem(const char c, const int rgb, const std::string &text) :
                ch(c), rgb(rgb), text(text) {}
            char ch;
            int rgb;
            int committedRgb;
            std::string text;
        };
        typedef std::vector<ColourElem> ColVector;
        ColVector mColVector;

        /**
         * Initialise colour
         *
         * @param c character that needs initialising
         * @param rgb default colour if not found in config
         * @param text identifier of colour
         */
        void addColour(const char c, const int rgb, const std::string &text);
};

extern Colour *textColour;

#endif