MWAWParagraph Class Reference

class to store the paragraph properties More...

#include <MWAWParagraph.hxx>

Inheritance diagram for MWAWParagraph:
ClarisDrawTextInternal::Paragraph ClarisWksTextInternal::Paragraph FullWrtTextInternal::Paragraph HanMacWrdJTextInternal::Paragraph HanMacWrdKTextInternal::Paragraph LightWayTxtTextInternal::Paragraph MacWrtProStructuresInternal::Paragraph MarinerWrtTextInternal::Paragraph MoreTextInternal::Paragraph MsWks4TextInternal::Paragraph MsWrd1ParserInternal::Paragraph MsWrdStruct::Paragraph NisusWrtTextInternal::Paragraph WriteNowTextInternal::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
 
 MWAWParagraph (MWAWParagraph const &)=default
 
MWAWParagraphoperator= (MWAWParagraph const &)=default
 
MWAWParagraphoperator= (MWAWParagraph &&)=default
 
virtual ~MWAWParagraph ()
 destructor
 
bool operator== (MWAWParagraph const &p) const
 operator==
 
bool operator!= (MWAWParagraph const &p) const
 operator!=
 
int cmp (MWAWParagraph const &p) const
 a comparison function
 
double getMarginsWidth () const
 return the paragraph margin width (in inches)
 
bool hasBorders () const
 check if the paragraph has some borders
 
bool hasDifferentBorders () const
 check if the paragraph has different borders
 
void resizeBorders (size_t newSize)
 a function used to resize the borders list ( adding empty borders if needed )
 
void setInterline (double value, librevenge::RVNGUnit unit, LineSpacingType type=Fixed)
 set the interline
 
void addTo (librevenge::RVNGPropertyList &propList, bool inTable) const
 add to the propList
 
void insert (MWAWParagraph const &para)
 insert the set values of para in the actual paragraph
 

Public Attributes

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

Friends

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

Detailed Description

class to store the paragraph properties

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

some bit use to defined the break status

Enumerator
NoBreakBit 
NoBreakWithNextBit 

◆ Justification

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

Enumerator
JustificationLeft 
JustificationFull 
JustificationCenter 
JustificationRight 
JustificationFullAllLines 

◆ LineSpacingType

the line spacing type: fixed or at least

Enumerator
Fixed 
AtLeast 

Constructor & Destructor Documentation

◆ MWAWParagraph() [1/2]

MWAWParagraph::MWAWParagraph ( )

constructor

◆ MWAWParagraph() [2/2]

MWAWParagraph::MWAWParagraph ( MWAWParagraph const &  )
default

◆ ~MWAWParagraph()

MWAWParagraph::~MWAWParagraph ( )
virtual

destructor

Referenced by MsWrdStruct::Paragraph::read().

Member Function Documentation

◆ addTo()

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

add to the propList

◆ cmp()

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

a comparison function

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

◆ getMarginsWidth()

double MWAWParagraph::getMarginsWidth ( ) const

return the paragraph margin width (in inches)

◆ hasBorders()

bool MWAWParagraph::hasBorders ( ) const

check if the paragraph has some borders

Referenced by addTo(), and hasDifferentBorders().

◆ hasDifferentBorders()

bool MWAWParagraph::hasDifferentBorders ( ) const

check if the paragraph has different borders

Referenced by addTo().

◆ insert()

void MWAWParagraph::insert ( MWAWParagraph const &  para)

insert the set values of para in the actual paragraph

Referenced by insert(), and MsWrdStruct::Paragraph::insert().

◆ operator!=()

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

operator!=

◆ operator=() [1/2]

MWAWParagraph & MWAWParagraph::operator= ( MWAWParagraph &&  )
default

◆ operator=() [2/2]

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

◆ operator==()

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

operator==

◆ resizeBorders()

void MWAWParagraph::resizeBorders ( size_t  newSize)
inline

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

Referenced by MsWrdStruct::Paragraph::read(), HanMacWrdJText::readParagraph(), HanMacWrdKText::readParagraph(), and MarinerWrtTextInternal::Paragraph::update().

◆ setInterline()

void MWAWParagraph::setInterline ( double  value,
librevenge::RVNGUnit  unit,
LineSpacingType  type = Fixed 
)
inline

set the interline

Referenced by MacWrtParser::readGraphic(), MacDraftParser::readLabel(), MacDraftParser::readObject(), ClarisDrawText::readParagraph(), ClarisWksText::readParagraph(), MsWrd1Parser::readParagraph(), WordMakerParser::readParagraph(), MacWrtParser::readParagraph(), JazzWriterParser::readParagraph(), WriteNowText::readParagraph(), MsWks4Text::readParagraph(), ScoopParser::readParagraph(), BeagleWksText::readParagraph(), PowerPoint3Parser::readParagraph(), MacWrtProStructures::readParagraph(), StudentWritingCParser::readParagraph(), MouseWrtParser::readParagraphPLCs(), NisusWrtText::readParagraphs(), RagTimeText::readParagraphs(), MacDrawProStyleManager::readParagraphStyles(), Canvas5StyleManager::readParaStyle(), MindWrtParser::readRuler(), GreatWksText::readRuler(), MarinerWrtText::readRulers(), StyleParser::readRules(), CricketDrawParser::readShape(), ReadySetGoParser::readStyle(), MacWrtParser::readText(), WriterPlsParser::readText(), MacDrawProParser::readTextII(), PowerPoint7Text::readTextZone(), ScriptWriterParser::send(), MindWrtParser::sendHeaderFooterFields(), DrawTableParser::sendShape(), CanvasGraph::sendText(), BeagleWksDRParser::sendText(), SuperPaintParser::sendText(), MsWks3Text::sendText(), PowerPoint1Parser::sendText(), ReadySetGoParser::sendText(), ScriptWriterParser::sendText(), MindWrtParser::sendZone(), MsWrdStruct::Paragraph::updateParagraphToFinalState(), RagTime5StyleManager::updateTextStyles(), and FullWrtTextInternal::Paragraph::updateToSent().

Friends And Related Function Documentation

◆ operator<<

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

operator <<

Member Data Documentation

◆ m_backgroundColor

◆ m_borders

◆ m_breakStatus

◆ m_dropNumCharacters

MWAWVariable<int> MWAWParagraph::m_dropNumCharacters

the drop number character

Referenced by addTo(), cmp(), insert(), and Canvas5StyleManager::readParaStyle().

◆ m_dropNumLines

MWAWVariable<int> MWAWParagraph::m_dropNumLines

the drop number of lines

Referenced by addTo(), cmp(), insert(), and Canvas5StyleManager::readParaStyle().

◆ m_extra

◆ m_justify

MWAWVariable<Justification> MWAWParagraph::m_justify

the justification

Referenced by addTo(), cmp(), WriteNowTextInternal::State::getDefaultParagraph(), insert(), MWAWHeaderFooter::insertPageNumberParagraph(), Canvas5GraphInternal::SubDocument::parse(), CanvasGraphInternal::SubDocument::parse(), ClarisDrawGraphInternal::SubDocument::parse(), MsWrdStruct::Paragraph::read(), MacDraftParser::readLabel(), MacDraftParser::readObject(), HanMacWrdJText::readParagraph(), HanMacWrdKText::readParagraph(), ClarisDrawText::readParagraph(), ClarisWksText::readParagraph(), MsWrd1Parser::readParagraph(), WordMakerParser::readParagraph(), MacWrtParser::readParagraph(), MsWks3Text::readParagraph(), JazzWriterParser::readParagraph(), WriteNowText::readParagraph(), MsWks4Text::readParagraph(), ScoopParser::readParagraph(), BeagleWksText::readParagraph(), PowerPoint3Parser::readParagraph(), MacWrtProStructures::readParagraph(), StudentWritingCParser::readParagraph(), MouseWrtParser::readParagraphPLCs(), NisusWrtText::readParagraphs(), RagTimeText::readParagraphs(), MacDrawProStyleManager::readParagraphStyles(), Canvas5StyleManager::readParaStyle(), MindWrtParser::readRuler(), GreatWksText::readRuler(), MarinerWrtText::readRulers(), LightWayTxtText::readRulers(), StyleParser::readRules(), CricketDrawParser::readShape(), ReadySetGoParser::readStyle(), MacWrtParser::readText(), MacDrawProParser::readTextII(), PowerPoint7Text::readTextZone(), ClarisWksDbaseContent::send(), ScriptWriterParser::send(), ActaParser::sendHeaderFooter(), LightWayTxtText::sendHeaderFooter(), MacDocParser::sendIndex(), MouseWrtParser::sendMainZone(), DrawTableParser::sendShape(), GreatWksText::sendSimpleTextbox(), MsWksTable::sendTable(), CanvasGraph::sendText(), DocMkrText::sendText(), BeagleWksDRParser::sendText(), SuperPaintParser::sendText(), FreeHandParser::sendText(), CorelPainterParser::sendText(), Canvas5Graph::sendText(), PowerPoint1Parser::sendText(), ReadySetGoParser::sendText(), ScriptWriterParser::sendText(), ZWrtText::sendText(), MsWksGraph::sendTextBox(), StudentWritingCParser::sendZone(), MindWrtParserInternal::ZoneInfo::updateListId(), RagTime5StyleManager::updateTextStyles(), and FullWrtTextInternal::Paragraph::updateToSent().

◆ m_listId

◆ m_listLevel

◆ m_listLevelIndex

◆ m_listStartValue

MWAWVariable<int> MWAWParagraph::m_listStartValue

the list start value (if set )

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

◆ m_margins

MWAWVariable<double> MWAWParagraph::m_margins[3]

the margins

  • 0: first line left margin
  • 1: left margin
  • 2: right margin

Referenced by addTo(), cmp(), WriteNowTextInternal::State::getDefaultParagraph(), getMarginsWidth(), WriterPlsParser::getParagraph(), FullWrtTextInternal::Paragraph::getTableDimensions(), insert(), MWAWParagraph(), MsWrdStruct::Paragraph::read(), HanMacWrdJText::readParagraph(), HanMacWrdKText::readParagraph(), ClarisDrawText::readParagraph(), ClarisWksText::readParagraph(), MsWrd1Parser::readParagraph(), WordMakerParser::readParagraph(), MacWrtParser::readParagraph(), MsWks3Text::readParagraph(), JazzWriterParser::readParagraph(), WriteNowText::readParagraph(), MsWks4Text::readParagraph(), ScoopParser::readParagraph(), BeagleWksText::readParagraph(), MacWrtProStructures::readParagraph(), StudentWritingCParser::readParagraph(), MouseWrtParser::readParagraphPLCs(), NisusWrtText::readParagraphs(), RagTimeText::readParagraphs(), MacDrawProStyleManager::readParagraphStyles(), FullWrtText::readParagraphTabs(), Canvas5StyleManager::readParaStyle(), MindWrtParser::readRuler(), GreatWksText::readRuler(), MarinerWrtText::readRulers(), LightWayTxtText::readRulers(), StyleParser::readRules(), ReadySetGoParser::readShapeV1(), ReadySetGoParser::readShapeV2(), ReadySetGoParser::readStyle(), EDocParser::sendIndex(), MacDocParser::sendIndex(), MouseWrtParser::sendMainZone(), PowerPoint1Parser::sendText(), ScriptWriterParser::sendText(), ActaText::sendTopic(), MoreTextInternal::Paragraph::setLeftMargin(), NisusWrtText::setProperty(), MoreTextInternal::Paragraph::setRightMargin(), MindWrtParserInternal::ZoneInfo::updateListId(), ClarisDrawTextInternal::Paragraph::updateListLevel(), ClarisWksTextInternal::Paragraph::updateListLevel(), PowerPoint7TextInternal::Ruler::updateParagraph(), PowerPoint3ParserInternal::Ruler::updateParagraph(), RagTime5StyleManager::updateTextStyles(), and MoreTextInternal::Paragraph::updateToFinalState().

◆ m_marginsUnit

◆ m_spacings

◆ m_spacingsInterlineType

MWAWVariable<LineSpacingType> MWAWParagraph::m_spacingsInterlineType

the interline type: fixed, atLeast, ...

Referenced by addTo(), cmp(), insert(), MsWks4Text::readParagraph(), NisusWrtText::readParagraphs(), and setInterline().

◆ m_spacingsInterlineUnit

MWAWVariable<librevenge::RVNGUnit> MWAWParagraph::m_spacingsInterlineUnit

◆ m_styleName

std::string MWAWParagraph::m_styleName

the style name

Referenced by addTo(), cmp(), and insert().

◆ m_tabs

MWAWVariable<std::vector<MWAWTabStop> > MWAWParagraph::m_tabs

the tabulations

Referenced by addTo(), cmp(), WriteNowTextInternal::State::getDefaultParagraph(), FullWrtTextInternal::Paragraph::getTableDimensions(), insert(), MsWrdStruct::Paragraph::insert(), MsWrdStruct::Paragraph::read(), HanMacWrdJText::readParagraph(), HanMacWrdKText::readParagraph(), ClarisDrawText::readParagraph(), ClarisWksText::readParagraph(), MsWrd1Parser::readParagraph(), WordMakerParser::readParagraph(), MacWrtParser::readParagraph(), MsWks3Text::readParagraph(), JazzWriterParser::readParagraph(), WriteNowText::readParagraph(), MsWks4Text::readParagraph(), ScoopParser::readParagraph(), BeagleWksText::readParagraph(), MacWrtProStructures::readParagraph(), StudentWritingCParser::readParagraph(), MouseWrtParser::readParagraphPLCs(), NisusWrtText::readParagraphs(), RagTimeText::readParagraphs(), MacDrawProStyleManager::readParagraphStyles(), FullWrtText::readParagraphTabs(), MindWrtParser::readRuler(), PowerPoint3Parser::readRuler(), GreatWksText::readRuler(), MarinerWrtText::readRulers(), LightWayTxtText::readRulers(), PowerPoint7Text::readRulerTabs(), ReadySetGoParser::readShapeV1(), ReadySetGoParser::readShapeV2(), MoreText::readTabs(), WordMakerParser::readTabulations(), WriteNowText::send(), DocMkrText::sendFooter(), MindWrtParser::sendHeaderFooterFields(), EDocParser::sendIndex(), MacDocParser::sendIndex(), PowerPoint1Parser::sendText(), ReadySetGoParser::sendText(), ScriptWriterParser::sendText(), DocMkrText::sendTOC(), PowerPoint3ParserInternal::Ruler::updateParagraph(), RagTime5StyleManager::updateTextStyles(), and FullWrtTextInternal::Paragraph::updateToSent().

◆ m_tabsRelativeToLeftMargin

MWAWVariable<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 addTo(), cmp(), insert(), and MsWrdStruct::Paragraph::Paragraph().

◆ m_writingMode

MWAWVariable<libmwaw::WritingMode> MWAWParagraph::m_writingMode

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