WPSCellFormat Class Reference

a structure used to defined the cell format More...

#include <WPSCell.h>

Inheritance diagram for WPSCellFormat:
LotusSpreadsheetInternal::Style QuattroSpreadsheetInternal::Style WKS4SpreadsheetInternal::Style WPSCell LotusSpreadsheetInternal::Cell QuattroSpreadsheetInternal::Cell WKS4SpreadsheetInternal::Cell WPS8TableInternal::Cell

Classes

struct  CompareFormat
 a comparaison structure used to store data More...
 

Public Types

enum  HorizontalAlignment {
  HALIGN_LEFT, HALIGN_RIGHT, HALIGN_CENTER, HALIGN_FULL,
  HALIGN_DEFAULT
}
 the default horizontal alignement. More...
 
enum  VerticalAlignment { VALIGN_TOP, VALIGN_CENTER, VALIGN_BOTTOM, VALIGN_DEFAULT }
 the default vertical alignement. More...
 
enum  FormatType {
  F_TEXT, F_BOOLEAN, F_NUMBER, F_DATE,
  F_TIME, F_UNKNOWN
}
 the different types of cell's field More...
 

Public Member Functions

 WPSCellFormat ()
 constructor More...
 
virtual ~WPSCellFormat ()
 destructor More...
 
bool hasBasicFormat () const
 returns true if this is a basic format style More...
 
std::string getValueType () const
 returns a value type More...
 
void addTo (librevenge::RVNGPropertyList &propList) const
 add to the propList More...
 
bool getNumberingProperties (librevenge::RVNGPropertyList &propList) const
 get the number style More...
 
WPSFont const & getFont () const
 returns the font More...
 
void setFont (WPSFont const &font)
 sets the font More...
 
HorizontalAlignment hAlignement () const
 returns the horizontal alignement More...
 
void setHAlignement (HorizontalAlignment align)
 sets the horizontal alignement More...
 
VerticalAlignment vAlignement () const
 returns the vertical alignement More...
 
void setVAlignement (VerticalAlignment align)
 sets the vertical alignement More...
 
FormatType getFormat () const
 returns the format type More...
 
int getSubFormat () const
 returns the subformat type More...
 
std::string getDTFormat () const
 returns the date/time format ( if set) More...
 
void setFormat (FormatType form, int subForm=0)
 sets the format type More...
 
void setDTFormat (FormatType form, std::string const &dtFormat="")
 sets the format type More...
 
int digits () const
 returns the number of digits ( for a number) More...
 
void setDigits (int newDigit)
 set the number of digits ( for a number) More...
 
bool isProtected () const
 returns true if the cell is protected More...
 
void setProtected (bool fl)
 returns true if the cell is protected More...
 
bool hasBorders () const
 return true if the cell has some border More...
 
std::vector< WPSBorder > const & borders () const
 return the cell border: libwps::LeftBit | ... More...
 
void resetBorders ()
 reset the border More...
 
void setBorders (int wh, WPSBorder const &border)
 sets the cell border: wh=WPSBorder::LeftBit|... More...
 
void setBorders (std::vector< WPSBorder > const &newBorders)
 sets the cell borders More...
 
WPSColor backgroundColor () const
 returns the background color More...
 
void setBackgroundColor (WPSColor const &color)
 set the background color More...
 
int compare (WPSCellFormat const &cell, bool onlyNumbering=false) const
 a comparison function More...
 

Static Protected Member Functions

static bool convertDTFormat (std::string const &dtFormat, librevenge::RVNGPropertyListVector &propListVector)
 convert a DTFormat in a propertyList More...
 

Protected Attributes

WPSFont m_font
 the cell font ( used in spreadsheet code ) More...
 
HorizontalAlignment m_hAlign
 the cell alignement : by default nothing More...
 
VerticalAlignment m_vAlign
 the cell vertical alignement : by default nothing More...
 
std::vector< WPSBorderm_bordersList
 the cell border WPSBorder::Pos More...
 
FormatType m_format
 the cell format : by default unknown More...
 
int m_subFormat
 the sub format More...
 
std::string m_DTFormat
 a date/time format ( using a subset of strftime format ) More...
 
int m_digits
 the number of digits More...
 
bool m_protected
 cell protected More...
 
WPSColor m_backgroundColor
 the backgroung color More...
 

Friends

std::ostream & operator<< (std::ostream &o, WPSCellFormat const &cell)
 operator<< More...
 

Detailed Description

a structure used to defined the cell format

Member Enumeration Documentation

§ FormatType

the different types of cell's field

Enumerator
F_TEXT 
F_BOOLEAN 
F_NUMBER 
F_DATE 
F_TIME 
F_UNKNOWN 

§ HorizontalAlignment

the default horizontal alignement.

Note
actually mainly used for table/spreadsheet cell, FULL is not yet implemented
Enumerator
HALIGN_LEFT 
HALIGN_RIGHT 
HALIGN_CENTER 
HALIGN_FULL 
HALIGN_DEFAULT 

§ VerticalAlignment

the default vertical alignement.

Enumerator
VALIGN_TOP 
VALIGN_CENTER 
VALIGN_BOTTOM 
VALIGN_DEFAULT 

Constructor & Destructor Documentation

§ WPSCellFormat()

WPSCellFormat::WPSCellFormat ( )
inline

constructor

§ ~WPSCellFormat()

virtual WPSCellFormat::~WPSCellFormat ( )
inlinevirtual

destructor

Member Function Documentation

§ addTo()

void WPSCellFormat::addTo ( librevenge::RVNGPropertyList &  propList) const

add to the propList

Referenced by WPSCell::addTo(), hasBasicFormat(), and WPSCell::~WPSCell().

§ backgroundColor()

WPSColor WPSCellFormat::backgroundColor ( ) const
inline

returns the background color

Referenced by addTo().

§ borders()

std::vector<WPSBorder> const& WPSCellFormat::borders ( ) const
inline

return the cell border: libwps::LeftBit | ...

§ compare()

§ convertDTFormat()

bool WPSCellFormat::convertDTFormat ( std::string const &  dtFormat,
librevenge::RVNGPropertyListVector &  propListVector 
)
staticprotected

convert a DTFormat in a propertyList

Referenced by getNumberingProperties(), and WPSCellFormat::CompareFormat::operator()().

§ digits()

int WPSCellFormat::digits ( ) const
inline

returns the number of digits ( for a number)

§ getDTFormat()

std::string WPSCellFormat::getDTFormat ( ) const
inline

returns the date/time format ( if set)

Referenced by operator<<().

§ getFont()

§ getFormat()

FormatType WPSCellFormat::getFormat ( ) const
inline

returns the format type

Referenced by WKSContentListener::openSheetCell().

§ getNumberingProperties()

bool WPSCellFormat::getNumberingProperties ( librevenge::RVNGPropertyList &  propList) const

get the number style

Referenced by hasBasicFormat(), and WKSContentListener::openSheetCell().

§ getSubFormat()

int WPSCellFormat::getSubFormat ( ) const
inline

returns the subformat type

§ getValueType()

std::string WPSCellFormat::getValueType ( ) const

returns a value type

Referenced by hasBasicFormat(), and WKSContentListener::openSheetCell().

§ hAlignement()

HorizontalAlignment WPSCellFormat::hAlignement ( ) const
inline

returns the horizontal alignement

§ hasBasicFormat()

bool WPSCellFormat::hasBasicFormat ( ) const
inline

returns true if this is a basic format style

Referenced by WKSContentListener::openSheetCell().

§ hasBorders()

bool WPSCellFormat::hasBorders ( ) const
inline

return true if the cell has some border

§ isProtected()

bool WPSCellFormat::isProtected ( ) const
inline

returns true if the cell is protected

§ resetBorders()

void WPSCellFormat::resetBorders ( )
inline

reset the border

§ setBackgroundColor()

void WPSCellFormat::setBackgroundColor ( WPSColor const &  color)
inline

§ setBorders() [1/2]

§ setBorders() [2/2]

void WPSCellFormat::setBorders ( std::vector< WPSBorder > const &  newBorders)
inline

sets the cell borders

§ setDigits()

void WPSCellFormat::setDigits ( int  newDigit)
inline

set the number of digits ( for a number)

Referenced by LotusSpreadsheet::readRowFormat(), and QuattroSpreadsheetInternal::Cell::updateFormat().

§ setDTFormat()

void WPSCellFormat::setDTFormat ( FormatType  form,
std::string const &  dtFormat = "" 
)
inline

§ setFont()

§ setFormat()

void WPSCellFormat::setFormat ( FormatType  form,
int  subForm = 0 
)
inline

§ setHAlignement()

void WPSCellFormat::setHAlignement ( HorizontalAlignment  align)
inline

§ setProtected()

void WPSCellFormat::setProtected ( bool  fl)
inline

returns true if the cell is protected

§ setVAlignement()

void WPSCellFormat::setVAlignement ( VerticalAlignment  align)
inline

sets the vertical alignement

§ vAlignement()

VerticalAlignment WPSCellFormat::vAlignement ( ) const
inline

returns the vertical alignement

Referenced by addTo().

Friends And Related Function Documentation

§ operator<<

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

operator<<

Referenced by setBackgroundColor(), and WPSCell::setNumSpannedCells().

Member Data Documentation

§ m_backgroundColor

WPSColor WPSCellFormat::m_backgroundColor
protected

the backgroung color

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

§ m_bordersList

std::vector<WPSBorder> WPSCellFormat::m_bordersList
protected

§ m_digits

int WPSCellFormat::m_digits
protected

§ m_DTFormat

std::string WPSCellFormat::m_DTFormat
protected

a date/time format ( using a subset of strftime format )

Referenced by compare(), getDTFormat(), getNumberingProperties(), and setDTFormat().

§ m_font

WPSFont WPSCellFormat::m_font
protected

§ m_format

§ m_hAlign

HorizontalAlignment WPSCellFormat::m_hAlign
protected

the cell alignement : by default nothing

Referenced by addTo(), compare(), hAlignement(), operator<<(), and setHAlignement().

§ m_protected

bool WPSCellFormat::m_protected
protected

§ m_subFormat

§ m_vAlign

VerticalAlignment WPSCellFormat::m_vAlign
protected

the cell vertical alignement : by default nothing

Referenced by compare(), operator<<(), setVAlignement(), and vAlignement().


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

Generated on Wed Oct 26 2016 16:54:38 for libwps by doxygen 1.8.12