MWAWGraphicStyle Class Reference

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

#include <MWAWGraphicStyle.hxx>

Inheritance diagram for MWAWGraphicStyle:
ClarisDrawGraphInternal::Style ClarisWksGraphInternal::Style MsWksGraph::Style

Classes

struct  Arrow
 a structure used to define an arrow More...
 
struct  Gradient
 a basic gradient used in a MWAWGraphicStyle More...
 
struct  Hatch
 a basic hatch used in MWAWGraphicStyle More...
 
struct  Pattern
 a basic pattern used in a MWAWGraphicStyle: 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  VerticalAlignment {
  V_AlignBottom , V_AlignCenter , V_AlignJustify , V_AlignTop ,
  V_AlignDefault
}
 an enum used to define the vertical alignment More...
 

Public Member Functions

 MWAWGraphicStyle ()
 constructor
 
 MWAWGraphicStyle (MWAWGraphicStyle const &)=default
 
MWAWGraphicStyleoperator= (MWAWGraphicStyle const &)=default
 
MWAWGraphicStyleoperator= (MWAWGraphicStyle &&)=default
 
virtual ~MWAWGraphicStyle ()
 virtual destructor
 
bool hasLine () const
 returns true if the border is defined
 
void setSurfaceColor (MWAWColor const &col, float opacity=1)
 set the surface color
 
bool hasSurfaceColor () const
 returns true if the surface is defined
 
void setPattern (Pattern const &pat, float opacity=1)
 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 hasHatch () const
 returns true if the hatch is defined
 
bool hasSurface () const
 returns true if the interior surface is defined
 
void setBackgroundColor (MWAWColor const &col, float opacity=1)
 set the background color
 
bool hasBackgroundColor () const
 returns true if the background is defined
 
void setShadowColor (MWAWColor 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< MWAWBorder > const & borders () const
 return the frame border: libmwaw::Left | ...
 
void resetBorders ()
 reset the border
 
void setBorders (int wh, MWAWBorder const &border)
 sets the cell border: wh=libmwaw::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 (MWAWGraphicStyle const &a) const
 compare two styles
 

Static Public Member Functions

static MWAWGraphicStyle emptyStyle ()
 returns an empty style.
 

Public Attributes

std::vector< float > m_lineDashWidth
 the dash array: a sequence of (fullsize, emptysize)
 
float m_lineWidth
 the linewidth
 
LineCap m_lineCap
 the line cap
 
LineJoin m_lineJoin
 the line join
 
float m_lineOpacity
 the line opacity: 0=transparent
 
MWAWColor m_lineColor
 the line color
 
MWAWColor m_surfaceColor
 the surface color
 
float m_surfaceOpacity
 true if the surface has some color
 
MWAWColor m_shadowColor
 the shadow color
 
float m_shadowOpacity
 true if the shadow has some color
 
MWAWVec2f m_shadowOffset
 the shadow offset
 
Pattern m_pattern
 the pattern if it exists
 
Gradient m_gradient
 the gradient
 
Hatch m_hatch
 the hatch
 
MWAWColor m_backgroundColor
 the background color
 
float m_backgroundOpacity
 true if the background has some color
 
float m_rotate
 the rotation
 
std::vector< MWAWBorderm_bordersList
 the borders MWAWBorder::Pos (for a frame)
 
std::string m_frameName
 the frame name
 
std::string m_frameNextName
 the frame next name (if there is a link)
 
Arrow m_arrows [2]
 the two arrows corresponding to start and end extremity
 
bool m_flip [2]
 two bool to indicated we need to flip the shape or not
 
bool m_fillRuleEvenOdd
 true if the fill rule is evenod
 
bool m_doNotPrint
 a bool to know if the shape must not be printed
 
VerticalAlignment m_verticalAlignment
 related to text area
 
std::string m_extra
 extra data
 

Friends

std::ostream & operator<< (std::ostream &o, MWAWGraphicStyle 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

◆ LineCap

an enum used to define the basic line cap

Enumerator
C_Butt 
C_Square 
C_Round 

◆ LineJoin

an enum used to define the basic line join

Enumerator
J_Miter 
J_Round 
J_Bevel 

◆ VerticalAlignment

an enum used to define the vertical alignment

Note
actually mainly used for text box
Enumerator
V_AlignBottom 
V_AlignCenter 
V_AlignJustify 
V_AlignTop 
V_AlignDefault 

Constructor & Destructor Documentation

◆ MWAWGraphicStyle() [1/2]

MWAWGraphicStyle::MWAWGraphicStyle ( )
inline

constructor

◆ MWAWGraphicStyle() [2/2]

MWAWGraphicStyle::MWAWGraphicStyle ( MWAWGraphicStyle const &  )
default

◆ ~MWAWGraphicStyle()

MWAWGraphicStyle::~MWAWGraphicStyle ( )
virtual

virtual destructor

Member Function Documentation

◆ addFrameTo()

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

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

Referenced by MWAWSpreadsheetListener::openFrame(), and MWAWTextListener::openFrame().

◆ addTo()

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

◆ borders()

std::vector< MWAWBorder > const & MWAWGraphicStyle::borders ( ) const
inline

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

◆ cmp()

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

compare two styles

◆ emptyStyle()

◆ hasBackgroundColor()

bool MWAWGraphicStyle::hasBackgroundColor ( ) const
inline

returns true if the background is defined

◆ hasBorders()

bool MWAWGraphicStyle::hasBorders ( ) const
inline

return true if the frame has some border

Referenced by addFrameTo().

◆ hasGradient()

bool MWAWGraphicStyle::hasGradient ( bool  complex = false) const
inline

◆ hasHatch()

bool MWAWGraphicStyle::hasHatch ( ) const
inline

returns true if the hatch is defined

Referenced by addTo(), MWAWGraphicStyle::Hatch::addTo(), and hasSurface().

◆ hasLine()

◆ hasPattern()

bool MWAWGraphicStyle::hasPattern ( ) const
inline

returns true if the pattern is defined

Referenced by addTo(), hasSurface(), HanMacWrdKGraph::sendFrame(), and GreatWksGraph::sendTextbox().

◆ hasSameBorders()

bool MWAWGraphicStyle::hasSameBorders ( ) const
inline

return true if the frame has some border

Referenced by addFrameTo().

◆ hasShadow()

bool MWAWGraphicStyle::hasShadow ( ) const
inline

returns true if the shadow is defined

Referenced by addFrameTo(), and addTo().

◆ hasSurface()

◆ hasSurfaceColor()

◆ operator=() [1/2]

MWAWGraphicStyle & MWAWGraphicStyle::operator= ( MWAWGraphicStyle &&  )
default

◆ operator=() [2/2]

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

◆ resetBorders()

void MWAWGraphicStyle::resetBorders ( )
inline

reset the border

Referenced by PowerPoint1Parser::readFramesList().

◆ setBackgroundColor()

◆ setBorders()

◆ setPattern()

◆ setShadowColor()

◆ setSurfaceColor()

Friends And Related Function Documentation

◆ operator<<

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

a print operator

Member Data Documentation

◆ m_arrows

◆ m_backgroundColor

MWAWColor MWAWGraphicStyle::m_backgroundColor

the background color

Referenced by addFrameTo(), cmp(), and setBackgroundColor().

◆ m_backgroundOpacity

float MWAWGraphicStyle::m_backgroundOpacity

◆ m_bordersList

std::vector<MWAWBorder> MWAWGraphicStyle::m_bordersList

the borders MWAWBorder::Pos (for a frame)

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

◆ m_doNotPrint

bool MWAWGraphicStyle::m_doNotPrint

a bool to know if the shape must not be printed

Referenced by addTo().

◆ m_extra

◆ m_fillRuleEvenOdd

bool MWAWGraphicStyle::m_fillRuleEvenOdd

true if the fill rule is evenod

Referenced by addTo(), cmp(), CorelPainterParser::readPolygon(), and MsWksGraph::Style::Style().

◆ m_flip

◆ m_frameName

◆ m_frameNextName

◆ m_gradient

◆ m_hatch

Hatch MWAWGraphicStyle::m_hatch

◆ m_lineCap

LineCap MWAWGraphicStyle::m_lineCap

◆ m_lineColor

◆ m_lineDashWidth

◆ m_lineJoin

LineJoin MWAWGraphicStyle::m_lineJoin

◆ m_lineOpacity

◆ m_lineWidth

float MWAWGraphicStyle::m_lineWidth

the linewidth

Referenced by addTo(), HanMacWrdJGraphInternal::FrameFormat::addTo(), HanMacWrdKGraphInternal::TextBox::addTo(), MWAWChart::Axis::Axis(), cmp(), emptyStyle(), HanMacWrdJGraphInternal::FrameFormat::FrameFormat(), MWAWGraphicShape::getBdBox(), GreatWksGraphInternal::FrameText::getStyle(), hasLine(), MsWksGraphInternal::BasicShape::needExtraBorderWidth(), BeagleWksSSParser::readChart(), RagTimeParser::readDataZoneHeader(), HanMacWrdJGraph::readFrames(), HanMacWrdKGraph::readFrames(), PowerPoint3Parser::readFramesList(), PowerPoint1Parser::readFramesList(), ClarisWksStyleManager::readGraphStyles(), MacDraftParser::readLabel(), MacDraftParser::readObject(), MacDraft5Parser::readObject(), MsWksGraph::readPictHeader(), CorelPainterParser::readPolygon(), CricketDrawParser::readShape(), SuperPaintParser::readShape(), ScoopParser::readShape(), ReadySetGoParser::readShapeV1(), ReadySetGoParser::readShapeV2(), BeagleWksDRParser::readStyle(), PowerPoint7Graph::readStyle(), GreatWksGraph::readStyle(), ClarisWksTable::readTableCells(), Canvas5Image::send(), CanvasGraph::send(), MsWksGraph::send(), RagTimeParser::send(), MacDrawProParser::send(), Canvas5Graph::send(), RagTime5Graph::send(), MacDraft5Parser::sendBitmap(), MacDrawProParser::sendBitmap(), HanMacWrdJGraph::sendComment(), CanvasGraph::sendDimension(), MWAWTable::sendExtraLines(), MsWksGraph::sendGroup(), MsWksGraph::sendGroupChild(), CanvasGraph::sendMultiLines(), RagTimeParser::sendPicture(), BeagleWksDRParser::sendPictures(), MarinerWrtGraph::sendRule(), DrawTableParser::sendShape(), ClarisDrawGraph::sendShape(), CanvasGraph::sendSpecial(), Canvas5Graph::sendSpecial(), MWAWChart::Series::Series(), MWAWChart::TextZone::TextZone(), CanvasGraph::update(), ClarisWksTableInternal::TableCell::update(), MacDraft5StyleManager::updateArrows(), RagTime5StyleManager::updateBorderStyle(), Canvas5StyleManager::updateLine(), Canvas5StyleManager::updateLineStyle(), MacDraft5StyleManager::updateLineStyle(), FreeHandParserInternal::State::updateLineStyle(), and ApplePictParserInternal::State::updateStyle().

◆ m_pattern

Pattern MWAWGraphicStyle::m_pattern

the pattern if it exists

Referenced by addTo(), cmp(), hasPattern(), RagTimeParser::readDataZoneHeader(), and setPattern().

◆ m_rotate

◆ m_shadowColor

MWAWColor MWAWGraphicStyle::m_shadowColor

the shadow color

Referenced by addFrameTo(), addTo(), cmp(), and setShadowColor().

◆ m_shadowOffset

◆ m_shadowOpacity

float MWAWGraphicStyle::m_shadowOpacity

true if the shadow has some color

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

◆ m_surfaceColor

◆ m_surfaceOpacity

◆ m_verticalAlignment

VerticalAlignment MWAWGraphicStyle::m_verticalAlignment

related to text area

Referenced by addTo(), cmp(), ReadySetGoParser::readShapeV3(), and ScoopParser::send().


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

Generated on Thu Jan 19 2023 00:00:00 for libmwaw by doxygen 1.9.6