filters

Swinder::XFRecord Class Reference

#include <excel.h>

Inheritance diagram for Swinder::XFRecord:

Swinder::Record List of all members.

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.


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

Static Public Attributes

static const unsigned int id

Constructor & Destructor Documentation

XFRecord::XFRecord (  ) 

Creates a new XF record.

Definition at line 4203 of file excel.cpp.

XFRecord::XFRecord ( const XFRecord xf  ) 

Creates a copy of XF record.

Definition at line 4240 of file excel.cpp.

XFRecord::~XFRecord (  ) 

Destroy the record.

Definition at line 4235 of file excel.cpp.


Member Function Documentation

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

Assigns from another XF record.

Definition at line 4246 of file excel.cpp.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

unsigned XFRecord::horizontalAlignment (  )  const

Gets the horizontal alignment, e.g Left.

Definition at line 4328 of file excel.cpp.

void XFRecord::setHorizontalAlignment ( unsigned  ha  ) 

Sets the horizontal alignment, e.g Left.

Definition at line 4333 of file excel.cpp.

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.

unsigned XFRecord::verticalAlignment (  )  const

Gets the vertical alignment, e.g Bottom.

See also:
setVerticalAlignment

Definition at line 4354 of file excel.cpp.

void XFRecord::setVerticalAlignment ( unsigned  va  ) 

Sets the vertical alignment, e.g Top.

See also:
verticalAlignment

Definition at line 4359 of file excel.cpp.

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.

bool XFRecord::textWrap (  )  const

Returns true if text is wrapped at right border.

See also:
setTextWrap

Definition at line 4379 of file excel.cpp.

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.

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.

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.

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.

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.

unsigned XFRecord::indentLevel (  )  const

Returns indent level.

See also:
indentLevel

Definition at line 4409 of file excel.cpp.

void XFRecord::setIndentLevel ( unsigned  i  ) 

Sets indent level.

See also:
indentLevel

Definition at line 4414 of file excel.cpp.

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.

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.

unsigned XFRecord::leftBorderStyle (  )  const

Returns the line style for left border.

See also:
setLeftBorderStyle, leftBorderColor

Definition at line 4429 of file excel.cpp.

void XFRecord::setLeftBorderStyle ( unsigned  style  ) 

Sets the line style for left border.

See also:
leftBorderStyle, setLeftBorderColor

Definition at line 4434 of file excel.cpp.

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.

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.

unsigned XFRecord::rightBorderStyle (  )  const

Returns the line style for right border.

See also:
setRightBorderStyle, rightBorderColor

Definition at line 4449 of file excel.cpp.

void XFRecord::setRightBorderStyle ( unsigned  style  ) 

Sets the line style for right border.

See also:
rightBorderStyle, setRightBorderColor

Definition at line 4454 of file excel.cpp.

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.

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.

unsigned XFRecord::topBorderStyle (  )  const

Returns the line style for top border.

See also:
setTopBorderStyle, topBorderColor

Definition at line 4469 of file excel.cpp.

void XFRecord::setTopBorderStyle ( unsigned  style  ) 

Sets the line style for top border.

See also:
topBorderStyle, setTopBorderColor

Definition at line 4474 of file excel.cpp.

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.

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.

unsigned XFRecord::bottomBorderStyle (  )  const

Returns the line style for bottom border.

See also:
setBottomBorderStyle, bottomBorderColor

Definition at line 4489 of file excel.cpp.

void XFRecord::setBottomBorderStyle ( unsigned  style  ) 

Sets the line style for bottom border.

See also:
bottomBorderStyle, setBottomBorderColor

Definition at line 4494 of file excel.cpp.

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.

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.

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.

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.

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.

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.

unsigned XFRecord::diagonalStyle (  )  const

Returns the diagonal line style.

See also:
diagonalTopLeft, diagonalBottomLeft, setDiagonalStyle

Definition at line 4529 of file excel.cpp.

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.

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.

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.

unsigned XFRecord::fillPattern (  )  const

Returns fill pattern.

See also:
setFillPattern

Definition at line 4549 of file excel.cpp.

void XFRecord::setFillPattern ( unsigned  pattern  ) 

Sets fill pattern.

See also:
fillPattern

Definition at line 4554 of file excel.cpp.

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.

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.

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.

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.

virtual const char* Swinder::XFRecord::name (  )  [inline, virtual]

Returns the name of the record.

For debugging only.

Reimplemented from Swinder::Record.

Definition at line 3167 of file excel.h.

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.

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.


Member Data Documentation

const unsigned int XFRecord::id [static]

Static ID of the record.

Subclasses should override this value with the id of the record they handle.

Reimplemented from Swinder::Record.

Definition at line 2691 of file excel.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys