diff options
Diffstat (limited to 'sc/source/filter/inc/worksheethelper.hxx')
| -rw-r--r-- | sc/source/filter/inc/worksheethelper.hxx | 305 |
1 files changed, 305 insertions, 0 deletions
diff --git a/sc/source/filter/inc/worksheethelper.hxx b/sc/source/filter/inc/worksheethelper.hxx new file mode 100644 index 000000000..7beacf7c2 --- /dev/null +++ b/sc/source/filter/inc/worksheethelper.hxx @@ -0,0 +1,305 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#pragma once + +#include <oox/helper/containerhelper.hxx> +#include <oox/helper/progressbar.hxx> +#include <oox/ole/olehelper.hxx> +#include <rangelst.hxx> +#include "formulabase.hxx" + +struct ScDataBarFormatData; +class ScDocument; + +namespace com::sun::star { + namespace awt { struct Point; } + namespace awt { struct Rectangle; } + namespace awt { struct Size; } + namespace drawing { class XDrawPage; } + namespace sheet { class XSpreadsheet; } + namespace table { class XCell; } + namespace table { class XCellRange; } +} + +namespace oox::xls { + +class AutoFilterBuffer; +class CommentsBuffer; +class CondFormatBuffer; +class Font; +class PageSettings; +class QueryTableBuffer; +class RichString; +class SheetDataBuffer; +class SheetViewSettings; +class VmlDrawing; +class WorksheetSettings; + +typedef ::std::map< OUString, ScDataBarFormatData* > ExtLst; + +/** An enumeration for all types of sheets in a workbook. */ +enum class WorksheetType +{ + Work, /// Worksheet. + Chart, /// Chart sheet. + Macro, /// Macro sheet. + Dialog, /// Dialog sheet (BIFF5+). + Empty /// Other (unsupported) sheet type. +}; + +/** Stores settings and formatting data about a range of sheet columns. */ +struct ColumnModel +{ + ValueRange maRange; /// 1-based (!) range of the described columns. + double mfWidth; /// Column width in number of characters. + sal_Int32 mnXfId; /// Column default formatting. + sal_Int32 mnLevel; /// Column outline level. + bool mbShowPhonetic:1; /// True = cells in column show phonetic settings. + bool mbHidden:1; /// True = column is hidden. + bool mbCollapsed:1; /// True = column outline is collapsed. + + explicit ColumnModel(); + + /** Returns true, if this entry can be merged with the passed column range (column settings are equal). */ + bool isMergeable( const ColumnModel& rModel ) const; +}; + +/** Stores settings and formatting data about a sheet row. */ +struct RowModel +{ + sal_Int32 mnRow; /// 1-based (!) index of the described row. + ValueRangeSet maColSpans; /// 0-based (!) column ranges of used cells. + double mfHeight; /// Row height in points. + sal_Int32 mnXfId; /// Row default formatting (see mbIsFormatted). + sal_Int32 mnLevel; /// Row outline level. + bool mbCustomHeight:1; /// True = row has custom height. + bool mbCustomFormat:1; /// True = cells in row have explicit formatting. + bool mbShowPhonetic:1; /// True = cells in row show phonetic settings. + bool mbHidden:1; /// True = row is hidden. + bool mbCollapsed:1; /// True = row outline is collapsed. + bool mbThickTop:1; /// True = row has extra space above text. + bool mbThickBottom:1; /// True = row has extra space below text. + + explicit RowModel(); + + /** Inserts the passed column span into the row model. */ + void insertColSpan( const ValueRange& rColSpan ); + /** Returns true, if this entry can be merged with the passed row range (row settings are equal). */ + bool isMergeable( const RowModel& rModel ) const; +}; + +/** Stores formatting data about a page break. */ +struct PageBreakModel +{ + sal_Int32 mnColRow; /// 0-based (!) index of column/row. + sal_Int32 mnMin; /// Start of limited break. + sal_Int32 mnMax; /// End of limited break. + bool mbManual; /// True = manual page break. + + explicit PageBreakModel(); +}; + +/** Stores data about a hyperlink range. */ +struct HyperlinkModel : public ::oox::ole::StdHlinkInfo +{ + ScRange maRange; /// The cell area containing the hyperlink. + OUString maTooltip; /// Additional tooltip text. + + explicit HyperlinkModel(); +}; + +/** Stores data about ranges with data validation settings. */ +struct ValidationModel +{ + ScRangeList maRanges; + ApiTokenSequence maTokens1; + ApiTokenSequence maTokens2; + OUString msRef; + OUString maInputTitle; + OUString maInputMessage; + OUString maErrorTitle; + OUString maErrorMessage; + sal_Int32 mnType; + sal_Int32 mnOperator; + sal_Int32 mnErrorStyle; + bool mbShowInputMsg:1; + bool mbShowErrorMsg:1; + bool mbNoDropDown:1; + bool mbAllowBlank:1; + + explicit ValidationModel(); + + /** Sets the passed BIFF validation type. */ + void setBiffType( sal_uInt8 nType ); + /** Sets the passed BIFF operator. */ + void setBiffOperator( sal_uInt8 nOperator ); + /** Sets the passed BIFF error style. */ + void setBiffErrorStyle( sal_uInt8 nErrorStyle ); +}; + +class WorksheetGlobals; +typedef std::shared_ptr< WorksheetGlobals > WorksheetGlobalsRef; + +class IWorksheetProgress { +public: + virtual ~IWorksheetProgress() {} + virtual ISegmentProgressBarRef getRowProgress() = 0; + virtual void setCustomRowProgress( + const ISegmentProgressBarRef &rxRowProgress ) = 0; +}; + +class WorksheetHelper : public WorkbookHelper +{ +public: + /*implicit*/ WorksheetHelper( WorksheetGlobals& rSheetGlob ); + + static WorksheetGlobalsRef constructGlobals( + const WorkbookHelper& rHelper, + const ISegmentProgressBarRef& rxProgressBar, + WorksheetType eSheetType, + SCTAB nSheet ); + + // horrible accessor for hidden WorksheetGlobals ... + static IWorksheetProgress *getWorksheetInterface( const WorksheetGlobalsRef &xRef ); + + /** Returns the type of this sheet. */ + WorksheetType getSheetType() const; + /** Returns the index of the current sheet. */ + SCTAB getSheetIndex() const; + /** Returns the XSpreadsheet interface of the current sheet. */ + const css::uno::Reference< css::sheet::XSpreadsheet >& + getSheet() const; + + /** Returns the XCell interface for the passed cell address. */ + css::uno::Reference< css::table::XCell > + getCell( const ScAddress& rAddress ) const; + /** Returns the XCellRange interface for the passed cell range address. */ + css::uno::Reference< css::table::XCellRange > + getCellRange( const ScRange& rRange ) const; + + /** Returns the XDrawPage interface of the draw page of the current sheet. */ + css::uno::Reference< css::drawing::XDrawPage > + getDrawPage() const; + + /** Returns the absolute cell position in 1/100 mm. */ + css::awt::Point getCellPosition( sal_Int32 nCol, sal_Int32 nRow ) const; + /** Returns the size of the entire drawing page in 1/100 mm. */ + const css::awt::Size& getDrawPageSize() const; + + /** Returns the buffer for cell contents and cell formatting. */ + SheetDataBuffer& getSheetData() const; + /** Returns the conditional formatting in this sheet. */ + CondFormatBuffer& getCondFormats() const; + /** Returns the buffer for all cell comments in this sheet. */ + CommentsBuffer& getComments() const; + /** Returns the auto filters for the sheet. */ + AutoFilterBuffer& getAutoFilters() const; + /** Returns the buffer for all web query tables in this sheet. */ + QueryTableBuffer& getQueryTables() const; + /** Returns the worksheet settings object. */ + WorksheetSettings& getWorksheetSettings() const; + /** Returns the page/print settings for this sheet. */ + PageSettings& getPageSettings() const; + /** Returns the view settings for this sheet. */ + SheetViewSettings& getSheetViewSettings() const; + /** Returns the VML drawing page for this sheet (OOXML/BIFF12 only). */ + VmlDrawing& getVmlDrawing() const; + + ExtLst& getExtLst() const; + + /** Sets a column or row page break described in the passed struct. */ + void setPageBreak( const PageBreakModel& rModel, bool bRowBreak ); + /** Inserts the hyperlink URL into the spreadsheet. */ + void setHyperlink( const HyperlinkModel& rModel ); + /** Inserts the data validation settings into the spreadsheet. */ + void setValidation( const ValidationModel& rModel ); + /** Sets the path to the DrawingML fragment of this sheet. */ + void setDrawingPath( const OUString& rDrawingPath ); + /** Sets the path to the legacy VML drawing fragment of this sheet. */ + void setVmlDrawingPath( const OUString& rVmlDrawingPath ); + + /** Extends the used area of this sheet by the passed cell position. */ + void extendUsedArea( const ScAddress& rAddress ); + /** Extends the used area of this sheet by the passed cell range. */ + void extendUsedArea( const ScRange& rRange ); + /** Extends the shape bounding box by the position and size of the passed rectangle (in 1/100 mm). */ + void extendShapeBoundingBox( const css::awt::Rectangle& rShapeRect ); + + /** Sets base width for all columns (without padding pixels). This value + is only used, if width has not been set with setDefaultColumnWidth(). */ + void setBaseColumnWidth( sal_Int32 nWidth ); + /** Sets default width for all columns. This function overrides the base + width set with the setBaseColumnWidth() function. */ + void setDefaultColumnWidth( double fWidth ); + /** Sets column settings for a specific range of columns. + @descr Column default formatting is converted directly, other settings + are cached and converted in the finalizeWorksheetImport() call. */ + void setColumnModel( const ColumnModel& rModel ); + + /** Sets default height and hidden state for all unused rows in the sheet. */ + void setDefaultRowSettings( + double fHeight, bool bCustomHeight, + bool bHidden, bool bThickTop, bool bThickBottom ); + /** Sets row settings for a specific range of rows. + @descr Row default formatting is converted directly, other settings + are cached and converted in the finalizeWorksheetImport() call. */ + void setRowModel( const RowModel& rModel ); + + /** Inserts a rich-string cell directly into the Calc sheet. */ + void putRichString( + const ScAddress& rAddress, + const RichString& rString, const oox::xls::Font* pFirstPortionFont ); + + /** Inserts a formula cell directly into the Calc sheet. */ + void putFormulaTokens( + const ScAddress& rAddress, const ApiTokenSequence& rTokens ); + + /** Initial conversion before importing the worksheet. */ + void initializeWorksheetImport(); + /** Final conversion after importing the worksheet. */ + void finalizeWorksheetImport(); + /** Final import of drawing objects. Has to be called after all content has been imported */ + void finalizeDrawingImport(); + + 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(); + + +private: + WorksheetGlobals& mrSheetGlob; +}; + +} // namespace oox::xls + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |