MuseScore/mstyle/frameshadow.h

//////////////////////////////////////////////////////////////////////////////
// oxygenframeshadow.h
// handle frames' shadows and rounded corners
// -------------------
//
// Copyright (c) 2010 Hugo Pereira Da Costa <hugo@oxygen-icons.org>
//
// Largely inspired from skulpture widget style
// Copyright (c) 2007-2009 Christoph Feck <christoph@maxiom.de>
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//////////////////////////////////////////////////////////////////////////////

#ifndef __FRAMESHADOW_H__
#define __FRAMESHADOW_H__

#include "colorscheme.h"
#include "mstyle.h"

//! shadow area
enum ShadowArea {
      UnknownArea,
      Left,
      Top,
      Right,
      Bottom
      };

//---------------------------------------------------------
//   FrameShadowFactory
//---------------------------------------------------------

class FrameShadowFactory: public QObject {
            Q_OBJECT

      public:

            //! constructor
            FrameShadowFactory( QObject* parent ) : QObject(parent) {}

            //! destructor
            virtual ~FrameShadowFactory() {}

            //! register widget
            bool registerWidget( QWidget*, StyleHelper& );

            //! unregister
            void unregisterWidget( QWidget* );

            //! true if widget is registered
            bool isRegistered( const QWidget* widget ) const {
                  return _registeredWidgets.contains( widget );
                  }

            //! event filter
            virtual bool eventFilter( QObject*, QEvent*);

            //! update state
            void updateState( const QWidget* widget, bool focus, bool hover, qreal opacity, AnimationMode ) const;

      protected:

            //! install shadows on given widget
            virtual void installShadows( QWidget*, StyleHelper&, bool flat = false );

            //! remove shadows from widget
            virtual void removeShadows( QWidget* );

            //! update shadows geometry
            virtual void updateShadowsGeometry( QObject* ) const;

            //! raise shadows
            virtual void raiseShadows( QObject* ) const;

            //! update shadows
            virtual void update( QObject* ) const;

            //! install shadow on given side
            virtual void installShadow( QWidget*, StyleHelper&, ShadowArea, bool flat = false ) const;

      protected slots:

            //! triggered by object destruction
            void widgetDestroyed( QObject* );

      private:

            //! set of registered widgets
            QSet<const QObject*> _registeredWidgets;

      };

//! frame shadow
/*! this allows the shadow to be painted over the widgets viewport */
class FrameShadowBase: public QWidget {

            Q_OBJECT

      public:

            //! constructor
            explicit FrameShadowBase( ShadowArea area ):
                  _area( area )
                  {}

            //! destructor
            virtual ~FrameShadowBase( void )
                  {}

            //! shadow area
            void setShadowArea(ShadowArea area) {
                  _area = area;
                  }

            //! shadow area
            const ShadowArea& shadowArea() const {
                  return _area;
                  }

            //! update geometry
            virtual void updateGeometry( void ) = 0;

            //! update state
            virtual void updateState( bool, bool, qreal, AnimationMode )
                  {}

      protected:

            //! event handler
            virtual bool event(QEvent* e);

            //! initialization
            virtual void init();

            //! return viewport associated to parent widget
            virtual QWidget* viewport( void ) const;

      private:

            //! shadow area
            ShadowArea _area;

      };

//! frame shadow
/*! this allows the shadow to be painted over the widgets viewport */
class SunkenFrameShadow : public FrameShadowBase {
            Q_OBJECT

      public:

            //! constructor
            SunkenFrameShadow( ShadowArea area, StyleHelper& helper ):
                  FrameShadowBase( area ),
                  _helper( helper ),
                  _viewFocusBrush( helper.viewFocusBrush() ),
                  _viewHoverBrush( helper.viewHoverBrush() ),
                  _focus( false ),
                  _hover( false ),
                  _opacity( -1 ),
                  _mode( AnimationNone ) {
                  init();
                  }


            //! destructor
            virtual ~SunkenFrameShadow()
                  {}

            //! update geometry
            virtual void updateGeometry( void );

            //! update state
            void updateState( bool focus, bool hover, qreal opacity, AnimationMode mode );

      protected:

            //! painting
            virtual void paintEvent(QPaintEvent*);

      private:

            //! shadow sizes
            enum {
                  SHADOW_SIZE_TOP = 3,
                  SHADOW_SIZE_BOTTOM = 3,
                  SHADOW_SIZE_LEFT = 3,
                  SHADOW_SIZE_RIGHT = 3
                  };

            //! helper
            StyleHelper& _helper;

            StatefulBrush _viewFocusBrush;
            StatefulBrush _viewHoverBrush;

            //!@name widget state
            //@{
            bool _focus;
            bool _hover;
            qreal _opacity;
            AnimationMode _mode;

      };


//! frame shadow
/*! this allows the shadow to be painted over the widgets viewport */
class FlatFrameShadow : public FrameShadowBase {
            Q_OBJECT

      public:

            //! constructor
            FlatFrameShadow( ShadowArea area, StyleHelper& helper ):
                  FrameShadowBase( area ),
                  _helper( helper ) {
                  init();
                  }


            //! destructor
            virtual ~FlatFrameShadow()
                  {}

            //! update geometry
            virtual void updateGeometry( void );

      protected:

            //! painting
            virtual void paintEvent(QPaintEvent*);

      private:

            //! shadow sizes
            enum {
                  SHADOW_SIZE_TOP = 5,
                  SHADOW_SIZE_BOTTOM = 5,
                  SHADOW_SIZE_LEFT = 5,
                  SHADOW_SIZE_RIGHT = 5
                  };

            //! helper
            StyleHelper& _helper;

      };

#endif