office-gobmx/include/oox/helper/modelobjecthelper.hxx

/* -*- 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_HELPER_MODELOBJECTHELPER_HXX
#define INCLUDED_OOX_HELPER_MODELOBJECTHELPER_HXX

#include <com/sun/star/uno/Any.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <oox/dllapi.h>
#include <rtl/ustring.hxx>
#include <sal/types.h>

namespace com::sun::star {
    namespace awt { struct Gradient;
                    struct Gradient2;
                    class XBitmap; }
    namespace graphic { class XGraphic; }
    namespace container { class XNameContainer; }
    namespace drawing { struct LineDash; }
    namespace drawing { struct Hatch; }
    namespace drawing { struct PolyPolygonBezierCoords; }
    namespace lang { class XMultiServiceFactory; }
}

namespace oox {


/** This helper manages named objects in a container, which is created on demand.
 */
class OOX_DLLPUBLIC ObjectContainer
{
public:
    explicit            ObjectContainer(
                            const css::uno::Reference< css::lang::XMultiServiceFactory >& rxModelFactory,
                            OUString aServiceName );
                        ~ObjectContainer();

    /** Returns true, if the object with the passed name exists in the container. */
    bool                hasObject( const OUString& rObjName ) const;

    css::uno::Any getObject( const OUString& rObjName ) const;

    /** Inserts the passed object into the container, returns its final name. */
    OUString     insertObject(
                            const OUString& rObjName,
                            const css::uno::Any& rObj,
                            bool bInsertByUnusedName );

private:
    void                createContainer() const;

private:
    mutable css::uno::Reference< css::lang::XMultiServiceFactory >
                        mxModelFactory;         ///< Factory to create the container.
    mutable css::uno::Reference< css::container::XNameContainer >
                        mxContainer;            ///< Container for the objects.
    OUString            maServiceName;          ///< Service name to create the container.
    sal_Int32           mnIndex;                ///< Index to create unique identifiers.
};


/** Contains tables for named drawing objects for a document model.

    Contains tables for named line markers, line dashes, fill gradients, and
    fill bitmap URLs. The class is needed to handle different document models
    in the same filter (e.g. embedded charts) which carry their own drawing
    object tables.
 */
class OOX_DLLPUBLIC ModelObjectHelper
{
public:
    explicit            ModelObjectHelper(
                            const css::uno::Reference< css::lang::XMultiServiceFactory >& rxModelFactory );

    /** Returns true, if the model contains a line marker with the passed name. */
    bool                hasLineMarker( const OUString& rMarkerName ) const;

    /** Inserts a new named line marker, overwrites an existing line marker
        with the same name. Returns true, if the marker could be inserted. */
    bool                insertLineMarker(
                            const OUString& rMarkerName,
                            const css::drawing::PolyPolygonBezierCoords& rMarker );

    /** Inserts a new named line dash, returns the line dash name, based on an
        internal constant name with a new unused index appended. */
    OUString     insertLineDash( const css::drawing::LineDash& rDash );

    /** Inserts a new named fill gradient, returns the gradient name, based on
        an internal constant name with a new unused index appended. */
    OUString     insertFillGradient( const css::awt::Gradient2& rGradient );
    OUString     insertFillGradient( const css::awt::Gradient& rGradient );

    OUString     insertTransGrandient( const css::awt::Gradient2& rGradient );
    OUString     insertTransGrandient( const css::awt::Gradient& rGradient );

    OUString     insertFillHatch( const css::drawing::Hatch& rHatch );

    /** Inserts a new named fill graphic, returns the bitmap name, based on
        an internal constant name with a new unused index appended. */
    OUString insertFillBitmapXGraphic(css::uno::Reference<css::graphic::XGraphic> const & rxGraphic);

    css::uno::Reference<css::awt::XBitmap> getFillBitmap(OUString const & rGraphicName);

private:
    ObjectContainer     maMarkerContainer;      ///< Contains all named line markers (line end polygons).
    ObjectContainer     maDashContainer;        ///< Contains all named line dashes.
    ObjectContainer     maGradientContainer;    ///< Contains all named fill gradients.
    ObjectContainer     maTransGradContainer;   ///< Contains all named transparency Gradients.
    ObjectContainer     maBitmapUrlContainer;   ///< Contains all named fill bitmap URLs.
    ObjectContainer     maHatchContainer;       ///< Contains all named fill hatches.
};


} // namespace oox

#endif

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