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 2584 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

Swinder::XFRecord::XFRecord  ) 
 

Creates a new XF record.

Swinder::XFRecord::XFRecord const XFRecord xf  ) 
 

Creates a copy of XF record.

Swinder::XFRecord::~XFRecord  ) 
 

Destroy the record.


Member Function Documentation

unsigned Swinder::XFRecord::bottomBorderColor  )  const
 

Returns the color for bottom border.

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

See also:
setBottomBorderColor, bottomBorderStyle

unsigned Swinder::XFRecord::bottomBorderStyle  )  const
 

Returns the line style for bottom border.

See also:
setBottomBorderStyle, bottomBorderColor

bool Swinder::XFRecord::diagonalBottomLeft  )  const
 

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

See also:
diagonalStyle, diagonalColor, setDiagonalBottomLeft

unsigned Swinder::XFRecord::diagonalColor  )  const
 

Returns the color for diagonal line.

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

See also:
setDiagonalColor, diagonalStyle

unsigned Swinder::XFRecord::diagonalStyle  )  const
 

Returns the diagonal line style.

See also:
diagonalTopLeft, diagonalBottomLeft, setDiagonalStyle

bool Swinder::XFRecord::diagonalTopLeft  )  const
 

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

See also:
diagonalStyle, diagonalColor, setDiagonalTopLeft

virtual void Swinder::XFRecord::dump std::ostream &  out  )  const [virtual]
 

Dumps record information to output stream.

For debugging only.

Reimplemented from Swinder::Record.

unsigned Swinder::XFRecord::fillPattern  )  const
 

Returns fill pattern.

See also:
setFillPattern

unsigned Swinder::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

unsigned Swinder::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

bool Swinder::XFRecord::formulaHidden  )  const
 

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

See also:
setFormulaHidden

unsigned Swinder::XFRecord::horizontalAlignment  )  const
 

Gets the horizontal alignment, e.g Left.

const char* Swinder::XFRecord::horizontalAlignmentAsString  )  const
 

Returns human-readable string representation of the horizontal alignment.

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

unsigned Swinder::XFRecord::indentLevel  )  const
 

Returns indent level.

See also:
indentLevel

unsigned Swinder::XFRecord::leftBorderColor  )  const
 

Returns the color for left border.

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

See also:
setLeftBorderColor, leftBorderStyle

unsigned Swinder::XFRecord::leftBorderStyle  )  const
 

Returns the line style for left border.

See also:
setLeftBorderStyle, leftBorderColor

bool Swinder::XFRecord::locked  )  const
 

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

See also:
setLocked

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

Returns the name of the record.

For debugging only.

Reimplemented from Swinder::Record.

Definition at line 3064 of file excel.h.

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

Assigns from another XF record.

unsigned Swinder::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

unsigned Swinder::XFRecord::patternBackColor  )  const
 

Returns the fill background color.

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

See also:
setPatternBackColor, patternForeColor

unsigned Swinder::XFRecord::patternForeColor  )  const
 

Returns the fill foreground color.

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

See also:
setPatternForeColor, patternBackColor

unsigned Swinder::XFRecord::rightBorderColor  )  const
 

Returns the color for right border.

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

See also:
setRightBorderColor, rightBorderStyle

unsigned Swinder::XFRecord::rightBorderStyle  )  const
 

Returns the line style for right border.

See also:
setRightBorderStyle, rightBorderColor

unsigned Swinder::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

void Swinder::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

void Swinder::XFRecord::setBottomBorderStyle unsigned  style  ) 
 

Sets the line style for bottom border.

See also:
bottomBorderStyle, setBottomBorderColor

virtual void Swinder::XFRecord::setData unsigned  size,
const unsigned char *  data
[virtual]
 

Sets the data for this record.

Reimplemented from Swinder::Record.

void Swinder::XFRecord::setDiagonalBottomLeft bool  d  ) 
 

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

See also:
diagonalBottomLeft, setDiagonalStlye, setDiagonalColor

void Swinder::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

void Swinder::XFRecord::setDiagonalStyle unsigned  style  ) 
 

Sets the line style for diagonal line.

See also:
diagonalBorderStyle, setDiagonalTopLeft, setDiagonalBottomLeft

void Swinder::XFRecord::setDiagonalTopLeft bool  d  ) 
 

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

See also:
diagonalTopLeft, setDiagonalStlye, setDiagonalColor

void Swinder::XFRecord::setFillPattern unsigned  pattern  ) 
 

Sets fill pattern.

See also:
fillPattern

void Swinder::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

void Swinder::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

void Swinder::XFRecord::setFormulaHidden bool  f  ) 
 

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

See also:
formulaHidden

void Swinder::XFRecord::setHorizontalAlignment unsigned  ha  ) 
 

Sets the horizontal alignment, e.g Left.

void Swinder::XFRecord::setIndentLevel unsigned  i  ) 
 

Sets indent level.

See also:
indentLevel

void Swinder::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

void Swinder::XFRecord::setLeftBorderStyle unsigned  style  ) 
 

Sets the line style for left border.

See also:
leftBorderStyle, setLeftBorderColor

void Swinder::XFRecord::setLocked bool  l  ) 
 

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

See also:
locked

void Swinder::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

void Swinder::XFRecord::setPatternBackColor unsigned  color  ) 
 

Sets the fill background color.

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

See also:
patternBackColor, setPatternForeColor

void Swinder::XFRecord::setPatternForeColor unsigned  color  ) 
 

Sets the fill foreground color.

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

See also:
patternForeColor, setPatternBackColor

void Swinder::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

void Swinder::XFRecord::setRightBorderStyle unsigned  style  ) 
 

Sets the line style for right border.

See also:
rightBorderStyle, setRightBorderColor

void Swinder::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

void Swinder::XFRecord::setShrinkContent bool  s  ) 
 

Sets whether content should be shrunk to fit into cell.

See also:
shrinkContent

void Swinder::XFRecord::setStackedLetters bool  stacked  ) 
 

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

See also:
stackedLetters

void Swinder::XFRecord::setTextWrap bool  wrap  ) 
 

Sets whether text should be wrapped at right border.

See also:
textWrap

void Swinder::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

void Swinder::XFRecord::setTopBorderStyle unsigned  style  ) 
 

Sets the line style for top border.

See also:
topBorderStyle, setTopBorderColor

void Swinder::XFRecord::setVerticalAlignment unsigned  va  ) 
 

Sets the vertical alignment, e.g Top.

See also:
verticalAlignment

bool Swinder::XFRecord::shrinkContent  )  const
 

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

See also:
setShrinkContent

bool Swinder::XFRecord::stackedLetters  )  const
 

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

See also:
setStackedLetters

bool Swinder::XFRecord::textWrap  )  const
 

Returns true if text is wrapped at right border.

See also:
setTextWrap

unsigned Swinder::XFRecord::topBorderColor  )  const
 

Returns the color for top border.

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

See also:
setTopBorderColor, topBorderStyle

unsigned Swinder::XFRecord::topBorderStyle  )  const
 

Returns the line style for top border.

See also:
setTopBorderStyle, topBorderColor

unsigned Swinder::XFRecord::verticalAlignment  )  const
 

Gets the vertical alignment, e.g Bottom.

See also:
setVerticalAlignment

const char* Swinder::XFRecord::verticalAlignmentAsString  )  const
 

Returns human-readable string representation of the vertical alignment.

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


Member Data Documentation

const unsigned int Swinder::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 2588 of file excel.h.


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