office-gobmx/include/xmloff/shapeexport.hxx
Noel Grandin aaad3500b3 remove some unused enum values in xmloff
(*) also make it more obvious what XMLShapeExportFlags::SIZE represents

Change-Id: Ie63edf0f2827f171542037b819ebe7d55e090275
Reviewed-on: https://gerrit.libreoffice.org/63948
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2018-11-26 10:41:14 +01:00

306 lines
18 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_XMLOFF_SHAPEEXPORT_HXX
#define INCLUDED_XMLOFF_SHAPEEXPORT_HXX
#include <sal/config.h>
#include <xmloff/dllapi.h>
#include <sal/types.h>
#include <rtl/ref.hxx>
#include <rtl/ustring.hxx>
#include <rtl/ustrbuf.hxx>
#include <salhelper/simplereferenceobject.hxx>
#include <com/sun/star/drawing/XShape.hpp>
#include <com/sun/star/drawing/XShapes.hpp>
#include <com/sun/star/awt/Point.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <map>
#include <xmloff/xmlprmap.hxx>
#include <xmloff/xmlexppr.hxx>
#include <xmloff/animexp.hxx>
#include <xmloff/families.hxx>
#include <xmloff/txtparae.hxx>
#include <o3tl/typed_flags_set.hxx>
#include <xmloff/table/XMLTableExport.hxx>
// shape export features are bits used for the nFeature
// parameter of XMLShapeExport::exportShape
enum class XMLShapeExportFlags {
NONE = 0,
X = 0x0001,
Y = 0x0002,
POSITION = 0x0003,
WIDTH = 0x0004,
HEIGHT = 0x0008,
SIZE = WIDTH | HEIGHT,
// when you set this flag a chart does NOT export its own data as table element
NO_CHART_DATA = 0x0010,
// When setting the flag below no ignorableWhiteSpace will be called around
// the drawing object elements
NO_WS = 0x0020,
// When setting the flag below a callout shape is exported as office:annotation
ANNOTATION = 0x0040,
};
namespace o3tl
{
template<> struct typed_flags<XMLShapeExportFlags> : is_typed_flags<XMLShapeExportFlags, 0x7f> {};
}
#define SEF_DEFAULT XMLShapeExportFlags::POSITION|XMLShapeExportFlags::SIZE
enum XmlShapeType
{
XmlShapeTypeUnknown, // not known
XmlShapeTypeDrawRectangleShape, // "com.sun.star.drawing.RectangleShape"
XmlShapeTypeDrawEllipseShape, // "com.sun.star.drawing.EllipseShape"
XmlShapeTypeDrawControlShape, // "com.sun.star.drawing.ControlShape"
XmlShapeTypeDrawConnectorShape, // "com.sun.star.drawing.ConnectorShape"
XmlShapeTypeDrawMeasureShape, // "com.sun.star.drawing.MeasureShape"
XmlShapeTypeDrawLineShape, // "com.sun.star.drawing.LineShape"
XmlShapeTypeDrawPolyPolygonShape, // "com.sun.star.drawing.PolyPolygonShape"
XmlShapeTypeDrawPolyLineShape, // "com.sun.star.drawing.PolyLineShape"
XmlShapeTypeDrawOpenBezierShape, // "com.sun.star.drawing.OpenBezierShape"
XmlShapeTypeDrawClosedBezierShape, // "com.sun.star.drawing.ClosedBezierShape"
XmlShapeTypeDrawGraphicObjectShape, // "com.sun.star.drawing.GraphicObjectShape"
XmlShapeTypeDrawGroupShape, // "com.sun.star.drawing.GroupShape"
XmlShapeTypeDrawTextShape, // "com.sun.star.drawing.TextShape"
XmlShapeTypeDrawOLE2Shape, // "com.sun.star.drawing.OLE2Shape"
XmlShapeTypeDrawChartShape, // embedded com.sun.star.chart
XmlShapeTypeDrawSheetShape, // embedded com.sun.star.sheet
XmlShapeTypeDrawPageShape, // "com.sun.star.drawing.PageShape"
XmlShapeTypeDrawFrameShape, // "com.sun.star.drawing.FrameShape"
XmlShapeTypeDrawCaptionShape, // "com.sun.star.drawing.CaptionShape"
XmlShapeTypeDrawAppletShape, // "com.sun.star.drawing.AppletShape"
XmlShapeTypeDrawPluginShape, // "com.sun.star.drawing.PlugginShape"
XmlShapeTypeDraw3DSceneObject, // "com.sun.star.drawing.Shape3DSceneObject"
XmlShapeTypeDraw3DCubeObject, // "com.sun.star.drawing.Shape3DCubeObject"
XmlShapeTypeDraw3DSphereObject, // "com.sun.star.drawing.Shape3DSphereObject"
XmlShapeTypeDraw3DLatheObject, // "com.sun.star.drawing.Shape3DLatheObject"
XmlShapeTypeDraw3DExtrudeObject, // "com.sun.star.drawing.Shape3DExtrudeObject"
XmlShapeTypePresTitleTextShape, // "com.sun.star.presentation.TitleTextShape"
XmlShapeTypePresOutlinerShape, // "com.sun.star.presentation.OutlinerShape"
XmlShapeTypePresSubtitleShape, // "com.sun.star.presentation.SubtitleShape"
XmlShapeTypePresGraphicObjectShape, // "com.sun.star.presentation.GraphicObjectShape"
XmlShapeTypePresPageShape, // "com.sun.star.presentation.PageShape"
XmlShapeTypePresOLE2Shape, // "com.sun.star.presentation.OLE2Shape"
XmlShapeTypePresChartShape, // "com.sun.star.presentation.ChartShape"
XmlShapeTypePresSheetShape, // "com.sun.star.presentation.CalcShape"
XmlShapeTypePresTableShape, // "com.sun.star.presentation.TableShape"
XmlShapeTypePresOrgChartShape, // "com.sun.star.presentation.OrgChartShape"
XmlShapeTypePresNotesShape, // "com.sun.star.presentation.NotesShape"
XmlShapeTypeHandoutShape, // "com.sun.star.presentation.HandoutShape"
XmlShapeTypePresHeaderShape, // "com.sun.star.presentation.HeaderShape"
XmlShapeTypePresFooterShape, // "com.sun.star.presentation.FooterShape"
XmlShapeTypePresSlideNumberShape, // "com.sun.star.presentation.SlideNumberShape"
XmlShapeTypePresDateTimeShape, // "com.sun.star.presentation.DateTimeShape"
XmlShapeTypeDrawCustomShape, // "com.sun.star.drawing.CustomShape"
XmlShapeTypeDrawMediaShape, // "com.sun.star.drawing.MediaShape"
XmlShapeTypePresMediaShape, // "com.sun.star.presentation.MediaShape"
XmlShapeTypeDrawTableShape, // "com.sun.star.drawing.TableShape"
XmlShapeTypeNotYetSet
};
/** caches style and type info after a collectShapeAutostyle for later use in exportShape */
struct ImplXMLShapeExportInfo
{
OUString msStyleName;
OUString msTextStyleName;
sal_Int32 mnFamily;
XmlShapeType meShapeType;
css::uno::Reference< css::drawing::XShape > xCustomShapeReplacement;
ImplXMLShapeExportInfo() : mnFamily( XML_STYLE_FAMILY_SD_GRAPHICS_ID ), meShapeType( XmlShapeTypeNotYetSet ) {}
};
/** a vector for shape style and type cache information */
typedef std::vector< ImplXMLShapeExportInfo > ImplXMLShapeExportInfoVector;
/** a map to store all cache data for already collected XShapes */
typedef std::map< css::uno::Reference < css::drawing::XShapes >, ImplXMLShapeExportInfoVector > ShapesInfos;
class SvXMLExport;
class SvXMLExportPropertyMapper;
namespace basegfx
{
class B2DTuple;
class B2DHomMatrix;
}
class XMLOFF_DLLPUBLIC XMLShapeExport : public salhelper::SimpleReferenceObject
{
private:
SvXMLExport& mrExport;
rtl::Reference< XMLPropertyHandlerFactory > mxSdPropHdlFactory;
rtl::Reference< SvXMLExportPropertyMapper > mxPropertySetMapper;
rtl::Reference< XMLAnimationsExporter > mxAnimationsExporter;
ShapesInfos maShapesInfos;
ShapesInfos::iterator maCurrentShapesIter;
bool mbExportLayer;
ImplXMLShapeExportInfoVector maShapeInfos;
ImplXMLShapeExportInfoVector::iterator maCurrentInfo;
OUString msPresentationStylePrefix;
// #88546# possibility to switch progress bar handling on/off
bool mbHandleProgressBar;
rtl::Reference< XMLTableExport > mxShapeTableExport;
protected:
SvXMLExport& GetExport() { return mrExport; }
const SvXMLExport& GetExport() const { return mrExport; }
private:
SAL_DLLPRIVATE const rtl::Reference< SvXMLExportPropertyMapper >& GetPropertySetMapper() const { return mxPropertySetMapper; }
OUStringBuffer msBuffer;
SAL_DLLPRIVATE void ImpCalcShapeType(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType& eShapeType);
SAL_DLLPRIVATE void ImpExportNewTrans(const css::uno::Reference< css::beans::XPropertySet >& xPropSet, XMLShapeExportFlags nFeatures, css::awt::Point* pRefPoint);
SAL_DLLPRIVATE void ImpExportNewTrans_GetB2DHomMatrix(::basegfx::B2DHomMatrix& rMatrix, const css::uno::Reference< css::beans::XPropertySet >& xPropSet);
SAL_DLLPRIVATE static void ImpExportNewTrans_DecomposeAndRefPoint(const ::basegfx::B2DHomMatrix& rMat, ::basegfx::B2DTuple& rTRScale, double& fTRShear, double& fTRRotate, ::basegfx::B2DTuple& rTRTranslate, css::awt::Point* pRefPoint);
SAL_DLLPRIVATE void ImpExportNewTrans_FeaturesAndWrite(::basegfx::B2DTuple const & rTRScale, double fTRShear, double fTRRotate, ::basegfx::B2DTuple const & rTRTranslate, const XMLShapeExportFlags nFeatures);
SAL_DLLPRIVATE bool ImpExportPresentationAttributes( const css::uno::Reference< css::beans::XPropertySet >& xPropSet, const OUString& rClass );
SAL_DLLPRIVATE void ImpExportText( const css::uno::Reference< css::drawing::XShape >& xShape, TextPNS eExtensionNS = TextPNS::ODF );
SAL_DLLPRIVATE void ImpExportEvents( const css::uno::Reference< css::drawing::XShape >& xShape );
SAL_DLLPRIVATE void ImpExportDescription( const css::uno::Reference< css::drawing::XShape >& xShape ); // #i68101#
SAL_DLLPRIVATE void ImpExportGluePoints( const css::uno::Reference< css::drawing::XShape >& xShape );
SAL_DLLPRIVATE void ImpExportSignatureLine(const css::uno::Reference<css::drawing::XShape>& xShape);
// single shape exporters
SAL_DLLPRIVATE void ImpExportGroupShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExport3DSceneShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportRectangleShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportLineShape(const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportEllipseShape(const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportPolygonShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportTextBoxShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportGraphicObjectShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportChartShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr, SvXMLAttributeList* pAttrList = nullptr );
SAL_DLLPRIVATE void ImpExportControlShape(const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportConnectorShape(const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportMeasureShape(const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point const * pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportOLE2Shape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr, SvXMLAttributeList* pAttrList = nullptr );
SAL_DLLPRIVATE void ImpExportPageShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportCaptionShape(const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExport3DShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType );
SAL_DLLPRIVATE void ImpExportFrameShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportPluginShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportAppletShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportCustomShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportMediaShape( const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
SAL_DLLPRIVATE void ImpExportTableShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );
public:
XMLShapeExport(SvXMLExport& rExp, SvXMLExportPropertyMapper *pExtMapper=nullptr );
virtual ~XMLShapeExport() override;
// This method collects all automatic styles for the given XShape
void collectShapeAutoStyles(
const css::uno::Reference < css::drawing::XShape >& xShape);
// This method exports the given XShape
void exportShape(
const css::uno::Reference < css::drawing::XShape >& xShape,
XMLShapeExportFlags nFeatures = SEF_DEFAULT,
css::awt::Point* pRefPoint = nullptr,
SvXMLAttributeList* pAttrList = nullptr
);
// This method collects all automatic styles for the shapes inside the given XShapes collection
void collectShapesAutoStyles(
const css::uno::Reference < css::drawing::XShapes >& xShapes);
// This method exports all XShape inside the given XShapes collection
void exportShapes(
const css::uno::Reference < css::drawing::XShapes >& xShapes,
XMLShapeExportFlags nFeatures = SEF_DEFAULT,
css::awt::Point* pRefPoint = nullptr
);
/** initializes some internal structures for fast access to the given XShapes collection
<p>This method has to be called before you use exportShape or collectShapeAutoStyles.
It is automatically called if you use collectShapesAutoStyles and exportShapes.
@see collectShapeAutoStyles
@see exportShape
@see collectShapesAutoStyles
@see exportShapes
*/
void seekShapes(
const css::uno::Reference< css::drawing::XShapes >& xShapes ) throw();
void exportAutoStyles();
/** sets a new reference to an XMLAnimationExporter.
If this is a non NULL reference, the animation information from all shapes given to exportShape()
from now on are collected.
*/
void setAnimationsExporter( rtl::Reference< XMLAnimationsExporter > const & xAnimExport ) { mxAnimationsExporter = xAnimExport; }
/** returns the last set XMLAnimationExport */
const rtl::Reference< XMLAnimationsExporter >& getAnimationsExporter() const { return mxAnimationsExporter; }
/// returns the export property mapper for external chaining
static SvXMLExportPropertyMapper* CreateShapePropMapper( SvXMLExport& rExport );
void enableLayerExport() { mbExportLayer = true; }
/** defines if the export should increment the progress bar or not */
void enableHandleProgressBar() { mbHandleProgressBar = true; }
bool IsHandleProgressBarEnabled() const { return mbHandleProgressBar; }
void setPresentationStylePrefix( const OUString& rPrefix ) { msPresentationStylePrefix = rPrefix; }
/** helper for chart that adds all attributes of a 3d scene element to the export */
void export3DSceneAttributes( const css::uno::Reference< css::beans::XPropertySet >& xPropSet );
/** helper for chart that exports all lamps from the propertyset */
void export3DLamps( const css::uno::Reference< css::beans::XPropertySet >& xPropSet );
/** sj: replacing CustomShapes with standard objects that are also supported in OpenOffice.org format */
css::uno::Reference < css::drawing::XShape > checkForCustomShapeReplacement(
const css::uno::Reference < css::drawing::XShape >& );
/** helper to export the style for graphic defaults */
void ExportGraphicDefaults();
/** is called before a shape element for the given XShape is exported */
virtual void onExport( const css::uno::Reference < css::drawing::XShape >& xShape );
const rtl::Reference< XMLTableExport >& GetShapeTableExport();
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */