/* -*- 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 <svtools/svtdllapi.h>
#include <com/sun/star/uno/Reference.hxx>
#include <vcl/graph.hxx>
#include <rtl/ustring.hxx>
#include <memory>

namespace com :: sun :: star :: io { class XInputStream; }

namespace comphelper
{
    class EmbeddedObjectContainer;
}

namespace com::sun::star::embed {
    class XEmbeddedObject;
}

class OutputDevice;
typedef struct _xmlTextWriter* xmlTextWriterPtr;

namespace svt {

struct EmbeddedObjectRef_Impl;

class SVT_DLLPUBLIC EmbeddedObjectRef
{
    std::unique_ptr<EmbeddedObjectRef_Impl> mpImpl;

    SVT_DLLPRIVATE std::unique_ptr<SvStream> GetGraphicStream( bool bUpdate ) const;
    SVT_DLLPRIVATE void GetReplacement( bool bUpdate );
    SVT_DLLPRIVATE void UpdateOleObject( bool bUpdateOle);

    EmbeddedObjectRef& operator = ( const EmbeddedObjectRef& ) = delete;

public:
    static void DrawPaintReplacement( const tools::Rectangle &rRect, const OUString &rText, OutputDevice *pOut );
    static void DrawShading( const tools::Rectangle &rRect, OutputDevice *pOut );
    static bool TryRunningState( const css::uno::Reference < css::embed::XEmbeddedObject >& );
    static void SetGraphicToContainer( const Graphic& rGraphic,
                                        comphelper::EmbeddedObjectContainer& aContainer,
                                        const OUString& aName,
                                        const OUString& aMediaType );

    static css::uno::Reference< css::io::XInputStream > GetGraphicReplacementStream(
                                        sal_Int64 nViewAspect,
                                        const css::uno::Reference < css::embed::XEmbeddedObject >&,
                                        OUString* pMediaType )
                            noexcept;

    static bool IsChart(const css::uno::Reference < css::embed::XEmbeddedObject >& xObj);

    const css::uno::Reference <css::embed::XEmbeddedObject>& operator->() const;
    const css::uno::Reference <css::embed::XEmbeddedObject>& GetObject() const;

    // default constructed object; needs further assignment before it can be used
    EmbeddedObjectRef();

    // assign a previously default constructed object
    void Assign( const css::uno::Reference < css::embed::XEmbeddedObject >& xObj, sal_Int64 nAspect );

    // create object for a certain view aspect
    EmbeddedObjectRef( const css::uno::Reference < css::embed::XEmbeddedObject >& xObj, sal_Int64 nAspect );

    ~EmbeddedObjectRef();
    EmbeddedObjectRef( const EmbeddedObjectRef& );

    // assigning to a container enables the object to exchange graphical representations with a storage
    void            AssignToContainer( comphelper::EmbeddedObjectContainer* pContainer, const OUString& rPersistName );
    comphelper::EmbeddedObjectContainer* GetContainer() const;

    sal_Int64       GetViewAspect() const;
    void            SetViewAspect( sal_Int64 nAspect );
    const Graphic* GetGraphic() const;

    // the original size of the object ( size of the icon for iconified object )
    // no conversion is done if no target mode is provided
    Size            GetSize( MapMode const * pTargetMapMode ) const;

    void            SetGraphic( const Graphic& rGraphic, const OUString& rMediaType );
    void            SetGraphicStream(
                        const css::uno::Reference< css::io::XInputStream >& xInGrStream,
                        const OUString& rMediaType );

                    // bUpdateOle = false update the Link-Objects
                    //            = true  update the OLE-Objects
    void            UpdateReplacement( bool bUpdateOle = false );
    void            UpdateReplacementOnDemand();
    void Lock( bool bLock = true );
    void            Clear();
    bool is() const;

    bool IsLocked() const;

    void SetIsProtectedHdl(const Link<LinkParamNone*, bool>& rProtectedHdl);
    const Link<LinkParamNone*, bool> & GetIsProtectedHdl() const;

    bool IsChart() const;

    OUString GetChartType();

    // #i104867#
    // Provides a graphic version number for the fetchable Graphic during this object's lifetime. Internally,
    // that number is incremented at each change of the Graphic. This mechanism is needed to identify if a
    // remembered Graphic (e.g. primitives) has changed compared to the current one, but without actively
    // fetching the Graphic what would be too expensive e.g. for charts
    sal_uInt32 getGraphicVersion() const;
    void            SetDefaultSizeForChart( const Size& rSizeIn_100TH_MM );//#i103460# charts do not necessarily have an own size within ODF files, in this case they need to use the size settings from the surrounding frame, which is made available with this method

    void dumpAsXml(xmlTextWriterPtr pWriter) const;
};

}

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