285 lines
12 KiB
C++
285 lines
12 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_VML_VMLFORMATTING_HXX
|
|
#define INCLUDED_OOX_VML_VMLFORMATTING_HXX
|
|
|
|
#include <sal/config.h>
|
|
|
|
#include <string_view>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
#include <com/sun/star/drawing/PolygonFlags.hpp>
|
|
#include <com/sun/star/uno/Reference.hxx>
|
|
#include <oox/dllapi.h>
|
|
#include <oox/helper/helper.hxx>
|
|
#include <rtl/ustring.hxx>
|
|
#include <sal/types.h>
|
|
#include <tools/degree.hxx>
|
|
|
|
namespace com::sun::star {
|
|
namespace awt { struct Point; }
|
|
namespace drawing { class XShape; }
|
|
}
|
|
|
|
namespace oox {
|
|
class GraphicHelper;
|
|
namespace drawingml { class Color; }
|
|
namespace drawingml { class ShapePropertyMap; }
|
|
}
|
|
|
|
namespace oox::vml {
|
|
|
|
|
|
typedef ::std::pair< sal_Int32, sal_Int32 > Int32Pair;
|
|
typedef ::std::pair< double, double > DoublePair;
|
|
|
|
|
|
namespace ConversionHelper
|
|
{
|
|
/** Returns two values contained in rValue separated by cSep.
|
|
*/
|
|
OOX_DLLPUBLIC bool separatePair(
|
|
std::u16string_view& orValue1, std::u16string_view& orValue2,
|
|
std::u16string_view rValue, sal_Unicode cSep );
|
|
|
|
/** Returns the boolean value from the passed string of a VML attribute.
|
|
Supported values: 'f', 't', 'false', 'true'. False for anything else.
|
|
*/
|
|
OOX_DLLPUBLIC bool decodeBool( std::u16string_view rValue );
|
|
|
|
/** Converts the passed VML percentage measure string to a normalized
|
|
floating-point value.
|
|
|
|
@param rValue The VML percentage value. This is a floating-point value
|
|
with optional following '%' or 'f' sign. If the sign is missing, the
|
|
floating point value will be returned unmodified. If the '%' sign
|
|
is present, the value will be divided by 100. If the 'f' sign is present,
|
|
the value will be divided by 65536.
|
|
*/
|
|
OOX_DLLPUBLIC double decodePercent(
|
|
std::u16string_view rValue,
|
|
double fDefValue );
|
|
|
|
/** Converts the passed VML rotation value to degrees.
|
|
See DffPropertyReader::Fix16ToAngle(): in VML, positive rotation
|
|
angles are clockwise, we have them as counter-clockwise.
|
|
Additionally, VML type is 0..360, our is 0..36000.
|
|
|
|
@param rValue The VML rotation value. This is a floating-point value
|
|
with optional 'fd' suffix. If the suffix is missing, the floating
|
|
point value will be returned unmodified. If the 'fd' suffix is
|
|
present, the value will be divided by 65536.
|
|
*/
|
|
OOX_DLLPUBLIC Degree100 decodeRotation( std::u16string_view rValue );
|
|
|
|
/** Converts the passed VML measure string to EMU (English Metric Units).
|
|
|
|
@param rGraphicHelper The graphic helper needed to perform pixel
|
|
conversion according to the current output device.
|
|
|
|
@param rValue The VML measure value. This is a floating-point value
|
|
with optional measure string following the value.
|
|
|
|
@param nRefValue Reference value needed for percentage measure.
|
|
|
|
@param bPixelX Set to true if the value is oriented horizontally (e.g.
|
|
X coordinates, widths). Set to false if the value is oriented
|
|
vertically (e.g. Y coordinates, heights). This is needed because
|
|
output devices may specify different width and height for a pixel.
|
|
|
|
@param bDefaultAsPixel Set to true if omitted measure unit means
|
|
pixel. Set to false if omitted measure unit means EMU.
|
|
*/
|
|
OOX_DLLPUBLIC sal_Int64 decodeMeasureToEmu(
|
|
const GraphicHelper& rGraphicHelper,
|
|
std::u16string_view rValue,
|
|
sal_Int32 nRefValue,
|
|
bool bPixelX,
|
|
bool bDefaultAsPixel );
|
|
|
|
/** Converts the passed VML measure string to 1/100 mm.
|
|
|
|
@param rGraphicHelper See above.
|
|
@param rValue See above.
|
|
@param nRefValue See above.
|
|
@param bPixelX See above.
|
|
@param bDefaultAsPixel See above.
|
|
*/
|
|
OOX_DLLPUBLIC sal_Int32 decodeMeasureToHmm(
|
|
const GraphicHelper& rGraphicHelper,
|
|
std::u16string_view rValue,
|
|
sal_Int32 nRefValue,
|
|
bool bPixelX,
|
|
bool bDefaultAsPixel );
|
|
|
|
/** Converts the passed VML measure string to Twip.
|
|
|
|
@param rGraphicHelper See above.
|
|
@param rValue See above.
|
|
@param nRefValue See above.
|
|
@param bPixelX See above.
|
|
@param bDefaultAsPixel See above.
|
|
*/
|
|
OOX_DLLPUBLIC sal_Int32 decodeMeasureToTwip(const GraphicHelper& rGraphicHelper,
|
|
std::u16string_view rValue, sal_Int32 nRefValue,
|
|
bool bPixelX, bool bDefaultAsPixel);
|
|
|
|
/** Converts VML color attributes to a DrawingML color.
|
|
|
|
@param roVmlColor The VML string representation of the color. If
|
|
existing, this can be a 3-digit or 6-digit hexadecimal RGB value
|
|
with leading '#' character, a predefined color name (e.g. 'black',
|
|
'red', etc.), the index into an application defined color palette
|
|
in brackets with leading color name (e.g. 'red [9]' or
|
|
'windowColor [64]'), or a color modifier used in one-color
|
|
gradients (e.g. 'fill darken(128)' or 'fill lighten(0)').
|
|
|
|
@param roVmlOpacity The opacity of the color. If existing, this should
|
|
be a floating-point value in the range [0.0;1.0].
|
|
|
|
@param nDefaultRgb Default RGB color used if the parameter roVmlColor
|
|
is empty.
|
|
|
|
@param nPrimaryRgb If set to something else than API_RGB_TRANSPARENT,
|
|
specifies the color to be used to resolve the color modifiers used
|
|
in one-color gradients.
|
|
|
|
@return The resulting DrawingML color.
|
|
*/
|
|
OOX_DLLPUBLIC ::oox::drawingml::Color decodeColor(
|
|
const GraphicHelper& rGraphicHelper,
|
|
const std::optional< OUString >& roVmlColor,
|
|
const std::optional< double >& roVmlOpacity,
|
|
::Color nDefaultRgb,
|
|
::Color nPrimaryRgb = API_RGB_TRANSPARENT );
|
|
|
|
/** Converts VML path string into point and flag vectors.
|
|
|
|
@param rPoints The point vector to fill with coordinates.
|
|
|
|
@param rFlags The flag vector to fill. PolygonFlags_NORMAL indicates
|
|
a corresponding plain shape coordinate in rPoints and
|
|
PolygonFlags_CONTROL indicates a bezier curve control point.
|
|
|
|
@param rPath The VML path string.
|
|
|
|
@param rGraphicHelper See above.
|
|
*/
|
|
OOX_DLLPUBLIC void decodeVmlPath(
|
|
::std::vector< ::std::vector< css::awt::Point > >& rPoints,
|
|
::std::vector< ::std::vector< css::drawing::PolygonFlags > >& rFlags,
|
|
std::u16string_view rPath );
|
|
}
|
|
|
|
|
|
/** The stroke arrow model structure contains all properties for a line end arrow. */
|
|
struct StrokeArrowModel
|
|
{
|
|
std::optional< sal_Int32 > moArrowType;
|
|
std::optional< sal_Int32 > moArrowWidth;
|
|
std::optional< sal_Int32 > moArrowLength;
|
|
|
|
void assignUsed( const StrokeArrowModel& rSource );
|
|
};
|
|
|
|
|
|
/** The stroke model structure contains all shape border properties. */
|
|
struct StrokeModel
|
|
{
|
|
std::optional< bool > moStroked; ///< Shape border line on/off.
|
|
StrokeArrowModel maStartArrow; ///< Start line arrow style.
|
|
StrokeArrowModel maEndArrow; ///< End line arrow style.
|
|
std::optional< OUString > moColor; ///< Solid line color.
|
|
std::optional< double > moOpacity; ///< Solid line color opacity.
|
|
std::optional< OUString > moWeight; ///< Line width.
|
|
std::optional< OUString > moDashStyle; ///< Line dash (predefined or manually).
|
|
std::optional< sal_Int32 > moLineStyle; ///< Line style (single, double, ...).
|
|
std::optional< sal_Int32 > moEndCap; ///< Type of line end cap.
|
|
std::optional< sal_Int32 > moJoinStyle; ///< Type of line join.
|
|
|
|
void assignUsed( const StrokeModel& rSource );
|
|
|
|
/** Writes the properties to the passed property map. */
|
|
void pushToPropMap(
|
|
::oox::drawingml::ShapePropertyMap& rPropMap,
|
|
const GraphicHelper& rGraphicHelper ) const;
|
|
};
|
|
|
|
|
|
/** The fill model structure contains all shape fill properties. */
|
|
struct OOX_DLLPUBLIC FillModel
|
|
{
|
|
std::optional< bool > moFilled; ///< Shape fill on/off.
|
|
std::optional< OUString > moColor; ///< Solid fill color.
|
|
std::optional< double > moOpacity; ///< Solid fill color opacity.
|
|
std::optional< OUString > moColor2; ///< End color of gradient.
|
|
std::optional< double > moOpacity2; ///< End color opacity of gradient.
|
|
std::optional< sal_Int32 > moType; ///< Fill type.
|
|
std::optional< sal_Int32 > moAngle; ///< Gradient rotation angle.
|
|
std::optional< double > moFocus; ///< Linear gradient focus of second color.
|
|
std::optional< DoublePair > moFocusPos; ///< Rectangular gradient focus position of second color.
|
|
std::optional< DoublePair > moFocusSize; ///< Rectangular gradient focus size of second color.
|
|
std::optional< OUString > moBitmapPath; ///< Path to fill bitmap fragment.
|
|
std::optional< bool > moRotate; ///< True = rotate gradient/bitmap with shape.
|
|
|
|
void assignUsed( const FillModel& rSource );
|
|
|
|
/** Writes the properties to the passed property map. */
|
|
void pushToPropMap(
|
|
::oox::drawingml::ShapePropertyMap& rPropMap,
|
|
const GraphicHelper& rGraphicHelper ) const;
|
|
};
|
|
|
|
|
|
/** The shadow model structure contains all shape shadow properties. */
|
|
struct OOX_DLLPUBLIC ShadowModel
|
|
{
|
|
bool mbHasShadow; ///< Is a v:shadow element seen?
|
|
std::optional<bool> moShadowOn; ///< Is the element turned on?
|
|
std::optional<OUString> moColor; ///< Specifies the color of the shadow.
|
|
std::optional<OUString> moOffset; ///< Specifies the shadow's offset from the shape's location.
|
|
std::optional<double> moOpacity; ///< Specifies the opacity of the shadow.
|
|
|
|
ShadowModel();
|
|
|
|
/** Writes the properties to the passed property map. */
|
|
void pushToPropMap(oox::drawingml::ShapePropertyMap& rPropMap, const GraphicHelper& rGraphicHelper) const;
|
|
};
|
|
|
|
/** The shadow model structure contains all shape textpath properties. */
|
|
struct TextpathModel
|
|
{
|
|
std::optional<OUString> moString; ///< Specifies the string of the textpath.
|
|
std::optional<OUString> moStyle; ///< Specifies the style of the textpath.
|
|
std::optional<bool> moTrim; ///< Specifies whether extra space is removed above and below the text
|
|
|
|
TextpathModel();
|
|
|
|
/** Writes the properties to the passed property map. */
|
|
void pushToPropMap(oox::drawingml::ShapePropertyMap& rPropMap, const css::uno::Reference<css::drawing::XShape>& xShape,
|
|
const GraphicHelper& rGraphicHelper) const;
|
|
};
|
|
|
|
} // namespace oox::vml
|
|
|
|
#endif
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|