LibreOffice Module sc (master)  1
Classes | Public Member Functions | Private Types | Private Attributes | Friends | List of all members
oox::xls::Xf Class Reference

Represents a cell format or a cell style (called XF, extended format). More...

#include <stylesbuffer.hxx>

Inheritance diagram for oox::xls::Xf:
[legend]
Collaboration diagram for oox::xls::Xf:
[legend]

Classes

struct  AttrList
 

Public Member Functions

 Xf (const WorkbookHelper &rHelper)
 
void importXf (const AttributeList &rAttribs, bool bCellXf)
 Sets all attributes from the xf element. More...
 
void importAlignment (const AttributeList &rAttribs)
 Sets all attributes from the alignment element. More...
 
void importProtection (const AttributeList &rAttribs)
 Sets all attributes from the protection element. More...
 
void importXf (SequenceInputStream &rStrm, bool bCellXf)
 Imports the XF record from the passed stream. More...
 
void finalizeImport ()
 Final processing after import of all style settings. More...
 
bool isCellXf () const
 Returns true, if the XF is a cell XF, and false, if it is a style XF. More...
 
FontRef getFont () const
 Returns the referred font object. More...
 
const AlignmentgetAlignment () const
 Returns the alignment data of this style. More...
 
void applyPatternToAttrList (AttrList &rAttrs, SCROW nRow1, SCROW nRow2, sal_Int32 nForceScNumFmt)
 
void writeToDoc (ScDocumentImport &rDoc, const ScRange &rRange)
 
const ::ScPatternAttrcreatePattern (bool bSkipPoolDefs=false)
 
- Public Member Functions inherited from oox::xls::WorkbookHelper
 WorkbookHelper (WorkbookGlobals &rBookGlob)
 
virtual ~WorkbookHelper ()
 
 WorkbookHelper (WorkbookHelper const &)=default
 
 WorkbookHelper (WorkbookHelper &&)=default
 
WorkbookHelperoperator= (WorkbookHelper const &)=delete
 
WorkbookHelperoperator= (WorkbookHelper &&)=delete
 
::oox::core::FilterBasegetBaseFilter () const
 Returns the base filter object (base class of all filters). More...
 
SegmentProgressBargetProgressBar () const
 Returns the filter progress bar. More...
 
sal_Int16 getCurrentSheetIndex () const
 Returns the index of the current Calc sheet, if filter currently processes a sheet. More...
 
bool isGeneratorKnownGood () const
 Returns true when reading a file generated by a known good generator. More...
 
void setVbaProjectStorage (const StorageRef &rxVbaPrjStrg)
 Sets the VBA project storage used to import VBA source code and forms. More...
 
void setCurrentSheetIndex (SCTAB nSheet)
 Sets the index of the current Calc sheet, if filter currently processes a sheet. More...
 
void finalizeWorkbookImport ()
 Final conversion after importing the workbook. More...
 
void useInternalChartDataTable (bool bInternal)
 
ScDocumentgetScDocument ()
 
const ScDocumentgetScDocument () const
 
ScDocumentImportgetDocImport ()
 
const ScDocumentImportgetDocImport () const
 
ScEditEngineDefaultergetEditEngine () const
 
const css::uno::Reference< css::sheet::XSpreadsheetDocument > & getDocument () const
 Returns a reference to the source/target spreadsheet document model. More...
 
css::uno::Reference< css::sheet::XSpreadsheet > getSheetFromDoc (sal_Int32 nSheet) const
 Returns a reference to the specified spreadsheet in the document model. More...
 
css::uno::Reference< css::sheet::XSpreadsheet > getSheetFromDoc (const OUString &rSheet) const
 Returns a reference to the specified spreadsheet in the document model. More...
 
css::uno::Reference< css::table::XCellRange > getCellRangeFromDoc (const ScRange &rRange) const
 Returns the XCellRange interface for the passed cell range address. More...
 
css::uno::Reference< css::container::XNameContainer > getCellStyleFamily () const
 Returns the cell styles container from the Calc document. More...
 
css::uno::Reference< css::style::XStyle > getStyleObject (const OUString &rStyleName, bool bPageStyle) const
 Returns the specified cell or page style from the Calc document. More...
 
ScRangeDatacreateNamedRangeObject (OUString &orName, const css::uno::Sequence< css::sheet::FormulaToken > &rTokens, sal_Int32 nIndex, sal_Int32 nNameFlags) const
 Creates and returns a defined name on-the-fly in the Calc document. More...
 
ScRangeDatacreateLocalNamedRangeObject (OUString &orName, const css::uno::Sequence< css::sheet::FormulaToken > &rTokens, sal_Int32 nIndex, sal_Int32 nNameFlags, sal_Int32 nTab) const
 Creates and returns a defined name on-the-fly in the sheet. More...
 
css::uno::Reference< css::sheet::XDatabaseRange > createDatabaseRangeObject (OUString &orName, const ScRange &rRangeAddr) const
 Creates and returns a database range on-the-fly in the Calc document. More...
 
css::uno::Reference< css::sheet::XDatabaseRange > createUnnamedDatabaseRangeObject (const ScRange &rRangeAddr) const
 Creates and returns an unnamed database range on-the-fly in the Calc document. More...
 
ScDBDatafindDatabaseRangeByIndex (sal_uInt16 nIndex) const
 Finds the (already existing) database range of the given formula token index. More...
 
css::uno::Reference< css::style::XStyle > createStyleObject (OUString &orStyleName, bool bPageStyle) const
 Creates and returns a com.sun.star.style.Style object for cells or pages. More...
 
FormulaBuffergetFormulaBuffer () const
 
WorkbookSettingsgetWorkbookSettings () const
 Returns the global workbook settings object. More...
 
ViewSettingsgetViewSettings () const
 Returns the workbook and sheet view settings object. More...
 
WorksheetBuffergetWorksheets () const
 Returns the worksheet buffer containing sheet names and properties. More...
 
ThemeBuffergetTheme () const
 Returns the office theme object read from the theme substorage. More...
 
StylesBuffergetStyles () const
 Returns all cell formatting objects read from the styles substream. More...
 
SharedStringsBuffergetSharedStrings () const
 Returns the shared strings read from the shared strings substream. More...
 
ExternalLinkBuffergetExternalLinks () const
 Returns the external links read from the external links substream. More...
 
DefinedNamesBuffergetDefinedNames () const
 Returns the defined names read from the workbook globals. More...
 
TableBuffergetTables () const
 Returns the tables collection (equivalent to Calc's database ranges). More...
 
ScenarioBuffergetScenarios () const
 Returns the scenarios collection. More...
 
ConnectionsBuffergetConnections () const
 Returns the collection of external data connections. More...
 
PivotCacheBuffergetPivotCaches () const
 Returns the collection of pivot caches. More...
 
PivotTableBuffergetPivotTables () const
 Returns the collection of pivot tables. More...
 
FormulaParsergetFormulaParser () const
 Returns a shared import formula parser (import filter only!). More...
 
FormulaParsercreateFormulaParser () const
 Returns an unshared import formula parser (import filter only!). More...
 
UnitConvertergetUnitConverter () const
 Returns the measurement unit converter. More...
 
AddressConvertergetAddressConverter () const
 Returns the converter for string to cell address/range conversion. More...
 
oox::drawingml::chart::ChartConvertergetChartConverter () const
 Returns the chart object converter. More...
 
PageSettingsConvertergetPageSettingsConverter () const
 Returns the page and print settings converter. More...
 
::oox::core::XmlFilterBasegetOoxFilter () const
 Returns the base OOXML/BIFF12 filter object. More...
 
bool importOoxFragment (const rtl::Reference< oox::core::FragmentHandler > &rxHandler)
 Imports a fragment using the passed fragment handler, which contains the full path to the fragment stream. More...
 
bool importOoxFragment (const rtl::Reference< oox::core::FragmentHandler > &rxHandler, oox::core::FastParser &rParser)
 
rtl_TextEncoding getTextEncoding () const
 Returns the text encoding used to import/export byte strings. More...
 

Private Types

typedef ::std::unique_ptr< ::ScPatternAttrScPatternAttrPtr
 

Private Attributes

ScPatternAttrPtr mpPattern
 
sal_uInt32 mnScNumFmt
 Calc item set. More...
 
XfModel maModel
 Calc number format. More...
 
Alignment maAlignment
 Cell XF or style XF model data. More...
 
Protection maProtection
 Cell alignment data. More...
 
sal_Int32 meRotationRef
 Cell protection data. More...
 
::ScStyleSheetmpStyleSheet
 Rotation reference dependent on border. More...
 

Friends

bool operator== (const Xf &rXf1, const Xf &rXf2)
 

Additional Inherited Members

- Static Public Member Functions inherited from oox::xls::WorkbookHelper
static WorkbookGlobalsRef constructGlobals (ExcelFilter &rFilter)
 

Detailed Description

Represents a cell format or a cell style (called XF, extended format).

This class stores the type (cell/style), the index to the parent style (if it is a cell format) and all "attribute used" flags, which reflect the state of specific attribute groups (true = user has changed the attributes) and all formatting data.

Definition at line 588 of file stylesbuffer.hxx.

Member Typedef Documentation

typedef ::std::unique_ptr< ::ScPatternAttr > oox::xls::Xf::ScPatternAttrPtr
private

Definition at line 632 of file stylesbuffer.hxx.

Constructor & Destructor Documentation

oox::xls::Xf::Xf ( const WorkbookHelper rHelper)
explicit

Definition at line 1940 of file stylesbuffer.cxx.

References STANDARD, and table.

Member Function Documentation

void oox::xls::Xf::applyPatternToAttrList ( AttrList rAttrs,
SCROW  nRow1,
SCROW  nRow2,
sal_Int32  nForceScNumFmt 
)
const ::ScPatternAttr & oox::xls::Xf::createPattern ( bool  bSkipPoolDefs = false)
void oox::xls::Xf::finalizeImport ( )

Final processing after import of all style settings.

Definition at line 2015 of file stylesbuffer.cxx.

References oox::xls::Alignment::finalizeImport(), oox::xls::Protection::finalizeImport(), maAlignment, and maProtection.

Referenced by oox::xls::StylesBuffer::finalizeImport().

const Alignment& oox::xls::Xf::getAlignment ( ) const
inline

Returns the alignment data of this style.

Definition at line 622 of file stylesbuffer.hxx.

References maAlignment.

Referenced by oox::xls::SheetDataBuffer::setCellFormat().

FontRef oox::xls::Xf::getFont ( ) const

Returns the referred font object.

Definition at line 2022 of file stylesbuffer.cxx.

References oox::xls::StylesBuffer::getFont(), oox::xls::WorkbookHelper::getStyles(), maModel, and oox::xls::XfModel::mnFontId.

void oox::xls::Xf::importAlignment ( const AttributeList rAttribs)

Sets all attributes from the alignment element.

Definition at line 1984 of file stylesbuffer.cxx.

References oox::xls::Alignment::importAlignment(), and maAlignment.

void oox::xls::Xf::importProtection ( const AttributeList rAttribs)

Sets all attributes from the protection element.

Definition at line 1989 of file stylesbuffer.cxx.

References oox::xls::Protection::importProtection(), and maProtection.

void oox::xls::Xf::importXf ( const AttributeList rAttribs,
bool  bCellXf 
)
void oox::xls::Xf::importXf ( SequenceInputStream rStrm,
bool  bCellXf 
)
bool oox::xls::Xf::isCellXf ( ) const
inline

Returns true, if the XF is a cell XF, and false, if it is a style XF.

Definition at line 617 of file stylesbuffer.hxx.

References maModel, and oox::xls::XfModel::mbCellXf.

Referenced by applyPatternToAttrList(), createPattern(), and writeToDoc().

void oox::xls::Xf::writeToDoc ( ScDocumentImport rDoc,
const ScRange rRange 
)

Friends And Related Function Documentation

bool operator== ( const Xf rXf1,
const Xf rXf2 
)
friend

Definition at line 2989 of file stylesbuffer.cxx.

Member Data Documentation

Alignment oox::xls::Xf::maAlignment
private

Cell XF or style XF model data.

Definition at line 638 of file stylesbuffer.hxx.

Referenced by createPattern(), finalizeImport(), getAlignment(), importAlignment(), importXf(), and oox::xls::operator==().

XfModel oox::xls::Xf::maModel
private

Calc number format.

Definition at line 637 of file stylesbuffer.hxx.

Referenced by applyPatternToAttrList(), createPattern(), getFont(), importXf(), isCellXf(), oox::xls::operator==(), and writeToDoc().

Protection oox::xls::Xf::maProtection
private

Cell alignment data.

Definition at line 639 of file stylesbuffer.hxx.

Referenced by createPattern(), finalizeImport(), importProtection(), importXf(), and oox::xls::operator==().

sal_Int32 oox::xls::Xf::meRotationRef
private

Cell protection data.

Definition at line 640 of file stylesbuffer.hxx.

Referenced by createPattern().

sal_uInt32 oox::xls::Xf::mnScNumFmt
private

Calc item set.

Definition at line 635 of file stylesbuffer.hxx.

Referenced by applyPatternToAttrList(), and createPattern().

ScPatternAttrPtr oox::xls::Xf::mpPattern
private

Definition at line 634 of file stylesbuffer.hxx.

Referenced by applyPatternToAttrList(), and createPattern().

::ScStyleSheet* oox::xls::Xf::mpStyleSheet
private

Rotation reference dependent on border.

Definition at line 641 of file stylesbuffer.hxx.

Referenced by applyPatternToAttrList(), and createPattern().


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