vmlshape.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 .
 */
 
#ifndef INCLUDED_OOX_VML_VMLSHAPE_HXX
#define INCLUDED_OOX_VML_VMLSHAPE_HXX
 
#include <memory>
#include <vector>
 
#include <com/sun/star/awt/Point.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include <oox/dllapi.h>
#include <oox/helper/helper.hxx>
#include <oox/vml/vmlformatting.hxx>
#include <rtl/ustring.hxx>
#include <sal/types.h>
 
namespace com::sun::star {
    namespace awt { struct Rectangle; }
    namespace drawing { class XShape; }
    namespace drawing { class XShapes; }
    namespace graphic { class XGraphic; }
}
 
namespace oox::vml {
 
class Drawing;
struct ShapeParentAnchor;
class ShapeContainer;
class TextBox;
 
const sal_Int32 VML_CLIENTDATA_UNCHECKED        = 0;
const sal_Int32 VML_CLIENTDATA_CHECKED          = 1;
const sal_Int32 VML_CLIENTDATA_MIXED            = 2;
 
const sal_Int32 VML_CLIENTDATA_TEXT             = 0;
const sal_Int32 VML_CLIENTDATA_INTEGER          = 1;
const sal_Int32 VML_CLIENTDATA_NUMBER           = 2;
const sal_Int32 VML_CLIENTDATA_REFERENCE        = 3;
const sal_Int32 VML_CLIENTDATA_FORMULA          = 4;
 
 
struct ShapeTypeModel
{
    OUString     maShapeId;              
    OUString     maLegacyId;             
    OUString     maShapeName;            
    std::optional< sal_Int32 > moShapeType;          
 
    std::optional< Int32Pair > moCoordPos;           
    std::optional< Int32Pair > moCoordSize;          
    OUString     maPosition;             
    OUString     maZIndex;                
    OUString     maLeft;                 
    OUString     maTop;                  
    OUString     maWidth;                
    OUString     maHeight;               
    OUString     maMarginLeft;           
    OUString     maMarginTop;            
    OUString     maPositionHorizontalRelative; 
    OUString     maPositionVerticalRelative; 
    OUString     maPositionHorizontal;   
    OUString     maPositionVertical;     
    OUString     maWidthPercent;         
    OUString     maHeightPercent;        
    OUString     maWidthRelative;        
    OUString     maHeightRelative;       
    OUString     maRotation;             
    OUString     maFlip;                 
    bool         mbAutoHeight;           
    bool         mbVisible;              
    OUString     maWrapStyle;            
    OUString     maArcsize;              
    OUString     maEditAs;               
    OUString     maAdjustments;          
 
    StrokeModel         maStrokeModel;          
    FillModel           maFillModel;            
    ShadowModel         maShadowModel;          
    TextpathModel       maTextpathModel;        
 
    std::optional< OUString > moGraphicPath;  
    std::optional< OUString > moGraphicTitle; 
    std::optional< OUString > moWrapAnchorX;  
    std::optional< OUString > moWrapAnchorY;  
    std::optional< OUString > moWrapType;     
    std::optional< OUString > moWrapSide;     
    OUString maVTextAnchor; 
    OUString maWrapDistanceLeft;         
    OUString maWrapDistanceRight;        
    OUString maWrapDistanceTop;          
    OUString maWrapDistanceBottom;       
    std::optional<OUString> moCropBottom; 
    std::optional<OUString> moCropLeft; 
    std::optional<OUString> moCropRight; 
    std::optional<OUString> moCropTop; 
    OUString maLayoutFlowAlt; 
 
    sal_Int32 mnGain = 0x10000;
 
    sal_Int16 mnBlacklevel = 0;
 
    explicit            ShapeTypeModel();
 
    void                assignUsed( const ShapeTypeModel& rSource );
};
 
 
class SAL_DLLPUBLIC_RTTI ShapeType
{
public:
    explicit            ShapeType( Drawing& rDrawing );
    virtual             ~ShapeType();
 
    ShapeTypeModel& getTypeModel() { return maTypeModel; }
    const ShapeTypeModel& getTypeModel() const { return maTypeModel; }
 
    const OUString& getShapeId() const { return maTypeModel.maShapeId; }
    sal_Int32           getShapeType() const;
    OUString     getGraphicPath() const;
 
    const Drawing& getDrawing() const { return mrDrawing; }
 
protected:
    css::awt::Rectangle getCoordSystem() const;
    css::awt::Rectangle getRectangle( const ShapeParentAnchor* pParentAnchor ) const;
    virtual css::awt::Rectangle getAbsRectangle() const;
    virtual css::awt::Rectangle getRelRectangle() const;
 
protected:
    Drawing&            mrDrawing;          
    ShapeTypeModel      maTypeModel;        
};
 
 
struct ClientData
{
    OUString     maAnchor;           
    OUString     maFmlaMacro;        
    OUString     maFmlaPict;         
    OUString     maFmlaLink;         
    OUString     maFmlaRange;        
    OUString     maFmlaGroup;        
    sal_Int32           mnObjType;          
    sal_Int32           mnTextHAlign;       
    sal_Int32           mnTextVAlign;       
    sal_Int32           mnCol;              
    sal_Int32           mnRow;              
    sal_Int32           mnChecked;          
    sal_Int32           mnDropStyle;        
    sal_Int32           mnDropLines;        
    sal_Int32           mnVal;              
    sal_Int32           mnMin;              
    sal_Int32           mnMax;              
    sal_Int32           mnInc;              
    sal_Int32           mnPage;             
    sal_Int32           mnSelType;          
    sal_Int32           mnVTEdit;           
    bool                mbPrintObject;      
    bool                mbVisible;          
    bool                mbDde;              
    bool                mbNo3D;             
    bool                mbNo3D2;            
    bool                mbMultiLine;        
    bool                mbVScroll;          
    bool                mbSecretEdit;       
 
    explicit            ClientData();
};
 
 
struct ShapeModel
{
    typedef ::std::vector< css::awt::Point >   PointVector;
 
    OUString     maType;             
    PointVector         maPoints;           
    std::unique_ptr<TextBox>          mxTextBox;          
    std::unique_ptr<ClientData>       mxClientData;       
    OUString     maLegacyDiagramPath;
    OUString     maFrom;             
    OUString     maTo;               
    OUString     maControl1;         
    OUString     maControl2;         
    OUString     maVmlPath;          
    bool         mbIsSignatureLine;  
    OUString     maSignatureId;      
    OUString     maSignatureLineSuggestedSignerName;
    OUString     maSignatureLineSuggestedSignerTitle;
    OUString     maSignatureLineSuggestedSignerEmail;
    OUString     maSignatureLineSigningInstructions;
    bool         mbSignatureLineShowSignDate;
    bool         mbSignatureLineCanAddComment;
    bool         mbInGroup;
    OUString     maHyperlink; 
 
    explicit            ShapeModel();
                        ~ShapeModel();
 
    TextBox&            createTextBox(ShapeTypeModel& rModel);
    ClientData&         createClientData();
};
 
 
class OOX_DLLPUBLIC ShapeBase : public ShapeType
{
public:
    ShapeModel&  getShapeModel() { return maShapeModel; }
    const ShapeModel& getShapeModel() const { return maShapeModel; }
 
    const TextBox* getTextBox() const { return maShapeModel.mxTextBox.get(); }
    const ClientData* getClientData() const { return maShapeModel.mxClientData.get(); }
 
    virtual void        finalizeFragmentImport();
 
    OUString     getShapeName() const;
 
    virtual const ShapeType* getChildTypeById( const OUString& rShapeId ) const;
    virtual const ShapeBase* getChildById( const OUString& rShapeId ) const;
 
    css::uno::Reference< css::drawing::XShape >
                        convertAndInsert(
                            const css::uno::Reference< css::drawing::XShapes >& rxShapes,
                            const ShapeParentAnchor* pParentAnchor = nullptr ) const;
 
    void                convertFormatting(
                            const css::uno::Reference< css::drawing::XShape >& rxShape ) const;
 
    void setContainer(ShapeContainer* pContainer);
    ShapeContainer* getContainer() const;
 
protected:
    explicit            ShapeBase( Drawing& rDrawing );
 
    virtual css::uno::Reference< css::drawing::XShape >
                        implConvertAndInsert(
                            const css::uno::Reference< css::drawing::XShapes >& rxShapes,
                            const css::awt::Rectangle& rShapeRect ) const = 0;
 
    virtual css::uno::Reference<css::drawing::XShape> finalImplConvertAndInsert(
        const css::uno::Reference<css::drawing::XShape>& rxShape) const
    {
        return rxShape;
    };
 
    css::awt::Rectangle calcShapeRectangle(
                            const ShapeParentAnchor* pParentAnchor ) const;
 
    void                convertShapeProperties(
                            const css::uno::Reference< css::drawing::XShape >& rxShape ) const;
 
protected:
    ShapeModel          maShapeModel;       
    ShapeContainer*     mpContainer = nullptr;
};
 
 
class SimpleShape : public ShapeBase
{
public:
    explicit            SimpleShape( Drawing& rDrawing, OUString aService );
 
    void setService( const OUString& aService ) { maService = aService; }
 
protected:
    virtual css::uno::Reference< css::drawing::XShape >
                        implConvertAndInsert(
                            const css::uno::Reference< css::drawing::XShapes >& rxShapes,
                            const css::awt::Rectangle& rShapeRect ) const override;
    virtual css::uno::Reference<css::drawing::XShape> finalImplConvertAndInsert(
        const css::uno::Reference<css::drawing::XShape>& rxShape) const override;
    css::uno::Reference<css::drawing::XShape>createEmbeddedPictureObject(
        const css::uno::Reference< css::drawing::XShapes >& rxShapes,
        const css::awt::Rectangle& rShapeRect, OUString const & rGraphicPath ) const;
 
    css::uno::Reference<css::drawing::XShape>createPictureObject(
            const css::uno::Reference< css::drawing::XShapes >& rxShapes,
            const css::awt::Rectangle& rShapeRect,
            css::uno::Reference<css::graphic::XGraphic> const & rxGraphic) const;
 
private:
    OUString     maService;          
};
 
 
class RectangleShape final : public SimpleShape
{
public:
    explicit            RectangleShape( Drawing& rDrawing );
private:
    virtual css::uno::Reference<css::drawing::XShape>
                        implConvertAndInsert(
                            const css::uno::Reference<css::drawing::XShapes>& rxShapes,
                            const css::awt::Rectangle& rShapeRect) const override;
};
 
 
class EllipseShape final : public SimpleShape
{
public:
    explicit            EllipseShape( Drawing& rDrawing );
};
 
 
class PolyLineShape final : public SimpleShape
{
public:
    explicit            PolyLineShape( Drawing& rDrawing );
 
private:
    virtual css::uno::Reference< css::drawing::XShape >
                        implConvertAndInsert(
                            const css::uno::Reference< css::drawing::XShapes >& rxShapes,
                            const css::awt::Rectangle& rShapeRect ) const override;
};
 
class LineShape final : public SimpleShape
{
public:
    explicit            LineShape( Drawing& rDrawing );
    virtual css::uno::Reference< css::drawing::XShape >
                        implConvertAndInsert(
                            const css::uno::Reference< css::drawing::XShapes >& rxShapes,
                            const css::awt::Rectangle& rShapeRect ) const override;
 
 
private:
    virtual css::awt::Rectangle getAbsRectangle() const override;
    virtual css::awt::Rectangle getRelRectangle() const override;
};
 
class BezierShape final : public SimpleShape
{
public:
    explicit             BezierShape( Drawing& rDrawing );
 
private:
    virtual css::uno::Reference< css::drawing::XShape >
                        implConvertAndInsert(
                            const css::uno::Reference< css::drawing::XShapes >& rxShapes,
                            const css::awt::Rectangle& rShapeRect ) const override;
};
 
 
class CustomShape : public SimpleShape
{
public:
    explicit            CustomShape( Drawing& rDrawing );
 
protected:
    virtual css::uno::Reference< css::drawing::XShape >
                        implConvertAndInsert(
                            const css::uno::Reference< css::drawing::XShapes >& rxShapes,
                            const css::awt::Rectangle& rShapeRect ) const override;
};
 
 
class ComplexShape final : public CustomShape
{
public:
    explicit            ComplexShape( Drawing& rDrawing );
 
private:
    virtual css::uno::Reference< css::drawing::XShape >
                        implConvertAndInsert(
                            const css::uno::Reference< css::drawing::XShapes >& rxShapes,
                            const css::awt::Rectangle& rShapeRect ) const override;
};
 
 
class GroupShape final : public ShapeBase
{
public:
    explicit            GroupShape( Drawing& rDrawing );
    virtual             ~GroupShape() override;
 
    ShapeContainer& getChildren() { return *mxChildren; }
    const ShapeContainer& getChildren() const { return *mxChildren; }
 
    virtual void        finalizeFragmentImport() override;
 
    virtual const ShapeType* getChildTypeById( const OUString& rShapeId ) const override;
    virtual const ShapeBase* getChildById( const OUString& rShapeId ) const override;
 
private:
    virtual css::uno::Reference< css::drawing::XShape >
                        implConvertAndInsert(
                            const css::uno::Reference< css::drawing::XShapes >& rxShapes,
                            const css::awt::Rectangle& rShapeRect ) const override;
 
private:
    std::unique_ptr<ShapeContainer>   mxChildren;         
};
 
 
} // namespace oox::vml
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */