include/oox/drawingml/color.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   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/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  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 .
  18  */
  19
  20 #ifndef INCLUDED_OOX_DRAWINGML_COLOR_HXX
  21 #define INCLUDED_OOX_DRAWINGML_COLOR_HXX
  22
  23 #include <vector>
  24
  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>
  31
  32 namespace oox { class GraphicHelper; }
  33
  34 namespace oox {
  35 namespace drawingml {
  36
  37
  38 class OOX_DLLPUBLIC Color
  39 {
  40 public:
  41     Color();
  42
  43     /** Returns the RGB value for the passed DrawingML color token, or nDefaultRgb on error. */
  44     static sal_Int32    getDmlPresetColor( sal_Int32 nToken, sal_Int32 nDefaultRgb );
  45     /** Returns the RGB value for the passed VML color token, or nDefaultRgb on error. */
  46     static sal_Int32    getVmlPresetColor( sal_Int32 nToken, sal_Int32 nDefaultRgb );
  47
  48     /** Sets the color to unused state. */
  49     void                setUnused();
  50     /** Sets an RGB value (hexadecimal RRGGBB) from the a:srgbClr element. */
  51     void                setSrgbClr( sal_Int32 nRgb );
  52     /** Sets the percentual RGB values from the a:scrgbClr element. */
  53     void                setScrgbClr( sal_Int32 nR, sal_Int32 nG, sal_Int32 nB );
  54     /** Sets the HSL values from the a:hslClr element. */
  55     void                setHslClr( sal_Int32 nHue, sal_Int32 nSat, sal_Int32 nLum );
  56     /** Sets a predefined color from the a:prstClr element. */
  57     void                setPrstClr( sal_Int32 nToken );
  58     /** Sets a scheme color from the a:schemeClr element. */
  59     void                setSchemeClr( sal_Int32 nToken );
  60     /** Sets the scheme name from the a:schemeClr element for interoperability purposes */
  61     void                setSchemeName( const OUString& sSchemeName ) { msSchemeName = sSchemeName; }
  62     /** Sets a system color from the a:sysClr element. */
  63     void                setSysClr( sal_Int32 nToken, sal_Int32 nLastRgb );
  64     /** Sets a palette color index. */
  65     void                setPaletteClr( sal_Int32 nPaletteIdx );
  66
  67     /** Inserts the passed color transformation. */
  68     void                addTransformation( sal_Int32 nElement, sal_Int32 nValue = -1 );
  69     /** Inserts Chart specific color tint (-1.0...0.0 = shade, 0.0...1.0 = tint). */
  70     void                addChartTintTransformation( double fTint );
  71     /** Inserts Excel specific color tint (-1.0...0.0 = shade, 0.0...1.0 = tint). */
  72     void                addExcelTintTransformation( double fTint );
  73     /** Removes all color transformations. */
  74     void                clearTransformations();
  75     /** Removes transparence from the color. */
  76     void                clearTransparence();
  77
  78     /** Overwrites this color with the passed color, if it is used. */
  79     void                assignIfUsed( const Color& rColor ) { if( rColor.isUsed() ) *this = rColor; }
  80
  81     /** Returns true, if the color is initialized. */
  82     bool                isUsed() const { return meMode != COLOR_UNUSED; }
  83     /** Returns true, if the color is a placeholder color in theme style lists. */
  84     bool                isPlaceHolder() const { return meMode == COLOR_PH; }
  85     /** Returns the final RGB color value.
  86         @param nPhClr  Actual color for the phClr placeholder color used in theme style lists. */
  87     sal_Int32           getColor( const GraphicHelper& rGraphicHelper, sal_Int32 nPhClr = API_RGB_TRANSPARENT ) const;
  88
  89     /** Returns true, if the color is transparent. */
  90     bool                hasTransparency() const;
  91     /** Returns the transparency of the color (0 = opaque, 100 = full transparent). */
  92     sal_Int16           getTransparency() const;
  93
  94     /** Returns the scheme name from the a:schemeClr element for interoperability purposes */
  95     const OUString&     getSchemeName() const { return msSchemeName; }
  96     /** Returns the unaltered list of transformations for interoperability purposes */
  97     const css::uno::Sequence< css::beans::PropertyValue >& getTransformations() const { return maInteropTransformations;}
  98
  99     /** Translates between color transformation tokens and their names */
 100     static OUString     getColorTransformationName( sal_Int32 nElement );
 101     /** Translates between color transformation token names and the corresponding token */
 102     static sal_Int32    getColorTransformationToken( const OUString& sName );
 103
 104 private:
 105     /** Internal helper for getColor(). */
 106     void                setResolvedRgb( sal_Int32 nRgb ) const;
 107
 108     /** Converts the color components to RGB values. */
 109     void                toRgb() const;
 110     /** Converts the color components to CRGB values (gamma corrected percentage). */
 111     void                toCrgb() const;
 112     /** Converts the color components to HSL values. */
 113     void                toHsl() const;
 114
 115 private:
 116     enum ColorMode
 117     {
 118         COLOR_UNUSED,       /// Color is not used, or undefined.
 119         COLOR_RGB,          /// Absolute RGB (r/g/b: 0...255).
 120         COLOR_CRGB,         /// Relative RGB (r/g/b: 0...100000).
 121         COLOR_HSL,          /// HSL (hue: 0...21600000, sat/lum: 0...100000).
 122         COLOR_SCHEME,       /// Color from scheme.
 123         COLOR_PALETTE,      /// Color from application defined palette.
 124         COLOR_SYSTEM,       /// Color from system palette.
 125         COLOR_PH,           /// Placeholder color in theme style lists.
 126         COLOR_FINAL         /// Finalized RGB color.
 127     };
 128
 129     struct Transformation
 130     {
 131         sal_Int32           mnToken;
 132         sal_Int32           mnValue;
 133
 134         explicit            Transformation( sal_Int32 nToken, sal_Int32 nValue ) : mnToken( nToken ), mnValue( nValue ) {}
 135     };
 136     typedef ::std::vector< Transformation > TransformVec;
 137
 138     mutable ColorMode   meMode;         /// Current color mode.
 139     mutable TransformVec maTransforms;  /// Color transformations.
 140     mutable sal_Int32   mnC1;           /// Red, red%, hue, scheme token, palette index, system token, or final RGB.
 141     mutable sal_Int32   mnC2;           /// Green, green%, saturation, or system default RGB.
 142     mutable sal_Int32   mnC3;           /// Blue, blue%, or luminance.
 143     sal_Int32           mnAlpha;        /// Alpha value (color opacity).
 144
 145     OUString            msSchemeName;   /// Scheme name from the a:schemeClr element for interoperability purposes
 146     css::uno::Sequence< css::beans::PropertyValue >
 147                         maInteropTransformations;   /// Unaltered list of transformations for interoperability purposes
 148 };
 149
 150 } // namespace drawingml
 151 } // namespace oox
 152
 153 #endif
 154
 155 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */