Regina Henschel
0430adb42b
Currently LibreOffice uses the VML fallback, when a docx document has a wpc:wpc element. This patch implements to use the choice part with the wpc:wpc element. That is often called 'drawing canvas'. The patch uses a similar approach as for SmartArt. The drawing canvas is imported as group shape and for the background an additional rectangular shape is inserted as first in the children vector. Not using VML has the advantage, that the custom shape import is used for preset shapes. VML import produces problems because some properties are not available in VML or the current VML import has deficits. The test suite shows examples, what is better without using the VML fallback. Affected bug reports are e.g. tdf#104671 or tdf#154828. A drawing canvas must be used in Word for connector shapes. A connector in Word on the drawing canvas is not written as cxnSp element, but as ordinary wsp element with additional wps:cNvCnPr child element. The patch generates a connector in such case. Unsolved problems: The path of a curved connector in OOXML is basically incompatible to the path which LibreOffice generates. This patch uses the default path for a curved connector. Same is done in import in Impress. Using the VML fallback had generated a custom shape with the current path and handles, but the connections to the target shapes were lost. Export to docx is missing. The drawing canvas is not recreated, instead a group with the additional background shape is exported. That is no regression, using VML has produced a group too on export. I don't know whether XML_graphicFrame can occur in WordprocessingCanvasContext. At least charts and math equations are not possible on the drawing canvas in Word. Import of WordArt shapes does not work. That is not regression. It works neither in the VML import. Change-Id: I04bf8407efd1939cdf3137775f8afad420b74014 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/156629 Tested-by: Jenkins Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
432 lines
20 KiB
C++
432 lines
20 KiB
C++
/* -*- 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_DRAWINGML_SHAPE_HXX
|
|
#define INCLUDED_OOX_DRAWINGML_SHAPE_HXX
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
#include <string_view>
|
|
#include <vector>
|
|
|
|
#include <com/sun/star/awt/Point.hpp>
|
|
#include <com/sun/star/awt/Size.hpp>
|
|
#include <com/sun/star/beans/PropertyValue.hpp>
|
|
#include <com/sun/star/uno/Reference.hxx>
|
|
#include <com/sun/star/uno/Sequence.hxx>
|
|
|
|
#include <oox/core/xmlfilterbase.hxx>
|
|
#include <oox/dllapi.h>
|
|
#include <oox/drawingml/color.hxx>
|
|
#include <oox/drawingml/connectorshapecontext.hxx>
|
|
#include <oox/drawingml/drawingmltypes.hxx>
|
|
#include <oox/helper/propertymap.hxx>
|
|
#include <rtl/ustring.hxx>
|
|
#include <sal/types.h>
|
|
|
|
namespace basegfx { class B2DHomMatrix; }
|
|
|
|
namespace com::sun::star {
|
|
namespace awt { struct Rectangle; }
|
|
namespace drawing { class XShape; }
|
|
namespace drawing { class XShapes; }
|
|
namespace uno { class Any; }
|
|
}
|
|
|
|
namespace oox::core {
|
|
class XmlFilterBase;
|
|
}
|
|
|
|
namespace oox::vml {
|
|
struct OleObjectInfo;
|
|
}
|
|
|
|
namespace svx::diagram {
|
|
class IDiagramHelper;
|
|
}
|
|
|
|
namespace oox::drawingml {
|
|
|
|
class Theme;
|
|
struct EffectProperties;
|
|
struct FillProperties;
|
|
struct GraphicProperties;
|
|
struct LineProperties;
|
|
struct Shape3DProperties;
|
|
class AdvancedDiagramHelper;
|
|
class CustomShapeProperties;
|
|
typedef std::shared_ptr< CustomShapeProperties > CustomShapePropertiesPtr;
|
|
|
|
typedef ::std::map< OUString, ShapePtr > ShapeIdMap;
|
|
|
|
typedef std::vector<ConnectorShapeProperties> ConnectorShapePropertiesList;
|
|
|
|
struct ShapeStyleRef
|
|
{
|
|
Color maPhClr;
|
|
sal_Int32 mnThemedIdx;
|
|
ShapeStyleRef() : mnThemedIdx(0) {}
|
|
};
|
|
|
|
typedef ::std::map< sal_Int32, ShapeStyleRef > ShapeStyleRefMap;
|
|
|
|
/** Additional information for a chart embedded in a drawing shape. */
|
|
struct ChartShapeInfo
|
|
{
|
|
OUString maFragmentPath; ///< Path to related XML stream, e.g. for charts.
|
|
bool mbEmbedShapes; ///< True = load chart shapes into chart, false = load into parent drawpage.
|
|
|
|
explicit ChartShapeInfo( bool bEmbedShapes ) : mbEmbedShapes( bEmbedShapes ) {}
|
|
};
|
|
|
|
/// Attributes for a linked textbox.
|
|
struct LinkedTxbxAttr
|
|
{
|
|
sal_Int32 id;
|
|
sal_Int32 seq;
|
|
LinkedTxbxAttr(): id(0),seq(0){};
|
|
};
|
|
|
|
class Diagram;
|
|
|
|
class OOX_DLLPUBLIC Shape
|
|
: public std::enable_shared_from_this< Shape >
|
|
{
|
|
public:
|
|
|
|
explicit Shape( const char* pServiceType = nullptr, bool bDefaultHeight = true );
|
|
explicit Shape( const ShapePtr& pSourceShape );
|
|
Shape(Shape const &) = default;
|
|
virtual ~Shape();
|
|
Shape & operator =(Shape const &) = default;
|
|
|
|
OUString& getServiceName(){ return msServiceName; }
|
|
void setServiceName( const char* pServiceName );
|
|
|
|
const OUString& getDiagramDataModelID() const { return msDiagramDataModelID; }
|
|
void setDiagramDataModelID( const OUString& rDiagramDataModelID ) { msDiagramDataModelID = rDiagramDataModelID; }
|
|
|
|
PropertyMap& getShapeProperties(){ return maShapeProperties; }
|
|
|
|
LineProperties& getLineProperties() { return *mpLinePropertiesPtr; }
|
|
const LineProperties& getLineProperties() const { return *mpLinePropertiesPtr; }
|
|
|
|
FillProperties& getFillProperties() { return *mpFillPropertiesPtr; }
|
|
const FillProperties& getFillProperties() const { return *mpFillPropertiesPtr; }
|
|
|
|
GraphicProperties& getGraphicProperties() { return *mpGraphicPropertiesPtr; }
|
|
const GraphicProperties& getGraphicProperties() const { return *mpGraphicPropertiesPtr; }
|
|
|
|
CustomShapePropertiesPtr& getCustomShapeProperties(){ return mpCustomShapePropertiesPtr; }
|
|
|
|
OUString& getConnectorName() { return msConnectorName; }
|
|
std::vector<OUString>& getConnectorAdjustments() { return maConnectorAdjustmentList; };
|
|
ConnectorShapePropertiesList& getConnectorShapeProperties() { return maConnectorShapePropertiesList; }
|
|
void setConnectorShape(bool bConnector) { mbConnector = bConnector; }
|
|
bool isConnectorShape() const { return mbConnector; }
|
|
|
|
Shape3DProperties& get3DProperties() { return *mp3DPropertiesPtr; }
|
|
const Shape3DProperties& get3DProperties() const { return *mp3DPropertiesPtr; }
|
|
|
|
table::TablePropertiesPtr const & getTableProperties();
|
|
|
|
EffectProperties& getEffectProperties() const { return *mpEffectPropertiesPtr; }
|
|
|
|
void setChildPosition( css::awt::Point nPosition ){ maChPosition = nPosition; }
|
|
void setChildSize( css::awt::Size aSize ){ maChSize = aSize; }
|
|
|
|
void setPosition( css::awt::Point nPosition ){ maPosition = nPosition; }
|
|
const css::awt::Point& getPosition() const { return maPosition; }
|
|
|
|
void setSize( css::awt::Size aSize ){ maSize = aSize; }
|
|
const css::awt::Size& getSize() const { return maSize; }
|
|
|
|
void setRotation( sal_Int32 nRotation ) { mnRotation = nRotation; }
|
|
sal_Int32 getRotation() const { return mnRotation; }
|
|
void setDiagramRotation( sal_Int32 nRotation ) { mnDiagramRotation = nRotation; }
|
|
void setFlip( bool bFlipH, bool bFlipV ) { mbFlipH = bFlipH; mbFlipV = bFlipV; }
|
|
bool getFlipH() const { return mbFlipH; }
|
|
bool getFlipV() const { return mbFlipV; }
|
|
void addChild( const ShapePtr& rChildPtr ) { maChildren.push_back( rChildPtr ); }
|
|
std::vector< ShapePtr >& getChildren() { return maChildren; }
|
|
|
|
void setName( const OUString& rName ) { msName = rName; }
|
|
const OUString& getName( ) const { return msName; }
|
|
void setInternalName( const OUString& rInternalName ) { msInternalName = rInternalName; }
|
|
const OUString& getInternalName() const { return msInternalName; }
|
|
void setId( const OUString& rId ) { msId = rId; }
|
|
const OUString& getId() const { return msId; }
|
|
void setDescription( const OUString& rDescr ) { msDescription = rDescr; }
|
|
void setDecorative(bool const isDecorative) { m_isDecorative = isDecorative; }
|
|
void setHidden( bool bHidden ) { mbHidden = bHidden; }
|
|
void setHiddenMasterShape( bool bHiddenMasterShape ) { mbHiddenMasterShape = bHiddenMasterShape; }
|
|
void setLocked( bool bLocked ) { mbLocked = bLocked; }
|
|
void setSubType( sal_Int32 nSubType ) { mnSubType = nSubType; }
|
|
sal_Int32 getSubType() const { return mnSubType; }
|
|
void setSubTypeIndex( sal_Int32 nSubTypeIndex ) { moSubTypeIndex = nSubTypeIndex; }
|
|
const std::optional< sal_Int32 >& getSubTypeIndex() const { return moSubTypeIndex; }
|
|
|
|
// setDefaults has to be called if styles are imported (OfficeXML is not storing properties having the default value)
|
|
void setDefaults(bool bHeight);
|
|
|
|
::oox::vml::OleObjectInfo& setOleObjectType();
|
|
ChartShapeInfo& setChartType( bool bEmbedShapes );
|
|
void setDiagramType();
|
|
void setTableType();
|
|
|
|
void setTextBody(const TextBodyPtr & pTextBody);
|
|
const TextBodyPtr& getTextBody() const { return mpTextBody;}
|
|
void setMasterTextListStyle( const TextListStylePtr& pMasterTextListStyle );
|
|
const TextListStylePtr& getMasterTextListStyle() const { return mpMasterTextListStyle; }
|
|
|
|
ShapeStyleRefMap& getShapeStyleRefs() { return maShapeStyleRefs; }
|
|
const ShapeStyleRefMap& getShapeStyleRefs() const { return maShapeStyleRefs; }
|
|
const ShapeStyleRef* getShapeStyleRef( sal_Int32 nRefType ) const;
|
|
bool hasShapeStyleRefs() const { return !maShapeStyleRefs.empty(); }
|
|
|
|
// addShape is creating and inserting the corresponding XShape.
|
|
void addShape(
|
|
::oox::core::XmlFilterBase& rFilterBase,
|
|
const Theme* pTheme,
|
|
const css::uno::Reference< css::drawing::XShapes >& rxShapes,
|
|
const basegfx::B2DHomMatrix& aTransformation,
|
|
const FillProperties& rShapeOrParentShapeFillProps,
|
|
ShapeIdMap* pShapeMap = nullptr,
|
|
oox::drawingml::ShapePtr pParentGroupShape = nullptr);
|
|
|
|
const css::uno::Reference< css::drawing::XShape > &
|
|
getXShape() const { return mxShape; }
|
|
|
|
void applyShapeReference( const Shape& rReferencedShape, bool bUseText = true );
|
|
const ::std::vector<OUString>&
|
|
getExtDrawings() const { return maExtDrawings; }
|
|
void addExtDrawingRelId( const OUString &rRelId ) { maExtDrawings.push_back( rRelId ); }
|
|
// Set font color only for extdrawings.
|
|
void setFontRefColorForNodes(const Color& rColor) { maFontRefColorForNodes = rColor; }
|
|
const Color& getFontRefColorForNodes() const { return maFontRefColorForNodes; }
|
|
void setLockedCanvas(bool bLockedCanvas);
|
|
bool getLockedCanvas() const { return mbLockedCanvas;}
|
|
void setWordprocessingCanvas(bool bWordprocessingCanvas);
|
|
bool isInWordprocessingCanvas() const {return mbWordprocessingCanvas;}
|
|
void setWPGChild(bool bWPG);
|
|
bool isWPGChild() const { return mbWPGChild;}
|
|
void setWps(bool bWps);
|
|
bool getWps() const { return mbWps;}
|
|
void setTextBox(bool bTextBox);
|
|
const css::uno::Sequence<css::beans::PropertyValue> &
|
|
getDiagramDoms() const { return maDiagramDoms; }
|
|
void setDiagramDoms(const css::uno::Sequence<css::beans::PropertyValue>& rDiagramDoms) { maDiagramDoms = rDiagramDoms; }
|
|
css::uno::Sequence< css::uno::Sequence< css::uno::Any > >resolveRelationshipsOfTypeFromOfficeDoc(
|
|
core::XmlFilterBase& rFilter, const OUString& sFragment, std::u16string_view sType );
|
|
void setLinkedTxbxAttributes(const LinkedTxbxAttr& rhs){ maLinkedTxbxAttr = rhs; };
|
|
void setTxbxHasLinkedTxtBox( const bool rhs){ mbHasLinkedTxbx = rhs; };
|
|
const LinkedTxbxAttr& getLinkedTxbxAttributes() const { return maLinkedTxbxAttr; };
|
|
bool isLinkedTxbx() const { return mbHasLinkedTxbx; };
|
|
|
|
void setZOrder(sal_Int32 nZOrder) { mnZOrder = nZOrder; }
|
|
|
|
sal_Int32 getZOrder() const { return mnZOrder; }
|
|
|
|
void setZOrderOff(sal_Int32 nZOrderOff) { mnZOrderOff = nZOrderOff; }
|
|
|
|
sal_Int32 getZOrderOff() const { return mnZOrderOff; }
|
|
|
|
void setDataNodeType(sal_Int32 nDataNodeType) { mnDataNodeType = nDataNodeType; }
|
|
|
|
sal_Int32 getDataNodeType() const { return mnDataNodeType; }
|
|
|
|
void setAspectRatio(double fAspectRatio) { mfAspectRatio = fAspectRatio; }
|
|
|
|
double getAspectRatio() const { return mfAspectRatio; }
|
|
|
|
void setVerticalShapesCount(sal_Int32 nVerticalShapesCount) { mnVerticalShapesCount = nVerticalShapesCount; }
|
|
sal_Int32 getVerticalShapesCount() const { return mnVerticalShapesCount; }
|
|
|
|
/// Changes reference semantics to value semantics for fill properties.
|
|
void cloneFillProperties();
|
|
|
|
void keepDiagramDrawing(::oox::core::XmlFilterBase& rFilterBase, const OUString& rFragmentPath);
|
|
|
|
// Allows preparation of a local Diagram helper && propagate an eventually
|
|
// existing one to the data holder object later
|
|
void prepareDiagramHelper(const std::shared_ptr< Diagram >& rDiagramPtr, const std::shared_ptr<::oox::drawingml::Theme>& rTheme);
|
|
void propagateDiagramHelper();
|
|
|
|
// for Writer it is necessary to migrate an existing helper to a new Shape
|
|
void migrateDiagramHelperToNewShape(const ShapePtr& pTarget);
|
|
|
|
protected:
|
|
|
|
enum FrameType
|
|
{
|
|
FRAMETYPE_GENERIC, ///< Generic shape, no special type.
|
|
FRAMETYPE_OLEOBJECT, ///< OLE object embedded in a shape.
|
|
FRAMETYPE_CHART, ///< Chart embedded in a shape.
|
|
FRAMETYPE_DIAGRAM, ///< Complex diagram drawing shape.
|
|
FRAMETYPE_TABLE ///< A table embedded in a shape.
|
|
};
|
|
|
|
css::uno::Reference< css::drawing::XShape > const &
|
|
createAndInsert(
|
|
::oox::core::XmlFilterBase& rFilterBase,
|
|
const OUString& rServiceName,
|
|
const Theme* pTheme,
|
|
const css::uno::Reference< css::drawing::XShapes >& rxShapes,
|
|
bool bClearText,
|
|
bool bDoNotInsertEmptyTextBody,
|
|
basegfx::B2DHomMatrix& aTransformation,
|
|
const FillProperties& rShapeOrParentShapeFillProps,
|
|
oox::drawingml::ShapePtr pParentGroupShape = nullptr
|
|
);
|
|
|
|
void addChildren(
|
|
::oox::core::XmlFilterBase& rFilterBase,
|
|
Shape& rMaster,
|
|
const Theme* pTheme,
|
|
const css::uno::Reference< css::drawing::XShapes >& rxShapes,
|
|
ShapeIdMap* pShapeMap,
|
|
const basegfx::B2DHomMatrix& aTransformation );
|
|
|
|
void keepDiagramCompatibilityInfo();
|
|
void convertSmartArtToMetafile( ::oox::core::XmlFilterBase const& rFilterBase );
|
|
|
|
css::uno::Reference< css::drawing::XShape >
|
|
renderDiagramToGraphic( ::oox::core::XmlFilterBase const & rFilterBase );
|
|
|
|
OUString finalizeServiceName(
|
|
::oox::core::XmlFilterBase& rFilter,
|
|
const OUString& rServiceName,
|
|
const css::awt::Rectangle& rShapeRect );
|
|
|
|
virtual void finalizeXShape(
|
|
::oox::core::XmlFilterBase& rFilter,
|
|
const css::uno::Reference< css::drawing::XShapes >& rxShapes );
|
|
|
|
void putPropertyToGrabBag(
|
|
const OUString& sPropertyName, const css::uno::Any& aPropertyValue );
|
|
void putPropertyToGrabBag(
|
|
const css::beans::PropertyValue& pProperty );
|
|
void putPropertiesToGrabBag(
|
|
const css::uno::Sequence< css::beans::PropertyValue >& aProperties );
|
|
|
|
FillProperties getActualFillProperties(const Theme* pTheme, const FillProperties* pParentShapeFillProps) const;
|
|
LineProperties getActualLineProperties(const Theme* pTheme) const;
|
|
EffectProperties getActualEffectProperties(const Theme* pTheme) const;
|
|
|
|
std::vector< ShapePtr > maChildren; // only used for group shapes
|
|
css::awt::Size maChSize; // only used for group shapes
|
|
css::awt::Point maChPosition; // only used for group shapes
|
|
|
|
std::vector<OUString> maConnectorAdjustmentList; // only used for connector shapes
|
|
|
|
TextBodyPtr mpTextBody;
|
|
LinePropertiesPtr mpLinePropertiesPtr;
|
|
LinePropertiesPtr mpShapeRefLinePropPtr;
|
|
FillPropertiesPtr mpFillPropertiesPtr;
|
|
FillPropertiesPtr mpShapeRefFillPropPtr;
|
|
GraphicPropertiesPtr mpGraphicPropertiesPtr;
|
|
CustomShapePropertiesPtr mpCustomShapePropertiesPtr;
|
|
table::TablePropertiesPtr mpTablePropertiesPtr;
|
|
Shape3DPropertiesPtr mp3DPropertiesPtr;
|
|
EffectPropertiesPtr mpEffectPropertiesPtr;
|
|
EffectPropertiesPtr mpShapeRefEffectPropPtr;
|
|
PropertyMap maShapeProperties;
|
|
PropertyMap maDefaultShapeProperties;
|
|
TextListStylePtr mpMasterTextListStyle;
|
|
css::uno::Reference< css::drawing::XShape > mxShape;
|
|
ConnectorShapePropertiesList maConnectorShapePropertiesList;
|
|
|
|
OUString msConnectorName;
|
|
OUString msServiceName;
|
|
OUString msName;
|
|
OUString msInternalName; // used by diagram; not displayed in UI
|
|
OUString msId;
|
|
OUString msDescription;
|
|
bool m_isDecorative = false;
|
|
sal_Int32 mnSubType; // if this type is not zero, then the shape is a placeholder
|
|
std::optional< sal_Int32 > moSubTypeIndex;
|
|
|
|
ShapeStyleRefMap maShapeStyleRefs;
|
|
|
|
css::awt::Size maSize;
|
|
css::awt::Point maPosition;
|
|
::std::vector<OUString> maExtDrawings;
|
|
Color maFontRefColorForNodes;
|
|
|
|
FrameType meFrameType; ///< Type for graphic frame shapes.
|
|
|
|
private:
|
|
|
|
typedef std::shared_ptr< ::oox::vml::OleObjectInfo > OleObjectInfoRef;
|
|
typedef std::shared_ptr< ChartShapeInfo > ChartShapeInfoRef;
|
|
|
|
OleObjectInfoRef mxOleObjectInfo; ///< Additional data for OLE objects.
|
|
ChartShapeInfoRef mxChartShapeInfo; ///< Additional data for chart shapes.
|
|
|
|
sal_Int32 mnRotation;
|
|
sal_Int32 mnDiagramRotation; // rotates shape prior to sizing, does not affect text rotation
|
|
bool mbFlipH;
|
|
bool mbFlipV;
|
|
bool mbHidden;
|
|
bool mbHiddenMasterShape; // master shapes can be hidden in layout slides
|
|
// we need separate flag because we don't want
|
|
// to propagate it when applying reference shape
|
|
bool mbLocked;
|
|
bool mbWPGChild; // Is this shape a child of a WPG shape?
|
|
bool mbLockedCanvas; ///< Is this shape part of a locked canvas?
|
|
bool mbWordprocessingCanvas; ///< Is this shape part of a wordprocessing canvas?
|
|
bool mbWps; ///< Is this a wps shape?
|
|
bool mbTextBox; ///< This shape has a textbox.
|
|
LinkedTxbxAttr maLinkedTxbxAttr;
|
|
bool mbHasLinkedTxbx; // this text box has linked text box ?
|
|
|
|
css::uno::Sequence<css::beans::PropertyValue> maDiagramDoms;
|
|
|
|
/// Z-Order.
|
|
sal_Int32 mnZOrder = 0;
|
|
|
|
/// Z-Order offset.
|
|
sal_Int32 mnZOrderOff = 0;
|
|
|
|
/// Type of data node for an in-diagram shape.
|
|
sal_Int32 mnDataNodeType = 0;
|
|
|
|
/// Aspect ratio for an in-diagram shape.
|
|
double mfAspectRatio = 0;
|
|
|
|
/// Number of child shapes to be layouted vertically inside org chart in-diagram shape.
|
|
sal_Int32 mnVerticalShapesCount = 0;
|
|
|
|
// Is this a connector shape?
|
|
bool mbConnector = false;
|
|
|
|
// temporary space for DiagramHelper in preparation for collecting data
|
|
// Note: I tried to use a unique_ptr here, but existing constructor func does not allow that
|
|
AdvancedDiagramHelper* mpDiagramHelper;
|
|
|
|
// association-ID to identify the Diagram ModelData
|
|
OUString msDiagramDataModelID;
|
|
};
|
|
|
|
}
|
|
|
|
#endif // INCLUDED_OOX_DRAWINGML_SHAPE_HXX
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|