| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the 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 is transparent. */ |
| bool hasTransparency() const; |
| /** Returns the transparency of the color (0 = opaque, 100 = full transparent). */ |
| sal_Int16 getTransparency() 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 |
| |