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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef OOX_DRAWINGML_COLOR_HXX
#define OOX_DRAWINGML_COLOR_HXX
#include <vector>
#include <boost/shared_ptr.hpp>
#include <sal/types.h>
#include <rtl/instance.hxx>
#include <rtl/ustring.hxx>
#include "oox/helper/helper.hxx"
namespace oox { class GraphicHelper; }
namespace oox {
namespace drawingml {
// ============================================================================
class Color
{
public:
Color();
~Color();
/** Returns the RGB value for the passed DrawingML color token, or nDefaultRgb on error. */
static sal_Int32 getDmlPresetColor( sal_Int32 nToken, sal_Int32 nDefaultRgb );
/** Returns the RGB value for the passed VML color token, or nDefaultRgb on error. */
static sal_Int32 getVmlPresetColor( sal_Int32 nToken, sal_Int32 nDefaultRgb );
/** Sets the color to unused state. */
void setUnused();
/** Sets an RGB value (hexadecimal RRGGBB) from the a:srgbClr element. */
void setSrgbClr( sal_Int32 nRgb );
/** Sets the percentual RGB values from the a:scrgbClr element. */
void setScrgbClr( sal_Int32 nR, sal_Int32 nG, sal_Int32 nB );
/** Sets the HSL values from the a:hslClr element. */
void setHslClr( sal_Int32 nHue, sal_Int32 nSat, sal_Int32 nLum );
/** Sets a predefined color from the a:prstClr element. */
void setPrstClr( sal_Int32 nToken );
/** Sets a scheme color from the a:schemeClr element. */
void setSchemeClr( sal_Int32 nToken );
/** Sets a system color from the a:sysClr element. */
void setSysClr( sal_Int32 nToken, sal_Int32 nLastRgb );
/** Sets a palette color index. */
void setPaletteClr( sal_Int32 nPaletteIdx );
/** Inserts the passed color transformation. */
void addTransformation( sal_Int32 nElement, sal_Int32 nValue = -1 );
/** Inserts Chart specific color tint (-1.0...0.0 = shade, 0.0...1.0 = tint). */
void addChartTintTransformation( double fTint );
/** Inserts Excel specific color tint (-1.0...0.0 = shade, 0.0...1.0 = tint). */
void addExcelTintTransformation( double fTint );
/** Removes all color transformations. */
void clearTransformations();
/** Removes transparence from the color. */
void clearTransparence();
/** Overwrites this color with the passed color, if it is used. */
inline void assignIfUsed( const Color& rColor ) { if( rColor.isUsed() ) *this = rColor; }
/** Returns true, if the color is initialized. */
bool isUsed() const { return meMode != COLOR_UNUSED; }
/** Returns true, if the color is a placeholder color in theme style lists. */
bool isPlaceHolder() const { return meMode == COLOR_PH; }
/** Returns the final RGB color value.
@param nPhClr Actual color for the phClr placeholder color used in theme style lists. */
sal_Int32 getColor( const GraphicHelper& rGraphicHelper, sal_Int32 nPhClr = API_RGB_TRANSPARENT ) const;
/** Returns true, if the color has a transparence set. */
bool hasTransparence() const;
/** Returns the transparence of the color (0 = opaque, 100 = full transparent). */
sal_Int16 getTransparence() const;
private:
/** Internal helper for getColor(). */
void setResolvedRgb( sal_Int32 nRgb ) const;
/** Converts the color components to RGB values. */
void toRgb() const;
/** Converts the color components to CRGB values (gamma corrected percentage). */
void toCrgb() const;
/** Converts the color components to HSL values. */
void toHsl() const;
private:
enum ColorMode
{
COLOR_UNUSED, /// Color is not used, or undefined.
COLOR_RGB, /// Absolute RGB (r/g/b: 0...255).
COLOR_CRGB, /// Relative RGB (r/g/b: 0...100000).
COLOR_HSL, /// HSL (hue: 0...21600000, sat/lum: 0...100000).
COLOR_SCHEME, /// Color from scheme.
COLOR_PALETTE, /// Color from application defined palette.
COLOR_SYSTEM, /// Color from system palette.
COLOR_PH, /// Placeholder color in theme style lists.
COLOR_FINAL /// Finalized RGB color.
};
struct Transformation
{
sal_Int32 mnToken;
sal_Int32 mnValue;
explicit Transformation( sal_Int32 nToken, sal_Int32 nValue ) : mnToken( nToken ), mnValue( nValue ) {}
};
typedef ::std::vector< Transformation > TransformVec;
mutable ColorMode meMode; /// Current color mode.
mutable TransformVec maTransforms; /// Color transformations.
mutable sal_Int32 mnC1; /// Red, red%, hue, scheme token, palette index, system token, or final RGB.
mutable sal_Int32 mnC2; /// Green, green%, saturation, or system default RGB.
mutable sal_Int32 mnC3; /// Blue, blue%, or luminance.
sal_Int32 mnAlpha; /// Alpha value (color opacity).
};
typedef boost::shared_ptr< Color > ColorPtr;
// ============================================================================
} // namespace drawingml
} // namespace oox
#endif
|
