/src/libreoffice/include/oox/drawingml/shapepropertymap.hxx

Source
/* -*- 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 .
 */

#pragma once

#include <com/sun/star/uno/Any.hxx>
#include <o3tl/enumarray.hxx>
#include <oox/dllapi.h>
#include <oox/helper/propertymap.hxx>
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include <tools/color.hxx>

namespace oox { class ModelObjectHelper; }

namespace oox::drawingml {

/** Enumeration for various properties related to drawing shape formatting.

    This is an abstraction for shape formatting properties that have different
    names in various implementations, e.g. drawing shapes vs. chart objects.

    If you *insert* ids into this list, then update spnCommonPropIds, spnLinearPropIds
    and spnFilledPropIds of oox/source/drawingml/chart/objectformatter.cxx if
    the newly inserted enum is inside the range they cover
 */
enum class ShapeProperty
{
    LineStyle,
    LineWidth,
    LineColor,
    LineTransparency,
    LineDash,                     ///< Explicit line dash or name of a line dash stored in a global container.
    LineCap,
    LineJoint,
    LineStart,                    ///< Explicit line start marker or name of a line marker stored in a global container.
    LineStartWidth,
    LineStartCenter,
    LineEnd,                      ///< Explicit line end marker or name of a line marker stored in a global container.
    LineEndWidth,
    LineEndCenter,
    FillStyle,
    FillColor,
    FillTransparency,
    GradientTransparency,
    FillGradient,                 ///< Explicit fill gradient or name of a fill gradient stored in a global container.
    FillBitmap,                   ///< Explicit fill bitmap or name of a fill bitmap stored in a global container.
    FillBitmapMode,
    FillBitmapSizeX,
    FillBitmapSizeY,
    FillBitmapOffsetX,
    FillBitmapOffsetY,
    FillBitmapRectanglePoint,
    FillHatch,                    ///< Explicit fill hatch or name of a fill hatch stored in a global container.
    FillBackground,
    FillUseSlideBackground,
    FillBitmapName,
    ShadowXDistance,
    ShadowSizeX,
    ShadowSizeY,
    LAST = ShadowSizeY
};

typedef o3tl::enumarray<ShapeProperty, sal_Int32> ShapePropertyIds;

struct OOX_DLLPUBLIC ShapePropertyInfo
{
    const ShapePropertyIds& mrPropertyIds;
    bool mbNamedLineMarker;      /// True = use named line marker instead of explicit line marker.
    bool mbNamedLineDash;        /// True = use named line dash instead of explicit line dash.
    bool mbNamedFillGradient;    /// True = use named fill gradient instead of explicit fill gradient.
    bool mbNamedFillBitmap;      /// True = use named fill bitmap instead of explicit fill bitmap.
    bool mbNamedFillHatch;       /// True = use named fill hatch instead of explicit fill hatch.

    static ShapePropertyInfo DEFAULT;           /// Default property info (used as default parameter of other methods).

    explicit ShapePropertyInfo(const ShapePropertyIds& rnPropertyIds,
                               bool bNamedLineMarker, bool bNamedLineDash,
                               bool bNamedFillGradient, bool bNamedFillBitmap, bool bNamedFillHatch);

    bool has(ShapeProperty ePropId) const
    {
        return mrPropertyIds[ePropId] >= 0;
    }
    sal_Int32 operator[](ShapeProperty ePropId) const
    {
        return mrPropertyIds[ePropId];
    }
};

class OOX_DLLPUBLIC ShapePropertyMap : public PropertyMap
{
public:
    explicit ShapePropertyMap(ModelObjectHelper& rModelObjHelper,
        const ShapePropertyInfo& rShapePropInfo = ShapePropertyInfo::DEFAULT );

    /** Returns true, if the specified property is supported. */
    bool                supportsProperty( ShapeProperty ePropId ) const;

    /** Returns true, if named line markers are supported, and the specified
        line marker has already been inserted into the marker table. */
    bool                hasNamedLineMarkerInTable( const OUString& rMarkerName ) const;

    /** Sets the specified shape property to the passed value. */
    bool                setAnyProperty( ShapeProperty ePropId, const css::uno::Any& rValue );

    /** Sets the specified shape property to the passed value. */
    template<typename Type>
    bool setProperty(ShapeProperty ePropId, const Type& rValue)
    {
        return setAnyProperty(ePropId, css::uno::Any(rValue));
    }
    bool setProperty(ShapeProperty ePropId, const ::Color& rValue)
    {
        return setAnyProperty(ePropId, css::uno::Any(rValue));
    }

    using PropertyMap::setAnyProperty;
    using PropertyMap::setProperty;

private:
    /** Sets an explicit line marker, or creates a named line marker. */
    bool setLineMarker( sal_Int32 nPropId, const css::uno::Any& rValue );
    /** Sets an explicit line dash, or creates a named line dash. */
    bool setLineDash( sal_Int32 nPropId, const css::uno::Any& rValue );
    /** Sets an explicit fill gradient, or creates a named fill gradient. */
    bool setFillGradient( sal_Int32 nPropId, const css::uno::Any& rValue );
    /** Creates a named transparency gradient. */
    bool setGradientTrans( sal_Int32 nPropId, const css::uno::Any& rValue );
    /** Sets an explicit fill bitmap, or creates a named fill bitmap. */
    bool setFillBitmap( sal_Int32 nPropId, const css::uno::Any& rValue );
    /** Sets an explicit fill bitmap and pushes the name to FillBitmapName */
    bool setFillBitmapName( const css::uno::Any& rValue );
    /** Sets an explicit fill hatch, or creates a named fill hatch. */
    bool setFillHatch( sal_Int32 nPropId, const css::uno::Any& rValue );

    // not implemented, to prevent implicit conversion from enum to int
    css::uno::Any& operator[]( ShapeProperty ePropId ) = delete;
    const css::uno::Any& operator[]( ShapeProperty ePropId ) const = delete;

private:
    ModelObjectHelper&  mrModelObjHelper;
    ShapePropertyInfo   maShapePropInfo;
};


} // namespace oox::drawingml

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

Coverage Report

Created: 2026-09-28 10:59