xeescher.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 <vcl/graph.hxx>
#include <filter/msfilter/escherex.hxx>
#include "xcl97rec.hxx"
#include "xlescher.hxx"
#include "xlformula.hxx"
#include <svx/sdtaitm.hxx>
#include <rtl/ustring.hxx>
#include <memory>

class ScPostIt;

namespace utl { class TempFile; }
namespace com::sun::star::chart { class XChartDocument; }
namespace com::sun::star::script { struct ScriptEventDescriptor; }


// DFF client anchor ==========================================================

class XclExpDffAnchorBase : public EscherExClientAnchor_Base, protected XclExpRoot
{
public:
    explicit            XclExpDffAnchorBase( const XclExpRoot& rRoot, sal_uInt16 nFlags = 0 );

    void                SetFlags( const SdrObject& rSdrObj );
    void                SetSdrObject( const SdrObject& rSdrObj );

    void                WriteDffData( EscherEx& rEscherEx ) const;

    virtual void        WriteData( EscherEx& rEscherEx, const tools::Rectangle& rRect ) override;

private:
    virtual void        ImplSetFlags( const SdrObject& rSdrObj );
    virtual void        ImplCalcAnchorRect( const tools::Rectangle& rRect, MapUnit eMapUnit );

protected:  // for access in derived classes
    XclObjAnchor        maAnchor;       
    sal_uInt16          mnFlags;        
};

class XclExpDffSheetAnchor : public XclExpDffAnchorBase
{
public:
    explicit            XclExpDffSheetAnchor( const XclExpRoot& rRoot );

private:
    virtual void        ImplSetFlags( const SdrObject& rSdrObj ) override;
    virtual void        ImplCalcAnchorRect( const tools::Rectangle& rRect, MapUnit eMapUnit ) override;

private:
    SCTAB               mnScTab;        
};

class XclExpDffEmbeddedAnchor : public XclExpDffAnchorBase
{
public:
    explicit            XclExpDffEmbeddedAnchor( const XclExpRoot& rRoot,
                            const Size& rPageSize, sal_Int32 nScaleX, sal_Int32 nScaleY );

private:
    virtual void        ImplSetFlags( const SdrObject& rSdrObj ) override;
    virtual void        ImplCalcAnchorRect( const tools::Rectangle& rRect, MapUnit eMapUnit ) override;

private:
    Size                maPageSize;
    sal_Int32           mnScaleX;
    sal_Int32           mnScaleY;
};

class XclExpDffNoteAnchor : public XclExpDffAnchorBase
{
public:
    explicit            XclExpDffNoteAnchor( const XclExpRoot& rRoot, const tools::Rectangle& rRect );
};

class XclExpDffDropDownAnchor : public XclExpDffAnchorBase
{
public:
    explicit            XclExpDffDropDownAnchor( const XclExpRoot& rRoot, const ScAddress& rScPos );
};

// MSODRAWING* records ========================================================

class XclExpMsoDrawingBase : public XclExpRecord
{
public:
    explicit            XclExpMsoDrawingBase( XclEscherEx& rEscherEx, sal_uInt16 nRecId );

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

protected:
    XclEscherEx&        mrEscherEx;         
    sal_uInt32          mnFragmentKey;      
};

class XclExpMsoDrawingGroup : public XclExpMsoDrawingBase
{
public:
    explicit            XclExpMsoDrawingGroup( XclEscherEx& rEscherEx );
};

class XclExpMsoDrawing : public XclExpMsoDrawingBase
{
public:
    explicit            XclExpMsoDrawing( XclEscherEx& rEscherEx );
};

class XclExpImgData : public XclExpRecordBase
{
public:
    explicit            XclExpImgData( const Graphic& rGraphic, sal_uInt16 nRecId );

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

private:
    Graphic             maGraphic;      
    sal_uInt16          mnRecId;        
};

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

protected:
    void                ConvertSheetLinks(
                            css::uno::Reference< css::drawing::XShape > const & xShape );

    const XclTokenArray* GetCellLinkTokArr() const { return mxCellLink.get(); }
    const XclTokenArray* GetSourceRangeTokArr() const { return mxSrcRange.get(); }
    sal_uInt16   GetSourceEntryCount() const { return mnEntryCount; }

    static void         WriteFormula( XclExpStream& rStrm, const XclTokenArray& rTokArr );
    static void         WriteFormulaSubRec( XclExpStream& rStrm, sal_uInt16 nSubRecId, const XclTokenArray& rTokArr );

private:
    XclTokenArrayRef    mxCellLink;     
    XclTokenArrayRef    mxSrcRange;     
    sal_uInt16          mnEntryCount;   
protected:
    ScAddress mxCellLinkAddress;
};

class XclMacroHelper : public XclExpControlHelper
{
    XclTokenArrayRef    mxMacroLink;    

public:
    explicit            XclMacroHelper( const XclExpRoot& rRoot );
    virtual             ~XclMacroHelper() override;
    void                WriteMacroSubRec( XclExpStream& rStrm  );
    bool                SetMacroLink( const css::script::ScriptEventDescriptor& rEvent,  const XclTbxEventType& nEventType );

    bool                SetMacroLink( const OUString& rMacro );
};

class XclExpShapeObj : public XclObjAny, public XclMacroHelper
{
public:
    explicit            XclExpShapeObj( XclExpObjectManager& rRoot, css::uno::Reference< css::drawing::XShape > const & xShape, ScDocument* pDoc );
    virtual             ~XclExpShapeObj() override;
private:
    virtual void        WriteSubRecs( XclExpStream& rStrm ) override;
};

//delete for exporting OCX
//#if EXC_EXP_OCX_CTRL

class XclExpOcxControlObj : public XclObj, public XclExpControlHelper
{
public:
    explicit            XclExpOcxControlObj(
                            XclExpObjectManager& rObjMgr,
                            css::uno::Reference< css::drawing::XShape > const & xShape,
                            const tools::Rectangle* pChildAnchor,
                            const OUString& rClassName,
                            sal_uInt32 nStrmStart, sal_uInt32 nStrmSize );

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

private:
    OUString            maClassName;        
    sal_uInt32          mnStrmStart;        
    sal_uInt32          mnStrmSize;         
};

//#else

class XclExpTbxControlObj : public XclObj, public XclMacroHelper
{
public:
    explicit            XclExpTbxControlObj(
                            XclExpObjectManager& rObjMgr,
                            css::uno::Reference< css::drawing::XShape > const & xShape,
                            const tools::Rectangle* pChildAnchor );

    bool                SetMacroLink( const css::script::ScriptEventDescriptor& rEvent );

    virtual void        SaveXml( XclExpXmlStream& rStrm ) override;

    OUString SaveControlPropertiesXml(XclExpXmlStream& rStrm) const;
    void SaveSheetXml(XclExpXmlStream& rStrm, const OUString& aIdFormControlPr) const;

    void setShapeId(sal_Int32 aShapeId);

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

    void                WriteCellLinkSubRec( XclExpStream& rStrm, sal_uInt16 nSubRecId );
    void                WriteSbs( XclExpStream& rStrm );

private:
    const css::uno::Reference< css::drawing::XShape > mxShape;
    ScfInt16Vec         maMultiSel;     
    XclTbxEventType     meEventType;    
    sal_Int32           mnHeight;       
    sal_uInt16          mnState;        
    sal_Int16           mnLineCount;    
    sal_Int16           mnSelEntry;     
    sal_uInt16          mnScrollValue;  
    sal_uInt16          mnScrollMin;    
    sal_uInt16          mnScrollMax;    
    sal_uInt16          mnScrollStep;   
    sal_uInt16          mnScrollPage;   
    bool                mbFlatButton;   
    bool                mbFlatBorder;   
    bool                mbMultiSel;     
    bool                mbScrollHor;    
    bool                mbPrint;
    bool                mbVisible;
    OUString            msCtrlName;
    OUString            msLabel;
    sal_Int32           mnShapeId;
    tools::Rectangle    maAreaFrom;
    tools::Rectangle    maAreaTo;
};

//#endif

class XclExpChart;

class XclExpChartObj : public XclObj, protected XclExpRoot
{
public:
    explicit            XclExpChartObj(
                            XclExpObjectManager& rObjMgr,
                            css::uno::Reference< css::drawing::XShape > const & xShape,
                            const tools::Rectangle* pChildAnchor,
                            ScDocument* pDoc );
    virtual             ~XclExpChartObj() override;

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

    const css::uno::Reference<css::chart::XChartDocument>& GetChartDoc() const;

private:
    typedef std::shared_ptr< XclExpChart > XclExpChartRef;
    XclExpChartRef                                    mxChart;        
    css::uno::Reference< css::drawing::XShape >       mxShape;
    css::uno::Reference< css::chart::XChartDocument > mxChartDoc;
    ScDocument*                                       mpDoc;
};

class XclExpNote : public XclExpRecord
{
public:
    explicit            XclExpNote(
                            const XclExpRoot& rRoot,
                            const ScAddress& rScPos,
                            const ScPostIt* pScNote,
                            std::u16string_view rAddText );

    virtual void        Save( XclExpStream& rStrm ) override;

    void                WriteXml( sal_Int32 nAuthorId, XclExpXmlStream& rStrm );

    const XclExpString& GetAuthor() const { return maAuthor; }
private:
    virtual void        WriteBody( XclExpStream& rStrm ) override;

private:
    const XclExpRoot&   mrRoot;
    XclExpString        maAuthor;       
    OString             maNoteText;     
    XclExpStringRef     mpNoteContents; 
    ScAddress           maScPos;        
    sal_uInt16          mnObjId;        
    bool                mbVisible;      
    SdrTextHorzAdjust   meTHA;          
    SdrTextVertAdjust   meTVA;          
    bool                mbAutoScale;    
    bool                mbLocked;       
    bool                mbAutoFill;     
    bool                mbColHidden;    
    bool                mbRowHidden;    
    tools::Rectangle           maCommentFrom;  
    tools::Rectangle           maCommentTo;    
};

class XclExpComments : public XclExpRecord
{
public:
                        XclExpComments( SCTAB nTab, XclExpRecordList< XclExpNote >& rNotes );

    virtual void        SaveXml( XclExpXmlStream& rStrm ) override;

private:
    SCTAB               mnTab;
    XclExpRecordList< XclExpNote >& mrNotes;
};

// object manager =============================================================

class XclExpObjectManager : public XclExpRoot
{
public:
    explicit            XclExpObjectManager( const XclExpRoot& rRoot );
    virtual             ~XclExpObjectManager() override;

    virtual XclExpDffAnchorBase* CreateDffAnchor() const;

    rtl::Reference< XclExpRecordBase > CreateDrawingGroup();

    void                StartSheet();

    rtl::Reference< XclExpRecordBase > ProcessDrawing( const SdrPage* pSdrPage );
    rtl::Reference< XclExpRecordBase > ProcessDrawing( const css::uno::Reference< css::drawing::XShapes >& rxShapes );

    void                EndDocument();

    XclEscherEx& GetEscherEx() { return *mxEscherEx; }
    XclExpMsoDrawing*   GetMsodrawingPerSheet();
    bool                HasObj() const;
    sal_uInt16          AddObj( std::unique_ptr<XclObj> pObjRec );
    std::unique_ptr<XclObj> RemoveLastObj();

protected:
    explicit            XclExpObjectManager( const XclExpObjectManager& rParent );

private:
    void                InitStream( bool bTempFile );

private:
    std::shared_ptr< ::utl::TempFile > mxTempFile;
    std::unique_ptr< SvStream >  mxDffStrm;
    std::shared_ptr< XclEscherEx > mxEscherEx;
    rtl::Reference< XclExpObjList > mxObjList;
};

class XclExpEmbeddedObjectManager : public XclExpObjectManager
{
public:
    explicit            XclExpEmbeddedObjectManager(
                            const XclExpObjectManager& rParent,
                            const Size& rPageSize,
                            sal_Int32 nScaleX, sal_Int32 nScaleY );

    virtual XclExpDffAnchorBase* CreateDffAnchor() const override;

private:
    Size                maPageSize;
    sal_Int32           mnScaleX;
    sal_Int32           mnScaleY;
};

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