MWAWCell Class Reference

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

#include <MWAWCell.hxx>

Inheritance diagram for MWAWCell:
BeagleWksDBParserInternal::Cell BeagleWksSSParserInternal::Cell ClarisWksTableInternal::TableCell GreatWksDBParserInternal::Cell GreatWksSSParserInternal::Cell HanMacWrdJGraphInternal::TableCell HanMacWrdKGraphInternal::TableCell JazzSSParserInternal::Cell MacWrtProStructuresInternal::Cell MsWksDBParserInternal::FieldType MsWksSSParserInternal::Cell RagTimeSpreadsheetInternal::Cell WingzParserInternal::Cell WriteNowTextInternal::Cell

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
 
 MWAWCell (MWAWCell const &)=default
 
MWAWCelloperator= (MWAWCell const &)=default
 
MWAWCelloperator= (MWAWCell &&)=default
 
virtual ~MWAWCell ()
 destructor
 
void addTo (librevenge::RVNGPropertyList &propList, std::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
 
double rotation () const
 returns the rotation angle in degree
 
void setRotation (double angle)
 sets the rotation angle
 
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 getBasicCellName (MWAWVec2i const &pos)
 return the name of a cell (given row and column) : 0,0 -> A1, 0,1 -> A2...
 
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
 
double m_rotation
 the content's rotation in degree
 
MWAWColor m_backgroundColor
 the backgroung color
 
bool m_protected
 cell protected
 
std::vector< MWAWBorderm_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

◆ 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 

◆ FormatType

the different format of a cell's content

Enumerator
F_TEXT 
F_BOOLEAN 
F_NUMBER 
F_DATE 
F_TIME 
F_UNKNOWN 

◆ 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 

◆ 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 

◆ 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() [1/2]

MWAWCell::MWAWCell ( )
inline

constructor

◆ MWAWCell() [2/2]

MWAWCell::MWAWCell ( MWAWCell const &  )
default

◆ ~MWAWCell()

virtual MWAWCell::~MWAWCell ( )
inlinevirtual

destructor

Member Function Documentation

◆ addTo()

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

◆ backgroundColor()

MWAWColor MWAWCell::backgroundColor ( ) const
inline

returns the background color

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

◆ bdBox()

◆ bdSize()

MWAWVec2f const & MWAWCell::bdSize ( ) const
inline

bdbox size accessor

◆ borders()

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

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

◆ extraLine()

ExtraLine MWAWCell::extraLine ( ) const
inline

◆ extraLineType()

MWAWBorder const & MWAWCell::extraLineType ( ) const
inline

returns the extra line border

Referenced by MWAWTable::sendExtraLines().

◆ getBasicCellName()

std::string MWAWCell::getBasicCellName ( MWAWVec2i const &  pos)
static

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

Referenced by RagTime5Spreadsheet::send(), BeagleWksDBParser::sendDatabase(), GreatWksDBParser::sendDatabase(), and ClarisWksDatabase::sendDatabase().

◆ getCellName()

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]

◆ getColumnName()

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

return the column name

◆ getFont()

MWAWFont MWAWCell::getFont ( ) const
inline

returns the font

Referenced by RagTimeSpreadsheet::send(), and MultiplanParser::sendCell().

◆ getFormat()

◆ hAlignment()

HorizontalAlignment MWAWCell::hAlignment ( ) const
inline

returns the horizontal alignment

Referenced by addTo().

◆ hasBorders()

bool MWAWCell::hasBorders ( ) const
inline

◆ hasExtraLine()

bool MWAWCell::hasExtraLine ( ) const
inline

returns true if we have some extra lines

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

◆ isFontSet()

bool MWAWCell::isFontSet ( ) const
inline

returns true if the font has been set

◆ isProtected()

bool MWAWCell::isProtected ( ) const
inline

returns true if the cell is protected

Referenced by addTo().

◆ numSpannedCells()

MWAWVec2i const & MWAWCell::numSpannedCells ( ) const
inline

returns the number of spanned cells

Referenced by addTo().

◆ operator=() [1/2]

MWAWCell & MWAWCell::operator= ( MWAWCell &&  )
default

◆ operator=() [2/2]

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

◆ position()

◆ resetBorders()

void MWAWCell::resetBorders ( )
inline

reset the border

◆ rotation()

double MWAWCell::rotation ( ) const
inline

returns the rotation angle in degree

◆ send()

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()

◆ sendContent()

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 MacWrtProStructuresInternal::Cell, ClarisWksTableInternal::TableCell, HanMacWrdJGraphInternal::TableCell, HanMacWrdKGraphInternal::TableCell, and WriteNowTextInternal::Cell.

Referenced by send().

◆ setBackgroundColor()

◆ setBdBox()

void MWAWCell::setBdBox ( MWAWBox2f  box)
inline

◆ setBdSize()

void MWAWCell::setBdSize ( MWAWVec2f  sz)
inline

set the bdbox size(unit point)

◆ setBorders()

◆ setExtraLine()

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

sets the extraline

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

◆ setFont()

◆ setFormat()

◆ setHAlignment()

◆ setNumSpannedCells()

void MWAWCell::setNumSpannedCells ( MWAWVec2i  numSpanned)
inline

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

Referenced by RagTime5Spreadsheet::send().

◆ setPosition()

◆ setProtected()

void MWAWCell::setProtected ( bool  fl)
inline

◆ setRotation()

void MWAWCell::setRotation ( double  angle)
inline

sets the rotation angle

Referenced by RagTime5Spreadsheet::send().

◆ setVAlignment()

void MWAWCell::setVAlignment ( VerticalAlignment  align)
inline

sets the vertical alignment

Referenced by RagTime5Spreadsheet::send(), and ClarisWksSpreadsheet::sendSpreadsheetAsTable().

◆ vAlignment()

VerticalAlignment MWAWCell::vAlignment ( ) const
inline

returns the vertical alignment

Referenced by addTo().

Friends And Related Function Documentation

◆ operator<<

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

operator<<

Member Data Documentation

◆ m_backgroundColor

MWAWColor MWAWCell::m_backgroundColor
protected

the backgroung color

Referenced by backgroundColor(), and setBackgroundColor().

◆ m_bdBox

MWAWBox2f MWAWCell::m_bdBox
protected

the cell bounding box (unit in point)

Referenced by bdBox(), and setBdBox().

◆ m_bdSize

MWAWVec2f MWAWCell::m_bdSize
protected

the cell bounding size : unit point

Referenced by bdSize(), and setBdSize().

◆ m_bordersList

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

the cell border MWAWBorder::Pos

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

◆ m_extraLine

ExtraLine MWAWCell::m_extraLine
protected

extra line

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

◆ m_extraLineType

MWAWBorder MWAWCell::m_extraLineType
protected

extra line type

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

◆ m_font

MWAWFont MWAWCell::m_font
protected

the cell font

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

◆ m_fontSet

bool MWAWCell::m_fontSet
protected

a flag to know if the font has been set

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

◆ m_format

◆ m_hAlign

HorizontalAlignment MWAWCell::m_hAlign
protected

the cell alignment : by default nothing

Referenced by hAlignment(), and setHAlignment().

◆ m_numberCellSpanned

MWAWVec2i MWAWCell::m_numberCellSpanned
protected

the cell spanned : by default (1,1)

Referenced by numSpannedCells(), and setNumSpannedCells().

◆ m_position

MWAWVec2i MWAWCell::m_position
protected

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

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

◆ m_protected

bool MWAWCell::m_protected
protected

cell protected

Referenced by isProtected(), and setProtected().

◆ m_rotation

double MWAWCell::m_rotation
protected

the content's rotation in degree

Referenced by addTo(), rotation(), and setRotation().

◆ m_vAlign

VerticalAlignment MWAWCell::m_vAlign
protected

the vertical cell alignment : by default nothing

Referenced by setVAlignment(), and vAlignment().


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