WPSGraphicStyle Class Reference

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

#include <WPSGraphicStyle.h>

List of all members.

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
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< GradientStopm_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< WPSBorderm_bordersList
 the borders WPSBorder::Pos (for a frame)
std::string m_frameName
 the frame name
std::string 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

an enum used to define the gradient type

Enumerator:
G_None 
G_Axial 
G_Linear 
G_Radial 
G_Rectangular 
G_Square 
G_Ellipsoid 

an enum used to define the basic line cap

Enumerator:
C_Butt 
C_Square 
C_Round 

an enum used to define the basic line join

Enumerator:
J_Miter 
J_Round 
J_Bevel 

Constructor & Destructor Documentation

constructor

virtual WPSGraphicStyle::~WPSGraphicStyle ( ) [inline, virtual]

virtual destructor


Member Function Documentation

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

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

Referenced by WKSContentListener::_openFrame().

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

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

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

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

compare two styles

static WPSGraphicStyle WPSGraphicStyle::emptyStyle ( ) [inline, static]

returns an empty style.

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

bool WPSGraphicStyle::hasBackgroundColor ( ) const [inline]

returns true if the background is defined

bool WPSGraphicStyle::hasBorders ( ) const [inline]

return true if the frame has some border

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

bool WPSGraphicStyle::hasGradient ( bool  complex = false) const [inline]

returns true if the gradient is defined

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

bool WPSGraphicStyle::hasLine ( ) const [inline]

returns true if the border is defined

Referenced by addTo().

bool WPSGraphicStyle::hasPattern ( ) const [inline]

returns true if the pattern is defined

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

bool WPSGraphicStyle::hasSameBorders ( ) const [inline]

return true if the frame has some border

Referenced by addFrameTo().

bool WPSGraphicStyle::hasShadow ( ) const [inline]

returns true if the shadow is defined

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

bool WPSGraphicStyle::hasSurface ( ) const [inline]

returns true if the interior surface is defined

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

bool WPSGraphicStyle::hasSurfaceColor ( ) const [inline]

returns true if the surface is defined

Referenced by hasSurface(), and operator<<().

void WPSGraphicStyle::resetBorders ( ) [inline]

reset the border

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

set the background color

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

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

void WPSGraphicStyle::setPattern ( Pattern const &  pat) [inline]

set the pattern

Referenced by LotusStyleManager::updateSurfaceStyle().

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

set the shadow color

Referenced by LotusStyleManager::updateShadowStyle().

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

set the surface color

Referenced by LotusStyleManager::updateSurfaceStyle().


Friends And Related Function Documentation

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

a print operator


Member Data Documentation

two bool to indicated if extremity has arrow or not

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

true if the background has some color

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

extra data

Referenced by operator<<().

true if the fill rule is evenod

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

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

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

the frame name

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

the frame next name (if there is a link)

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

the gradient angle

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

the gradient border opacity

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

the gradient center

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

the gradient radius

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

the line cap

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

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

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

the line join

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

the line opacity: 0=transparent

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

the pattern if it exists

Referenced by addTo(), cmp(), hasPattern(), operator<<(), and setPattern().

the rotation

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

true if the shadow has some color

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

true if the surface has some color

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


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