CColour.hpp

Go to the documentation of this file.

#ifndef __CColour__
#define __CColour__

#include <Basics/CCountedObject.hpp>
using Exponent::Basics::CCountedObject;

//  ===========================================================================

namespace Exponent
{
    namespace GUI
    {
        namespace Basics
        {
            class CColour : public CCountedObject
            {
                EXPONENT_CLASS_DECLARATION;
//  ===========================================================================

            public:

//  ===========================================================================

                const static CColour CCOLOUR_BLACK;         
                const static CColour CCOLOUR_WHITE;         
                const static CColour CCOLOUR_RED;           
                const static CColour CCOLOUR_GREEN;         
                const static CColour CCOLOUR_BLUE;          
                const static CColour CCOLOUR_YELLOW;        
                const static CColour CCOLOUR_ORANGE;        
                const static CColour CCOLOUR_TURQUOISE;     
                const static CColour CCOLOUR_PURPLE;        
                const static CColour CCOLOUR_PINK;          
                const static CColour CCOLOUR_LIGHT_GREY;    
                const static CColour CCOLOUR_DARK_GREY;     
//  ===========================================================================

                CColour(const unsigned long red, const unsigned long green, const unsigned long blue);

                CColour();

                CColour(const CColour &colour);

                #ifdef WIN32

                    CColour(COLORREF &colour);
                #else

                    CColour(const RGBColor &colour);
                #endif

                virtual ~CColour();

//  ===========================================================================

                CColour &operator = (const CColour &colour);

                CColour &operator += (const CColour &colour);

                bool operator == (const CColour &colour);

//  ===========================================================================

                void setRed(const unsigned long red) { m_red = red; }

                void setGreen(const unsigned long green) { m_green = green; }

                void setBlue(const unsigned long blue) { m_blue = blue; }

                virtual void setColour(const unsigned long red, const unsigned long green, const unsigned long blue);

//  ===========================================================================

                unsigned long getRed() const { return m_red; }

                unsigned long getGreen() const { return m_green; }

                unsigned long getBlue() const { return m_blue; }

//  ===========================================================================

                #ifdef WIN32

                    COLORREF getAsColourRef() const;

                    void setFromColourRef(const COLORREF &colour);
                #else

                    RGBColor *getAsRGBColour() const;

                    void setFromRGBColour(const RGBColor &colour);
                #endif

//  ===========================================================================

                virtual void getObjectDescription(char *string, const long size) const;

//  ===========================================================================

            protected:

//  ===========================================================================
            
                #ifndef WIN32

                    static unsigned short toAppleValue(const long value);
                    
                    static long fromAppleValue(const unsigned short appleValue);
                #endif

//  ===========================================================================

                unsigned long m_red;            
                unsigned long m_green;          
                unsigned long m_blue;           
            };
        }
    }
}
#endif  // End of CColour.hpp

---