MWAWFont Class Reference

Class to store font. More...

#include <MWAWFont.hxx>

List of all members.

Classes

struct  Line
 a small struct to define a line in MWAWFont More...
struct  Script
 a small struct to define the script position in MWAWFont More...

Public Types

enum  FontBits {
  boldBit = 1, italicBit = 2, blinkBit = 4, embossBit = 8,
  engraveBit = 0x10, hiddenBit = 0x20, outlineBit = 0x40, shadowBit = 0x80,
  reverseVideoBit = 0x100, smallCapsBit = 0x200, allCapsBit = 0x400, lowercaseBit = 0x800,
  boxedBit = 0x1000, boxedRoundedBit = 0x2000, reverseWritingBit = 0x4000
}
 the different font bit More...

Public Member Functions

 MWAWFont (int newId=-1, float sz=12, uint32_t f=0)
 constructor
bool isSet () const
 returns true if the font id is initialized
void insert (MWAWFont const &ft)
 inserts the set value in the current font
void setFont (int newId)
 sets the font id and resets size to the previous size for this font
int id () const
 returns the font id
void setId (int newId)
 sets the font id
float size () const
 returns the font size
void setSize (float sz)
 sets the font size
float deltaLetterSpacing () const
 returns the condensed(negative)/extended(positive) width
void setDeltaLetterSpacing (float d)
 sets the letter spacing ( delta value in point )
float texteWidthScaling () const
 returns the text width scaling
void setTexteWidthScaling (float scale=1.0)
 sets the text width scaling
Script const & script () const
 returns the script position
void set (Script const &newscript)
 sets the script position
uint32_t flags () const
 returns the font flags
void setFlags (uint32_t fl)
 sets the font attributes bold, ...
bool hasColor () const
 returns true if the font color is not black
void getColor (MWAWColor &c) const
 returns the font color
void setColor (MWAWColor color)
 sets the font color
void getBackgroundColor (MWAWColor &c) const
 returns the font background color
void setBackgroundColor (MWAWColor color)
 sets the font background color
void resetColor ()
 resets the font color to black and the background color to white
bool hasDecorationLines () const
 return true if the font has decorations line (overline, strikeout, underline)
void resetDecorationLines ()
 reset the decoration
Line const & getOverline () const
 returns the overline
void setOverline (Line const &line)
 sets the overline
void setOverlineStyle (Line::Style style=Line::None, bool doReset=true)
 sets the overline style ( by default, we also reset the style)
void setOverlineType (Line::Type type=Line::Single)
 sets the overline type
void setOverlineWordFlag (bool wordFlag=false)
 sets the overline word flag
void setOverlineWidth (float w)
 sets the overline width
void setOverlineColor (MWAWColor const &color)
 sets the overline color
Line const & getStrikeOut () const
 returns the strikeoutline
void setStrikeOut (Line const &line)
 sets the strikeoutline
void setStrikeOutStyle (Line::Style style=Line::None, bool doReset=true)
 sets the strikeoutline style ( by default, we also reset the style)
void setStrikeOutType (Line::Type type=Line::Single)
 sets the strikeoutline type
void setStrikeOutWordFlag (bool wordFlag=false)
 sets the strikeoutline word flag
void setStrikeOutWidth (float w)
 sets the strikeoutline width
void setStrikeOutColor (MWAWColor const &color)
 sets the strikeoutline color
Line const & getUnderline () const
 returns the underline
void setUnderline (Line const &line)
 sets the underline
void setUnderlineStyle (Line::Style style=Line::None, bool doReset=true)
 sets the underline style ( by default, we also reset the style)
void setUnderlineType (Line::Type type=Line::Single)
 sets the underline type
void setUnderlineWordFlag (bool wordFlag=false)
 sets the underline word flag
void setUnderlineWidth (float w)
 sets the underline width
void setUnderlineColor (MWAWColor const &color)
 sets the underline color
std::string const & language () const
 returns the language
void setLanguage (std::string const &lang)
 set the language ( in the for en_US, en_GB, en, ...)
void addTo (librevenge::RVNGPropertyList &propList, shared_ptr< MWAWFontConverter > fontConverter) const
 add to the propList
std::string getDebugString (shared_ptr< MWAWFontConverter > &converter) const
 returns a string which can be used for debugging
bool operator== (MWAWFont const &f) const
 operator==
bool operator!= (MWAWFont const &f) const
 operator!=
int cmp (MWAWFont const &oth) const
 a comparison function

Public Attributes

std::string m_extra
 extra data

Protected Attributes

MWAWVariable< int > m_id
 font identificator
MWAWVariable< float > m_size
 font size
MWAWVariable< float > m_deltaSpacing
 expand(> 0), condensed(< 0) depl in point
MWAWVariable< float > m_texteWidthScaling
 the texte width scaling
MWAWVariable< Scriptm_scriptPosition
 the sub/super script definition
MWAWVariable< uint32_t > m_flags
 font attributes
MWAWVariable< Linem_overline
 overline attributes
MWAWVariable< Linem_strikeoutline
 overline attributes
MWAWVariable< Linem_underline
 underline attributes
MWAWVariable< MWAWColorm_color
 font color
MWAWVariable< MWAWColorm_backgroundColor
 font background color
MWAWVariable< std::string > m_language
 the language if set

Detailed Description

Class to store font.


Member Enumeration Documentation

the different font bit

Enumerator:
boldBit 
italicBit 
blinkBit 
embossBit 
engraveBit 
hiddenBit 
outlineBit 
shadowBit 
reverseVideoBit 
smallCapsBit 
allCapsBit 
lowercaseBit 
boxedBit 
boxedRoundedBit 
reverseWritingBit 

Constructor & Destructor Documentation

MWAWFont::MWAWFont ( int  newId = -1,
float  sz = 12,
uint32_t  f = 0 
) [inline]

constructor

Parameters:
newIdsystem id font
szthe font size
fthe font attributes bold, ...

Member Function Documentation

void MWAWFont::addTo ( librevenge::RVNGPropertyList &  propList,
shared_ptr< MWAWFontConverter fontConverter 
) const

add to the propList

Referenced by MWAWCell::addTo().

int MWAWFont::cmp ( MWAWFont const &  oth) const [inline]

a comparison function

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

float MWAWFont::deltaLetterSpacing ( ) const [inline]

returns the condensed(negative)/extended(positive) width

void MWAWFont::getBackgroundColor ( MWAWColor c) const [inline]

returns the font background color

Referenced by LightWayTxtTextInternal::Font::merge().

void MWAWFont::getColor ( MWAWColor c) const [inline]

returns the font color

Referenced by MarinerWrtGraph::sendRule(), and MoreText::sendText().

std::string MWAWFont::getDebugString ( shared_ptr< MWAWFontConverter > &  converter) const

returns a string which can be used for debugging

Referenced by ZWrtTextInternal::HFZone::getDebugString(), MsWrdText::prepareData(), BeagleWksSSParser::readCellSheet(), RagTimeText::readCharProperties(), MacWrtProStructures::readCharStyles(), MoreText::readCustomListLevel(), LightWayTxtText::readDocumentHF(), MsWksDBParser::readFieldTypes(), MacDocParser::readFont(), ClarisDrawText::readFont(), ClarisWksStyleManager::readFont(), HanMacWrdKText::readFont(), MsWks4Text::readFont(), LightWayTxtText::readFont2(), LightWayTxtText::readFonts(), RagTimeText::readFonts(), MarinerWrtText::readFonts(), HanMacWrdJText::readFonts(), MindWrtParser::readFonts(), NisusWrtText::readFonts(), MacWrtProStructures::readFontsDef(), MacDrawProStyleManager::readFontStyles(), DocMkrText::readFooter(), BeagleWksDBParser::readFormat(), MsWksDBParser::readForms(), MsWksDBParser::readFormTypes(), ActaParser::readHFProperties(), MacWrtParser::readInformations(), MacDraftParser::readLabel(), MacDraftParser::readObject(), MacDrawParser::readObject(), MsWrdTextStyles::readPLC(), MsWrd1Parser::readPLC(), ClarisWksDbaseContent::readRecordSSV1(), MsWksDBParser::readReportHeader(), RagTimeSpreadsheet::readResource(), ZWrtText::readSectionFonts(), SuperPaintParser::readShape(), RagTimeSpreadsheet::readSpreadsheetCellFormat(), RagTimeSpreadsheet::readSpreadsheetCellV2(), WingzParser::readSpreadsheetStyle(), MsWksSSParser::readSSheetZone(), BeagleWksDRParser::readStyle(), MacWrtProStructures::readStyle(), TeachTxtParser::readStyles(), GreatWksSSParser::readStyles(), DocMkrText::readStyles(), MsWksTable::readTable(), MacWrtParser::readText(), MsWksGraph::readText(), ActaText::readTopic(), MsWksDBParser::readUnknownV2(), GreatWksText::readZone(), WriteNowText::send(), GreatWksText::sendSimpleTextbox(), ActaText::sendText(), and MsWks3Text::sendText().

Line const& MWAWFont::getOverline ( ) const [inline]

returns the overline

Referenced by LightWayTxtTextInternal::Font::merge().

bool MWAWFont::hasColor ( ) const [inline]

returns true if the font color is not black

Referenced by getDebugString().

bool MWAWFont::hasDecorationLines ( ) const [inline]

return true if the font has decorations line (overline, strikeout, underline)

void MWAWFont::insert ( MWAWFont const &  ft) [inline]

inserts the set value in the current font

Referenced by MsWrdStruct::Font::insert().

bool MWAWFont::isSet ( ) const [inline]

returns true if the font id is initialized

Referenced by MWAWFont::Script::str().

std::string const& MWAWFont::language ( ) const [inline]

returns the language

bool MWAWFont::operator!= ( MWAWFont const &  f) const [inline]

operator!=

bool MWAWFont::operator== ( MWAWFont const &  f) const [inline]

operator==

void MWAWFont::resetColor ( ) [inline]

resets the font color to black and the background color to white

Referenced by MWAWFont(), and setFont().

void MWAWFont::resetDecorationLines ( ) [inline]

reset the decoration

Script const& MWAWFont::script ( ) const [inline]

returns the script position

Referenced by cmp(), and LightWayTxtTextInternal::Font::merge().

void MWAWFont::setFlags ( uint32_t  fl) [inline]

sets the font attributes bold, ...

Referenced by BeagleWksTextInternal::Font::getFont(), insert(), LightWayTxtTextInternal::Font::merge(), MsWksSSParser::readCell(), BeagleWksSSParser::readCellSheet(), RagTimeText::readCharProperties(), MoreText::readCustomListLevel(), LightWayTxtText::readDocumentHF(), MsWksDBParser::readFieldTypes(), MsWksDBParser::readFieldTypesV2(), MacDocParser::readFont(), MsWrdTextStyles::readFont(), MsWrd1Parser::readFont(), ActaText::readFont(), ClarisDrawText::readFont(), ClarisWksStyleManager::readFont(), HanMacWrdJText::readFont(), GreatWksText::readFont(), HanMacWrdKText::readFont(), MsWks3Text::readFont(), WriteNowText::readFont(), MsWks4Text::readFont(), MsWksGraph::readFont(), MacWrtProStructures::readFont(), LightWayTxtText::readFont2(), LightWayTxtText::readFonts(), RagTimeText::readFonts(), MarinerWrtText::readFonts(), MindWrtParser::readFonts(), NisusWrtText::readFonts(), WriterPlsParser::readFonts(), MacDrawProStyleManager::readFontStyles(), BeagleWksDBParser::readFormat(), MsWksDBParser::readFormTypes(), ActaParser::readHFProperties(), ZWrtText::readHFZone(), MacWrtParser::readInformations(), MacDraftParser::readLabel(), MacDraftParser::readObject(), MacDrawParser::readObject(), MoreText::readOutline(), ClarisWksDbaseContent::readRecordSSV1(), MsWksDBParser::readReportHeader(), ZWrtText::readSectionFonts(), SuperPaintParser::readShape(), RagTimeSpreadsheet::readSpreadsheetCellV2(), WingzParser::readSpreadsheetStyle(), BeagleWksDRParser::readStyle(), TeachTxtParser::readStyles(), GreatWksSSParser::readStyles(), DocMkrText::readStyles(), MsWksTable::readTable(), MacWrtParser::readText(), FullWrtText::send(), EDocParser::sendIndex(), GreatWksText::sendSimpleTextbox(), MoreText::sendText(), DocMkrText::sendTOC(), and MsWrdStruct::Font::updateFontToFinalState().

void MWAWFont::setFont ( int  newId) [inline]

sets the font id and resets size to the previous size for this font

Referenced by MsWksGraph::readFont(), BeagleWksDRParser::sendText(), SuperPaintParser::sendText(), and MacDrawProParser::sendText().

void MWAWFont::setId ( int  newId) [inline]

sets the font id

Referenced by MsWrdTextStyles::getFont(), BeagleWksText::getFont(), MarinerWrtTextInternal::Zone::getFont(), BeagleWksSSParser::readCellSheet(), RagTimeText::readCharProperties(), MoreText::readCustomListLevel(), LightWayTxtText::readDocumentHF(), MsWksDBParser::readFieldTypes(), MacDocParser::readFont(), MsWrdTextStyles::readFont(), MsWrd1Parser::readFont(), ActaText::readFont(), ClarisDrawText::readFont(), ClarisWksStyleManager::readFont(), HanMacWrdJText::readFont(), GreatWksText::readFont(), HanMacWrdKText::readFont(), MsWks3Text::readFont(), WriteNowText::readFont(), MsWks4Text::readFont(), MacWrtProStructures::readFont(), LightWayTxtText::readFonts(), RagTimeText::readFonts(), MindWrtParser::readFonts(), NisusWrtText::readFonts(), WriterPlsParser::readFonts(), MacDrawProStyleManager::readFontStyles(), DocMkrText::readFooter(), BeagleWksDBParser::readFormat(), MsWksDBParser::readForms(), MsWksDBParser::readFormTypes(), ActaParser::readHFProperties(), ZWrtText::readHFZone(), MacWrtParser::readInformations(), MacDraftParser::readLabel(), FullWrtText::readLineHeader(), MacDraftParser::readObject(), MacDrawParser::readObject(), MoreText::readOutline(), ClarisWksDbaseContent::readRecordSSV1(), MsWksDBParser::readReportHeader(), MarinerWrtText::readRulers(), ZWrtText::readSectionFonts(), SuperPaintParser::readShape(), RagTimeSpreadsheet::readSpreadsheetCellV2(), WingzParser::readSpreadsheetStyle(), BeagleWksDRParser::readStyle(), TeachTxtParser::readStyles(), GreatWksSSParser::readStyles(), DocMkrText::readStyles(), MsWks4Text::readText(), MacWrtParser::readText(), MsWksDBParser::readUnknownV2(), FullWrtText::send(), FullWrtText::sendHiddenItem(), GreatWksText::sendSimpleTextbox(), MoreText::sendText(), MWAWTextListener::setFont(), MWAWPresentationListener::setFont(), MWAWGraphicListener::setFont(), MWAWSpreadsheetListener::setFont(), and MsWrdTextStyles::setProperty().

void MWAWFont::setLanguage ( std::string const &  lang) [inline]

set the language ( in the for en_US, en_GB, en, ...)

Referenced by MacWrtProStructures::readFont(), and RagTimeText::readFonts().

void MWAWFont::setOverline ( Line const &  line) [inline]
void MWAWFont::setOverlineColor ( MWAWColor const &  color) [inline]

sets the overline color

Referenced by LightWayTxtText::readFont2().

void MWAWFont::setOverlineStyle ( Line::Style  style = Line::None,
bool  doReset = true 
) [inline]

sets the overline style ( by default, we also reset the style)

Referenced by HanMacWrdJText::readFont(), HanMacWrdKText::readFont(), LightWayTxtText::readFont2(), NisusWrtText::readFonts(), and FullWrtText::send().

sets the overline type

Referenced by LightWayTxtText::readFont2().

void MWAWFont::setOverlineWidth ( float  w) [inline]
void MWAWFont::setOverlineWordFlag ( bool  wordFlag = false) [inline]

sets the overline word flag

void MWAWFont::setSize ( float  sz) [inline]

sets the font size

Referenced by MsWrdTextStyles::getFont(), BeagleWksSSParser::readCellSheet(), RagTimeText::readCharProperties(), MoreText::readCustomListLevel(), LightWayTxtText::readDocumentHF(), MsWksDBParser::readFieldTypes(), MacDocParser::readFont(), MsWrdTextStyles::readFont(), MsWrd1Parser::readFont(), ActaText::readFont(), ClarisDrawText::readFont(), ClarisWksStyleManager::readFont(), HanMacWrdJText::readFont(), GreatWksText::readFont(), HanMacWrdKText::readFont(), MsWks3Text::readFont(), WriteNowText::readFont(), MsWks4Text::readFont(), MsWksGraph::readFont(), MacWrtProStructures::readFont(), LightWayTxtText::readFonts(), RagTimeText::readFonts(), MarinerWrtText::readFonts(), MindWrtParser::readFonts(), NisusWrtText::readFonts(), WriterPlsParser::readFonts(), MacDrawProStyleManager::readFontStyles(), DocMkrText::readFooter(), BeagleWksDBParser::readFormat(), MsWksDBParser::readForms(), MsWksDBParser::readFormTypes(), ActaParser::readHFProperties(), ZWrtText::readHFZone(), MacWrtParser::readInformations(), MacDraftParser::readLabel(), FullWrtText::readLineHeader(), MacDraftParser::readObject(), MacDrawParser::readObject(), MoreText::readOutline(), ClarisWksDbaseContent::readRecordSSV1(), MsWksDBParser::readReportHeader(), MarinerWrtText::readRulers(), ZWrtText::readSectionFonts(), SuperPaintParser::readShape(), RagTimeSpreadsheet::readSpreadsheetCellV2(), WingzParser::readSpreadsheetStyle(), BeagleWksDRParser::readStyle(), TeachTxtParser::readStyles(), GreatWksSSParser::readStyles(), DocMkrText::readStyles(), MacWrtParser::readText(), MsWksDBParser::readUnknownV2(), FullWrtText::send(), FullWrtText::sendHiddenItem(), GreatWksText::sendSimpleTextbox(), MoreText::sendText(), MWAWTextListener::setFont(), MWAWPresentationListener::setFont(), MWAWGraphicListener::setFont(), MWAWSpreadsheetListener::setFont(), and MsWrdTextStyles::setProperty().

void MWAWFont::setStrikeOut ( Line const &  line) [inline]

sets the strikeoutline

Referenced by LightWayTxtTextInternal::Font::merge().

void MWAWFont::setStrikeOutColor ( MWAWColor const &  color) [inline]

sets the strikeoutline color

Referenced by LightWayTxtText::readFont2().

void MWAWFont::setStrikeOutWidth ( float  w) [inline]

sets the strikeoutline width

Referenced by LightWayTxtText::readFont2().

void MWAWFont::setStrikeOutWordFlag ( bool  wordFlag = false) [inline]

sets the strikeoutline word flag

void MWAWFont::setTexteWidthScaling ( float  scale = 1.0) [inline]

sets the text width scaling

Referenced by HanMacWrdJText::readFont(), and HanMacWrdKText::readFont().

void MWAWFont::setUnderline ( Line const &  line) [inline]
void MWAWFont::setUnderlineColor ( MWAWColor const &  color) [inline]

sets the underline color

Referenced by WriteNowText::readFont(), and LightWayTxtText::readFont2().

void MWAWFont::setUnderlineStyle ( Line::Style  style = Line::None,
bool  doReset = true 
) [inline]

sets the underline style ( by default, we also reset the style)

Referenced by BeagleWksTextInternal::Font::getFont(), MsWksSSParser::readCell(), BeagleWksSSParser::readCellSheet(), RagTimeText::readCharProperties(), MoreText::readCustomListLevel(), LightWayTxtText::readDocumentHF(), MsWksDBParser::readFieldTypes(), MsWksDBParser::readFieldTypesV2(), MacDocParser::readFont(), MsWrdTextStyles::readFont(), MsWrd1Parser::readFont(), ActaText::readFont(), ClarisDrawText::readFont(), ClarisWksStyleManager::readFont(), HanMacWrdJText::readFont(), GreatWksText::readFont(), HanMacWrdKText::readFont(), MsWks3Text::readFont(), WriteNowText::readFont(), MsWks4Text::readFont(), MsWksGraph::readFont(), MacWrtProStructures::readFont(), LightWayTxtText::readFont2(), LightWayTxtText::readFonts(), RagTimeText::readFonts(), MarinerWrtText::readFonts(), MindWrtParser::readFonts(), NisusWrtText::readFonts(), WriterPlsParser::readFonts(), MacDrawProStyleManager::readFontStyles(), BeagleWksDBParser::readFormat(), MsWksDBParser::readFormTypes(), ActaParser::readHFProperties(), ZWrtText::readHFZone(), MacWrtParser::readInformations(), MacDraftParser::readLabel(), MacDraftParser::readObject(), MacDrawParser::readObject(), MoreText::readOutline(), ClarisWksDbaseContent::readRecordSSV1(), MsWksDBParser::readReportHeader(), ZWrtText::readSectionFonts(), SuperPaintParser::readShape(), RagTimeSpreadsheet::readSpreadsheetCellV2(), WingzParser::readSpreadsheetStyle(), BeagleWksDRParser::readStyle(), TeachTxtParser::readStyles(), GreatWksSSParser::readStyles(), DocMkrText::readStyles(), MsWksTable::readTable(), MacWrtParser::readText(), FullWrtText::send(), GreatWksText::sendSimpleTextbox(), MoreText::sendText(), and MsWrdStruct::Font::updateFontToFinalState().

void MWAWFont::setUnderlineWordFlag ( bool  wordFlag = false) [inline]
float MWAWFont::texteWidthScaling ( ) const [inline]

returns the text width scaling


Member Data Documentation

expand(> 0), condensed(< 0) depl in point

Referenced by addTo(), cmp(), deltaLetterSpacing(), getDebugString(), insert(), and setDeltaLetterSpacing().

MWAWVariable<uint32_t> MWAWFont::m_flags [protected]

font attributes

Referenced by addTo(), flags(), getDebugString(), insert(), and setFlags().

MWAWVariable<int> MWAWFont::m_id [protected]

font identificator

Referenced by id(), insert(), isSet(), setFont(), and setId().

MWAWVariable<std::string> MWAWFont::m_language [protected]

the language if set

Referenced by addTo(), cmp(), getDebugString(), language(), and setLanguage().

the sub/super script definition

Referenced by addTo(), getDebugString(), insert(), script(), and set().

MWAWVariable<float> MWAWFont::m_size [protected]

font size

Referenced by insert(), setSize(), and size().


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