MWAWParagraph Class Reference

class to store the paragraph properties More...

#include <MWAWParagraph.hxx>

Inheritance diagram for MWAWParagraph:
CWTextInternal::Paragraph FWTextInternal::Paragraph HMWJTextInternal::Paragraph HMWKTextInternal::Paragraph LWTextInternal::Paragraph MORTextInternal::Paragraph MRWTextInternal::Paragraph MSK4TextInternal::Paragraph MSW1ParserInternal::Paragraph MSWStruct::Paragraph MWProStructuresInternal::Paragraph NSTextInternal::Paragraph WNTextInternal::Paragraph

Public Types

enum  { NoBreakBit = 0x1, NoBreakWithNextBit =0x2 }
 some bit use to defined the break status More...
 
enum  Justification {
  JustificationLeft, JustificationFull, JustificationCenter, JustificationRight,
  JustificationFullAllLines
}
 an enum used to defined the paragraph justification: left, center, right, full ... More...
 
enum  LineSpacingType { Fixed, AtLeast }
 the line spacing type: fixed or at least More...
 

Public Member Functions

 MWAWParagraph ()
 constructor More...
 
virtual ~MWAWParagraph ()
 destructor More...
 
bool operator== (MWAWParagraph const &p) const
 operator== More...
 
bool operator!= (MWAWParagraph const &p) const
 operator!= More...
 
int cmp (MWAWParagraph const &p) const
 a comparison function More...
 
double getMarginsWidth () const
 return the paragraph margin width (in inches) More...
 
bool hasBorders () const
 check if the paragraph has some borders More...
 
bool hasDifferentBorders () const
 check if the paragraph has different borders More...
 
void resizeBorders (size_t newSize)
 a function used to resize the borders list ( adding empty borders if needed ) More...
 
void setInterline (double value, WPXUnit unit, LineSpacingType type=Fixed)
 set the interline More...
 
void addTo (WPXPropertyList &propList, bool inTable) const
 add to the propList More...
 
void addTabsTo (WPXPropertyListVector &propList, double decalX=0.0) const
 add tabs to the propList More...
 
void insert (MWAWParagraph const &para)
 insert the set values of para in the actual paragraph More...
 

Public Attributes

Variable< double > m_margins [3]
 the margins More...
 
Variable< WPXUnit > m_marginsUnit
 the margins INCH, ... More...
 
Variable< double > m_spacings [3]
 the line spacing More...
 
Variable< WPXUnit > m_spacingsInterlineUnit
 the interline unit PERCENT or INCH, ... More...
 
Variable< LineSpacingTypem_spacingsInterlineType
 the interline type: fixed, atLeast, ... More...
 
Variable< std::vector
< MWAWTabStop > > 
m_tabs
 the tabulations More...
 
Variable< bool > m_tabsRelativeToLeftMargin
 true if the tabs are relative to left margin, false if there are relative to the page margin (default) More...
 
Variable< Justificationm_justify
 the justification More...
 
Variable< int > m_breakStatus
 a list of bits: 0x1 (unbreakable), 0x2 (do not break after) More...
 
Variable< int > m_listLevelIndex
 the actual level index More...
 
Variable< int > m_listId
 the list id (if know ) More...
 
Variable< int > m_listStartValue
 the list start value (if set ) More...
 
Variable< MWAWListLevelm_listLevel
 the actual level More...
 
Variable< MWAWColorm_backgroundColor
 the background color More...
 
std::vector< Variable
< MWAWBorder > > 
m_borders
 list of border ( order MWAWBorder::Pos) More...
 
std::string m_extra
 a string to store some errors More...
 

Friends

std::ostream & operator<< (std::ostream &o, MWAWParagraph const &ft)
 operator << More...
 

Detailed Description

class to store the paragraph properties

Member Enumeration Documentation

anonymous enum

some bit use to defined the break status

Enumerator
NoBreakBit 
NoBreakWithNextBit 

an enum used to defined the paragraph justification: left, center, right, full ...

Enumerator
JustificationLeft 
JustificationFull 
JustificationCenter 
JustificationRight 
JustificationFullAllLines 

the line spacing type: fixed or at least

Enumerator
Fixed 
AtLeast 

Constructor & Destructor Documentation

MWAWParagraph::MWAWParagraph ( )

constructor

MWAWParagraph::~MWAWParagraph ( )
virtual

destructor

Member Function Documentation

void MWAWParagraph::addTabsTo ( WPXPropertyListVector &  propList,
double  decalX = 0.0 
) const

add tabs to the propList

void MWAWParagraph::addTo ( WPXPropertyList &  propList,
bool  inTable 
) const

add to the propList

int MWAWParagraph::cmp ( MWAWParagraph const &  p) const

a comparison function

Referenced by operator!=(), and operator==().

double MWAWParagraph::getMarginsWidth ( ) const

return the paragraph margin width (in inches)

bool MWAWParagraph::hasBorders ( ) const

check if the paragraph has some borders

Referenced by addTo(), and hasDifferentBorders().

bool MWAWParagraph::hasDifferentBorders ( ) const

check if the paragraph has different borders

Referenced by addTo().

void MWAWParagraph::insert ( MWAWParagraph const &  para)

insert the set values of para in the actual paragraph

Referenced by MSWStruct::Paragraph::insert().

bool MWAWParagraph::operator!= ( MWAWParagraph const &  p) const
inline

operator!=

bool MWAWParagraph::operator== ( MWAWParagraph const &  p) const
inline

operator==

void MWAWParagraph::resizeBorders ( size_t  newSize)
inline

a function used to resize the borders list ( adding empty borders if needed )

Referenced by MSWStruct::Paragraph::read(), HMWJText::readParagraph(), HMWKText::readParagraph(), and MRWTextInternal::Paragraph::update().

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o,
MWAWParagraph const &  ft 
)
friend

operator <<

Member Data Documentation

Variable<MWAWColor> MWAWParagraph::m_backgroundColor
Variable<int> MWAWParagraph::m_breakStatus

a list of bits: 0x1 (unbreakable), 0x2 (do not break after)

Referenced by addTo(), cmp(), insert(), operator<<(), MSWStruct::Paragraph::read(), MORText::readOutline(), HMWJText::readParagraph(), and HMWKText::readParagraph().

Variable<int> MWAWParagraph::m_listStartValue

the list start value (if set )

Referenced by cmp(), insert(), and MDWParserInternal::ZoneInfo::updateListId().

Variable<LineSpacingType> MWAWParagraph::m_spacingsInterlineType

the interline type: fixed, atLeast, ...

Referenced by addTo(), cmp(), insert(), operator<<(), MSK4Text::readParagraph(), NSText::readParagraphs(), and setInterline().

Variable<WPXUnit> MWAWParagraph::m_spacingsInterlineUnit
Variable<bool> MWAWParagraph::m_tabsRelativeToLeftMargin

true if the tabs are relative to left margin, false if there are relative to the page margin (default)

Referenced by addTabsTo(), cmp(), insert(), and MSWStruct::Paragraph::Paragraph().


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

Generated on Tue Mar 10 2015 17:32:10 for libmwaw by doxygen 1.8.5