a structure used to define a picture style More...

#include <WPSGraphicStyle.h>

Classes
struct	GradientStop
	a structure used to define the gradient limit More...
struct	Pattern
	a basic pattern used in a WPSGraphicStyle: More...

Public Types
enum	LineCap { C_Butt , C_Square , C_Round }
	an enum used to define the basic line cap More...
enum	LineJoin { J_Miter , J_Round , J_Bevel }
	an enum used to define the basic line join More...
enum	GradientType { G_None , G_Axial , G_Linear , G_Radial , G_Rectangular , G_Square , G_Ellipsoid }
	an enum used to define the gradient type More...

Public Member Functions
	WPSGraphicStyle ()
	constructor
	WPSGraphicStyle (WPSGraphicStyle const &)=default
	WPSGraphicStyle (WPSGraphicStyle &&)=default
WPSGraphicStyle &	operator= (WPSGraphicStyle &&)=default
WPSGraphicStyle &	operator= (WPSGraphicStyle const &)=default
virtual	~WPSGraphicStyle ()
	virtual destructor
bool	hasLine () const
	returns true if the border is defined
void	setSurfaceColor (WPSColor const &col, float opacity=1)
	set the surface color
bool	hasSurfaceColor () const
	returns true if the surface is defined
void	setPattern (Pattern const &pat)
	set the pattern
bool	hasPattern () const
	returns true if the pattern is defined
bool	hasGradient (bool complex=false) const
	returns true if the gradient is defined
bool	hasSurface () const
	returns true if the interior surface is defined
void	setBackgroundColor (WPSColor const &col, float opacity=1)
	set the background color
bool	hasBackgroundColor () const
	returns true if the background is defined
void	setShadowColor (WPSColor const &col, float opacity=1)
	set the shadow color
bool	hasShadow () const
	returns true if the shadow is defined
bool	hasBorders () const
	return true if the frame has some border
bool	hasSameBorders () const
	return true if the frame has some border
std::vector< WPSBorder > const &	borders () const
	return the frame border: libwps::Left \| ...
void	resetBorders ()
	reset the border
void	setBorders (int wh, WPSBorder const &border)
	sets the cell border: wh=libwps::LeftBit\|...
void	addTo (librevenge::RVNGPropertyList &pList, bool only1d=false) const
	add all the parameters to the propList excepted the frame parameter: the background and the borders
void	addFrameTo (librevenge::RVNGPropertyList &pList) const
	add all the frame parameters to propList: the background and the borders
int	cmp (WPSGraphicStyle const &a) const
	compare two styles

Static Public Member Functions
static WPSGraphicStyle	emptyStyle ()
	returns an empty style.

Public Attributes
float	m_lineWidth
	the linewidth
std::vector< float >	m_lineDashWidth
	the dash array: a sequence of (fullsize, emptysize)
LineCap	m_lineCap
	the line cap
LineJoin	m_lineJoin
	the line join
float	m_lineOpacity
	the line opacity: 0=transparent
WPSColor	m_lineColor
	the line color
bool	m_fillRuleEvenOdd
	true if the fill rule is evenod
WPSColor	m_surfaceColor
	the surface color
float	m_surfaceOpacity
	true if the surface has some color
WPSColor	m_shadowColor
	the shadow color
float	m_shadowOpacity
	true if the shadow has some color
Vec2f	m_shadowOffset
	the shadow offset
Pattern	m_pattern
	the pattern if it exists
GradientType	m_gradientType
	the gradient type
std::vector< GradientStop >	m_gradientStopList
	the list of gradient limits
float	m_gradientAngle
	the gradient angle
float	m_gradientBorder
	the gradient border opacity
Vec2f	m_gradientPercentCenter
	the gradient center
float	m_gradientRadius
	the gradient radius
bool	m_arrows [2]
	two bool to indicated if extremity has arrow or not
WPSColor	m_backgroundColor
	the background color
float	m_backgroundOpacity
	true if the background has some color
std::vector< WPSBorder >	m_bordersList
	the borders WPSBorder::Pos (for a frame)
librevenge::RVNGString	m_frameName
	the frame name
librevenge::RVNGString	m_frameNextName
	the frame next name (if there is a link)
float	m_rotate
	the rotation
bool	m_flip [2]
	two bool to indicated we need to flip the shape or not
std::string	m_extra
	extra data

Friends
std::ostream &	operator<< (std::ostream &o, WPSGraphicStyle const &st)
	a print operator

Detailed Description

a structure used to define a picture style

Note: in order to define the internal surface style, first it looks for a gradient, if so it uses it. Then it looks for a pattern. Finally if it found nothing, it uses surfaceColor and surfaceOpacity.

Member Enumeration Documentation

◆ GradientType

enum WPSGraphicStyle::GradientType

an enum used to define the gradient type

Enumerator
G_None
G_Axial
G_Linear
G_Radial
G_Rectangular
G_Square
G_Ellipsoid

◆ LineCap

enum WPSGraphicStyle::LineCap

an enum used to define the basic line cap

Enumerator
C_Butt
C_Square
C_Round

◆ LineJoin

enum WPSGraphicStyle::LineJoin

an enum used to define the basic line join

Enumerator
J_Miter
J_Round
J_Bevel

Constructor & Destructor Documentation

◆ WPSGraphicStyle() [1/3]

WPSGraphicStyle::WPSGraphicStyle ( )

inline

constructor

Referenced by cmp(), emptyStyle(), operator<<, operator=(), operator=(), WPSGraphicStyle(), and WPSGraphicStyle().

◆ WPSGraphicStyle() [2/3]

WPSGraphicStyle::WPSGraphicStyle ( WPSGraphicStyle const & )

default

◆ WPSGraphicStyle() [3/3]

WPSGraphicStyle::WPSGraphicStyle ( WPSGraphicStyle && )

default

◆ ~WPSGraphicStyle()

WPSGraphicStyle::~WPSGraphicStyle ( )

virtual

virtual destructor

Member Function Documentation

◆ addFrameTo()

void WPSGraphicStyle::addFrameTo ( librevenge::RVNGPropertyList & pList ) const

add all the frame parameters to propList: the background and the borders

Referenced by WKSContentListener::_openFrame().

◆ addTo()

void WPSGraphicStyle::addTo	(	librevenge::RVNGPropertyList &	pList,
		bool	only1d = false ) const

add all the parameters to the propList excepted the frame parameter: the background and the borders

Referenced by WKSContentListener::insertPicture().

◆ borders()

std::vector< WPSBorder > const & WPSGraphicStyle::borders ( ) const

inline

return the frame border: libwps::Left | ...

◆ cmp()

int WPSGraphicStyle::cmp ( WPSGraphicStyle const & a ) const

compare two styles

◆ emptyStyle()

WPSGraphicStyle WPSGraphicStyle::emptyStyle ( )

inlinestatic

returns an empty style.

Can be used to initialize a default frame style...

Referenced by Quattro9Graph::readShape(), Quattro9Graph::readTextboxStyle(), and LotusChart::sendCharts().

◆ hasBackgroundColor()

bool WPSGraphicStyle::hasBackgroundColor ( ) const

inline

returns true if the background is defined

◆ hasBorders()

bool WPSGraphicStyle::hasBorders ( ) const

inline

return true if the frame has some border

Referenced by addFrameTo(), and operator<<.

◆ hasGradient()

bool WPSGraphicStyle::hasGradient ( bool complex = false ) const

inline

returns true if the gradient is defined

Referenced by addTo(), hasSurface(), operator<<, and LotusStyleManager::updateSurfaceStyle().

◆ hasLine()

bool WPSGraphicStyle::hasLine ( ) const

inline

returns true if the border is defined

Referenced by addTo().

◆ hasPattern()

bool WPSGraphicStyle::hasPattern ( ) const

inline

returns true if the pattern is defined

Referenced by addTo(), hasSurface(), operator<<, and LotusStyleManager::updateSurfaceStyle().

◆ hasSameBorders()

bool WPSGraphicStyle::hasSameBorders ( ) const

inline

return true if the frame has some border

Referenced by addFrameTo().

◆ hasShadow()

bool WPSGraphicStyle::hasShadow ( ) const

inline

returns true if the shadow is defined

Referenced by addFrameTo(), addTo(), and operator<<.

◆ hasSurface()

bool WPSGraphicStyle::hasSurface ( ) const

inline

returns true if the interior surface is defined

Referenced by addTo(), and WKSContentListener::insertPicture().

◆ hasSurfaceColor()

bool WPSGraphicStyle::hasSurfaceColor ( ) const

inline

returns true if the surface is defined

Referenced by hasSurface(), and operator<<.

◆ operator=() [1/2]

WPSGraphicStyle & WPSGraphicStyle::operator= ( WPSGraphicStyle && )

default

◆ operator=() [2/2]

WPSGraphicStyle & WPSGraphicStyle::operator= ( WPSGraphicStyle const & )

default

◆ resetBorders()

void WPSGraphicStyle::resetBorders ( )

inline

reset the border

◆ setBackgroundColor()

void WPSGraphicStyle::setBackgroundColor	(	WPSColor const &	col,
		float	opacity = 1 )

inline

set the background color

Referenced by Quattro9Graph::readTextboxStyle(), and QuattroGraph::sendGraphic().

◆ setBorders()

void WPSGraphicStyle::setBorders	(	int	wh,
		WPSBorder const &	border )

sets the cell border: wh=libwps::LeftBit|...

◆ setPattern()

void WPSGraphicStyle::setPattern ( Pattern const & pat )

inline

set the pattern

Referenced by LotusChart::readFramesStyle(), Quattro9Graph::readShapeRec(), and LotusStyleManager::updateSurfaceStyle().

◆ setShadowColor()

void WPSGraphicStyle::setShadowColor	(	WPSColor const &	col,
		float	opacity = 1 )

inline

set the shadow color

Referenced by LotusStyleManager::updateShadowStyle().

◆ setSurfaceColor()

void WPSGraphicStyle::setSurfaceColor	(	WPSColor const &	col,
		float	opacity = 1 )

inline

set the surface color

Referenced by LotusChart::readFramesStyle(), Quattro9Graph::readShapeRec(), LotusStyleManager::updateSurfaceStyle(), and LotusStyleManager::updateSurfaceStyle().

◆ operator<<

std::ostream & operator<<	(	std::ostream &	o,
		WPSGraphicStyle const &	st )

friend

a print operator

Member Data Documentation

◆ m_arrows

bool WPSGraphicStyle::m_arrows[2]

two bool to indicated if extremity has arrow or not

Referenced by addTo(), cmp(), operator<<, LotusGraph::readGraphic(), Quattro9Graph::readShapeRec(), LotusGraph::sendGraphics(), LotusGraph::sendZone(), and WPSGraphicStyle().

◆ m_backgroundColor

WPSColor WPSGraphicStyle::m_backgroundColor

the background color

Referenced by addFrameTo(), cmp(), operator<<, setBackgroundColor(), and WPSGraphicStyle().

◆ m_backgroundOpacity

float WPSGraphicStyle::m_backgroundOpacity

true if the background has some color

Referenced by addFrameTo(), cmp(), hasBackgroundColor(), operator<<, setBackgroundColor(), and WPSGraphicStyle().

◆ m_bordersList

std::vector<WPSBorder> WPSGraphicStyle::m_bordersList

the borders WPSBorder::Pos (for a frame)

Referenced by addFrameTo(), borders(), cmp(), hasBorders(), hasSameBorders(), operator<<, resetBorders(), setBorders(), and WPSGraphicStyle().

◆ m_extra

std::string WPSGraphicStyle::m_extra

extra data

Referenced by operator<<, and WPSGraphicStyle().

◆ m_fillRuleEvenOdd

bool WPSGraphicStyle::m_fillRuleEvenOdd

true if the fill rule is evenod

Referenced by addTo(), cmp(), operator<<, and WPSGraphicStyle().

◆ m_flip

bool WPSGraphicStyle::m_flip[2]

two bool to indicated we need to flip the shape or not

Referenced by cmp(), operator<<, and WPSGraphicStyle().

◆ m_frameName

librevenge::RVNGString WPSGraphicStyle::m_frameName

the frame name

Referenced by addFrameTo(), cmp(), WKSContentListener::insertChart(), operator<<, and WPSGraphicStyle().

◆ m_frameNextName

librevenge::RVNGString WPSGraphicStyle::m_frameNextName

the frame next name (if there is a link)

Referenced by cmp(), operator<<, and WPSGraphicStyle().

◆ m_gradientAngle

float WPSGraphicStyle::m_gradientAngle

the gradient angle

Referenced by addTo(), cmp(), operator<<, Quattro9Graph::readShapeRec(), LotusStyleManager::updateSurfaceStyle(), and WPSGraphicStyle().

◆ m_gradientBorder

float WPSGraphicStyle::m_gradientBorder

the gradient border opacity

Referenced by addTo(), cmp(), operator<<, and WPSGraphicStyle().

◆ m_gradientPercentCenter

Vec2f WPSGraphicStyle::m_gradientPercentCenter

the gradient center

Referenced by addTo(), cmp(), operator<<, Quattro9Graph::readShapeRec(), and WPSGraphicStyle().

◆ m_gradientRadius

float WPSGraphicStyle::m_gradientRadius

the gradient radius

Referenced by addTo(), cmp(), operator<<, and WPSGraphicStyle().

◆ m_gradientStopList

std::vector<GradientStop> WPSGraphicStyle::m_gradientStopList

the list of gradient limits

Referenced by addTo(), cmp(), hasGradient(), operator<<, Quattro9Graph::readShapeRec(), LotusStyleManager::updateSurfaceStyle(), LotusStyleManager::updateSurfaceStyle(), and WPSGraphicStyle().

◆ m_gradientType

GradientType WPSGraphicStyle::m_gradientType

the gradient type

Referenced by addTo(), cmp(), hasGradient(), operator<<, Quattro9Graph::readShapeRec(), LotusStyleManager::updateSurfaceStyle(), LotusStyleManager::updateSurfaceStyle(), and WPSGraphicStyle().

◆ m_lineCap

LineCap WPSGraphicStyle::m_lineCap

the line cap

Referenced by addTo(), cmp(), operator<<, and WPSGraphicStyle().

◆ m_lineColor

WPSColor WPSGraphicStyle::m_lineColor

the line color

Referenced by addTo(), cmp(), operator<<, LotusChart::readFramesStyle(), LotusGraph::readGraphic(), Quattro9Graph::readShapeRec(), LotusStyleManager::updateGraphicStyle(), LotusStyleManager::updateLineStyle(), and WPSGraphicStyle().

◆ m_lineDashWidth

std::vector<float> WPSGraphicStyle::m_lineDashWidth

the dash array: a sequence of (fullsize, emptysize)

Referenced by addTo(), cmp(), operator<<, LotusGraph::readGraphic(), Quattro9Graph::readShapeRec(), and WPSGraphicStyle().

◆ m_lineJoin

LineJoin WPSGraphicStyle::m_lineJoin

the line join

Referenced by addTo(), cmp(), operator<<, Quattro9Graph::readShapeRec(), and WPSGraphicStyle().

◆ m_lineOpacity

float WPSGraphicStyle::m_lineOpacity

the line opacity: 0=transparent

Referenced by addTo(), cmp(), hasLine(), operator<<, and WPSGraphicStyle().

◆ m_lineWidth

float WPSGraphicStyle::m_lineWidth

the linewidth

Referenced by addTo(), cmp(), emptyStyle(), hasLine(), operator<<, LotusChart::readFramesStyle(), LotusGraph::readGraphic(), Quattro9Graph::readShapeRec(), Quattro9Graph::readTextboxStyle(), LotusStyleManager::updateGraphicStyle(), LotusStyleManager::updateLineStyle(), and WPSGraphicStyle().

◆ m_pattern

Pattern WPSGraphicStyle::m_pattern

the pattern if it exists

Referenced by addTo(), cmp(), hasPattern(), operator<<, setPattern(), LotusStyleManager::updateSurfaceStyle(), and WPSGraphicStyle().

◆ m_rotate

float WPSGraphicStyle::m_rotate

the rotation

Referenced by cmp(), operator<<, and WPSGraphicStyle().

◆ m_shadowColor

WPSColor WPSGraphicStyle::m_shadowColor

the shadow color

Referenced by addFrameTo(), addTo(), cmp(), operator<<, setShadowColor(), and WPSGraphicStyle().

◆ m_shadowOffset

Vec2f WPSGraphicStyle::m_shadowOffset

the shadow offset

Referenced by addFrameTo(), addTo(), cmp(), operator<<, LotusStyleManager::updateShadowStyle(), and WPSGraphicStyle().

◆ m_shadowOpacity

float WPSGraphicStyle::m_shadowOpacity

true if the shadow has some color

Referenced by addFrameTo(), addTo(), cmp(), hasShadow(), operator<<, setShadowColor(), and WPSGraphicStyle().

◆ m_surfaceColor

WPSColor WPSGraphicStyle::m_surfaceColor

the surface color

Referenced by addTo(), cmp(), operator<<, setSurfaceColor(), and WPSGraphicStyle().

◆ m_surfaceOpacity

float WPSGraphicStyle::m_surfaceOpacity

true if the surface has some color

Referenced by addTo(), cmp(), hasSurfaceColor(), operator<<, setSurfaceColor(), and WPSGraphicStyle().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ GradientType

◆ LineCap

◆ LineJoin

Constructor & Destructor Documentation

◆ WPSGraphicStyle() [1/3]

◆ WPSGraphicStyle() [2/3]

◆ WPSGraphicStyle() [3/3]

◆ ~WPSGraphicStyle()

Member Function Documentation

◆ addFrameTo()

◆ addTo()

◆ borders()

◆ cmp()

◆ emptyStyle()

◆ hasBackgroundColor()

◆ hasBorders()

◆ hasGradient()

◆ hasLine()

◆ hasPattern()

◆ hasSameBorders()

◆ hasShadow()

◆ hasSurface()

◆ hasSurfaceColor()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ resetBorders()

◆ setBackgroundColor()

◆ setBorders()

◆ setPattern()

◆ setShadowColor()

◆ setSurfaceColor()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ m_arrows

◆ m_backgroundColor

◆ m_backgroundOpacity

◆ m_bordersList

◆ m_extra

◆ m_fillRuleEvenOdd

◆ m_flip

◆ m_frameName

◆ m_frameNextName

◆ m_gradientAngle

◆ m_gradientBorder

◆ m_gradientPercentCenter

◆ m_gradientRadius

◆ m_gradientStopList

◆ m_gradientType

◆ m_lineCap

◆ m_lineColor

◆ m_lineDashWidth

◆ m_lineJoin

◆ m_lineOpacity

◆ m_lineWidth

◆ m_pattern

◆ m_rotate

◆ m_shadowColor

◆ m_shadowOffset

◆ m_shadowOpacity

◆ m_surfaceColor

◆ m_surfaceOpacity