#include <scenariobuffer.hxx>
Public Member Functions | |
| Scenario (const WorkbookHelper &rHelper, sal_Int16 nSheet, bool bIsActive) | |
| void | importScenario (const AttributeList &rAttribs) |
| Imports a scenario definition from a scenario element. More... | |
| void | importInputCells (const AttributeList &rAttribs) |
| Imports a new cell for this scenario from an inputCells element. More... | |
| void | importScenario (SequenceInputStream &rStrm) |
| Imports a scenario definition from a SCENARIO record. More... | |
| void | importInputCells (SequenceInputStream &rStrm) |
| Imports a new cell for this scenario from an INPUTCELLS record. More... | |
| void | finalizeImport () |
| Creates the scenario in the Calc document. More... | |
 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 | |
| std::vector< ScenarioCellModel > | maCells |
| ScenarioModel | maModel |
| Scenario cells. More... | |
| sal_Int16 | mnSheet |
| Scenario model data. More... | |
Additional Inherited Members | |
| Public Types inherited from oox::xls::WorkbookHelper | |
| typedef std::pair< ScRangeData *, bool > | RangeDataRet |
| Static Public Member Functions inherited from oox::xls::WorkbookHelper | |
| static WorkbookGlobalsRef | constructGlobals (ExcelFilter &rFilter) |
Detailed Description
Definition at line 53 of file scenariobuffer.hxx.
Constructor & Destructor Documentation
◆ Scenario()
|
explicit |
Definition at line 56 of file scenariobuffer.cxx.
References maModel, and oox::xls::ScenarioModel::mbActive.
Member Function Documentation
◆ finalizeImport()
| void oox::xls::Scenario::finalizeImport | ( | ) |
Creates the scenario in the Calc document.
Definition at line 104 of file scenariobuffer.cxx.
References oox::xls::AddressConverter::checkCellAddress(), ScRangeList::empty(), Exception, oox::xls::WorkbookHelper::getAddressConverter(), oox::xls::WorkbookHelper::getDocument(), oox::xls::WorkbookHelper::getSheetFromDoc(), oox::ContainerHelper::getUnusedName(), maCells, oox::xls::ScenarioModel::maComment, maModel, oox::xls::ScenarioModel::maName, oox::xls::ScenarioModel::mbActive, oox::xls::ScenarioModel::mbLocked, mnSheet, ScRangeList::push_back(), oox::PropertySet::setProperty(), and oox::xls::AddressConverter::toApiSequence().
Referenced by oox::xls::SheetScenarios::finalizeImport().
◆ importInputCells() [1/2]
| void oox::xls::Scenario::importInputCells | ( | const AttributeList & | rAttribs | ) |
Imports a new cell for this scenario from an inputCells element.
Definition at line 72 of file scenariobuffer.cxx.
References oox::xls::AddressConverter::convertToCellAddressUnchecked(), oox::AttributeList::getBool(), oox::AttributeList::getInteger(), oox::AttributeList::getString(), oox::AttributeList::getXString(), maCells, oox::xls::ScenarioCellModel::maPos, oox::xls::ScenarioCellModel::maValue, oox::xls::ScenarioCellModel::mbDeleted, oox::xls::ScenarioCellModel::mnNumFmtId, and mnSheet.
Referenced by oox::xls::ScenarioContext::onCreateContext(), and oox::xls::ScenarioContext::onCreateRecordContext().
◆ importInputCells() [2/2]
| void oox::xls::Scenario::importInputCells | ( | SequenceInputStream & | rStrm | ) |
Imports a new cell for this scenario from an INPUTCELLS record.
Definition at line 91 of file scenariobuffer.cxx.
References oox::xls::AddressConverter::convertToCellAddressUnchecked(), maCells, oox::xls::ScenarioCellModel::maPos, oox::xls::ScenarioCellModel::maValue, oox::xls::ScenarioCellModel::mnNumFmtId, mnSheet, and rStrm.
◆ importScenario() [1/2]
| void oox::xls::Scenario::importScenario | ( | const AttributeList & | rAttribs | ) |
Imports a scenario definition from a scenario element.
Definition at line 63 of file scenariobuffer.cxx.
References oox::AttributeList::getBool(), oox::AttributeList::getXString(), oox::xls::ScenarioModel::maComment, maModel, oox::xls::ScenarioModel::maName, oox::xls::ScenarioModel::maUser, oox::xls::ScenarioModel::mbHidden, and oox::xls::ScenarioModel::mbLocked.
Referenced by oox::xls::ScenarioContext::onStartElement(), and oox::xls::ScenarioContext::onStartRecord().
◆ importScenario() [2/2]
| void oox::xls::Scenario::importScenario | ( | SequenceInputStream & | rStrm | ) |
Imports a scenario definition from a SCENARIO record.
Definition at line 82 of file scenariobuffer.cxx.
References oox::xls::ScenarioModel::maComment, maModel, oox::xls::ScenarioModel::maName, oox::xls::ScenarioModel::maUser, oox::xls::ScenarioModel::mbHidden, oox::xls::ScenarioModel::mbLocked, and rStrm.
Member Data Documentation
◆ maCells
|
private |
Definition at line 72 of file scenariobuffer.hxx.
Referenced by finalizeImport(), and importInputCells().
◆ maModel
|
private |
Scenario cells.
Definition at line 73 of file scenariobuffer.hxx.
Referenced by finalizeImport(), importScenario(), and Scenario().
◆ mnSheet
|
private |
Scenario model data.
Definition at line 74 of file scenariobuffer.hxx.
Referenced by finalizeImport(), and importInputCells().
The documentation for this class was generated from the following files:
