filters

#include <excel.h>

Inheritance diagram for Swinder::XFRecord:
Swinder::Record

Public Types

enum  {
  General = 0 , Left , Centered , Right ,
  Filled , Justified , CenteredSelection , Distributed
}
 
enum  {
  Top = 0 , VCentered = 1 , Bottom = 2 , VJustified = 3 ,
  VDistributed = 4
}
 
enum  {
  NoLine = 0 , Thin = 1 , Medium = 2 , Dashed = 3 ,
  Dotted = 4 , Thick = 5 , Double = 6 , Hair = 7 ,
  MediumDashed = 8 , ThinDashDotted = 9 , MediumDashDotted = 10 , ThinDashDotDotted = 11 ,
  MediumDashDotDotted = 12 , SlantedMediumDashDotted = 13
}
 

Public Member Functions

unsigned int rtti ()
 
 XFRecord ()
 
 XFRecord (const XFRecord &xf)
 
XFRecord & operator= (const XFRecord &xf)
 
 ~XFRecord ()
 
unsigned fontIndex () const
 
void setFontIndex (unsigned fi)
 
unsigned formatIndex () const
 
void setFormatIndex (unsigned fi)
 
bool locked () const
 
void setLocked (bool l)
 
bool formulaHidden () const
 
void setFormulaHidden (bool f)
 
unsigned parentStyle () const
 
void setParentStyle (unsigned ps)
 
unsigned horizontalAlignment () const
 
void setHorizontalAlignment (unsigned ha)
 
const char * horizontalAlignmentAsString () const
 
unsigned verticalAlignment () const
 
void setVerticalAlignment (unsigned va)
 
const char * verticalAlignmentAsString () const
 
bool textWrap () const
 
void setTextWrap (bool wrap)
 
unsigned rotationAngle () const
 
void setRotationAngle (unsigned angle)
 
bool stackedLetters () const
 
void setStackedLetters (bool stacked)
 
unsigned indentLevel () const
 
void setIndentLevel (unsigned i)
 
bool shrinkContent () const
 
void setShrinkContent (bool s)
 
unsigned leftBorderStyle () const
 
void setLeftBorderStyle (unsigned style)
 
unsigned leftBorderColor () const
 
void setLeftBorderColor (unsigned color)
 
unsigned rightBorderStyle () const
 
void setRightBorderStyle (unsigned style)
 
unsigned rightBorderColor () const
 
void setRightBorderColor (unsigned color)
 
unsigned topBorderStyle () const
 
void setTopBorderStyle (unsigned style)
 
unsigned topBorderColor () const
 
void setTopBorderColor (unsigned color)
 
unsigned bottomBorderStyle () const
 
void setBottomBorderStyle (unsigned style)
 
unsigned bottomBorderColor () const
 
void setBottomBorderColor (unsigned color)
 
bool diagonalTopLeft () const
 
void setDiagonalTopLeft (bool d)
 
bool diagonalBottomLeft () const
 
void setDiagonalBottomLeft (bool d)
 
unsigned diagonalStyle () const
 
void setDiagonalStyle (unsigned style)
 
unsigned diagonalColor () const
 
void setDiagonalColor (unsigned color)
 
unsigned fillPattern () const
 
void setFillPattern (unsigned pattern)
 
unsigned patternForeColor () const
 
void setPatternForeColor (unsigned color)
 
unsigned patternBackColor () const
 
void setPatternBackColor (unsigned color)
 
virtual const char * name ()
 
virtual void setData (unsigned size, const unsigned char *data)
 
virtual void dump (std::ostream &out) const
 
- Public Member Functions inherited from Swinder::Record
 Record ()
 
virtual ~Record ()
 
void setVersion (unsigned v)
 
unsigned version ()
 
void setPosition (unsigned pos)
 
unsigned position () const
 

Static Public Attributes

static const unsigned int id = 0x00e0
 
- Static Public Attributes inherited from Swinder::Record
static const unsigned int id = 0
 

Additional Inherited Members

- Static Public Member Functions inherited from Swinder::Record
static Record * create (unsigned type)
 
- Protected Attributes inherited from Swinder::Record
unsigned stream_position
 
unsigned ver
 

Detailed Description

Class XFRecord holds information of XF (eXtended Format) which specifies many kind of properties of a specific cell.

It will be referred by record derived from CellInfo, in the member function xfIndex().

Definition at line 2687 of file excel.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Definition at line 2797 of file excel.h.

◆ anonymous enum

anonymous enum

Definition at line 2823 of file excel.h.

◆ anonymous enum

anonymous enum

Definition at line 2925 of file excel.h.

Constructor & Destructor Documentation

◆ XFRecord() [1/2]

XFRecord::XFRecord ( )

Creates a new XF record.

Definition at line 4203 of file excel.cpp.

◆ XFRecord() [2/2]

XFRecord::XFRecord ( const XFRecord &  xf)

Creates a copy of XF record.

Definition at line 4240 of file excel.cpp.

◆ ~XFRecord()

XFRecord::~XFRecord ( )

Destroy the record.

Definition at line 4235 of file excel.cpp.

Member Function Documentation

◆ bottomBorderColor()

unsigned XFRecord::bottomBorderColor ( ) const

Returns the color for bottom border.

This is an index to color palette specified in Palette record.

See also
setBottomBorderColor, bottomBorderStyle

Definition at line 4499 of file excel.cpp.

◆ bottomBorderStyle()

unsigned XFRecord::bottomBorderStyle ( ) const

Returns the line style for bottom border.

See also
setBottomBorderStyle, bottomBorderColor

Definition at line 4489 of file excel.cpp.

◆ diagonalBottomLeft()

bool XFRecord::diagonalBottomLeft ( ) const

Returns true if there is a diagonal line from bottom left to right top.

See also
diagonalStyle, diagonalColor, setDiagonalBottomLeft

Definition at line 4519 of file excel.cpp.

◆ diagonalColor()

unsigned XFRecord::diagonalColor ( ) const

Returns the color for diagonal line.

This is an index to color palette specified in Palette record.

See also
setDiagonalColor, diagonalStyle

Definition at line 4539 of file excel.cpp.

◆ diagonalStyle()

unsigned XFRecord::diagonalStyle ( ) const

Returns the diagonal line style.

See also
diagonalTopLeft, diagonalBottomLeft, setDiagonalStyle

Definition at line 4529 of file excel.cpp.

◆ diagonalTopLeft()

bool XFRecord::diagonalTopLeft ( ) const

Returns true if there is a diagonal line from top left to right bottom.

See also
diagonalStyle, diagonalColor, setDiagonalTopLeft

Definition at line 4509 of file excel.cpp.

◆ dump()

void XFRecord::dump ( std::ostream &  out) const
virtual

Dumps record information to output stream.

For debugging only.

Reimplemented from Swinder::Record.

Definition at line 4657 of file excel.cpp.

◆ fillPattern()

unsigned XFRecord::fillPattern ( ) const

Returns fill pattern.

See also
setFillPattern

Definition at line 4549 of file excel.cpp.

◆ fontIndex()

unsigned XFRecord::fontIndex ( ) const

Gets the index of the font for use in this XFormat.

The index refers to the font table.

See also
setFontIndex, FontRecord

Definition at line 4278 of file excel.cpp.

◆ formatIndex()

unsigned XFRecord::formatIndex ( ) const

Gets the index of the number format for use in this XFormat.

The index refers to the format table.

See also
setFormatIndex, FormatRecord

Definition at line 4288 of file excel.cpp.

◆ formulaHidden()

bool XFRecord::formulaHidden ( ) const

Returns true if the formula of the cells using this format should be hidden from user.

See also
setFormulaHidden

Definition at line 4308 of file excel.cpp.

◆ horizontalAlignment()

unsigned XFRecord::horizontalAlignment ( ) const

Gets the horizontal alignment, e.g Left.

Definition at line 4328 of file excel.cpp.

◆ horizontalAlignmentAsString()

const char * XFRecord::horizontalAlignmentAsString ( ) const

Returns human-readable string representation of the horizontal alignment.

For example, XFRecord::Left will return "Left".

Definition at line 4338 of file excel.cpp.

◆ indentLevel()

unsigned XFRecord::indentLevel ( ) const

Returns indent level.

See also
indentLevel

Definition at line 4409 of file excel.cpp.

◆ leftBorderColor()

unsigned XFRecord::leftBorderColor ( ) const

Returns the color for left border.

This is an index to color palette specified in Palette record.

See also
setLeftBorderColor, leftBorderStyle

Definition at line 4439 of file excel.cpp.

◆ leftBorderStyle()

unsigned XFRecord::leftBorderStyle ( ) const

Returns the line style for left border.

See also
setLeftBorderStyle, leftBorderColor

Definition at line 4429 of file excel.cpp.

◆ locked()

bool XFRecord::locked ( ) const

Returns true if the cells using this format should be locked.

See also
setLocked

Definition at line 4298 of file excel.cpp.

◆ name()

virtual const char * Swinder::XFRecord::name ( )
inlinevirtual

Returns the name of the record.

For debugging only.

Reimplemented from Swinder::Record.

Definition at line 3167 of file excel.h.

◆ operator=()

XFRecord & XFRecord::operator= ( const XFRecord &  xf)

Assigns from another XF record.

Definition at line 4246 of file excel.cpp.

◆ parentStyle()

unsigned XFRecord::parentStyle ( ) const

Returns the index of the parent stlye of this format.

This refers to the index of the XFormat table which is constructed from a series of XFormat records.

See also
setParentStyle

Definition at line 4318 of file excel.cpp.

◆ patternBackColor()

unsigned XFRecord::patternBackColor ( ) const

Returns the fill background color.

This is an index to color palette specified in Palette record.

See also
setPatternBackColor, patternForeColor

Definition at line 4569 of file excel.cpp.

◆ patternForeColor()

unsigned XFRecord::patternForeColor ( ) const

Returns the fill foreground color.

This is an index to color palette specified in Palette record.

See also
setPatternForeColor, patternBackColor

Definition at line 4559 of file excel.cpp.

◆ rightBorderColor()

unsigned XFRecord::rightBorderColor ( ) const

Returns the color for right border.

This is an index to color palette specified in Palette record.

See also
setRightBorderColor, rightBorderStyle

Definition at line 4459 of file excel.cpp.

◆ rightBorderStyle()

unsigned XFRecord::rightBorderStyle ( ) const

Returns the line style for right border.

See also
setRightBorderStyle, rightBorderColor

Definition at line 4449 of file excel.cpp.

◆ rotationAngle()

unsigned XFRecord::rotationAngle ( ) const

Returns the rotation angle of the text.

If it is between 1 to 90, the text is rotated 1 to 90 degrees counterclockwise. If it is between 91 to 180, the text is rotated 1 to 90 degrees clockwise.

See also
setRotationAngle

Definition at line 4389 of file excel.cpp.

◆ rtti()

unsigned int Swinder::XFRecord::rtti ( )
inlinevirtual

Reimplemented from Swinder::Record.

Definition at line 2693 of file excel.h.

◆ setBottomBorderColor()

void XFRecord::setBottomBorderColor ( unsigned  color)

Sets the color for bottom border.

This is an index to color palette specified in Palette record.

See also
bottomBorderColor, setBottomBorderStyle

Definition at line 4504 of file excel.cpp.

◆ setBottomBorderStyle()

void XFRecord::setBottomBorderStyle ( unsigned  style)

Sets the line style for bottom border.

See also
bottomBorderStyle, setBottomBorderColor

Definition at line 4494 of file excel.cpp.

◆ setData()

void XFRecord::setData ( unsigned  size,
const unsigned char *  data 
)
virtual

Sets the data for this record.

Reimplemented from Swinder::Record.

Definition at line 4579 of file excel.cpp.

◆ setDiagonalBottomLeft()

void XFRecord::setDiagonalBottomLeft ( bool  d)

Sets whether there should be a diagonal line from bottom left to right top.

See also
diagonalBottomLeft, setDiagonalStlye, setDiagonalColor

Definition at line 4524 of file excel.cpp.

◆ setDiagonalColor()

void XFRecord::setDiagonalColor ( unsigned  color)

Sets the color for diagonal line.

This is an index to color palette specified in Palette record.

See also
diagonalColor, setDiagonalStyle

Definition at line 4544 of file excel.cpp.

◆ setDiagonalStyle()

void XFRecord::setDiagonalStyle ( unsigned  style)

Sets the line style for diagonal line.

See also
diagonalBorderStyle, setDiagonalTopLeft, setDiagonalBottomLeft

Definition at line 4534 of file excel.cpp.

◆ setDiagonalTopLeft()

void XFRecord::setDiagonalTopLeft ( bool  d)

Sets whether there should be a diagonal line from top left to right bottom.

See also
diagonalTopLeft, setDiagonalStlye, setDiagonalColor

Definition at line 4514 of file excel.cpp.

◆ setFillPattern()

void XFRecord::setFillPattern ( unsigned  pattern)

Sets fill pattern.

See also
fillPattern

Definition at line 4554 of file excel.cpp.

◆ setFontIndex()

void XFRecord::setFontIndex ( unsigned  fi)

Sets the index of the font for use in this XFormat.

The index refers to the font table.

See also
fontIndex, FontRecord

Definition at line 4283 of file excel.cpp.

◆ setFormatIndex()

void XFRecord::setFormatIndex ( unsigned  fi)

Sets the index of the number format for use in this XFormat.

The index refers to the format table.

See also
formatIndex, FormatRecord

Definition at line 4293 of file excel.cpp.

◆ setFormulaHidden()

void XFRecord::setFormulaHidden ( bool  f)

Sets whether the formula of the cells using this format should be hidden or should be visible.

See also
formulaHidden

Definition at line 4313 of file excel.cpp.

◆ setHorizontalAlignment()

void XFRecord::setHorizontalAlignment ( unsigned  ha)

Sets the horizontal alignment, e.g Left.

Definition at line 4333 of file excel.cpp.

◆ setIndentLevel()

void XFRecord::setIndentLevel ( unsigned  i)

Sets indent level.

See also
indentLevel

Definition at line 4414 of file excel.cpp.

◆ setLeftBorderColor()

void XFRecord::setLeftBorderColor ( unsigned  color)

Sets the color for left border.

This is an index to color palette specified in Palette record.

See also
leftBorderColor, setLeftBorderStyle

Definition at line 4444 of file excel.cpp.

◆ setLeftBorderStyle()

void XFRecord::setLeftBorderStyle ( unsigned  style)

Sets the line style for left border.

See also
leftBorderStyle, setLeftBorderColor

Definition at line 4434 of file excel.cpp.

◆ setLocked()

void XFRecord::setLocked ( bool  l)

Sets whether the cells using this format should be locked or not.

See also
locked

Definition at line 4303 of file excel.cpp.

◆ setParentStyle()

void XFRecord::setParentStyle ( unsigned  ps)

Sets the index of the parent stlye of this format.

This refers to the index of the XFormat table which is constructed from a series of XFormat records.

See also
parentStyle

Definition at line 4323 of file excel.cpp.

◆ setPatternBackColor()

void XFRecord::setPatternBackColor ( unsigned  color)

Sets the fill background color.

This is an index to color palette specified in Palette record.

See also
patternBackColor, setPatternForeColor

Definition at line 4574 of file excel.cpp.

◆ setPatternForeColor()

void XFRecord::setPatternForeColor ( unsigned  color)

Sets the fill foreground color.

This is an index to color palette specified in Palette record.

See also
patternForeColor, setPatternBackColor

Definition at line 4564 of file excel.cpp.

◆ setRightBorderColor()

void XFRecord::setRightBorderColor ( unsigned  color)

Sets the color for right border.

This is an index to color palette specified in Palette record.

See also
rightBorderColor, setRightBorderStyle

Definition at line 4464 of file excel.cpp.

◆ setRightBorderStyle()

void XFRecord::setRightBorderStyle ( unsigned  style)

Sets the line style for right border.

See also
rightBorderStyle, setRightBorderColor

Definition at line 4454 of file excel.cpp.

◆ setRotationAngle()

void XFRecord::setRotationAngle ( unsigned  angle)

Sets the rotation angle of the text.

If it is between 1 to 90, the text is rotated 1 to 90 degrees counterclockwise. If it is between 91 to 180, the text is rotated 1 to 90 degrees clockwise.

See also
setRotationAngle

Definition at line 4394 of file excel.cpp.

◆ setShrinkContent()

void XFRecord::setShrinkContent ( bool  s)

Sets whether content should be shrunk to fit into cell.

See also
shrinkContent

Definition at line 4424 of file excel.cpp.

◆ setStackedLetters()

void XFRecord::setStackedLetters ( bool  stacked)

Sets whether the letters for text should be stacked top-to-bottom.

See also
stackedLetters

Definition at line 4404 of file excel.cpp.

◆ setTextWrap()

void XFRecord::setTextWrap ( bool  wrap)

Sets whether text should be wrapped at right border.

See also
textWrap

Definition at line 4384 of file excel.cpp.

◆ setTopBorderColor()

void XFRecord::setTopBorderColor ( unsigned  color)

Sets the color for top border.

This is an index to color palette specified in Palette record.

See also
topBorderColor, setTopBorderStyle

Definition at line 4484 of file excel.cpp.

◆ setTopBorderStyle()

void XFRecord::setTopBorderStyle ( unsigned  style)

Sets the line style for top border.

See also
topBorderStyle, setTopBorderColor

Definition at line 4474 of file excel.cpp.

◆ setVerticalAlignment()

void XFRecord::setVerticalAlignment ( unsigned  va)

Sets the vertical alignment, e.g Top.

See also
verticalAlignment

Definition at line 4359 of file excel.cpp.

◆ shrinkContent()

bool XFRecord::shrinkContent ( ) const

Returns true if content should be shrunk to fit into cell.

See also
setShrinkContent

Definition at line 4419 of file excel.cpp.

◆ stackedLetters()

bool XFRecord::stackedLetters ( ) const

Returns true if the letters for text are not rotated, but instead stacked top-to-bottom.

See also
setStackedLetters

Definition at line 4399 of file excel.cpp.

◆ textWrap()

bool XFRecord::textWrap ( ) const

Returns true if text is wrapped at right border.

See also
setTextWrap

Definition at line 4379 of file excel.cpp.

◆ topBorderColor()

unsigned XFRecord::topBorderColor ( ) const

Returns the color for top border.

This is an index to color palette specified in Palette record.

See also
setTopBorderColor, topBorderStyle

Definition at line 4479 of file excel.cpp.

◆ topBorderStyle()

unsigned XFRecord::topBorderStyle ( ) const

Returns the line style for top border.

See also
setTopBorderStyle, topBorderColor

Definition at line 4469 of file excel.cpp.

◆ verticalAlignment()

unsigned XFRecord::verticalAlignment ( ) const

Gets the vertical alignment, e.g Bottom.

See also
setVerticalAlignment

Definition at line 4354 of file excel.cpp.

◆ verticalAlignmentAsString()

const char * XFRecord::verticalAlignmentAsString ( ) const

Returns human-readable string representation of the vertical alignment.

For example, XFRecord::Top will return "Top".

Definition at line 4364 of file excel.cpp.

Member Data Documentation

◆ id

const unsigned int XFRecord::id = 0x00e0
static

Definition at line 2691 of file excel.h.


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