filters
Swinder::XFRecord Class Reference
#include <excel.h>
Inheritance diagram for Swinder::XFRecord:
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) | |
| 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 |
Static Public Attributes | |
| static const unsigned int | id |
Constructor & Destructor Documentation
| XFRecord::XFRecord | ( | const XFRecord & | xf | ) |
Member Function Documentation
| 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
| 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
| 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
| 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
| bool XFRecord::locked | ( | ) | const |
| void XFRecord::setLocked | ( | bool | l | ) |
| bool XFRecord::formulaHidden | ( | ) | const |
Returns true if the formula of the cells using this format should be hidden from user.
- See also:
- 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
| 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
| 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
| unsigned XFRecord::horizontalAlignment | ( | ) | const |
| void XFRecord::setHorizontalAlignment | ( | unsigned | ha | ) |
| const char * XFRecord::horizontalAlignmentAsString | ( | ) | const |
| unsigned XFRecord::verticalAlignment | ( | ) | const |
| void XFRecord::setVerticalAlignment | ( | unsigned | va | ) |
| const char * XFRecord::verticalAlignmentAsString | ( | ) | const |
| bool XFRecord::textWrap | ( | ) | const |
| void XFRecord::setTextWrap | ( | bool | wrap | ) |
| 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
| 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
| bool XFRecord::stackedLetters | ( | ) | const |
Returns true if the letters for text are not rotated, but instead stacked top-to-bottom.
- See also:
- setStackedLetters
| void XFRecord::setStackedLetters | ( | bool | stacked | ) |
| unsigned XFRecord::indentLevel | ( | ) | const |
| void XFRecord::setIndentLevel | ( | unsigned | i | ) |
| bool XFRecord::shrinkContent | ( | ) | const |
| void XFRecord::setShrinkContent | ( | bool | s | ) |
| unsigned XFRecord::leftBorderStyle | ( | ) | const |
| void XFRecord::setLeftBorderStyle | ( | unsigned | style | ) |
| 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
| 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
| unsigned XFRecord::rightBorderStyle | ( | ) | const |
| void XFRecord::setRightBorderStyle | ( | unsigned | style | ) |
| 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
| 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
| unsigned XFRecord::topBorderStyle | ( | ) | const |
| void XFRecord::setTopBorderStyle | ( | unsigned | style | ) |
| 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
| 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
| unsigned XFRecord::bottomBorderStyle | ( | ) | const |
| void XFRecord::setBottomBorderStyle | ( | unsigned | style | ) |
| 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
| 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
| bool XFRecord::diagonalTopLeft | ( | ) | const |
Returns true if there is a diagonal line from top left to right bottom.
- See also:
- diagonalStyle, diagonalColor, 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
| bool XFRecord::diagonalBottomLeft | ( | ) | const |
Returns true if there is a diagonal line from bottom left to right top.
- See also:
- diagonalStyle, diagonalColor, 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
| unsigned XFRecord::diagonalStyle | ( | ) | const |
| void XFRecord::setDiagonalStyle | ( | unsigned | style | ) |
Sets the line style for diagonal line.
- See also:
- diagonalBorderStyle, setDiagonalTopLeft, setDiagonalBottomLeft
| 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
| 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
| unsigned XFRecord::fillPattern | ( | ) | const |
| void XFRecord::setFillPattern | ( | unsigned | pattern | ) |
| unsigned XFRecord::patternForeColor | ( | ) | const |
Returns the fill foreground color.
This is an index to color palette specified in Palette record.
- See also:
- setPatternForeColor, patternBackColor
| 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
| unsigned XFRecord::patternBackColor | ( | ) | const |
Returns the fill background color.
This is an index to color palette specified in Palette record.
- See also:
- setPatternBackColor, patternForeColor
| 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
| virtual const char* Swinder::XFRecord::name | ( | ) | [inline, virtual] |
| void XFRecord::setData | ( | unsigned | size, | |
| const unsigned char * | data | |||
| ) | [virtual] |
| void XFRecord::dump | ( | std::ostream & | out | ) | const [virtual] |
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.
The documentation for this class was generated from the following files:
