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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/* -*- 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_GRAPHICHELPER_HXX
#define INCLUDED_OOX_HELPER_GRAPHICHELPER_HXX
#include <deque>
#include <map>
#include <com/sun/star/awt/DeviceInfo.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include <oox/dllapi.h>
#include <oox/helper/binarystreambase.hxx>
#include <oox/helper/helper.hxx>
#include <oox/helper/storagebase.hxx>
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include <com/sun/star/graphic/XGraphicProvider2.hpp>
struct WMF_EXTERNALHEADER;
namespace com { namespace sun { namespace star {
namespace awt { struct Point; }
namespace awt { struct Size; }
namespace awt { class XUnitConversion; }
namespace io { class XInputStream; }
namespace frame { class XFrame; }
namespace graphic { class XGraphic; }
namespace graphic { class XGraphicObject; }
namespace graphic { class XGraphicProvider; }
namespace uno { class XComponentContext; }
} } }
namespace oox {
/** Provides helper functions for colors, device measurement conversion,
graphics, and graphic objects handling.
All createGraphicObject() and importGraphicObject() functions create
persistent graphic objects internally and store them in an internal
container to prevent their early destruction. This makes it possible to use
the returned URL of the graphic object in any way (e.g. insert it into a
property map) without needing to store it immediately at an object that
resolves the graphic object from the passed URL and thus prevents it from
being destroyed.
*/
class OOX_DLLPUBLIC GraphicHelper
{
public:
explicit GraphicHelper(
const css::uno::Reference< css::uno::XComponentContext >& rxContext,
const css::uno::Reference< css::frame::XFrame >& rxTargetFrame,
const StorageRef& rxStorage );
virtual ~GraphicHelper();
// System colors and predefined colors ------------------------------------
/** Returns a system color specified by the passed XML token identifier. */
sal_Int32 getSystemColor( sal_Int32 nToken, sal_Int32 nDefaultRgb = API_RGB_TRANSPARENT ) const;
/** Derived classes may implement to resolve a scheme color from the passed XML token identifier. */
virtual sal_Int32 getSchemeColor( sal_Int32 nToken ) const;
/** Derived classes may implement to resolve a palette index to an RGB color. */
virtual sal_Int32 getPaletteColor( sal_Int32 nPaletteIdx ) const;
virtual sal_Int32 getDefaultChartAreaFillStyle() const;
// Device info and device dependent unit conversion -----------------------
/** Returns information about the output device. */
const css::awt::DeviceInfo& getDeviceInfo() const { return maDeviceInfo;}
/** Converts the passed value from horizontal screen pixels to 1/100 mm. */
sal_Int32 convertScreenPixelXToHmm( double fPixelX ) const;
/** Converts the passed value from vertical screen pixels to 1/100 mm. */
sal_Int32 convertScreenPixelYToHmm( double fPixelY ) const;
/** Converts the passed size from screen pixels to 1/100 mm. */
css::awt::Size convertScreenPixelToHmm( const css::awt::Size& rPixel ) const;
/** Converts the passed value from 1/100 mm to horizontal screen pixels. */
double convertHmmToScreenPixelX( sal_Int32 nHmmX ) const;
/** Converts the passed value from 1/100 mm to vertical screen pixels. */
double convertHmmToScreenPixelY( sal_Int32 nHmmY ) const;
/** Converts the passed point from 1/100 mm to screen pixels. */
css::awt::Point convertHmmToScreenPixel( const css::awt::Point& rHmm ) const;
/** Converts the passed size from 1/100 mm to screen pixels. */
css::awt::Size convertHmmToScreenPixel( const css::awt::Size& rHmm ) const;
/** Converts the passed point from 1/100 mm to AppFont units. */
css::awt::Point convertHmmToAppFont( const css::awt::Point& rHmm ) const;
/** Converts the passed size from 1/100 mm to AppFont units. */
css::awt::Size convertHmmToAppFont( const css::awt::Size& rHmm ) const;
// Graphics and graphic objects ------------------------------------------
/** Imports a graphic from the passed input stream. */
css::uno::Reference< css::graphic::XGraphic >
importGraphic(
const css::uno::Reference< css::io::XInputStream >& rxInStrm,
const WMF_EXTERNALHEADER* pExtHeader = nullptr ) const;
/** Imports graphics from the passed input streams. */
std::vector< css::uno::Reference<css::graphic::XGraphic> >
importGraphics(const std::vector< css::uno::Reference<css::io::XInputStream> >& rStreams) const;
/** Imports a graphic from the passed binary memory block. */
css::uno::Reference< css::graphic::XGraphic >
importGraphic( const StreamDataSequence& rGraphicData ) const;
/** Imports a graphic from the storage stream with the passed path and name. */
css::uno::Reference< css::graphic::XGraphic >
importEmbeddedGraphic(
const OUString& rStreamName,
const WMF_EXTERNALHEADER* pExtHeader = nullptr ) const;
/** Imports graphics from the storage with the passed stream names. */
void importEmbeddedGraphics(const std::vector<OUString>& rStreamNames) const;
/** Creates a persistent graphic object from the passed graphic.
@return The URL of the created and internally cached graphic object. */
OUString createGraphicObject(
const css::uno::Reference< css::graphic::XGraphic >& rxGraphic ) const;
/** Creates a persistent graphic object from the passed input stream.
@return The URL of the created and internally cached graphic object. */
OUString importGraphicObject(
const css::uno::Reference< css::io::XInputStream >& rxInStrm,
const WMF_EXTERNALHEADER* pExtHeader ) const;
/** Creates a persistent graphic object from the passed binary memory block.
@return The URL of the created and internally cached graphic object. */
OUString importGraphicObject( const StreamDataSequence& rGraphicData ) const;
/** Imports a graphic object from the storage stream with the passed path and name.
@return The URL of the created and internally cached graphic object. */
OUString importEmbeddedGraphicObject( const OUString& rStreamName ) const;
/** calculates the original size of a graphic which is necessary to be able to calculate cropping values
@return The original Graphic size in 100thmm */
css::awt::Size getOriginalSize( const css::uno::Reference< css::graphic::XGraphic >& rxGraphic ) const;
private:
typedef ::std::map< sal_Int32, sal_Int32 > SystemPalette;
typedef ::std::deque< css::uno::Reference< css::graphic::XGraphicObject > > GraphicObjectDeque;
typedef ::std::map< OUString, css::uno::Reference< css::graphic::XGraphic > > EmbeddedGraphicMap;
css::uno::Reference< css::uno::XComponentContext > mxContext;
css::uno::Reference< css::graphic::XGraphicProvider2 > mxGraphicProvider;
css::uno::Reference< css::awt::XUnitConversion > mxUnitConversion;
css::awt::DeviceInfo maDeviceInfo; ///< Current output device info.
SystemPalette maSystemPalette; ///< Maps system colors (XML tokens) to RGB color values.
StorageRef mxStorage; ///< Storage containing embedded graphics.
mutable GraphicObjectDeque maGraphicObjects; ///< Caches all created graphic objects to keep them alive.
mutable EmbeddedGraphicMap maEmbeddedGraphics; ///< Maps all embedded graphics by their storage path.
const OUString maGraphicObjScheme; ///< The URL scheme name for graphic objects.
double mfPixelPerHmmX; ///< Number of screen pixels per 1/100 mm in X direction.
double mfPixelPerHmmY; ///< Number of screen pixels per 1/100 mm in Y direction.
};
} // namespace oox
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
