xecontent.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 <memory>
#include <rangelst.hxx>
#include "xladdress.hxx"
#include "xerecord.hxx"
#include "xeroot.hxx"
#include "xestring.hxx"
#include "xeextlst.hxx"
#include "xlformula.hxx"

#include <colorscale.hxx>

/* ============================================================================
Classes to export the big Excel document contents (related to several cells or
globals for the sheet or document).
- Shared string table
- Merged cells
- Hyperlinks
- Label ranges
- Conditional formatting
- Data validation
- Web Queries
============================================================================ */

// Shared string table ========================================================

class XclExpSstImpl;

class XclExpSst : public XclExpRecordBase
{
public:
    explicit            XclExpSst();
    virtual             ~XclExpSst() override;

    sal_uInt32          Insert( const XclExpStringRef& xString );

    virtual void        Save( XclExpStream& rStrm ) override;
    virtual void        SaveXml( XclExpXmlStream& rStrm ) override;

private:
    typedef std::unique_ptr< XclExpSstImpl > XclExpSstImplPtr;
    XclExpSstImplPtr    mxImpl;
};

// Merged cells ===============================================================

class XclExpMergedcells : public XclExpRecordBase, protected XclExpRoot
{
public:
    explicit            XclExpMergedcells( const XclExpRoot& rRoot );

    void                AppendRange( const ScRange& rRange, sal_uInt32 nBaseXFId );
    sal_uInt32          GetBaseXFId( const ScAddress& rPos ) const;

    virtual void        Save( XclExpStream& rStrm ) override;
    virtual void        SaveXml( XclExpXmlStream& rStrm ) override;

private:
    ScRangeList         maMergedRanges;     
    ScfUInt32Vec        maBaseXFIds;        
};

// Hyperlinks =================================================================

class SvxURLField;

class XclExpHyperlink : public XclExpRecord
{
public:
    explicit            XclExpHyperlink( const XclExpRoot& rRoot,
                            const SvxURLField& rUrlField, const ScAddress& rScPos );
    virtual             ~XclExpHyperlink() override;

    const OUString* GetRepr() const { return m_Repr.isEmpty() ? nullptr : &m_Repr; }

    virtual void        SaveXml( XclExpXmlStream& rStrm ) override;

    void                WriteEmbeddedData( XclExpStream& rStrm );

    static OUString     BuildFileName(
                            sal_uInt16& rnLevel, bool& rbRel,
                            const OUString& rUrl, const XclExpRoot& rRoot, bool bEncoded );
private:

    virtual void        WriteBody( XclExpStream& rStrm ) override;

private:
    typedef std::unique_ptr< SvStream > SvStreamPtr;

    ScAddress           maScPos;            
    OUString            m_Repr;             
    SvStreamPtr         mxVarData;          
    sal_uInt32          mnFlags;            
    XclExpStringRef     mxTextMark;         
    OUString            msTarget;           
};

typedef XclExpRecordList< XclExpHyperlink > XclExpHyperlinkList;

// Label ranges ===============================================================

class XclExpLabelranges : public XclExpRecordBase, protected XclExpRoot
{
public:
    explicit            XclExpLabelranges( const XclExpRoot& rRoot );

    virtual void        Save( XclExpStream& rStrm ) override;

private:
    static void         FillRangeList( ScRangeList& rScRanges,
                            const ScRangePairListRef& xLabelRangesRef, SCTAB nScTab );

private:
    ScRangeList         maRowRanges;    
    ScRangeList         maColRanges;    
};

// Conditional formatting =====================================================

class XclExpCFImpl;

class XclExpCF : public XclExpRecord, protected XclExpRoot
{
public:
    explicit            XclExpCF( const XclExpRoot& rRoot, const ScCondFormatEntry& rFormatEntry, sal_Int32 nPriority, ScAddress aOrigin );
    virtual             ~XclExpCF() override;

    virtual void        SaveXml( XclExpXmlStream& rStrm ) override;

private:
    virtual void        WriteBody( XclExpStream& rStrm ) override;

private:
    typedef std::unique_ptr< XclExpCFImpl > XclExpCFImplPtr;
    XclExpCFImplPtr     mxImpl;
};

class XclExpDateFormat : public XclExpRecord, protected XclExpRoot
{
public:
    explicit XclExpDateFormat( const XclExpRoot& rRoot, const ScCondDateFormatEntry& rFormatEntry, sal_Int32 nPriority );
    virtual ~XclExpDateFormat() override;

    virtual void SaveXml( XclExpXmlStream& rStrm ) override;

private:
    const ScCondDateFormatEntry& mrFormatEntry;
    sal_Int32 mnPriority;
};

class XclExpCfvo : public XclExpRecord, protected XclExpRoot
{
public:
    explicit XclExpCfvo( const XclExpRoot& rRoot, const ScColorScaleEntry& rFormatEntry, const ScAddress& rPos, bool bFirst = true);

    virtual void SaveXml( XclExpXmlStream& rStrm ) override;
private:
    const ScColorScaleEntry& mrEntry;
    ScAddress maSrcPos;
    bool mbFirst;
};

class XclExpColScaleCol : public XclExpRecord, protected XclExpRoot
{
public:
    explicit XclExpColScaleCol( const XclExpRoot& rRoot, const Color& rColor);
    virtual ~XclExpColScaleCol() override;

    virtual void SaveXml( XclExpXmlStream& rStrm ) override;
private:
    const Color& mrColor;
};

class XclExpCondfmt : public XclExpRecord, protected XclExpRoot
{
public:
    explicit            XclExpCondfmt( const XclExpRoot& rRoot, const ScConditionalFormat& rCondFormat, const XclExtLstRef& xExtLst, sal_Int32& rIndex );
    virtual             ~XclExpCondfmt() override;

    bool                IsValidForBinary() const;
    bool                IsValidForXml() const;

    virtual void        Save( XclExpStream& rStrm ) override;
    virtual void        SaveXml( XclExpXmlStream& rStrm ) override;

private:
    virtual void        WriteBody( XclExpStream& rStrm ) override;

private:
    XclExpRecordList< XclExpRecord >
                        maCFList;       
    XclRangeList        maXclRanges;    
    OUString            msSeqRef;       
};

class XclExpColorScale: public XclExpRecord, protected XclExpRoot
{
public:
    explicit XclExpColorScale( const XclExpRoot& rRoot, const ScColorScaleFormat& rFormat, sal_Int32 nPriority );

    virtual void SaveXml( XclExpXmlStream& rStrm ) override;
private:
    typedef XclExpRecordList< XclExpCfvo > XclExpCfvoList;
    typedef XclExpRecordList< XclExpColScaleCol > XclExpColScaleColList;

    XclExpCfvoList maCfvoList;
    XclExpColScaleColList maColList;
    sal_Int32 mnPriority;
};

class XclExpDataBar : public XclExpRecord, protected XclExpRoot
{
public:
    explicit XclExpDataBar( const XclExpRoot& rRoot, const ScDataBarFormat& rFormat, sal_Int32 nPriority, const OString& rGUID);

    virtual void SaveXml( XclExpXmlStream& rStrm ) override;
private:
    std::unique_ptr<XclExpCfvo> mpCfvoLowerLimit;
    std::unique_ptr<XclExpCfvo> mpCfvoUpperLimit;
    std::unique_ptr<XclExpColScaleCol> mpCol;

    const ScDataBarFormat& mrFormat;
    sal_Int32 mnPriority;
    OString maGUID;
};

class XclExpIconSet : public XclExpRecord, protected XclExpRoot
{
public:
    explicit XclExpIconSet( const XclExpRoot& rRoot, const ScIconSetFormat& rFormat, sal_Int32 nPriority );

    virtual void SaveXml( XclExpXmlStream& rStrm ) override;
private:
    typedef XclExpRecordList< XclExpCfvo > XclExpCfvoList;

    XclExpCfvoList maCfvoList;
    const ScIconSetFormat& mrFormat;
    sal_Int32 mnPriority;
};

class XclExpCondFormatBuffer : public XclExpRecordBase, protected XclExpRoot
{
public:
    explicit            XclExpCondFormatBuffer( const XclExpRoot& rRoot, const XclExtLstRef& xExtLst );

    virtual void        Save( XclExpStream& rStrm ) override;
    virtual void        SaveXml( XclExpXmlStream& rStrm ) override;

private:
    typedef XclExpRecordList< XclExpCondfmt > XclExpCondfmtList;
    XclExpCondfmtList   maCondfmtList;  
};

// Data Validation ============================================================

class XclExpDV : public XclExpRecord, protected XclExpRoot
{
public:
    explicit            XclExpDV( const XclExpRoot& rRoot, sal_uLong nScHandle );
    virtual             ~XclExpDV() override;

    sal_uLong        GetScHandle() const { return mnScHandle; }

    void                InsertCellRange( const ScRange& rPos );
    bool                Finalize();

    virtual void        SaveXml( XclExpXmlStream& rStrm ) override;

private:
    virtual void        WriteBody( XclExpStream& rStrm ) override;

private:
    ScRangeList         maScRanges;     
    XclRangeList        maXclRanges;    
    XclExpString        maPromptTitle;  
    XclExpString        maPromptText;   
    XclExpString        maErrorTitle;   
    XclExpString        maErrorText;    
    XclExpStringRef     mxString1;      
    XclTokenArrayRef    mxTokArr1;      
    OUString            msFormula1;     
    OUString            msList;         
    XclTokenArrayRef    mxTokArr2;      
    OUString            msFormula2;     
    sal_uInt32          mnFlags;        
    sal_uLong               mnScHandle;     
};

class XclExpDval : public XclExpRecord, protected XclExpRoot
{
public:
    explicit            XclExpDval( const XclExpRoot& rRoot );
    virtual             ~XclExpDval() override;

    void                InsertCellRange( const ScRange& rRange, sal_uLong nScHandle );

    virtual void        Save( XclExpStream& rStrm ) override;
    virtual void        SaveXml( XclExpXmlStream& rStrm ) override;

private:
    XclExpDV&           SearchOrCreateDv( sal_uLong nScHandle );

    virtual void        WriteBody( XclExpStream& rStrm ) override;

private:
    typedef XclExpRecordList< XclExpDV >    XclExpDVList;
    typedef XclExpDVList::RecordRefType     XclExpDVRef;

    XclExpDVList        maDVList;       
    XclExpDVRef         mxLastFoundDV;  
};

// Web Queries ================================================================

class XclExpWebQuery : public XclExpRecordBase
{
public:
    explicit            XclExpWebQuery(
                            const OUString& rRangeName,
                            const OUString& rUrl,
                            std::u16string_view rSource,
                            sal_Int32 nRefrSecs );
    virtual             ~XclExpWebQuery() override;

    virtual void        Save( XclExpStream& rStrm ) override;

private:
    XclExpString        maDestRange;    
    XclExpString        maUrl;          
    XclExpStringRef     mxQryTables;    
    sal_Int16           mnRefresh;      
    bool                mbEntireDoc;    
};

class XclExpWebQueryBuffer : public XclExpRecordList< XclExpWebQuery >
{
public:
    explicit            XclExpWebQueryBuffer( const XclExpRoot& rRoot );
};

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */