Represents a single rule in a conditional formatting. More...
#include <condformatbuffer.hxx>
Public Member Functions | |
| CondFormatRule (const CondFormat &rCondFormat, ScConditionalFormat *pFormat) | |
| void | importCfRule (const AttributeList &rAttribs) |
| Imports rule settings from the cfRule element. More... | |
| void | appendFormula (const OUString &rFormula) |
| Appends a new condition formula string. More... | |
| void | importCfRule (SequenceInputStream &rStrm) |
| Imports rule settings from a CFRULE record. More... | |
| void | setFormatEntry (sal_Int32 nPriority, ScFormatEntry *pEntry) |
| Directly set a ScFormatEntry with a priority ready for finalizeImport(). More... | |
| void | finalizeImport () |
| Creates a conditional formatting rule in the Calc document. More... | |
| sal_Int32 | getPriority () const |
| Returns the priority of this rule. More... | |
| ColorScaleRule * | getColorScale () |
| DataBarRule * | getDataBar () |
| IconSetRule * | getIconSet () |
 Public Member Functions inherited from oox::xls::WorksheetHelper | |
| WorksheetHelper (WorksheetGlobals &rSheetGlob) | |
| WorksheetType | getSheetType () const |
| Returns the type of this sheet. More... | |
| SCTAB | getSheetIndex () const |
| Returns the index of the current sheet. More... | |
| const css::uno::Reference< css::sheet::XSpreadsheet > & | getSheet () const |
| Returns the XSpreadsheet interface of the current sheet. More... | |
| css::uno::Reference< css::table::XCell > | getCell (const ScAddress &rAddress) const |
| Returns the XCell interface for the passed cell address. More... | |
| css::uno::Reference< css::table::XCellRange > | getCellRange (const ScRange &rRange) const |
| Returns the XCellRange interface for the passed cell range address. More... | |
| css::uno::Reference< css::drawing::XDrawPage > | getDrawPage () const |
| Returns the XDrawPage interface of the draw page of the current sheet. More... | |
| css::awt::Point | getCellPosition (sal_Int32 nCol, sal_Int32 nRow) const |
| Returns the absolute cell position in 1/100 mm. More... | |
| const css::awt::Size & | getDrawPageSize () const |
| Returns the size of the entire drawing page in 1/100 mm. More... | |
| SheetDataBuffer & | getSheetData () const |
| Returns the buffer for cell contents and cell formatting. More... | |
| CondFormatBuffer & | getCondFormats () const |
| Returns the conditional formatting in this sheet. More... | |
| CommentsBuffer & | getComments () const |
| Returns the buffer for all cell comments in this sheet. More... | |
| AutoFilterBuffer & | getAutoFilters () const |
| Returns the auto filters for the sheet. More... | |
| QueryTableBuffer & | getQueryTables () const |
| Returns the buffer for all web query tables in this sheet. More... | |
| WorksheetSettings & | getWorksheetSettings () const |
| Returns the worksheet settings object. More... | |
| PageSettings & | getPageSettings () const |
| Returns the page/print settings for this sheet. More... | |
| SheetViewSettings & | getSheetViewSettings () const |
| Returns the view settings for this sheet. More... | |
| VmlDrawing & | getVmlDrawing () const |
| Returns the VML drawing page for this sheet (OOXML/BIFF12 only). More... | |
| ExtLst & | getExtLst () const |
| void | setPageBreak (const PageBreakModel &rModel, bool bRowBreak) |
| Sets a column or row page break described in the passed struct. More... | |
| void | setHyperlink (const HyperlinkModel &rModel) |
| Inserts the hyperlink URL into the spreadsheet. More... | |
| void | setValidation (const ValidationModel &rModel) |
| Inserts the data validation settings into the spreadsheet. More... | |
| void | setDrawingPath (const OUString &rDrawingPath) |
| Sets the path to the DrawingML fragment of this sheet. More... | |
| void | setVmlDrawingPath (const OUString &rVmlDrawingPath) |
| Sets the path to the legacy VML drawing fragment of this sheet. More... | |
| void | extendUsedArea (const ScAddress &rAddress) |
| Extends the used area of this sheet by the passed cell position. More... | |
| void | extendUsedArea (const ScRange &rRange) |
| Extends the used area of this sheet by the passed cell range. More... | |
| void | extendShapeBoundingBox (const css::awt::Rectangle &rShapeRect) |
| Extends the shape bounding box by the position and size of the passed rectangle (in 1/100 mm). More... | |
| void | setBaseColumnWidth (sal_Int32 nWidth) |
| Sets base width for all columns (without padding pixels). More... | |
| void | setDefaultColumnWidth (double fWidth) |
| Sets default width for all columns. More... | |
| void | setColumnModel (const ColumnModel &rModel) |
| Sets column settings for a specific range of columns. More... | |
| void | setDefaultRowSettings (double fHeight, bool bCustomHeight, bool bHidden, bool bThickTop, bool bThickBottom) |
| Sets default height and hidden state for all unused rows in the sheet. More... | |
| void | setRowModel (const RowModel &rModel) |
| Sets row settings for a specific range of rows. More... | |
| void | putRichString (const ScAddress &rAddress, RichString &rString, const oox::xls::Font *pFirstPortionFont, bool bSingleLine=false) |
| Inserts a rich-string cell directly into the Calc sheet. More... | |
| void | putFormulaTokens (const ScAddress &rAddress, const ApiTokenSequence &rTokens) |
| Inserts a formula cell directly into the Calc sheet. More... | |
| void | initializeWorksheetImport () |
| Initial conversion before importing the worksheet. More... | |
| void | finalizeWorksheetImport () |
| Final conversion after importing the worksheet. More... | |
| void | finalizeDrawingImport () |
| Final import of drawing objects. More... | |
| void | setCellFormula (const ScAddress &rTokenAddress, const OUString &) |
| void | setCellFormula (const ScAddress &rAddr, sal_Int32 nSharedId, const OUString &rCellValue, sal_Int32 nValueType) |
| void | setCellArrayFormula (const ScRange &rRangeAddress, const ScAddress &rTokenAddress, const OUString &rTokenStr) |
| void | createSharedFormulaMapEntry (const ScAddress &rAddress, sal_Int32 nSharedId, const OUString &rTokens) |
| void | setCellFormulaValue (const ScAddress &rAddress, const OUString &rValueStr, sal_Int32 nCellType) |
| ScDocument & | getScDocument () |
| Public Member Functions inherited from oox::xls::WorkbookHelper | |
| WorkbookHelper (WorkbookGlobals &rBookGlob) | |
| virtual | ~WorkbookHelper () |
| WorkbookHelper (WorkbookHelper const &)=default | |
| WorkbookHelper (WorkbookHelper &&)=default | |
| WorkbookHelper & | operator= (WorkbookHelper const &)=delete |
| WorkbookHelper & | operator= (WorkbookHelper &&)=delete |
| ::oox::core::FilterBase & | getBaseFilter () const |
| Returns the base filter object (base class of all filters). More... | |
| SegmentProgressBar & | getProgressBar () 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... | |
| bool | hasCalculatedFormulaCells () const |
| Returns true if any formula cell is calculated. More... | |
| void | setCalculatedFormulaCells () |
| Set if any formula cell is calculated. 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) |
| ScDocument & | getScDocument () |
| const ScDocument & | getScDocument () const |
| ScDocumentImport & | getDocImport () |
| const ScDocumentImport & | getDocImport () const |
| ScEditEngineDefaulter & | getEditEngine () 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... | |
| RangeDataRet | createNamedRangeObject (OUString &orName, sal_Int32 nIndex, sal_Int32 nNameFlags, bool bHidden) const |
| Creates and returns a defined name on-the-fly in the Calc document. More... | |
| RangeDataRet | createLocalNamedRangeObject (OUString &orName, sal_Int32 nIndex, sal_Int32 nNameFlags, sal_Int32 nTab, bool bHidden) 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... | |
| ScDBData * | findDatabaseRangeByIndex (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... | |
| FormulaBuffer & | getFormulaBuffer () const |
| WorkbookSettings & | getWorkbookSettings () const |
| Returns the global workbook settings object. More... | |
| ViewSettings & | getViewSettings () const |
| Returns the workbook and sheet view settings object. More... | |
| WorksheetBuffer & | getWorksheets () const |
| Returns the worksheet buffer containing sheet names and properties. More... | |
| ThemeBuffer & | getTheme () const |
| Returns the office theme object read from the theme substorage. More... | |
| StylesBuffer & | getStyles () const |
| Returns all cell formatting objects read from the styles substream. More... | |
| SharedStringsBuffer & | getSharedStrings () const |
| Returns the shared strings read from the shared strings substream. More... | |
| ExternalLinkBuffer & | getExternalLinks () const |
| Returns the external links read from the external links substream. More... | |
| DefinedNamesBuffer & | getDefinedNames () const |
| Returns the defined names read from the workbook globals. More... | |
| TableBuffer & | getTables () const |
| Returns the tables collection (equivalent to Calc's database ranges). More... | |
| ScenarioBuffer & | getScenarios () const |
| Returns the scenarios collection. More... | |
| ConnectionsBuffer & | getConnections () const |
| Returns the collection of external data connections. More... | |
| PivotCacheBuffer & | getPivotCaches () const |
| Returns the collection of pivot caches. More... | |
| PivotTableBuffer & | getPivotTables () const |
| Returns the collection of pivot tables. More... | |
| FormulaParser & | getFormulaParser () const |
| Returns a shared import formula parser (import filter only!). More... | |
| FormulaParser * | createFormulaParser () const |
| Returns an unshared import formula parser (import filter only!). More... | |
| UnitConverter & | getUnitConverter () const |
| Returns the measurement unit converter. More... | |
| AddressConverter & | getAddressConverter () const |
| Returns the converter for string to cell address/range conversion. More... | |
| oox::drawingml::chart::ChartConverter * | getChartConverter () const |
| Returns the chart object converter. More... | |
| PageSettingsConverter & | getPageSettingsConverter () const |
| Returns the page and print settings converter. More... | |
| ::oox::core::XmlFilterBase & | getOoxFilter () 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 Attributes | |
| const CondFormat & | mrCondFormat |
| CondFormatRuleModel | maModel |
| ScConditionalFormat * | mpFormat |
| ScFormatEntry * | mpFormatEntry |
| std::unique_ptr< ColorScaleRule > | mpColor |
| std::unique_ptr< DataBarRule > | mpDataBar |
| std::unique_ptr< IconSetRule > | mpIconSet |
Friends | |
| class | CondFormatBuffer |
Additional Inherited Members | |
| Public Types inherited from oox::xls::WorkbookHelper | |
| typedef std::pair< ScRangeData *, bool > | RangeDataRet |
| Static Public Member Functions inherited from oox::xls::WorksheetHelper | |
| static WorksheetGlobalsRef | constructGlobals (const WorkbookHelper &rHelper, const ISegmentProgressBarRef &rxProgressBar, WorksheetType eSheetType, SCTAB nSheet) |
| static IWorksheetProgress * | getWorksheetInterface (const WorksheetGlobalsRef &xRef) |
| Static Public Member Functions inherited from oox::xls::WorkbookHelper | |
| static WorkbookGlobalsRef | constructGlobals (ExcelFilter &rFilter) |
Detailed Description
Represents a single rule in a conditional formatting.
Definition at line 149 of file condformatbuffer.hxx.
Constructor & Destructor Documentation
◆ CondFormatRule()
|
explicit |
Definition at line 506 of file condformatbuffer.cxx.
Member Function Documentation
◆ appendFormula()
| void oox::xls::CondFormatRule::appendFormula | ( | const OUString & | rFormula | ) |
Appends a new condition formula string.
Definition at line 537 of file condformatbuffer.cxx.
References oox::xls::WorkbookHelper::getFormulaParser(), oox::xls::CondFormat::getRanges(), ScRangeList::GetTopLeftCorner(), oox::xls::FormulaParser::importFormula(), oox::xls::CondFormatRuleModel::maFormulas, maModel, and mrCondFormat.
Referenced by finalizeImport().
◆ finalizeImport()
| void oox::xls::CondFormatRule::finalizeImport | ( | ) |
Creates a conditional formatting rule in the Calc document.
Definition at line 790 of file condformatbuffer.cxx.
References AboveAverage, AboveEqualAverage, formula::FormulaTokenArray::AddDouble(), ScConditionalFormat::AddEntry(), formula::FormulaTokenArray::AddString(), appendFormula(), BeginsWith, BelowAverage, BelowEqualAverage, Bottom10, BottomPercent, ScDocument::CheckLinkFormulaNeedingCheck(), ContainsText, oox::xls::CondFormatBuffer::convertToInternalOperator(), ScTokenConversion::ConvertToTokenArray(), oox::xls::StylesBuffer::createDxfStyle(), Direct, Duplicate, EndsWith, Error, oox::xls::FormulaProcessorBase::generateAddress2dString(), oox::xls::CondFormat::getRanges(), oox::xls::WorksheetHelper::getScDocument(), ScDocument::GetSharedStringPool(), oox::xls::WorkbookHelper::getStyles(), ScRangeList::GetTopLeftCorner(), svl::SharedStringPool::intern(), condformat::LAST7DAYS, condformat::LASTMONTH, condformat::LASTWEEK, oox::xls::CondFormatRuleModel::maFormulas, maModel, oox::xls::CondFormatRuleModel::maText, oox::xls::CondFormatRuleModel::mbAboveAverage, oox::xls::CondFormatRuleModel::mbBottom, oox::xls::CondFormatRuleModel::mbEqualAverage, oox::xls::CondFormatRuleModel::mbPercent, oox::xls::CondFormatRuleModel::mnDxfId, oox::xls::CondFormatRuleModel::mnOperator, oox::xls::CondFormatRuleModel::mnRank, oox::xls::CondFormatRuleModel::mnStdDev, oox::xls::CondFormatRuleModel::mnTimePeriod, oox::xls::CondFormatRuleModel::mnType, mpColor, mpDataBar, mpFormat, mpFormatEntry, mpIconSet, mrCondFormat, condformat::NEXTMONTH, condformat::NEXTWEEK, NoError, NONE, NotContainsText, NotDuplicate, SAL_WARN, ScCondDateFormatEntry::SetDateType(), ScCondDateFormatEntry::SetStyleName(), condformat::THISMONTH, condformat::THISWEEK, condformat::TODAY, condformat::TOMORROW, Top10, TopPercent, and condformat::YESTERDAY.
Referenced by oox::xls::CondFormat::finalizeImport().
◆ getColorScale()
| ColorScaleRule * oox::xls::CondFormatRule::getColorScale | ( | ) |
Definition at line 1066 of file condformatbuffer.cxx.
References mpColor, and mrCondFormat.
◆ getDataBar()
| DataBarRule * oox::xls::CondFormatRule::getDataBar | ( | ) |
Definition at line 1074 of file condformatbuffer.cxx.
References mpDataBar, and mrCondFormat.
◆ getIconSet()
| IconSetRule * oox::xls::CondFormatRule::getIconSet | ( | ) |
Definition at line 1082 of file condformatbuffer.cxx.
References mpIconSet, and mrCondFormat.
◆ getPriority()
|
inline |
Returns the priority of this rule.
Definition at line 170 of file condformatbuffer.hxx.
References maModel, and oox::xls::CondFormatRuleModel::mnPriority.
◆ importCfRule() [1/2]
| void oox::xls::CondFormatRule::importCfRule | ( | const AttributeList & | rAttribs | ) |
Imports rule settings from the cfRule element.
Definition at line 514 of file condformatbuffer.cxx.
References oox::AttributeList::getBool(), oox::AttributeList::getInteger(), oox::AttributeList::getString(), oox::AttributeList::getToken(), maModel, oox::xls::CondFormatRuleModel::maText, oox::xls::CondFormatRuleModel::mbAboveAverage, oox::xls::CondFormatRuleModel::mbBottom, oox::xls::CondFormatRuleModel::mbEqualAverage, oox::xls::CondFormatRuleModel::mbPercent, oox::xls::CondFormatRuleModel::mbStopIfTrue, oox::xls::CondFormatRuleModel::mnDxfId, oox::xls::CondFormatRuleModel::mnOperator, oox::xls::CondFormatRuleModel::mnPriority, oox::xls::CondFormatRuleModel::mnRank, oox::xls::CondFormatRuleModel::mnStdDev, oox::xls::CondFormatRuleModel::mnTimePeriod, oox::xls::CondFormatRuleModel::mnType, XML_TOKEN_INVALID, and XML_type.
◆ importCfRule() [2/2]
| void oox::xls::CondFormatRule::importCfRule | ( | SequenceInputStream & | rStrm | ) |
Imports rule settings from a CFRULE record.
Definition at line 544 of file condformatbuffer.cxx.
References oox::xls::CondFormat, oox::getFlag(), oox::xls::WorkbookHelper::getFormulaParser(), oox::xls::CondFormat::getRanges(), ScRangeList::GetTopLeftCorner(), oox::xls::FormulaParser::importFormula(), oox::xls::CondFormatRuleModel::maFormulas, maModel, oox::xls::CondFormatRuleModel::maText, oox::xls::CondFormatRuleModel::mbAboveAverage, oox::xls::CondFormatRuleModel::mbBottom, oox::xls::CondFormatRuleModel::mbEqualAverage, oox::xls::CondFormatRuleModel::mbPercent, oox::xls::CondFormatRuleModel::mbStopIfTrue, oox::xls::CondFormatRuleModel::mnDxfId, oox::xls::CondFormatRuleModel::mnOperator, oox::xls::CondFormatRuleModel::mnPriority, oox::xls::CondFormatRuleModel::mnRank, oox::xls::CondFormatRuleModel::mnStdDev, oox::xls::CondFormatRuleModel::mnTimePeriod, oox::xls::CondFormatRuleModel::mnType, mrCondFormat, nType, rStrm, SAL_WARN_IF, oox::xls::CondFormatRuleModel::setBiff12TextType(), oox::xls::CondFormatRuleModel::setBiffOperator(), and XML_TOKEN_INVALID.
◆ setFormatEntry()
| void oox::xls::CondFormatRule::setFormatEntry | ( | sal_Int32 | nPriority, |
| ScFormatEntry * | pEntry | ||
| ) |
Directly set a ScFormatEntry with a priority ready for finalizeImport().
Definition at line 784 of file condformatbuffer.cxx.
References maModel, oox::xls::CondFormatRuleModel::mnPriority, and mpFormatEntry.
Friends And Related Function Documentation
◆ CondFormatBuffer
|
friend |
Definition at line 151 of file condformatbuffer.hxx.
Member Data Documentation
◆ maModel
|
private |
Definition at line 178 of file condformatbuffer.hxx.
Referenced by appendFormula(), finalizeImport(), getPriority(), importCfRule(), and setFormatEntry().
◆ mpColor
|
private |
Definition at line 181 of file condformatbuffer.hxx.
Referenced by finalizeImport(), and getColorScale().
◆ mpDataBar
|
private |
Definition at line 182 of file condformatbuffer.hxx.
Referenced by finalizeImport(), and getDataBar().
◆ mpFormat
|
private |
Definition at line 179 of file condformatbuffer.hxx.
Referenced by finalizeImport().
◆ mpFormatEntry
|
private |
Definition at line 180 of file condformatbuffer.hxx.
Referenced by finalizeImport(), and setFormatEntry().
◆ mpIconSet
|
private |
Definition at line 183 of file condformatbuffer.hxx.
Referenced by finalizeImport(), and getIconSet().
◆ mrCondFormat
|
private |
Definition at line 177 of file condformatbuffer.hxx.
Referenced by appendFormula(), finalizeImport(), getColorScale(), getDataBar(), getIconSet(), and importCfRule().
The documentation for this class was generated from the following files:
