/* -*- 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/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;
/** The shape model structure contains all properties shared by all types of shapes. */
struct ShapeTypeModel
{
OUString maShapeId;
///< Unique identifier of the shape.
OUString maLegacyId;
///< Plaintext identifier of the shape.
OUString maShapeName;
///< Name of the shape, if present.
std::optional< sal_Int32 > moShapeType;
///< Builtin shape type identifier.
std::optional< Int32Pair > moCoordPos;
///< Top-left position of coordinate system for children scaling.
std::optional< Int32Pair > moCoordSize;
///< Size of coordinate system for children scaling.
OUString maPosition;
///< Position type of the shape.
OUString maZIndex;
///< ZIndex of the shape
OUString maLeft;
///< X position of the shape bounding box (number with unit).
OUString maTop;
///< Y position of the shape bounding box (number with unit).
OUString maWidth;
///< Width of the shape bounding box (number with unit).
OUString maHeight;
///< Height of the shape bounding box (number with unit).
OUString maMarginLeft;
///< X position of the shape bounding box to shape anchor (number with unit).
OUString maMarginTop;
///< Y position of the shape bounding box to shape anchor (number with unit).
OUString maPositionHorizontalRelative;
///< The X position is relative to this.
OUString maPositionVerticalRelative;
///< The Y position is relative to this.
OUString maPositionHorizontal;
///< The X position orientation (default: absolute).
OUString maPositionVertical;
///< The Y position orientation.
OUString maWidthPercent;
///< The width in percents of the WidthRelative
OUString maHeightPercent;
///< The height in percents of the HeightRelative
OUString maWidthRelative;
///< To what the width is relative
OUString maHeightRelative;
///< To what the height is relative
OUString maRotation;
///< Rotation of the shape, in degrees.
OUString maFlip;
///< Flip type of the shape (can be "x" or "y").
bool mbAutoHeight;
///< If true, the height value is a minimum value (mostly used for textboxes)
bool mbVisible;
///< Visible or Hidden
OUString maWrapStyle;
///< Wrapping mode for text.
OUString maArcsize;
///< round rectangles arc size
OUString maEditAs;
///< Edit As type (e.g. "canvas" etc)
OUString maAdjustments;
///< Shape adjustment values
StrokeModel maStrokeModel;
///< Border line formatting.
FillModel maFillModel;
///< Shape fill formatting.
ShadowModel maShadowModel;
///< Shape shadow formatting.
TextpathModel maTextpathModel;
///< Shape textpath formatting.
std::optional< OUString > moGraphicPath;
///< Path to a graphic for this shape.
std::optional< OUString > moGraphicTitle;
///< Title of the graphic.
std::optional< OUString > moWrapAnchorX;
///< The base object from which our horizontal positioning should be calculated.
std::optional< OUString > moWrapAnchorY;
///< The base object from which our vertical positioning should be calculated.
std::optional< OUString > moWrapType;
///< How to wrap the text around the object
std::optional< OUString > moWrapSide;
///< On which side to wrap the text around the object
OUString maVTextAnchor;
///< How the text inside the shape is anchored vertically.
OUString maWrapDistanceLeft;
///< Distance from the left side of the shape to the text that wraps around it.
OUString maWrapDistanceRight;
///< Distance from the right side of the shape to the text that wraps around it.
OUString maWrapDistanceTop;
///< Distance from the top of the shape to the text that wraps around it.
OUString maWrapDistanceBottom;
///< Distance from the bottom of the shape to the text that wraps around it.
std::optional<OUString> moCropBottom;
///< Specifies the how much to crop the image from the bottom up as a fraction of picture size.
std::optional<OUString> moCropLeft;
///< Specifies how much to crop the image from the left in as a fraction of picture size.
std::optional<OUString> moCropRight;
///< Specifies how much to crop the image from the right in as a fraction of picture size.
std::optional<OUString> moCropTop;
///< Specifies how much to crop the image from the top down as a fraction of picture size.
OUString maLayoutFlowAlt;
///< Specifies the alternate layout flow for text in textboxes.
/// An adjustment for the intensity of all colors, i.e. contrast, on a 0..0x10000 scale.
sal_Int32 mnGain = 0x10000;
/// The image brightness, on a 0..0x10000 scale.
sal_Int16 mnBlacklevel = 0;
explicit ShapeTypeModel();
void assignUsed(
const ShapeTypeModel& rSource );
};
/** A shape template contains all formatting properties of shapes and can serve
as templates for several shapes in a drawing. */
class SAL_DLLPUBLIC_RTTI ShapeType
{
public:
explicit ShapeType( Drawing& rDrawing );
virtual ~ShapeType();
/** Returns read/write access to the shape template model structure. */
ShapeTypeModel& getTypeModel() {
return maTypeModel; }
/** Returns read access to the shape template model structure. */
const ShapeTypeModel& getTypeModel()
const {
return maTypeModel; }
/** Returns the shape identifier (which is unique through the containing drawing). */
const OUString& getShapeId()
const {
return maTypeModel.maShapeId; }
/** Returns the application defined shape type. */
sal_Int32 getShapeType()
const;
/** Returns the fragment path to the embedded graphic used by this shape. */
OUString getGraphicPath()
const;
const Drawing& getDrawing()
const {
return mrDrawing; }
void setTextBox(
bool bSet) {mbTextBox = bSet;}
bool isTextBox()
const {
return mbTextBox;}
protected:
/** Returns the coordinate system of this shape. */
css::awt::Rectangle getCoordSystem()
const;
/** Returns the absolute shape rectangle according to the passed anchor. */
css::awt::Rectangle getRectangle(
const ShapeParentAnchor* pParentAnchor )
const;
/** Returns the absolute shape rectangle. */
virtual css::awt::Rectangle getAbsRectangle()
const;
/** Returns the rectangle relative to the parent coordinate system. */
virtual css::awt::Rectangle getRelRectangle()
const;
protected:
Drawing& mrDrawing;
///< The VML drawing page that contains this shape.
ShapeTypeModel maTypeModel;
///< The model structure containing shape type data.
bool mbTextBox;
//will be set if the shape contains a text box
};
/** Excel specific shape client data (such as cell anchor). */
struct ClientData
{
OUString maAnchor;
///< Cell anchor as comma-separated string.
OUString maFmlaMacro;
///< Link to macro associated to the control.
OUString maFmlaPict;
///< Target cell range of picture links.
OUString maFmlaLink;
///< Link to value cell associated to the control.
OUString maFmlaRange;
///< Link to cell range used as data source for the control.
OUString maFmlaGroup;
///< Link to value cell associated to a group of option buttons.
sal_Int32 mnObjType;
///< Type of the shape.
sal_Int32 mnTextHAlign;
///< Horizontal text alignment.
sal_Int32 mnTextVAlign;
///< Vertical text alignment.
sal_Int32 mnCol;
///< Column index for spreadsheet cell note.
sal_Int32 mnRow;
///< Row index for spreadsheet cell note.
sal_Int32 mnChecked;
///< State for checkboxes and option buttons.
sal_Int32 mnDropStyle;
///< Drop down box style (read-only or editable).
sal_Int32 mnDropLines;
///< Number of lines in drop down box.
sal_Int32 mnVal;
///< Current value of spin buttons and scroll bars.
sal_Int32 mnMin;
///< Minimum value of spin buttons and scroll bars.
sal_Int32 mnMax;
///< Maximum value of spin buttons and scroll bars.
sal_Int32 mnInc;
///< Small increment of spin buttons and scroll bars.
sal_Int32 mnPage;
///< Large increment of spin buttons and scroll bars.
sal_Int32 mnSelType;
///< Listbox selection type.
sal_Int32 mnVTEdit;
///< Data type of the textbox.
bool mbPrintObject;
///< True = print the object.
bool mbVisible;
///< True = cell note is visible.
bool mbDde;
///< True = object is linked through DDE.
bool mbNo3D;
///< True = flat style, false = 3D style.
bool mbNo3D2;
///< True = flat style, false = 3D style (listboxes and dropdowns).
bool mbMultiLine;
///< True = textbox allows line breaks.
bool mbVScroll;
///< True = textbox has a vertical scrollbar.
bool mbSecretEdit;
///< True = textbox is a password edit field.
explicit ClientData();
};
struct ShapeModel
{
typedef ::std::vector< css::awt::Point > PointVector;
OUString maType;
///< Shape template with default properties.
PointVector maPoints;
///< Points for the polyline shape.
std::unique_ptr<TextBox> mxTextBox;
///< Text contents and properties.
std::unique_ptr<ClientData> mxClientData;
///< Excel specific client data.
OUString maLegacyDiagramPath;
///< Legacy Diagram Fragment Path
OUString maFrom;
///< Start point for line shape.
OUString maTo;
///< End point for line shape.
OUString maControl1;
///< Bezier control point 1
OUString maControl2;
///< Bezier control point 2
OUString maVmlPath;
///< VML path for this shape
bool mbIsSignatureLine;
///< Shape is a signature line
OUString maSignatureId;
///< ID of the signature
OUString maSignatureLineSuggestedSignerName;
OUString maSignatureLineSuggestedSignerTitle;
OUString maSignatureLineSuggestedSignerEmail;
OUString maSignatureLineSigningInstructions;
bool mbSignatureLineShowSignDate;
bool mbSignatureLineCanAddComment;
bool mbInGroup;
OUString maHyperlink;
///< The hyperlink assigned to the shape
explicit ShapeModel();
~ShapeModel();
/** Creates and returns a new shape textbox structure. */
TextBox& createTextBox(ShapeTypeModel& rModel);
/** Creates and returns a new shape client data structure. */
ClientData& createClientData();
};
/** A shape object that is part of a drawing. May inherit properties from a
shape template. */
class OOX_DLLPUBLIC ShapeBase :
public ShapeType
{
public:
/** Returns read/write access to the shape model structure. */
ShapeModel& getShapeModel() {
return maShapeModel; }
/** Returns read access to the shape model structure. */
const ShapeModel& getShapeModel()
const {
return maShapeModel; }
/** Returns read access to the shape textbox. */
const TextBox* getTextBox()
const {
return maShapeModel.mxTextBox.get(); }
/** Returns read access to the shape client data structure. */
const ClientData* getClientData()
const {
return maShapeModel.mxClientData.get(); }
/** Final processing after import of the drawing fragment. */
virtual void finalizeFragmentImport();
/** Returns the real shape name if existing, or a generated shape name. */
OUString getShapeName()
const;
/** Returns the shape template with the passed identifier from the child shapes. */
virtual const ShapeType* getChildTypeById(
const OUString& rShapeId )
const;
/** Returns the shape with the passed identifier from the child shapes. */
virtual const ShapeBase* getChildById(
const OUString& rShapeId )
const;
/** Creates the corresponding XShape and inserts it into the passed container. */
css::uno::Reference< css::drawing::XShape >
convertAndInsert(
const css::uno::Reference< css::drawing::XShapes >& rxShapes,
const ShapeParentAnchor* pParentAnchor = nullptr )
const;
/** Returns bounds of Shape */
css::awt::Rectangle getShapeRectangle()
const;
/** Collects common shape properties such as formatting attributes. */
oox::drawingml::ShapePropertyMap makeShapePropertyMap()
const;
void setContainer(ShapeContainer* pContainer);
ShapeContainer* getContainer()
const;
protected:
explicit ShapeBase( Drawing& rDrawing );
/** Derived classes create the corresponding XShape and insert it into the passed container. */
virtual css::uno::Reference< css::drawing::XShape >
implConvertAndInsert(
const css::uno::Reference< css::drawing::XShapes >& rxShapes,
const css::awt::Rectangle& rShapeRect )
const = 0;
/** Always called after implConvertAndInsert for the same task.*/
virtual css::uno::Reference<css::drawing::XShape> finalImplConvertAndInsert(
const css::uno::Reference<css::drawing::XShape>& rxShape)
const
{
return rxShape;
};
/** Calculates the final shape rectangle according to the passed anchor,
if present, otherwise according to the own anchor settings. */
css::awt::Rectangle calcShapeRectangle(
const ShapeParentAnchor* pParentAnchor )
const;
/** Converts common shape properties such as formatting attributes. */
void convertShapeProperties(
const css::uno::Reference< css::drawing::XShape >& rxShape )
const;
protected:
ShapeModel maShapeModel;
///< The model structure containing shape data.
ShapeContainer* mpContainer = nullptr;
};
/** A simple shape object based on a specific UNO shape service. */
class SimpleShape :
public ShapeBase
{
public:
explicit SimpleShape( Drawing& rDrawing, OUString aService );
void setService(
const OUString& aService ) { maService = aService; }
protected:
/** Creates the corresponding XShape and inserts it into the passed container. */
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;
/** Used by both RectangleShape and ComplexShape. */
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;
///< Name of the UNO shape service.
};
/** A rectangular shape object. */
class RectangleShape final :
public SimpleShape
{
public:
explicit RectangleShape( Drawing& rDrawing );
private:
/** Creates the corresponding XShape and inserts it into the passed container. */
virtual css::uno::Reference<css::drawing::XShape>
implConvertAndInsert(
const css::uno::Reference<css::drawing::XShapes>& rxShapes,
const css::awt::Rectangle& rShapeRect)
const override;
};
/** An oval shape object. */
class EllipseShape final :
public SimpleShape
{
public:
explicit EllipseShape( Drawing& rDrawing );
};
/** A polygon shape object. */
class PolyLineShape final :
public SimpleShape
{
public:
explicit PolyLineShape( Drawing& rDrawing );
private:
/** Creates the corresponding XShape and inserts it into the passed container. */
virtual css::uno::Reference< css::drawing::XShape >
implConvertAndInsert(
const css::uno::Reference< css::drawing::XShapes >& rxShapes,
const css::awt::Rectangle& rShapeRect )
const override;
};
/** A Line shape object. */
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:
/** Returns the absolute shape rectangle. */
virtual css::awt::Rectangle getAbsRectangle()
const override;
/** Returns the rectangle relative to the parent coordinate system. */
virtual css::awt::Rectangle getRelRectangle()
const override;
};
/** Bezier shape object that supports to, from, control1 and control2
attribute or path attribute specification */
class BezierShape final :
public SimpleShape
{
public:
explicit BezierShape( Drawing& rDrawing );
private:
/** Creates the corresponding XShape and inserts it into the passed container. */
virtual css::uno::Reference< css::drawing::XShape >
implConvertAndInsert(
const css::uno::Reference< css::drawing::XShapes >& rxShapes,
const css::awt::Rectangle& rShapeRect )
const override;
};
/** A shape object with custom geometry. */
class CustomShape :
public SimpleShape
{
public:
explicit CustomShape( Drawing& rDrawing );
protected:
/** Creates the corresponding XShape and inserts it into the passed container. */
virtual css::uno::Reference< css::drawing::XShape >
implConvertAndInsert(
const css::uno::Reference< css::drawing::XShapes >& rxShapes,
const css::awt::Rectangle& rShapeRect )
const override;
};
/** A complex shape object. This can be a picture shape, a custom shape, an OLE
object, or an ActiveX form control. */
class ComplexShape final :
public CustomShape
{
public:
explicit ComplexShape( Drawing& rDrawing );
private:
/** Creates the corresponding XShape and inserts it into the passed container. */
virtual css::uno::Reference< css::drawing::XShape >
implConvertAndInsert(
const css::uno::Reference< css::drawing::XShapes >& rxShapes,
const css::awt::Rectangle& rShapeRect )
const override;
};
/** A group shape that extends the basic shape by a container of child shapes. */
class GroupShape final :
public ShapeBase
{
public:
explicit GroupShape( Drawing& rDrawing );
virtual ~GroupShape() override;
/** Returns read/write access to the container of child shapes and templates. */
ShapeContainer& getChildren() {
return *mxChildren; }
/** Returns read access to the container of child shapes and templates. */
const ShapeContainer& getChildren()
const {
return *mxChildren; }
/** Final processing after import of the drawing fragment. */
virtual void finalizeFragmentImport() override;
/** Returns the shape template with the passed identifier from the child shapes. */
virtual const ShapeType* getChildTypeById(
const OUString& rShapeId )
const override;
/** Returns the shape with the passed identifier from the child shapes. */
virtual const ShapeBase* getChildById(
const OUString& rShapeId )
const override;
private:
/** Creates the corresponding XShape and inserts it into the passed container. */
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;
///< Shapes and templates that are part of this group.
};
}
// namespace oox::vml
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
