worksheethelper.hxx

Go to the documentation of this file.

/* -*- 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;

enum class WorksheetType
{
    Work,            
    Chart,           
    Macro,           
    Dialog,          
    Empty            
};

struct ColumnModel
{
    ValueRange          maRange;            
    double              mfWidth;            
    sal_Int32           mnXfId;             
    sal_Int32           mnLevel;            
    bool                mbShowPhonetic:1;   
    bool                mbHidden:1;         
    bool                mbCollapsed:1;      

    explicit            ColumnModel();

    bool                isMergeable( const ColumnModel& rModel ) const;
};

struct RowModel
{
    sal_Int32           mnRow;              
    ValueRangeSet       maColSpans;         
    double              mfHeight;           
    sal_Int32           mnXfId;             
    sal_Int32           mnLevel;            
    bool                mbCustomHeight:1;   
    bool                mbCustomFormat:1;   
    bool                mbShowPhonetic:1;   
    bool                mbHidden:1;         
    bool                mbCollapsed:1;      
    bool                mbThickTop:1;       
    bool                mbThickBottom:1;    

    explicit            RowModel();

    void                insertColSpan( const ValueRange& rColSpan );
    bool                isMergeable( const RowModel& rModel ) const;
};

struct PageBreakModel
{
    sal_Int32           mnColRow;           
    sal_Int32           mnMin;              
    sal_Int32           mnMax;              
    bool                mbManual;           

    explicit            PageBreakModel();
};

struct HyperlinkModel : public ::oox::ole::StdHlinkInfo
{
    ScRange             maRange;            
    OUString            maTooltip;          

    explicit            HyperlinkModel();
};

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();

    void                setBiffType( sal_uInt8 nType );
    void                setBiffOperator( sal_uInt8 nOperator );
    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 );

    WorksheetType       getSheetType() const;
    SCTAB               getSheetIndex() const;
    const css::uno::Reference< css::sheet::XSpreadsheet >&
                        getSheet() const;

    css::uno::Reference< css::table::XCell >
                        getCell( const ScAddress& rAddress ) const;
    css::uno::Reference< css::table::XCellRange >
                        getCellRange( const ScRange& rRange ) const;

    css::uno::Reference< css::drawing::XDrawPage >
                        getDrawPage() const;

    css::awt::Point getCellPosition( sal_Int32 nCol, sal_Int32 nRow ) const;
    const css::awt::Size& getDrawPageSize() const;

    SheetDataBuffer&    getSheetData() const;
    CondFormatBuffer&   getCondFormats() const;
    CommentsBuffer&     getComments() const;
    AutoFilterBuffer&   getAutoFilters() const;
    QueryTableBuffer&   getQueryTables() const;
    WorksheetSettings&  getWorksheetSettings() const;
    PageSettings&       getPageSettings() const;
    SheetViewSettings&  getSheetViewSettings() const;
    VmlDrawing&         getVmlDrawing() const;

    ExtLst&             getExtLst() const;

    void                setPageBreak( const PageBreakModel& rModel, bool bRowBreak );
    void                setHyperlink( const HyperlinkModel& rModel );
    void                setValidation( const ValidationModel& rModel );
    void                setDrawingPath( const OUString& rDrawingPath );
    void                setVmlDrawingPath( const OUString& rVmlDrawingPath );

    void                extendUsedArea( const ScAddress& rAddress );
    void                extendUsedArea( const ScRange& rRange );
    void                extendShapeBoundingBox( const css::awt::Rectangle& rShapeRect );

    void                setBaseColumnWidth( sal_Int32 nWidth );
    void                setDefaultColumnWidth( double fWidth );
    void                setColumnModel( const ColumnModel& rModel );

    void                setDefaultRowSettings(
                            double fHeight, bool bCustomHeight,
                            bool bHidden, bool bThickTop, bool bThickBottom );
    void                setRowModel( const RowModel& rModel );

    void putRichString(
        const ScAddress& rAddress,
        const RichString& rString, const oox::xls::Font* pFirstPortionFont );

    void putFormulaTokens(
        const ScAddress& rAddress, const ApiTokenSequence& rTokens );

    void                initializeWorksheetImport();
    void                finalizeWorksheetImport();
    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: */