summaryrefslogtreecommitdiff
path: root/include/svtools/embedhlp.hxx
blob: f157ce6c776190da0d7d771b22aaffa0c5984b18 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/* -*- 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_SVTOOLS_EMBEDHLP_HXX
#define INCLUDED_SVTOOLS_EMBEDHLP_HXX

#include <svtools/svtdllapi.h>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/io/XInputStream.hpp>
#include <vcl/graph.hxx>
#include <tools/mapunit.hxx>
#include <rtl/ustring.hxx>

namespace comphelper
{
    class EmbeddedObjectContainer;
}

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

class Rectangle;
class OutputDevice;

namespace svt {

struct EmbeddedObjectRef_Impl;

class SVT_DLLPUBLIC EmbeddedObjectRef
{
    EmbeddedObjectRef_Impl* mpImpl;

    SVT_DLLPRIVATE SvStream* GetGraphicStream( bool bUpdate ) const;
    SVT_DLLPRIVATE void GetReplacement( bool bUpdate );

    EmbeddedObjectRef& operator = ( const EmbeddedObjectRef& );

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

    static ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > GetGraphicReplacementStream(
                                        sal_Int64 nViewAspect,
                                        const ::com::sun::star::uno::Reference < ::com::sun::star::embed::XEmbeddedObject >&,
                                        OUString* pMediaType )
                            throw();

    static bool IsChart(const ::com::sun::star::uno::Reference < ::com::sun::star::embed::XEmbeddedObject >& xObj);
    static bool IsGLChart(const ::com::sun::star::uno::Reference < ::com::sun::star::embed::XEmbeddedObject >& xObj);

    const com::sun::star::uno::Reference <com::sun::star::embed::XEmbeddedObject>& operator->() const;
    const com::sun::star::uno::Reference <com::sun::star::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 ::com::sun::star::uno::Reference < ::com::sun::star::embed::XEmbeddedObject >& xObj, sal_Int64 nAspect );

    // create object for a certain view aspect
    EmbeddedObjectRef( const ::com::sun::star::uno::Reference < ::com::sun::star::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( OUString* pMediaType = NULL ) 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* pTargetMapMode = NULL ) const;

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

    void            UpdateReplacement();
    void            UpdateReplacementOnDemand();
    void Lock( bool bLock = true );
    void            Clear();
    bool is() const;

    bool IsLocked() const;
    bool IsChart() const;
    bool IsGLChart() 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 necessaryly 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
};

}

#endif

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