XLColor.hpp

Go to the documentation of this file.

#ifndef OPENXLSX_XLCOLOR_HPP
#define OPENXLSX_XLCOLOR_HPP
 
#ifdef _MSC_VER    // conditionally enable MSVC specific pragmas to avoid other compilers warning about unknown pragmas
#    pragma warning(push)
#    pragma warning(disable : 4251)
#    pragma warning(disable : 4275)
#endif    // _MSC_VER
 
// ===== External Includes ===== //
#include <cstdint>    // Pull request #276
#include <string>
 
// ===== OpenXLSX Includes ===== //
#include "OpenXLSX-Exports.hpp"
 
namespace OpenXLSX
{
    class OPENXLSX_EXPORT XLColor
    {
        friend bool operator==(const XLColor& lhs, const XLColor& rhs);
        friend bool operator!=(const XLColor& lhs, const XLColor& rhs);
 
    public:
        XLColor();
 
        XLColor(uint8_t alpha, uint8_t red, uint8_t green, uint8_t blue);
 
        XLColor(uint8_t red, uint8_t green, uint8_t blue);
 
        explicit XLColor(std::string_view hexCode);
 
        XLColor(const XLColor& other);
 
        XLColor(XLColor&& other) noexcept;
 
        ~XLColor();
 
        XLColor& operator=(const XLColor& other);
 
        XLColor& operator=(XLColor&& other) noexcept;
 
        void set(uint8_t alpha, uint8_t red, uint8_t green, uint8_t blue);
 
        void set(uint8_t red = 0, uint8_t green = 0, uint8_t blue = 0);
 
        void set(std::string_view hexCode);
 
        [[nodiscard]] uint8_t alpha() const;
 
        [[nodiscard]] uint8_t red() const;
 
        [[nodiscard]] uint8_t green() const;
 
        [[nodiscard]] uint8_t blue() const;
 
        [[nodiscard]] std::string hex() const;
 
    private:
        uint8_t m_alpha{255};
 
        uint8_t m_red{0};
 
        uint8_t m_green{0};
 
        uint8_t m_blue{0};
    };
 
}    // namespace OpenXLSX
 
namespace OpenXLSX
{
    inline bool operator==(const XLColor& lhs, const XLColor& rhs)
    { return lhs.alpha() == rhs.alpha() and lhs.red() == rhs.red() and lhs.green() == rhs.green() and lhs.blue() == rhs.blue(); }
 
    inline bool operator!=(const XLColor& lhs, const XLColor& rhs) { return !(lhs == rhs); }
 
}    // namespace OpenXLSX
 
#ifdef _MSC_VER    // conditionally enable MSVC specific pragmas to avoid other compilers warning about unknown pragmas
#    pragma warning(pop)
#endif    // _MSC_VER
 
#endif    // OPENXLSX_XLCOLOR_HPP