Class to store font. More...

#include <MWAWFont.hxx>

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)
	set the letter spacing ( delta value in point )
float	texteWidthScaling () const
	returns the texte width scaling
void	setTexteWidthScaling (float scale=1.0)
	set the texte 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
	return the language
void	setLanguage (std::string const &lang)
	set the language ( in the for en_US, en_GB, en, ...)
void	addTo (WPXPropertyList &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
Variable< int >	m_id
	font identificator
Variable< float >	m_size
	font size
Variable< float >	m_deltaSpacing
	expand(>0), condensed(<0) depl in point
Variable< float >	m_texteWidthScaling
	the texte width scaling
Variable< Script >	m_scriptPosition
	the sub/super script definition
Variable< uint32_t >	m_flags
	font attributes
Variable< Line >	m_overline
	overline attributes
Variable< Line >	m_strikeoutline
	overline attributes
Variable< Line >	m_underline
	underline attributes
Variable< MWAWColor >	m_color
	font color
Variable< MWAWColor >	m_backgroundColor
	font background color
Variable< std::string >	m_language
	the language if set

Detailed Description

Class to store font.

Member Enumeration Documentation

enum MWAWFont::FontBits

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

newId	system id font
sz	the font size
f	the font attributes bold, ...

Member Function Documentation

void MWAWFont::addTo	(	WPXPropertyList &	propList,
		shared_ptr< MWAWFontConverter >	fontConverter
	)		const

add to the propList

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

uint32_t MWAWFont::flags ( ) const

inline

returns the font flags

Referenced by cmp(), insert(), LWTextInternal::Font::merge(), FWText::send(), and MSWStruct::Font::updateFontToFinalState().

void MWAWFont::getBackgroundColor ( MWAWColor & c ) const

inline

returns the font background color

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

void MWAWFont::getColor ( MWAWColor & c ) const

inline

returns the font color

Referenced by MRWGraph::sendRule().

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

returns a string which can be used for debugging

Referenced by ZWTextInternal::HFZone::getDebugString(), MSWText::prepareData(), CWText::readChar(), MWProStructures::readCharStyles(), LWText::readDocumentHF(), HMWKText::readFont(), MSK4Text::readFont(), LWText::readFont2(), LWText::readFonts(), MRWText::readFonts(), HMWJText::readFonts(), MDWParser::readFonts(), NSText::readFonts(), MWProStructures::readFontsDef(), DMText::readFooter(), ACParser::readHFProperties(), MWParser::readInformations(), MSWTextStyles::readParagraph(), MSWTextStyles::readPLC(), MSW1Parser::readPLC(), ZWText::readSectionFonts(), MWProStructures::readStyle(), TTParser::readStyles(), DMText::readStyles(), MSKGraph::readTable(), MWParser::readText(), MSKGraph::readText(), ACText::readTopic(), WNText::send(), ACText::sendText(), and MSK3Text::sendText().

Line const& MWAWFont::getOverline ( ) const

inline

returns the overline

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

Line const& MWAWFont::getStrikeOut ( ) const

inline

returns the strikeoutline

Referenced by LWTextInternal::Font::merge(), and MSWStruct::Font::updateFontToFinalState().

Line const& MWAWFont::getUnderline ( ) const

inline

returns the underline

Referenced by LWTextInternal::Font::merge(), MRWText::readFonts(), and MSWStruct::Font::updateFontToFinalState().

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)

int MWAWFont::id ( ) const

inline

returns the font id

Referenced by cmp(), getDebugString(), MSWTextStyles::getFont(), MSK4Text::readText(), MWAWContentListener::setFont(), and MSWTextStyles::setProperty().

void MWAWFont::insert ( MWAWFont const & ft )

inline

inserts the set value in the current font

Referenced by MSWStruct::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

return 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 LWTextInternal::Font::merge().

void MWAWFont::set ( Script const & newscript )

inline

void MWAWFont::setBackgroundColor ( MWAWColor color )

inline

sets the font background color

Referenced by LWTextInternal::Font::merge(), HMWJText::readFont(), HMWKText::readFont(), LWText::readFont2(), and MRWText::readFonts().

void MWAWFont::setColor ( MWAWColor color )

inline

sets the font color

Referenced by CWText::readChar(), LWText::readDocumentHF(), MSWTextStyles::readFont(), HMWJText::readFont(), HMWKText::readFont(), MSK3Text::readFont(), WNText::readFont(), MSK4Text::readFont(), MSKGraph::readFont(), MWProStructures::readFont(), LWText::readFonts(), MRWText::readFonts(), NSText::readFonts(), ZWText::readHFZone(), ZWText::readSectionFonts(), TTParser::readStyles(), DMText::readStyles(), MSKGraph::readTable(), and FWTextInternal::Font::update().

void MWAWFont::setDeltaLetterSpacing ( float d )

inline

set the letter spacing ( delta value in point )

Referenced by CWText::readChar(), LWText::readDocumentHF(), MSWTextStyles::readFont(), HMWJText::readFont(), HMWKText::readFont(), WNText::readFont(), MSK4Text::readFont(), MWProStructures::readFont(), LWText::readFonts(), MRWText::readFonts(), NSText::readFonts(), TTParser::readStyles(), and FWText::send().

void MWAWFont::setFlags ( uint32_t fl )

inline

void MWAWFont::setFont ( int newId )

inline

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

Referenced by MSKGraph::readFont().

void MWAWFont::setId ( int newId )

inline

void MWAWFont::setLanguage ( std::string const & lang )

inline

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

Referenced by MWProStructures::readFont().

void MWAWFont::setOverline ( Line const & line )

inline

sets the overline

Referenced by LWTextInternal::Font::merge(), and MRWText::readFonts().

void MWAWFont::setOverlineColor ( MWAWColor const & color )

inline

sets the overline color

Referenced by LWText::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 HMWJText::readFont(), HMWKText::readFont(), LWText::readFont2(), NSText::readFonts(), and FWText::send().

void MWAWFont::setOverlineType ( Line::Type type = Line::Single )

inline

sets the overline type

Referenced by LWText::readFont2().

void MWAWFont::setOverlineWidth ( float w )

inline

sets the overline width

Referenced by HMWJText::readFont(), HMWKText::readFont(), and LWText::readFont2().

void MWAWFont::setOverlineWordFlag ( bool wordFlag = false )

inline

sets the overline word flag

void MWAWFont::setSize ( float sz )

inline

void MWAWFont::setStrikeOut ( Line const & line )

inline

sets the strikeoutline

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

void MWAWFont::setStrikeOutColor ( MWAWColor const & color )

inline

sets the strikeoutline color

Referenced by LWText::readFont2().

void MWAWFont::setStrikeOutStyle	(	Line::Style	style = `Line::None`,
		bool	doReset = `true`
	)

inline

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

Referenced by CWText::readChar(), MSWTextStyles::readFont(), HMWJText::readFont(), HMWKText::readFont(), WNText::readFont(), MWProStructures::readFont(), LWText::readFont2(), MRWText::readFonts(), NSText::readFonts(), FWText::send(), and MSWStruct::Font::updateFontToFinalState().

void MWAWFont::setStrikeOutType ( Line::Type type = Line::Single )

inline

sets the strikeoutline type

Referenced by HMWJText::readFont(), HMWKText::readFont(), and LWText::readFont2().

void MWAWFont::setStrikeOutWidth ( float w )

inline

sets the strikeoutline width

Referenced by LWText::readFont2().

void MWAWFont::setStrikeOutWordFlag ( bool wordFlag = false )

inline

sets the strikeoutline word flag

void MWAWFont::setTexteWidthScaling ( float scale = 1.0 )

inline

set the texte width scaling

Referenced by HMWJText::readFont(), and HMWKText::readFont().

void MWAWFont::setUnderline ( Line const & line )

inline

sets the underline

Referenced by LWTextInternal::Font::merge(), and MRWText::readFonts().

void MWAWFont::setUnderlineColor ( MWAWColor const & color )

inline

sets the underline color

Referenced by WNText::readFont(), and LWText::readFont2().

void MWAWFont::setUnderlineStyle	(	Line::Style	style = `Line::None`,
		bool	doReset = `true`
	)

inline

void MWAWFont::setUnderlineType ( Line::Type type = Line::Single )

inline

sets the underline type

Referenced by CWText::readChar(), MSWTextStyles::readFont(), HMWJText::readFont(), HMWKText::readFont(), WNText::readFont(), MWProStructures::readFont(), LWText::readFont2(), MRWText::readFonts(), and FWText::send().

void MWAWFont::setUnderlineWidth ( float w )

inline

sets the underline width

Referenced by HMWJText::readFont(), HMWKText::readFont(), WNText::readFont(), and LWText::readFont2().

void MWAWFont::setUnderlineWordFlag ( bool wordFlag = false )

inline

sets the underline word flag

Referenced by MSWTextStyles::readFont(), MRWText::readFonts(), NSText::readFonts(), and FWText::send().

float MWAWFont::size ( ) const

inline

returns the font size

Referenced by addTo(), cmp(), getDebugString(), MSWTextStyles::getFont(), MSWStruct::operator<<(), HMWJText::readFont(), HMWKText::readFont(), MWProStructures::readFont(), LWText::readFonts(), ZWText::readSectionFonts(), FWText::send(), MWAWContentListener::setFont(), and MSWTextStyles::setProperty().

float MWAWFont::texteWidthScaling ( ) const

inline

returns the texte width scaling

Member Data Documentation

Variable<MWAWColor> MWAWFont::m_backgroundColor

protected

font background color

Referenced by addTo(), cmp(), getBackgroundColor(), getDebugString(), resetColor(), and setBackgroundColor().

Variable<MWAWColor> MWAWFont::m_color

protected

font color

Referenced by addTo(), cmp(), getColor(), getDebugString(), hasColor(), insert(), resetColor(), and setColor().

Variable<float> MWAWFont::m_deltaSpacing

protected

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

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

std::string MWAWFont::m_extra

extra data

Referenced by getDebugString(), insert(), LWTextInternal::Font::merge(), ACText::readFont(), HMWJText::readFont(), HMWKText::readFont(), WNText::readFont(), MWProStructures::readFont(), LWText::readFont2(), LWText::readFonts(), WPParser::readFonts(), TTParser::readStyles(), and DMText::readStyles().

Variable<uint32_t> MWAWFont::m_flags

protected

font attributes

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

Variable<int> MWAWFont::m_id

protected

font identificator

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

Variable<std::string> MWAWFont::m_language

protected

the language if set

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

Variable<Line> MWAWFont::m_overline

protected

overline attributes

Referenced by addTo(), cmp(), getDebugString(), getOverline(), hasDecorationLines(), insert(), resetDecorationLines(), setOverline(), setOverlineColor(), setOverlineStyle(), setOverlineType(), setOverlineWidth(), and setOverlineWordFlag().

Variable<Script> MWAWFont::m_scriptPosition

protected

the sub/super script definition

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

Variable<float> MWAWFont::m_size

protected

font size

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

Variable<Line> MWAWFont::m_strikeoutline

protected

overline attributes

Referenced by addTo(), cmp(), getDebugString(), getStrikeOut(), hasDecorationLines(), insert(), resetDecorationLines(), setStrikeOut(), setStrikeOutColor(), setStrikeOutStyle(), setStrikeOutType(), setStrikeOutWidth(), and setStrikeOutWordFlag().

Variable<float> MWAWFont::m_texteWidthScaling

protected

the texte width scaling

Referenced by addTo(), cmp(), getDebugString(), insert(), setTexteWidthScaling(), and texteWidthScaling().

Variable<Line> MWAWFont::m_underline

protected

underline attributes

Referenced by addTo(), cmp(), getDebugString(), getUnderline(), hasDecorationLines(), insert(), resetDecorationLines(), setUnderline(), setUnderlineColor(), setUnderlineStyle(), setUnderlineType(), setUnderlineWidth(), and setUnderlineWordFlag().

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

Classes

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation