color.hxx

Go to the documentation of this file.

/* -*- 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_DRAWINGML_COLOR_HXX
#define INCLUDED_OOX_DRAWINGML_COLOR_HXX
 
#include <vector>
 
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/uno/Sequence.hxx>
#include <oox/helper/helper.hxx>
#include <oox/dllapi.h>
#include <rtl/ustring.hxx>
#include <sal/types.h>
#include <tools/color.hxx>
#include <docmodel/theme/ThemeColorType.hxx>
#include <docmodel/color/ComplexColor.hxx>
 
namespace oox { class GraphicHelper; }
 
namespace oox::drawingml
{
 
model::ThemeColorType schemeTokenToThemeColorType(sal_uInt32 nToken);
model::ThemeColorType schemeNameToThemeColorType(OUString const& rSchemeName);
 
class OOX_DLLPUBLIC Color
{
public:
    Color();
 
    static ::Color      getDmlPresetColor( sal_Int32 nToken, ::Color nDefaultRgb );
    static ::Color      getVmlPresetColor( sal_Int32 nToken, ::Color nDefaultRgb );
    static ::Color      getHighlightColor(sal_Int32 nToken, ::Color nDefaultRgb);
 
    void                setUnused();
    void                setSrgbClr( sal_Int32 nRgb );
    void                setSrgbClr( ::Color nRgb );
    void                setScrgbClr( sal_Int32 nR, sal_Int32 nG, sal_Int32 nB );
    void                setHslClr( sal_Int32 nHue, sal_Int32 nSat, sal_Int32 nLum );
    void                setPrstClr( sal_Int32 nToken );
    void                setHighlight(sal_Int32 nToken);
    void                setSchemeClr( sal_Int32 nToken );
    void                setSchemeName( const OUString& sSchemeName ) { msSchemeName = sSchemeName; }
    void                setSysClr( sal_Int32 nToken, sal_Int32 nLastRgb );
    void                setPaletteClr( sal_Int32 nPaletteIdx );
 
    void                addTransformation( sal_Int32 nElement, sal_Int32 nValue = -1 );
    void                addChartTintTransformation( double fTint );
    void                addExcelTintTransformation( double fTint );
    void                clearTransformations();
    void                clearTransparence();
 
    void                assignIfUsed( const Color& rColor ) { if( rColor.isUsed() ) *this = rColor; }
 
    bool                isUsed() const { return meMode != COLOR_UNUSED; }
    bool                isPlaceHolder() const { return meMode == COLOR_PH; }
    ::Color             getColor( const GraphicHelper& rGraphicHelper, ::Color nPhClr = API_RGB_TRANSPARENT ) const;
 
    bool                hasTransparency() const;
    sal_Int16           getTransparency() const;
 
    const OUString&     getSchemeColorName() const { return msSchemeName; }
    sal_Int16           getSchemeColorIndex() const;
    sal_Int16           getTintOrShade() const;
    sal_Int16           getLumMod() const;
    sal_Int16           getLumOff() const;
 
    model::ThemeColorType getThemeColorType() const
    {
        return meThemeColorType;
    }
 
    model::ComplexColor createComplexColor(const GraphicHelper& rGraphicHelper, sal_Int16 nPhClrTheme) const;
 
    const css::uno::Sequence< css::beans::PropertyValue >& getTransformations() const { return maInteropTransformations;}
 
    static OUString     getColorTransformationName( sal_Int32 nElement );
    static sal_Int32    getColorTransformationToken( std::u16string_view sName );
 
    bool equals(const Color& rOther, const GraphicHelper& rGraphicHelper, ::Color nPhClr) const;
 
    model::ComplexColor getComplexColor() const;
 
private:
    void                setResolvedRgb( ::Color nRgb ) const;
 
    void                toRgb() const;
    void                toCrgb() const;
    void                toHsl() const;
 
private:
    enum ColorMode
    {
        COLOR_UNUSED,       
        COLOR_RGB,          
        COLOR_CRGB,         
        COLOR_HSL,          
        COLOR_SCHEME,       
        COLOR_PALETTE,      
        COLOR_SYSTEM,       
        COLOR_PH,           
        COLOR_FINAL         
    };
 
    struct Transformation
    {
        sal_Int32           mnToken;
        sal_Int32           mnValue;
 
        explicit            Transformation( sal_Int32 nToken, sal_Int32 nValue ) : mnToken( nToken ), mnValue( nValue ) {}
    };
 
    mutable ColorMode   meMode;         
    mutable std::vector< Transformation >
                        maTransforms;  
    mutable sal_Int32   mnC1;           
    mutable sal_Int32   mnC2;           
    mutable sal_Int32   mnC3;           
    sal_Int32           mnAlpha;        
    OUString            msSchemeName;   
    model::ThemeColorType meThemeColorType;
    css::uno::Sequence< css::beans::PropertyValue >
                        maInteropTransformations;   
};
 
} // namespace oox::drawingml
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */