WPSColor Struct Reference

the class to store a color More...

#include <libwps_internal.h>

Public Member Functions

 WPSColor (uint32_t argb=0)
 constructor More...
 
 WPSColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a=255)
 constructor from color More...
 
WPSColoroperator= (uint32_t argb)
 operator= More...
 
uint32_t value () const
 return the rgba value More...
 
unsigned char getAlpha () const
 returns the alpha value More...
 
unsigned char getBlue () const
 returns the green value More...
 
unsigned char getRed () const
 returns the red value More...
 
unsigned char getGreen () const
 returns the green value More...
 
bool isBlack () const
 return true if the color is black More...
 
bool isWhite () const
 return true if the color is white More...
 
bool operator== (WPSColor const &c) const
 operator== More...
 
bool operator!= (WPSColor const &c) const
 operator!= More...
 
bool operator< (WPSColor const &c) const
 operator< More...
 
bool operator<= (WPSColor const &c) const
 operator<= More...
 
bool operator> (WPSColor const &c) const
 operator> More...
 
bool operator>= (WPSColor const &c) const
 operator>= More...
 
std::string str () const
 print the color in the form #rrggbb More...
 

Static Public Member Functions

static WPSColor black ()
 return the back color More...
 
static WPSColor white ()
 return the white color More...
 
static WPSColor barycenter (float alpha, WPSColor const &colA, float beta, WPSColor const &colB)
 return alpha*colA+beta*colB More...
 

Protected Attributes

uint32_t m_value
 the argb color More...
 

Friends

std::ostream & operator<< (std::ostream &o, WPSColor const &c)
 operator<< in the form #rrggbb More...
 

Detailed Description

the class to store a color

Constructor & Destructor Documentation

◆ WPSColor() [1/2]

WPSColor::WPSColor ( uint32_t  argb = 0)
inlineexplicit

constructor

◆ WPSColor() [2/2]

WPSColor::WPSColor ( unsigned char  r,
unsigned char  g,
unsigned char  b,
unsigned char  a = 255 
)
inline

constructor from color

Member Function Documentation

◆ barycenter()

WPSColor WPSColor::barycenter ( float  alpha,
WPSColor const &  colA,
float  beta,
WPSColor const &  colB 
)
static

◆ black()

◆ getAlpha()

unsigned char WPSColor::getAlpha ( ) const
inline

returns the alpha value

◆ getBlue()

unsigned char WPSColor::getBlue ( ) const
inline

returns the green value

Referenced by DosWordParser::readPAP().

◆ getGreen()

unsigned char WPSColor::getGreen ( ) const
inline

returns the green value

Referenced by DosWordParser::readPAP().

◆ getRed()

unsigned char WPSColor::getRed ( ) const
inline

returns the red value

Referenced by DosWordParser::readPAP().

◆ isBlack()

bool WPSColor::isBlack ( ) const
inline

◆ isWhite()

◆ operator!=()

bool WPSColor::operator!= ( WPSColor const &  c) const
inline

operator!=

◆ operator<()

bool WPSColor::operator< ( WPSColor const &  c) const
inline

operator<

◆ operator<=()

bool WPSColor::operator<= ( WPSColor const &  c) const
inline

operator<=

◆ operator=()

WPSColor& WPSColor::operator= ( uint32_t  argb)
inline

operator=

◆ operator==()

bool WPSColor::operator== ( WPSColor const &  c) const
inline

operator==

◆ operator>()

bool WPSColor::operator> ( WPSColor const &  c) const
inline

operator>

◆ operator>=()

bool WPSColor::operator>= ( WPSColor const &  c) const
inline

operator>=

◆ str()

std::string WPSColor::str ( ) const

print the color in the form #rrggbb

Referenced by WPSGraphicStyle::addFrameTo(), WPSFont::addTo(), and WPSGraphicStyle::addTo().

◆ value()

uint32_t WPSColor::value ( ) const
inline

return the rgba value

Referenced by WPSGraphicStyle::Pattern::getBinary().

◆ white()

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  o,
WPSColor const &  c 
)
friend

operator<< in the form #rrggbb

Member Data Documentation

◆ m_value

uint32_t WPSColor::m_value
protected

the argb color

Referenced by barycenter(), operator<(), operator<<(), operator<=(), and operator==().


The documentation for this struct was generated from the following files:

Generated on Tue Oct 31 2017 04:26:20 for libwps by doxygen 1.8.13