LibreOffice Module sc (master)  1
workbookhelper.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #ifndef INCLUDED_SC_SOURCE_FILTER_INC_WORKBOOKHELPER_HXX
21 #define INCLUDED_SC_SOURCE_FILTER_INC_WORKBOOKHELPER_HXX
22 
23 #include <memory>
24 #include <string_view>
25 
27 #include <address.hxx>
28 
29 namespace oox::drawingml::chart { class ChartConverter; }
30 namespace rtl { template <class reference_type> class Reference; }
31 
32 namespace com::sun::star {
33  namespace container { class XNameContainer; }
34  namespace sheet { class XDatabaseRange; }
35  namespace sheet { class XSpreadsheet; }
36  namespace sheet { class XSpreadsheetDocument; }
37  namespace sheet { struct FormulaToken; }
38  namespace style { class XStyle; }
39  namespace table { class XCellRange; }
40 }
41 
42 namespace oox {
43  class SegmentProgressBar;
44 }
45 
46 namespace oox::core {
47  class FilterBase;
48  class FragmentHandler;
49  class XmlFilterBase;
50  class FastParser;
51 }
52 
53 class ScDocument;
54 class ScDocumentImport;
56 class ScDBData;
57 class ScRangeData;
58 
59 namespace oox::xls {
60 
61 class ExcelFilter;
62 
65 {
66  bool operator()( const OUString& rName1, std::u16string_view rName2 ) const;
67 };
68 
69 class AddressConverter;
70 class ConnectionsBuffer;
71 class DefinedNamesBuffer;
72 class ExternalLinkBuffer;
73 class FormulaParser;
75 class PivotCacheBuffer;
76 class PivotTableBuffer;
77 class ScenarioBuffer;
79 class StylesBuffer;
80 class TableBuffer;
81 class ThemeBuffer;
82 class UnitConverter;
83 class ViewSettings;
84 class WorkbookSettings;
85 class WorksheetBuffer;
86 class FormulaBuffer;
87 
89 typedef std::shared_ptr< WorkbookGlobals > WorkbookGlobalsRef;
90 
103 {
104 public:
105  /*implicit*/ WorkbookHelper( WorkbookGlobals& rBookGlob ) : mrBookGlob( rBookGlob ) {}
106  virtual ~WorkbookHelper();
107 
108  WorkbookHelper(WorkbookHelper const &) = default;
109  WorkbookHelper(WorkbookHelper &&) = default;
110  WorkbookHelper & operator =(WorkbookHelper const &) = delete; // due to mrBookGlob
111  WorkbookHelper & operator =(WorkbookHelper &&) = delete; // due to mrBookGlob
112 
113  static WorkbookGlobalsRef constructGlobals( ExcelFilter& rFilter );
114 
115  // filter -----------------------------------------------------------------
116 
122  sal_Int16 getCurrentSheetIndex() const;
124  bool isGeneratorKnownGood() const;
125 
127  void setVbaProjectStorage( const StorageRef& rxVbaPrjStrg );
129  void setCurrentSheetIndex( SCTAB nSheet );
131  void finalizeWorkbookImport();
132  void useInternalChartDataTable( bool bInternal );
133 
134  // document model ---------------------------------------------------------
136  const ScDocument& getScDocument() const;
137 
139  const ScDocumentImport& getDocImport() const;
140 
143  const css::uno::Reference< css::sheet::XSpreadsheetDocument >&
144  getDocument() const;
145 
147  css::uno::Reference< css::sheet::XSpreadsheet >
148  getSheetFromDoc( sal_Int32 nSheet ) const;
150  css::uno::Reference< css::sheet::XSpreadsheet >
151  getSheetFromDoc( const OUString& rSheet ) const;
152 
154  css::uno::Reference< css::table::XCellRange >
155  getCellRangeFromDoc( const ScRange& rRange ) const;
156 
158  css::uno::Reference< css::container::XNameContainer >
159  getCellStyleFamily() const;
161  css::uno::Reference< css::style::XStyle >
162  getStyleObject( const OUString& rStyleName, bool bPageStyle ) const;
163 
168  OUString& orName,
169  const css::uno::Sequence< css::sheet::FormulaToken>& rTokens,
170  sal_Int32 nIndex,
171  sal_Int32 nNameFlags ) const;
172 
177  OUString& orName,
178  const css::uno::Sequence< css::sheet::FormulaToken>& rTokens,
179  sal_Int32 nIndex,
180  sal_Int32 nNameFlags, sal_Int32 nTab ) const;
181 
185  css::uno::Reference< css::sheet::XDatabaseRange >
187  OUString& orName,
188  const ScRange& rRangeAddr ) const;
189 
192  css::uno::Reference< css::sheet::XDatabaseRange >
194  const ScRange& rRangeAddr ) const;
195 
197  ScDBData* findDatabaseRangeByIndex( sal_uInt16 nIndex ) const;
198 
200  css::uno::Reference< css::style::XStyle >
202  OUString& orStyleName,
203  bool bPageStyle ) const;
204 
205  // buffers ----------------------------------------------------------------
206 
211  ViewSettings& getViewSettings() const;
215  ThemeBuffer& getTheme() const;
217  StylesBuffer& getStyles() const;
225  TableBuffer& getTables() const;
227  ScenarioBuffer& getScenarios() const;
234 
235  // converters -------------------------------------------------------------
236 
249 
250  // OOXML/BIFF12 specific (MUST NOT be called in BIFF filter) --------------
251 
255 
259 
261 
262  // BIFF2-BIFF8 specific (MUST NOT be called in OOXML/BIFF12 filter) -------
263 
265  rtl_TextEncoding getTextEncoding() const;
266 
267 private:
269 };
270 
271 } // namespace oox::xls
272 
273 #endif
274 
275 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Helper class to provide access to global workbook data.
void setCurrentSheetIndex(SCTAB nSheet)
Sets the index of the current Calc sheet, if filter currently processes a sheet.
ScDocumentImport & getDocImport()
ScenarioBuffer & getScenarios() const
Returns the scenarios collection.
oox::drawingml::chart::ChartConverter * getChartConverter() const
Returns the chart object converter.
Stores information about all sheets in a spreadsheet document.
UnitConverter & getUnitConverter() const
Returns the measurement unit converter.
bool isGeneratorKnownGood() const
Returns true when reading a file generated by a known good generator.
css::uno::Reference< css::style::XStyle > getStyleObject(const OUString &rStyleName, bool bPageStyle) const
Returns the specified cell or page style from the Calc document.
Collects all strings from the shared strings substream.
Reference
exports com.sun.star. table
Helper class that provides functions to convert values from and to different units.
WorkbookGlobals & mrBookGlob
css::uno::Reference< css::table::XCellRange > getCellRangeFromDoc(const ScRange &rRange) const
Returns the XCellRange interface for the passed cell range address.
WorkbookHelper(WorkbookGlobals &rBookGlob)
rtl_TextEncoding getTextEncoding() const
Returns the text encoding used to import/export byte strings.
std::shared_ptr< StorageBase > StorageRef
Accessor class to ScDocument.
StylesBuffer & getStyles() const
Returns all cell formatting objects read from the styles substream.
WorkbookSettings & getWorkbookSettings() const
Returns the global workbook settings object.
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 st...
exports com.sun.star. sheet
exports com.sun.star. container
ViewSettings & getViewSettings() const
Returns the workbook and sheet view settings object.
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.
ScDBData * findDatabaseRangeByIndex(sal_uInt16 nIndex) const
Finds the (already existing) database range of the given formula token index.
::oox::core::FilterBase & getBaseFilter() const
Returns the base filter object (base class of all filters).
PivotCacheBuffer & getPivotCaches() const
Returns the collection of pivot caches.
sal_Int16 getCurrentSheetIndex() const
Returns the index of the current Calc sheet, if filter currently processes a sheet.
void useInternalChartDataTable(bool bInternal)
ScRangeData * createLocalNamedRangeObject(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.
void finalizeWorkbookImport()
Final conversion after importing the workbook.
PageSettingsConverter & getPageSettingsConverter() const
Returns the page and print settings converter.
const css::uno::Reference< css::sheet::XSpreadsheetDocument > & getDocument() const
Returns a reference to the source/target spreadsheet document model.
css::uno::Reference< css::container::XNameContainer > getCellStyleFamily() const
Returns the cell styles container from the Calc document.
ExternalLinkBuffer & getExternalLinks() const
Returns the external links read from the external links substream.
FormulaParser * createFormulaParser() const
Returns an unshared import formula parser (import filter only!).
::oox::core::XmlFilterBase & getOoxFilter() const
Returns the base OOXML/BIFF12 filter object.
SegmentProgressBar & getProgressBar() const
Returns the filter progress bar.
std::shared_ptr< WorkbookGlobals > WorkbookGlobalsRef
ScRangeData * createNamedRangeObject(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.
ScEditEngineDefaulter & getEditEngine() const
exports com.sun.star. style
static WorkbookGlobalsRef constructGlobals(ExcelFilter &rFilter)
bool operator()(const OUString &rName1, std::u16string_view rName2) const
Converter for cell addresses and cell ranges for OOXML and BIFF filters.
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.
SharedStringsBuffer & getSharedStrings() const
Returns the shared strings read from the shared strings substream.
Import formula parser for OOXML and BIFF filters.
ConnectionsBuffer & getConnections() const
Returns the collection of external data connections.
TableBuffer & getTables() const
Returns the tables collection (equivalent to Calc's database ranges).
FormulaParser & getFormulaParser() const
Returns a shared import formula parser (import filter only!).
css::uno::Reference< css::sheet::XSpreadsheet > getSheetFromDoc(sal_Int32 nSheet) const
Returns a reference to the specified spreadsheet in the document model.
PivotTableBuffer & getPivotTables() const
Returns the collection of pivot tables.
ThemeBuffer & getTheme() const
Returns the office theme object read from the theme substorage.
void setVbaProjectStorage(const StorageRef &rxVbaPrjStrg)
Sets the VBA project storage used to import VBA source code and forms.
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.
WorkbookHelper & operator=(WorkbookHelper const &)=delete
DefinedNamesBuffer & getDefinedNames() const
Returns the defined names read from the workbook globals.
sal_Int16 SCTAB
Definition: types.hxx:23
AddressConverter & getAddressConverter() const
Returns the converter for string to cell address/range conversion.
FormulaBuffer & getFormulaBuffer() const
Functor for case-insensitive string comparison, usable in maps etc.
WorksheetBuffer & getWorksheets() const
Returns the worksheet buffer containing sheet names and properties.