a structure used to define a cell and its format More...

#include <MWAWCell.hxx>

Inheritance diagram for MWAWCell:

Classes
struct	CompareFormat
	a comparaison structure used to store data More...
struct	Format
	a structure uses to define the format of a cell content More...
Public Types
enum	FormatType { F_TEXT, F_BOOLEAN, F_NUMBER, F_DATE, F_TIME, F_UNKNOWN }
	the different format of a cell's content More...
enum	NumberType { F_NUMBER_CURRENCY, F_NUMBER_DECIMAL, F_NUMBER_FRACTION, F_NUMBER_GENERIC, F_NUMBER_SCIENTIFIC, F_NUMBER_PERCENT, F_NUMBER_UNKNOWN }
	the different number format of a cell's content More...
enum	HorizontalAlignment { HALIGN_LEFT, HALIGN_RIGHT, HALIGN_CENTER, HALIGN_FULL, HALIGN_DEFAULT }
	the default horizontal alignment. More...
enum	VerticalAlignment { VALIGN_TOP, VALIGN_CENTER, VALIGN_BOTTOM, VALIGN_DEFAULT }
	the default vertical alignment. More...
enum	ExtraLine { E_None, E_Line1, E_Line2, E_Cross }
	an enum to defined potential internal line: E_Line1=TL to RB, E_Line2=BL to RT More...
Public Member Functions
	MWAWCell ()
	constructor
virtual	~MWAWCell ()
	destructor
void	addTo (librevenge::RVNGPropertyList &propList, shared_ptr< MWAWFontConverter > fontConverter) const
	adds to the propList
virtual bool	send (MWAWListenerPtr listener, MWAWTable &table)
	function called when a cell is send by MWAWTable to send a cell to a listener.
virtual bool	sendContent (MWAWListenerPtr listener, MWAWTable &table)
	function called when the content of a cell must be send to the listener, ie.
MWAWVec2i const &	position () const
	position accessor
void	setPosition (MWAWVec2i posi)
	set the cell positions : 0,0 -> A1, 0,1 -> A2
MWAWVec2i const &	numSpannedCells () const
	returns the number of spanned cells
void	setNumSpannedCells (MWAWVec2i numSpanned)
	sets the number of spanned cells : MWAWVec2i(1,1) means 1 cellule
MWAWBox2f const &	bdBox () const
	bdbox accessor
void	setBdBox (MWAWBox2f box)
	set the bdbox (unit point)
MWAWVec2f const &	bdSize () const
	bdbox size accessor
void	setBdSize (MWAWVec2f sz)
	set the bdbox size(unit point)
Format const &	getFormat () const
	returns the cell format
void	setFormat (Format const &format)
	set the cell format
bool	isFontSet () const
	returns true if the font has been set
MWAWFont	getFont () const
	returns the font
void	setFont (MWAWFont const &font, bool isDefault=false)
	sets the fonts
bool	isProtected () const
	returns true if the cell is protected
void	setProtected (bool fl)
	sets the cell's protected flag
HorizontalAlignment	hAlignment () const
	returns the horizontal alignment
void	setHAlignment (HorizontalAlignment align)
	sets the horizontal alignment
VerticalAlignment	vAlignment () const
	returns the vertical alignment
void	setVAlignment (VerticalAlignment align)
	sets the vertical alignment
bool	hasBorders () const
	return true if the cell has some border
std::vector< MWAWBorder > const &	borders () const
	return the cell border: libmwaw::Left \| ...
void	resetBorders ()
	reset the border
void	setBorders (int wh, MWAWBorder const &border)
	sets the cell border: wh=libmwaw::LeftBit\|...
MWAWColor	backgroundColor () const
	returns the background color
void	setBackgroundColor (MWAWColor color)
	sets the background color
bool	hasExtraLine () const
	returns true if we have some extra lines
ExtraLine	extraLine () const
	returns the extra lines
MWAWBorder const &	extraLineType () const
	returns the extra line border
void	setExtraLine (ExtraLine extrLine, MWAWBorder const &type=MWAWBorder())
	sets the extraline
Static Public Member Functions
static std::string	getCellName (MWAWVec2i const &pos, MWAWVec2b const &absolute)
	return the name of a cell (given row and column) : 0,0 -> A1, 0,1 -> A2
static std::string	getColumnName (int col)
	return the column name
Protected Attributes
MWAWVec2i	m_position
	the cell row and column : 0,0 -> A1, 0,1 -> A2
MWAWVec2i	m_numberCellSpanned
	the cell spanned : by default (1,1)
MWAWBox2f	m_bdBox
	the cell bounding box (unit in point)
MWAWVec2f	m_bdSize
	the cell bounding size : unit point
Format	m_format
	the cell format
MWAWFont	m_font
	the cell font
bool	m_fontSet
	a flag to know if the font has been set
HorizontalAlignment	m_hAlign
	the cell alignment : by default nothing
VerticalAlignment	m_vAlign
	the vertical cell alignment : by default nothing
MWAWColor	m_backgroundColor
	the backgroung color
bool	m_protected
	cell protected
std::vector< MWAWBorder >	m_bordersList
	the cell border MWAWBorder::Pos
ExtraLine	m_extraLine
	extra line
MWAWBorder	m_extraLineType
	extra line type
Friends
std::ostream &	operator<< (std::ostream &o, MWAWCell const &cell)
	operator<<

Detailed Description

a structure used to define a cell and its format

Member Enumeration Documentation

enum MWAWCell::ExtraLine

an enum to defined potential internal line: E_Line1=TL to RB, E_Line2=BL to RT

Enumerator:

E_None
E_Line1
E_Line2
E_Cross

enum MWAWCell::FormatType

the different format of a cell's content

Enumerator:

F_TEXT
F_BOOLEAN
F_NUMBER
F_DATE
F_TIME
F_UNKNOWN

enum MWAWCell::HorizontalAlignment

the default horizontal alignment.

Note:: actually mainly used for table/spreadsheet cell, FULL is not yet implemented

Enumerator:

HALIGN_LEFT
HALIGN_RIGHT
HALIGN_CENTER
HALIGN_FULL
HALIGN_DEFAULT

enum MWAWCell::NumberType

the different number format of a cell's content

Enumerator:

F_NUMBER_CURRENCY
F_NUMBER_DECIMAL
F_NUMBER_FRACTION
F_NUMBER_GENERIC
F_NUMBER_SCIENTIFIC
F_NUMBER_PERCENT
F_NUMBER_UNKNOWN

enum MWAWCell::VerticalAlignment

the default vertical alignment.

Note:: actually mainly used for table/spreadsheet cell, not yet implemented

Enumerator:

VALIGN_TOP
VALIGN_CENTER
VALIGN_BOTTOM
VALIGN_DEFAULT

Constructor & Destructor Documentation

MWAWCell::MWAWCell ( ) [inline]

constructor

virtual MWAWCell::~MWAWCell ( ) [inline, virtual]

destructor

Member Function Documentation

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

adds to the propList

Referenced by MWAWSpreadsheetListener::openSheetCell(), MWAWTextListener::openTableCell(), MWAWPresentationListener::openTableCell(), MWAWGraphicListener::openTableCell(), and MWAWSpreadsheetListener::openTableCell().

MWAWColor MWAWCell::backgroundColor ( ) const [inline]

returns the background color

Referenced by addTo(), and BeagleWksSSParser::readCellSheet().

MWAWBox2f const& MWAWCell::bdBox ( ) const [inline]

bdbox accessor

Referenced by MWAWTableInternal::Compare::Point::getPos(), MWAWTableInternal::Compare::Point::getSize(), and MWAWTableInternal::Compare::operator()().

MWAWVec2f const& MWAWCell::bdSize ( ) const [inline]

bdbox size accessor

std::vector<MWAWBorder> const& MWAWCell::borders ( ) const [inline]

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

ExtraLine MWAWCell::extraLine ( ) const [inline]

returns the extra lines

Referenced by MWAWTable::sendExtraLines(), and HanMacWrdJGraphInternal::TableCell::update().

MWAWBorder const& MWAWCell::extraLineType ( ) const [inline]

returns the extra line border

Referenced by MWAWTable::sendExtraLines().

std::string MWAWCell::getCellName	(	MWAWVec2i const &	pos,
		MWAWVec2b const &	absolute
	)		`[static]`

return the name of a cell (given row and column) : 0,0 -> A1, 0,1 -> A2

Referenced by operator<<().

std::string MWAWCell::getColumnName ( int col ) [static]

return the column name

MWAWFont MWAWCell::getFont ( ) const [inline]

returns the font

Referenced by RagTimeSpreadsheet::send(), BeagleWksDBParser::sendDatabase(), MsWksDBParser::sendDatabase(), WingzParser::sendSpreadsheet(), BeagleWksSSParser::sendSpreadsheet(), and MsWksSSParser::sendSpreadsheet().

Format const& MWAWCell::getFormat ( ) const [inline]

returns the cell format

Referenced by MWAWSpreadsheetListener::openSheetCell(), MsWksDBParser::readDefaultValues(), GreatWksDBParser::readFormulaResult(), RagTimeSpreadsheet::readSpreadsheetCellContent(), RagTimeSpreadsheet::send(), RagTimeSpreadsheetInternal::CellFormat::update(), BeagleWksDBParserInternal::Database::updateWithContent(), and MsWksDBParserInternal::FieldType::updateWithContent().

HorizontalAlignment MWAWCell::hAlignment ( ) const [inline]

returns the horizontal alignment

Referenced by addTo().

bool MWAWCell::hasBorders ( ) const [inline]

return true if the cell has some border

Referenced by MsWksSSParserInternal::Cell::isEmpty(), GreatWksSSParserInternal::Cell::isEmpty(), and GreatWksDBParserInternal::Cell::isEmpty().

bool MWAWCell::hasExtraLine ( ) const [inline]

returns true if we have some extra lines

Referenced by MWAWTable::sendExtraLines(), and HanMacWrdJGraphInternal::TableCell::update().

bool MWAWCell::isFontSet ( ) const [inline]

returns true if the font has been set

Referenced by BeagleWksSSParser::sendSpreadsheet(), and MsWksSSParser::sendSpreadsheet().

bool MWAWCell::isProtected ( ) const [inline]

returns true if the cell is protected

Referenced by addTo().

MWAWVec2i const& MWAWCell::numSpannedCells ( ) const [inline]

returns the number of spanned cells

Referenced by addTo(), and operator<<().

MWAWVec2i const& MWAWCell::position ( ) const [inline]

position accessor

Referenced by addTo(), RagTimeSpreadsheetInternal::Spreadsheet::getRightBottomPosition(), BeagleWksSSParser::readCellSheet(), RagTimeSpreadsheet::readSpreadsheetCellContent(), RagTimeSpreadsheet::readSpreadsheetCellFormat(), RagTimeSpreadsheet::readSpreadsheetCellV2(), RagTimeSpreadsheet::send(), GreatWksSSParser::sendSpreadsheet(), WingzParser::sendSpreadsheet(), BeagleWksSSParser::sendSpreadsheet(), MsWksSSParser::sendSpreadsheet(), and WingzParserInternal::Spreadsheet::update().

void MWAWCell::resetBorders ( ) [inline]

reset the border

bool MWAWCell::send	(	MWAWListenerPtr	listener,
		MWAWTable &	table
	)		`[virtual]`

function called when a cell is send by MWAWTable to send a cell to a listener.

By default: calls openTableCell(*this), sendContent and then closeTableCell()

bool MWAWCell::sendContent	(	MWAWListenerPtr	listener,
		MWAWTable &	table
	)		`[virtual]`

function called when the content of a cell must be send to the listener, ie.

when MWAWTable::sendTable or MWAWTable::sendAsText is called.

Note:: default behavior: does nothing and prints an error in debug mode.

Reimplemented in WriteNowTextInternal::Cell, MacWrtProStructuresInternal::Cell, HanMacWrdKGraphInternal::TableCell, HanMacWrdJGraphInternal::TableCell, and ClarisWksTableInternal::TableCell.

Referenced by send().

void MWAWCell::setBackgroundColor ( MWAWColor color ) [inline]

sets the background color

Referenced by MacWrtProStructuresInternal::Cell::Cell(), BeagleWksSSParser::readCellSheet(), WingzParser::readSpreadsheetCellList(), GreatWksSSParser::sendSpreadsheet(), ClarisWksSpreadsheet::sendSpreadsheet(), MsWksTable::sendTable(), MsWrdText::sendTable(), HanMacWrdJGraphInternal::TableCell::update(), MarinerWrtTextInternal::Paragraph::update(), RagTimeSpreadsheetInternal::CellExtra::update(), and WriteNowTextInternal::TableData::updateCell().

void MWAWCell::setBdBox ( MWAWBox2f box ) [inline]

set the bdbox (unit point)

Referenced by MacWrtProStructuresInternal::Cell::Cell(), and WriteNowTextInternal::TableData::updateCell().

void MWAWCell::setBdSize ( MWAWVec2f sz ) [inline]

set the bdbox size(unit point)

void MWAWCell::setBorders	(	int	wh,
		MWAWBorder const &	border
	)

sets the cell border: wh=libmwaw::LeftBit|...

Referenced by MacWrtProStructuresInternal::Cell::Cell(), GreatWksSSParser::readCell(), MsWksSSParser::readCell(), BeagleWksSSParser::readCellSheet(), WingzParser::readSpreadsheetCellList(), RagTimeSpreadsheet::readSpreadsheetCellV2(), ClarisWksSpreadsheet::sendSpreadsheet(), MsWksTable::sendTable(), FullWrtText::sendTable(), MsWrdText::sendTable(), ClarisWksTableInternal::TableCell::update(), HanMacWrdJGraphInternal::TableCell::update(), MarinerWrtTextInternal::Paragraph::update(), RagTimeSpreadsheetInternal::CellBorder::update(), and WriteNowTextInternal::TableData::updateCell().

void MWAWCell::setExtraLine	(	ExtraLine	extrLine,
		MWAWBorder const &	type = `MWAWBorder()`
	)		`[inline]`

sets the extraline

Referenced by HanMacWrdJGraphInternal::TableCell::update().

void MWAWCell::setFont	(	MWAWFont const &	font,
		bool	isDefault = `false`
	)		`[inline]`

sets the fonts

Referenced by MsWksSSParser::readCell(), BeagleWksSSParser::readCellSheet(), MsWksDBParser::readFieldTypes(), MsWksDBParser::readFieldTypesV2(), BeagleWksDBParser::readFormat(), RagTimeSpreadsheet::readSpreadsheetCellFormat(), WingzParser::readSpreadsheetCellList(), RagTimeSpreadsheet::readSpreadsheetCellV2(), GreatWksSSParser::sendSpreadsheet(), and ClarisWksSpreadsheet::sendSpreadsheet().

void MWAWCell::setFormat ( Format const & format ) [inline]

set the cell format

Referenced by GreatWksSSParser::readCell(), MsWksSSParser::readCell(), BeagleWksSSParser::readCellSheet(), GreatWksDBParser::readFieldRecords(), MsWksDBParser::readFieldTypes(), MsWksDBParser::readFieldTypesV2(), BeagleWksDBParser::readFormat(), GreatWksDBParser::readFormulaResult(), GreatWksDBParser::readRowRecords(), RagTimeSpreadsheet::readSpreadsheetCellContent(), WingzParser::readSpreadsheetCellList(), RagTimeSpreadsheet::readSpreadsheetCellV2(), ClarisWksDatabase::sendDatabase(), ClarisWksSpreadsheet::sendSpreadsheet(), and RagTimeSpreadsheetInternal::CellFormat::update().

void MWAWCell::setHAlignment ( HorizontalAlignment align ) [inline]

sets the horizontal alignment

Referenced by GreatWksSSParser::readCell(), MsWksSSParser::readCell(), BeagleWksSSParser::readCellSheet(), MsWksDBParser::readFieldTypes(), MsWksDBParser::readFieldTypesV2(), BeagleWksDBParser::readFormat(), WingzParser::readSpreadsheetCellList(), RagTimeSpreadsheet::readSpreadsheetCellV2(), ClarisWksDatabase::sendDatabase(), ClarisWksSpreadsheet::sendSpreadsheet(), and RagTimeSpreadsheetInternal::CellFormat::update().

void MWAWCell::setNumSpannedCells ( MWAWVec2i numSpanned ) [inline]

sets the number of spanned cells : MWAWVec2i(1,1) means 1 cellule

void MWAWCell::setPosition ( MWAWVec2i posi ) [inline]

set the cell positions : 0,0 -> A1, 0,1 -> A2

Referenced by BeagleWksSSParserInternal::Cell::Cell(), BeagleWksDBParserInternal::Cell::Cell(), WingzParserInternal::Cell::Cell(), RagTimeSpreadsheetInternal::Cell::Cell(), GreatWksSSParser::readCell(), MsWksSSParser::readCell(), RagTimeSpreadsheet::readSpreadsheetCellsV2(), RagTimeSpreadsheet::readSpreadsheetComplexStructure(), GreatWksDBParser::sendDatabase(), ClarisWksDatabase::sendDatabase(), ClarisWksSpreadsheet::sendSpreadsheet(), ClarisWksSpreadsheet::sendSpreadsheetAsTable(), MsWksTable::sendTable(), MarinerWrtText::sendTable(), FullWrtText::sendTable(), MsWrdText::sendTable(), WriterPlsParser::sendWindow(), BeagleWksDBParserInternal::Database::updateWithContent(), and MsWksDBParserInternal::FieldType::updateWithContent().

void MWAWCell::setProtected ( bool fl ) [inline]

sets the cell's protected flag

Referenced by GreatWksSSParser::readCell(), MsWksSSParser::readCell(), and RagTimeSpreadsheetInternal::CellFormat::update().

void MWAWCell::setVAlignment ( VerticalAlignment align ) [inline]

sets the vertical alignment

Referenced by ClarisWksSpreadsheet::sendSpreadsheetAsTable().

VerticalAlignment MWAWCell::vAlignment ( ) const [inline]

returns the vertical alignment

Referenced by addTo().

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	o,
		MWAWCell const &	cell
	)		`[friend]`

operator<<

Member Data Documentation

MWAWColor MWAWCell::m_backgroundColor [protected]

the backgroung color

Referenced by backgroundColor(), operator<<(), and setBackgroundColor().

MWAWBox2f MWAWCell::m_bdBox [protected]

the cell bounding box (unit in point)

Referenced by bdBox(), operator<<(), and setBdBox().

MWAWVec2f MWAWCell::m_bdSize [protected]

the cell bounding size : unit point

Referenced by bdSize(), operator<<(), and setBdSize().

std::vector<MWAWBorder> MWAWCell::m_bordersList [protected]

the cell border MWAWBorder::Pos

Referenced by addTo(), borders(), hasBorders(), operator<<(), resetBorders(), and setBorders().

ExtraLine MWAWCell::m_extraLine [protected]

extra line

Referenced by extraLine(), hasExtraLine(), operator<<(), and setExtraLine().

MWAWBorder MWAWCell::m_extraLineType [protected]

extra line type

Referenced by extraLineType(), hasExtraLine(), operator<<(), and setExtraLine().

MWAWFont MWAWCell::m_font [protected]

the cell font

Referenced by addTo(), getFont(), and setFont().

bool MWAWCell::m_fontSet [protected]

a flag to know if the font has been set

Referenced by addTo(), isFontSet(), operator<<(), and setFont().

Format MWAWCell::m_format [protected]

the cell format

Referenced by MWAWCell::Format::compare(), getFormat(), MWAWCell::Format::getNumberingProperties(), operator<<(), and setFormat().

HorizontalAlignment MWAWCell::m_hAlign [protected]

the cell alignment : by default nothing

Referenced by hAlignment(), operator<<(), and setHAlignment().

MWAWVec2i MWAWCell::m_numberCellSpanned [protected]

the cell spanned : by default (1,1)

Referenced by numSpannedCells(), and setNumSpannedCells().

MWAWVec2i MWAWCell::m_position [protected]

the cell row and column : 0,0 -> A1, 0,1 -> A2

Referenced by MWAWCellContent::FormulaInstruction::getPropertyList(), operator<<(), position(), and setPosition().

bool MWAWCell::m_protected [protected]

cell protected

Referenced by isProtected(), operator<<(), and setProtected().

VerticalAlignment MWAWCell::m_vAlign [protected]

the vertical cell alignment : by default nothing

Referenced by operator<<(), setVAlignment(), and vAlignment().

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation