1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
20 #ifndef INCLUDED_OOX_DRAWINGML_COLOR_HXX
21 #define INCLUDED_OOX_DRAWINGML_COLOR_HXX
25 #include <com/sun/star/beans/PropertyValue.hpp>
26 #include <com/sun/star/uno/Sequence.hxx>
27 #include <oox/helper/helper.hxx>
28 #include <oox/dllapi.h>
29 #include <rtl/ustring.hxx>
30 #include <sal/types.h>
32 namespace oox
{ class GraphicHelper
; }
38 class OOX_DLLPUBLIC Color
44 /** Returns the RGB value for the passed DrawingML color token, or nDefaultRgb on error. */
45 static sal_Int32
getDmlPresetColor( sal_Int32 nToken
, sal_Int32 nDefaultRgb
);
46 /** Returns the RGB value for the passed VML color token, or nDefaultRgb on error. */
47 static sal_Int32
getVmlPresetColor( sal_Int32 nToken
, sal_Int32 nDefaultRgb
);
49 /** Sets the color to unused state. */
51 /** Sets an RGB value (hexadecimal RRGGBB) from the a:srgbClr element. */
52 void setSrgbClr( sal_Int32 nRgb
);
53 /** Sets the percentual RGB values from the a:scrgbClr element. */
54 void setScrgbClr( sal_Int32 nR
, sal_Int32 nG
, sal_Int32 nB
);
55 /** Sets the HSL values from the a:hslClr element. */
56 void setHslClr( sal_Int32 nHue
, sal_Int32 nSat
, sal_Int32 nLum
);
57 /** Sets a predefined color from the a:prstClr element. */
58 void setPrstClr( sal_Int32 nToken
);
59 /** Sets a scheme color from the a:schemeClr element. */
60 void setSchemeClr( sal_Int32 nToken
);
61 /** Sets the scheme name from the a:schemeClr element for interoperability purposes */
62 void setSchemeName( const OUString
& sSchemeName
) { msSchemeName
= sSchemeName
; }
63 /** Sets a system color from the a:sysClr element. */
64 void setSysClr( sal_Int32 nToken
, sal_Int32 nLastRgb
);
65 /** Sets a palette color index. */
66 void setPaletteClr( sal_Int32 nPaletteIdx
);
68 /** Inserts the passed color transformation. */
69 void addTransformation( sal_Int32 nElement
, sal_Int32 nValue
= -1 );
70 /** Inserts Chart specific color tint (-1.0...0.0 = shade, 0.0...1.0 = tint). */
71 void addChartTintTransformation( double fTint
);
72 /** Inserts Excel specific color tint (-1.0...0.0 = shade, 0.0...1.0 = tint). */
73 void addExcelTintTransformation( double fTint
);
74 /** Removes all color transformations. */
75 void clearTransformations();
76 /** Removes transparence from the color. */
77 void clearTransparence();
79 /** Overwrites this color with the passed color, if it is used. */
80 void assignIfUsed( const Color
& rColor
) { if( rColor
.isUsed() ) *this = rColor
; }
82 /** Returns true, if the color is initialized. */
83 bool isUsed() const { return meMode
!= COLOR_UNUSED
; }
84 /** Returns true, if the color is a placeholder color in theme style lists. */
85 bool isPlaceHolder() const { return meMode
== COLOR_PH
; }
86 /** Returns the final RGB color value.
87 @param nPhClr Actual color for the phClr placeholder color used in theme style lists. */
88 sal_Int32
getColor( const GraphicHelper
& rGraphicHelper
, sal_Int32 nPhClr
= API_RGB_TRANSPARENT
) const;
90 /** Returns true, if the color is transparent. */
91 bool hasTransparency() const;
92 /** Returns the transparency of the color (0 = opaque, 100 = full transparent). */
93 sal_Int16
getTransparency() const;
95 /** Returns the scheme name from the a:schemeClr element for interoperability purposes */
96 const OUString
& getSchemeName() const { return msSchemeName
; }
97 /** Returns the unaltered list of transformations for interoperability purposes */
98 const css::uno::Sequence
< css::beans::PropertyValue
>& getTransformations() const { return maInteropTransformations
;}
100 /** Translates between color transformation tokens and their names */
101 static OUString
getColorTransformationName( sal_Int32 nElement
);
102 /** Translates between color transformation token names and the corresponding token */
103 static sal_Int32
getColorTransformationToken( const OUString
& sName
);
106 /** Internal helper for getColor(). */
107 void setResolvedRgb( sal_Int32 nRgb
) const;
109 /** Converts the color components to RGB values. */
111 /** Converts the color components to CRGB values (gamma corrected percentage). */
113 /** Converts the color components to HSL values. */
119 COLOR_UNUSED
, /// Color is not used, or undefined.
120 COLOR_RGB
, /// Absolute RGB (r/g/b: 0...255).
121 COLOR_CRGB
, /// Relative RGB (r/g/b: 0...100000).
122 COLOR_HSL
, /// HSL (hue: 0...21600000, sat/lum: 0...100000).
123 COLOR_SCHEME
, /// Color from scheme.
124 COLOR_PALETTE
, /// Color from application defined palette.
125 COLOR_SYSTEM
, /// Color from system palette.
126 COLOR_PH
, /// Placeholder color in theme style lists.
127 COLOR_FINAL
/// Finalized RGB color.
130 struct Transformation
135 explicit Transformation( sal_Int32 nToken
, sal_Int32 nValue
) : mnToken( nToken
), mnValue( nValue
) {}
137 typedef ::std::vector
< Transformation
> TransformVec
;
139 mutable ColorMode meMode
; /// Current color mode.
140 mutable TransformVec maTransforms
; /// Color transformations.
141 mutable sal_Int32 mnC1
; /// Red, red%, hue, scheme token, palette index, system token, or final RGB.
142 mutable sal_Int32 mnC2
; /// Green, green%, saturation, or system default RGB.
143 mutable sal_Int32 mnC3
; /// Blue, blue%, or luminance.
144 sal_Int32 mnAlpha
; /// Alpha value (color opacity).
146 OUString msSchemeName
; /// Scheme name from the a:schemeClr element for interoperability purposes
147 css::uno::Sequence
< css::beans::PropertyValue
>
148 maInteropTransformations
; /// Unaltered list of transformations for interoperability purposes
151 } // namespace drawingml
156 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */