WPSColor Struct Reference

the class to store a color More...

#include <libwps_internal.h>

Public Member Functions

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

Static Public Member Functions

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

Protected Attributes

uint32_t m_value
 the argb color
 

Friends

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

Detailed Description

the class to store a color

Constructor & Destructor Documentation

◆ WPSColor() [1/4]

WPSColor::WPSColor ( uint32_t  argb = 0)
inlineexplicit

constructor

◆ WPSColor() [2/4]

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

constructor from color

◆ WPSColor() [3/4]

WPSColor::WPSColor ( WPSColor const &  )
default

copy constructor

◆ WPSColor() [4/4]

WPSColor::WPSColor ( WPSColor &&  )
default

move assignement

Member Function Documentation

◆ barycenter()

◆ 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()

◆ isWhite()

◆ operator!=()

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

operator!=

◆ operator<()

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

operator<

Referenced by operator>=().

◆ operator<=()

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

operator<=

Referenced by operator>().

◆ operator=() [1/3]

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

operator=

◆ operator=() [2/3]

WPSColor & WPSColor::operator= ( WPSColor &&  )
default

move operator=

◆ operator=() [3/3]

WPSColor & WPSColor::operator= ( WPSColor const &  )
default

operator=

◆ operator==()

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

operator==

Referenced by 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

◆ value()

uint32_t WPSColor::value ( ) const
inline

return the rgba value

◆ white()

Friends And Related Symbol 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 documentation for this struct was generated from the following files:

Generated on Thu Jul 27 2023 11:31:48 for libwps by doxygen 1.9.7