oxygen-gtk2-1.4.6/src/oxygencachekey.h

#ifndef oxygencachekey_h
#define oxygencachekey_h

/*
* this file is part of the oxygen gtk engine
* Copyright (c) 2010 Hugo Pereira Da Costa <hugo.pereira@free.fr>
*
* This  library is free  software; you can  redistribute it and/or
* modify it  under  the terms  of the  GNU Lesser  General  Public
* License  as published  by the Free  Software  Foundation; either
* version 2 of the License, or( at your option ) any later version.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License  along  with  this library;  if not,  write to  the Free
* Software Foundation, Inc., 51  Franklin St, Fifth Floor, Boston,
* MA 02110-1301, USA.
*/

#include "oxygenrgba.h"
#include "oxygenwindecooptions.h"

namespace Oxygen
{

    //! key for separators
    /*! keys are used to store tilesets into cache */
    class SeparatorKey
    {
        public:

        //! constructor
        SeparatorKey( const ColorUtils::Rgba& color, bool vertical, int size ):
            _color( color.toInt() ),
            _vertical( vertical ),
            _size( size )
        {}

        //! equal to operator
        bool operator == (const SeparatorKey& other ) const
        {
            return
                _color == other._color &&
                _vertical == other._vertical &&
                _size == other._size;
        }

        //! less than operator
        bool operator < (const SeparatorKey& other ) const
        {
            if( _color != other._color ) return _color < other._color;
            else if( _vertical != other._vertical ) return _vertical < other._vertical;
            else return _size < other._size;
        }

        private:

        guint32 _color;
        bool _vertical;
        int _size;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const SeparatorKey& key )
        {
            out << "SeparatorKey - color: " << key._color << " shade: " << key._vertical << " size: " << key._size;
            return out;
        }

    };

    //! key for focused slabs
    class SlabKey
    {
        public:

        //! constructor
        SlabKey( const ColorUtils::Rgba& color, double shade, int size ):
            _color( color.toInt() ),
            _glow( 0 ),
            _shade( shade ),
            _size( size )
        {}

        //! constructor
        SlabKey( const ColorUtils::Rgba& color, const ColorUtils::Rgba& glow, double shade, int size ):
            _color( color.toInt() ),
            _glow( glow.toInt() ),
            _shade( shade ),
            _size( size )
        {}

        //! equal to operator
        bool operator == (const SlabKey& other ) const
        {
            return
                _color == other._color &&
                _glow == other._glow &&
                _shade == other._shade &&
                _size == other._size;
        }

        //! less than operator
        bool operator < (const SlabKey& other ) const
        {
            if( _color != other._color ) return _color < other._color;
            else if( _glow != other._glow ) return _glow < other._glow;
            else if( _shade != other._shade ) return _shade < other._shade;
            else return _size < other._size;
        }

        private:

        guint32 _color;
        guint32 _glow;
        double _shade;
        int _size;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const SlabKey& key )
        {
            out << "SlabKey - color: " << key._color << " glow: " << key._glow << " shade: " << key._shade << " size: " << key._size;
            return out;
        }
    };

    class SliderSlabKey
    {
        public:

        //! constructor
        SliderSlabKey( const ColorUtils::Rgba& color, const ColorUtils::Rgba& glow, bool sunken, double shade, int size ):
            _color( color.toInt() ),
            _glow( glow.toInt() ),
            _sunken( sunken ),
            _shade( shade ),
            _size( size )
        {}

        //! equal to operator
        bool operator == (const SliderSlabKey& other ) const
        {
            return
                _color == other._color &&
                _glow == other._glow &&
                _sunken == other._sunken &&
                _shade == other._shade &&
                _size == other._size;
        }

        //! less than operator
        bool operator < (const SliderSlabKey& other ) const
        {
            if( _color != other._color ) return _color < other._color;
            else if( _glow != other._glow ) return _glow < other._glow;
            else if( _sunken != other._sunken ) return _sunken < other._sunken;
            else if( _shade != other._shade ) return _shade < other._shade;
            else return _size < other._size;
        }

        private:

        guint32 _color;
        guint32 _glow;
        bool _sunken;
        double _shade;
        int _size;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const SliderSlabKey& key )
        {
            out << "SliderSlabKey -"
                << " color: " << key._color
                << " glow: " << key._glow
                << " sunken: " << key._sunken
                << " shade: " << key._shade
                << " size: " << key._size;
            return out;
        }
    };

    //! key for holes
    class HoleFocusedKey
    {
        public:

        //! constructor
        HoleFocusedKey( const ColorUtils::Rgba& color, const ColorUtils::Rgba& fill, const ColorUtils::Rgba& glow, int size, bool contrast ):
            _color( color.toInt() ),
            _fill( fill.toInt() ),
            _glow( glow.toInt() ),
            _size( size ),
            _filled( fill.isValid() ),
            _contrast( contrast )
        {}

        //! equal to operator
        bool operator == (const HoleFocusedKey& other ) const
        {
            return
                _color == other._color &&
                _glow == other._glow &&
                _size == other._size &&
                _filled == other._filled &&
                (_fill == other._fill || !_filled ) &&
                _contrast == other._contrast;
        }

        //! less than operator
        bool operator < (const HoleFocusedKey& other ) const
        {
            if( _color != other._color ) return _color < other._color;
            if( _glow != other._glow ) return _glow < other._glow;
            else if( _size != other._size ) return _size < other._size;
            else if( _filled != other._filled ) return !_filled;
            else if( _filled && _fill != other._fill ) return _fill < other._fill;
            else if( _contrast != other._contrast ) return _contrast < other._contrast;
            else return false;
        }

        private:

        guint32 _color;
        guint32 _fill;
        guint32 _glow;
        int _size;
        bool _filled;
        bool _contrast;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const HoleFocusedKey& key )
        {
            out
                << "HoleFocusedKey -"
                << " color: " << key._color << " glow: " << key._glow << " fill: " << key._fill
                << " size: " << key._size << " filled: " << key._filled << " contrast: " << key._contrast;
            return out;
        }

    };

    //! key for flat holes
    class HoleFlatKey
    {
       public:

        //! constructor
        HoleFlatKey( const ColorUtils::Rgba& color, double shade, bool fill, int size ):
            _color( color.toInt() ),
            _shade( shade ),
            _fill( fill ),
            _size( size )
        {}

        //! equal to operator
        bool operator == (const HoleFlatKey& other ) const
        {
            return
                _color == other._color &&
                _shade == other._shade &&
                _fill == other._fill &&
                _size == other._size;
        }

        //! less than operator
        bool operator < (const HoleFlatKey& other ) const
        {
            if( _color != other._color ) return _color < other._color;
            else if( _shade != other._shade ) return _shade < other._shade;
            else if( _fill != other._fill ) return _fill < other._fill;
            else return _size < other._size;
        }

        private:

        guint32 _color;
        double _shade;
        bool _fill;
        int _size;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const HoleFlatKey& key )
        {
            out
                << "HoleFlatKey -"
                << " color: " << key._color
                << " shade: " << key._shade
                << " fill: " << (key._fill ? "true":"false")
                << " size: " << key._size;

            return out;
        }

    };

    //! key for scroll holes
    class ScrollHoleKey
    {
       public:

        //! constructor
        ScrollHoleKey( const ColorUtils::Rgba& color, bool vertical, bool smallShadow ):
            _color( color.toInt() ),
            _vertical( vertical ),
            _smallShadow( smallShadow )
        {}

        //! equal to operator
        bool operator == (const ScrollHoleKey& other ) const
        {
            return
                _color == other._color &&
                _vertical == other._vertical &&
                _smallShadow == other._smallShadow;
        }

        //! less than operator
        bool operator < (const ScrollHoleKey& other ) const
        {
            if( _color != other._color ) return _color < other._color;
            else if( _vertical != other._vertical ) return _vertical < other._vertical;
            else return _smallShadow < other._smallShadow;
        }

        private:

        guint32 _color;
        bool _vertical;
        bool _smallShadow;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const ScrollHoleKey& key )
        {
            out << "ScrollHoleKey -"
                << " color: " << key._color
                << " vertical: " << (key._vertical ? "true":"false")
                << " smallShadow: " << (key._smallShadow ? "true":"false");
            return out;
        }

    };

    //! key for scrollbar handles
    class ScrollHandleKey
    {
       public:

        //! constructor
        ScrollHandleKey( const ColorUtils::Rgba& color, const ColorUtils::Rgba& glow, int size ):
            _color( color.toInt() ),
            _glow( glow.toInt() ),
            _size( size )
        {}

        //! equal to operator
        bool operator == (const ScrollHandleKey& other ) const
        {
            return
                _color == other._color &&
                _glow == other._glow &&
                _size == other._size;
        }

        //! less than operator
        bool operator < (const ScrollHandleKey& other ) const
        {
            if( _color != other._color ) return _color < other._color;
            else if( _glow != other._glow ) return _glow < other._glow;
            else return _size < other._size;
        }

        private:

        guint32 _color;
        guint32 _glow;
        int _size;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const ScrollHandleKey& key )
        {
            out << "ScrollHandleKey -"
                << " color: " << key._color
                << " glow: " << key._glow
                << " size: " << key._size;
            return out;
        }

    };

    //@}

    //! key for focused slits
    class SlitFocusedKey
    {
       public:

        //! constructor
        SlitFocusedKey( const ColorUtils::Rgba& color ):
            _color( color.toInt() )
        {}

        //! equal to operator
        bool operator == (const SlitFocusedKey& other ) const
        { return _color == other._color; }

        //! less than operator
        bool operator < (const SlitFocusedKey& other ) const
        { return _color < other._color; }

        private:

        guint32 _color;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const SlitFocusedKey& key )
        {
            out << "SlitFocusedKey - color: " << key._color;
            return out;
        }

    };

    //@}

    //! key for docks
    class DockFrameKey
    {
       public:

        //! constructor
        DockFrameKey( const ColorUtils::Rgba& top, const ColorUtils::Rgba& bottom ):
            _top( top.toInt() ),
            _bottom( bottom.toInt() )
        {}

        //! equal to operator
        bool operator == (const DockFrameKey& other ) const
        {
            return
                _top == other._top &&
                _bottom == other._bottom;
        }

        //! less than operator
        bool operator < (const DockFrameKey& other ) const
        {
            if( _top != other._top ) return _top < other._top;
            else return _bottom < other._bottom;
        }

        private:

        guint32 _top;
        guint32 _bottom;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const DockFrameKey& key )
        {
            out << "DockFrameKey - top color: " << key._top << " bottom color: " << key._bottom;
            return out;
        }

    };

    //! key for grooves
    class GrooveKey
    {
       public:

        //! constructor
        GrooveKey( const ColorUtils::Rgba& color, int size ):
            _color( color.toInt() ),
            _size( size )
        {}

        //! equal to operator
        bool operator == (const GrooveKey& other ) const
        {
            return
                _color == other._color &&
                _size == other._size;
        }

        //! less than operator
        bool operator < (const GrooveKey& other ) const
        {
            if( _color != other._color ) return _color < other._color;
            else return _size < other._size;
        }

        private:

        guint32 _color;
        int _size;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const GrooveKey& key )
        {
            out << "GrooveKey - color: " << key._color << " size: " << key._size;
            return out;
        }

    };

    //! key for selection rects
    class SelectionKey
    {
       public:

        //! constructor
        SelectionKey( const ColorUtils::Rgba& color, int size, bool custom ):
            _color( color.toInt() ),
            _size( size ),
            _custom( custom )
        {}

        //! equal to operator
        bool operator == (const SelectionKey& other ) const
        {
            return
                _color == other._color &&
                _size == other._size &&
                _custom == other._custom;
        }

        //! less than operator
        bool operator < (const SelectionKey& other ) const
        {

            if( _color != other._color ) return _color < other._color;
            else if( _size != other._size ) return _size < other._size;
            else return _custom < other._custom;

        }

        private:

        guint32 _color;
        int _size;
        bool _custom;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const SelectionKey& key )
        {
            out << "SelectionKey - color: " << key._color << " size: " << key._size << " custom: " << ( key._custom ? "true":"false" );
            return out;
        }

    };

    //! key for progressbar indicator
    class ProgressBarIndicatorKey
    {
        public:

        //! constructor
        ProgressBarIndicatorKey( const ColorUtils::Rgba& color, const ColorUtils::Rgba& glow, int width, int height ):
            _color( color.toInt() ),
            _glow( glow.toInt() ),
            _width( width ),
            _height( height )
        {}

        //! equal to operator
        bool operator == (const ProgressBarIndicatorKey& other ) const
        {
            return
                _color == other._color &&
                _glow == other._glow &&
                _width == other._width &&
                _height == other._height;
        }

        //! less than operator
        bool operator < (const ProgressBarIndicatorKey& other ) const
        {
            if( _color != other._color ) return _color < other._color;
            else if( _glow != other._glow ) return _glow < other._glow;
            else if( _width != other._width ) return _width < other._width;
            else return _height < other._height;
        }

        private:

        guint32 _color;
        guint32 _glow;
        int _width;
        int _height;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const ProgressBarIndicatorKey& key )
        {
            out << "ProgressBarIndicatorKey - color: " << key._color << " glow: " << key._glow << " width: " << key._width << " height: " << key._height;
            return out;
        }
    };

    //! key for windeco buttons
    /*! keys are used to store tilesets into cache */
    class WindecoButtonKey
    {
        public:

        //! constructor
        WindecoButtonKey( const ColorUtils::Rgba& color, int size, bool pressed ):
            _color( color.toInt() ),
            _size( size ),
            _pressed( pressed )
        {}

        //! equal to operator
        bool operator == (const WindecoButtonKey& other ) const
        {
            return
                _color == other._color &&
                _size == other._size &&
                _pressed == other._pressed;
        }

        //! less than operator
        bool operator < (const WindecoButtonKey& other ) const
        {
            if( _color != other._color ) return _color < other._color;
            else if( _size != other._size ) return _size < other._size;
            else return _pressed < other._pressed;
        }

        private:

        guint32 _color;
        int _size;
        bool _pressed;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const WindecoButtonKey& key )
        {
            out << "WindecoButtonKey - color: " << key._color << " size: " << key._size << " pressed: " << key._pressed;
            return out;
        }

    };

    //! key for windeco buttons
    /*! keys are used to store tilesets into cache */
    class WindecoButtonGlowKey
    {
        public:

        //! constructor
        WindecoButtonGlowKey( const ColorUtils::Rgba& color, int size ):
            _color( color.toInt() ),
            _size( size )
        {}

        //! equal to operator
        bool operator == (const WindecoButtonGlowKey& other ) const
        {
            return
                _color == other._color &&
                _size == other._size;
        }

        //! less than operator
        bool operator < (const WindecoButtonGlowKey& other ) const
        {
            if( _color != other._color ) return _color < other._color;
            else return _size < other._size;
        }

        private:

        guint32 _color;
        int _size;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const WindecoButtonGlowKey& key )
        {
            out << "WindecoButtonGlowKey - color: " << key._color << " size: " << key._size;
            return out;
        }

    };

    //! key for window shadows
    /*! keys are used to store tilesets into cache */
    class WindowShadowKey
    {

        public:

        //! explicit constructor
        explicit WindowShadowKey( void ):
            active(false),
            useOxygenShadows(true),
            isShade(false),
            hasTitleOutline(false),
            hasTopBorder( true ),
            hasBottomBorder( true )
        {}

        //! equal to operator
        bool operator == (const WindowShadowKey& other) const
        {
            return
                ( active == other.active ) &&
                ( useOxygenShadows == other.useOxygenShadows ) &&
                ( isShade == other.isShade ) &&
                ( hasTitleOutline == other.hasTitleOutline ) &&
                ( hasTopBorder == other.hasTopBorder ) &&
                ( hasBottomBorder == other.hasBottomBorder );

        }

        //! less than operator
        bool operator < (const WindowShadowKey& other) const
        {
            if( active != other.active ) return active < other.active;
            else if( useOxygenShadows != other.useOxygenShadows ) return useOxygenShadows < other.useOxygenShadows;
            else if( isShade != other.isShade ) return isShade < other.isShade;
            else if( hasTitleOutline != other.hasTitleOutline ) return hasTitleOutline < other.hasTitleOutline;
            else if( hasTopBorder != other.hasTopBorder ) return hasTopBorder < other.hasTopBorder;
            else return hasBottomBorder < other.hasBottomBorder;
        }

        bool active;
        bool useOxygenShadows;
        bool isShade;
        bool hasTitleOutline;
        bool hasTopBorder;
        bool hasBottomBorder;

    };

    //! key for window background vertical gradient
    class VerticalGradientKey
    {
        public:

        //! constructor
        VerticalGradientKey( const ColorUtils::Rgba& color, int size ):
            _color( color.toInt() ),
            _size( size )
        {}

        //! equal to operator
        bool operator == (const VerticalGradientKey& other ) const
        {
            return
                _color == other._color &&
                _size == other._size;
        }

        //! less than operator
        bool operator < (const VerticalGradientKey& other ) const
        {
            if( _color != other._color ) return _color < other._color;
            else return _size < other._size;
        }

        private:

        guint32 _color;
        int _size;

        //! streamer
        friend std::ostream& operator << ( std::ostream& out, const VerticalGradientKey& key )
        {
            out << "VerticalGradientKey - color: " << key._color << " size: " << key._size;
            return out;
        }

    };

    //! key for window background radial gradient
    typedef VerticalGradientKey RadialGradientKey;

    //! key for left windeco border
    class WindecoBorderKey
    {
        public:

        //! constructor
        WindecoBorderKey( WinDeco::Options wopt, const int width, const int height, bool gradient ):
            _wopt(wopt),
            _width(width),
            _height(height),
            _gradient(gradient)
        {}

        //! equal to operator
        bool operator == (const WindecoBorderKey& other) const
        {
            return _width == other._width &&
                _height == other._height &&
                _wopt == other._wopt &&
                _gradient == other._gradient;
        }

        //! less than operator
        bool operator < (const WindecoBorderKey& other) const
        {
            if( _width != other._width ) return _width < other._width;
            else if( _height != other._height ) return _height < other._height;
            else if( _gradient != other._gradient ) return _gradient < other._gradient;
            else return _wopt < other._wopt;
        }

        private:

        WinDeco::Options _wopt;
        int _width;
        int _height;
        bool _gradient;
    };

    //! key for other windeco borders
    typedef WindecoBorderKey WindecoLeftBorderKey;
    typedef WindecoBorderKey WindecoRightBorderKey;
    typedef WindecoBorderKey WindecoTopBorderKey;
    typedef WindecoBorderKey WindecoBottomBorderKey;

    //! key for dock widget button
    class DockWidgetButtonKey
    {
        public:

        //! constructor
        DockWidgetButtonKey( const ColorUtils::Rgba& base, bool pressed, int size ):
            _base(base.toInt()),
            _pressed(pressed),
            _size(size)
        {}

        //! equal to operator
        bool operator == (const DockWidgetButtonKey& other) const
        {
            return _base == other._base &&
                _pressed == other._pressed &&
                _size == other._size;
        }

        //! less than operator
        bool operator < (const DockWidgetButtonKey& other) const
        {
            if( _base != other._base ) return _base < other._base;
            else if( _pressed != other._pressed ) return _pressed < other._pressed;
            else return _size < other._size;
        }

        private:

        guint32  _base;
        bool _pressed;
        int _size;
    };

}

#endif