qskinny/src/controls/QskSkinnable.h

/******************************************************************************
 * QSkinny - Copyright (C) 2016 Uwe Rathmann
 * This file may be used under the terms of the QSkinny License, Version 1.0
 *****************************************************************************/

#ifndef QSK_SKINNABLE_H
#define QSK_SKINNABLE_H

#include "QskAspect.h"
#include <memory>

typedef unsigned int QRgb;
class QSizeF;
class QRectF;
class QColor;
class QFont;
class QMarginsF;
struct QMetaObject;
class QVariant;
class QDebug;

class QSGNode;

class QskControl;
class QskAnimationHint;
class QskColorFilter;
class QskBoxShapeMetrics;
class QskBoxBorderMetrics;
class QskBoxBorderColors;
class QskGradient;
class QskIntervalF;

class QskSkin;
class QskSkinlet;
class QskSkinHintTable;

class QSK_EXPORT QskSkinHintStatus
{
  public:
    enum Source
    {
        NoSource = 0,

        Skinnable,
        Skin,
        Animator
    };

    QskSkinHintStatus()
        : source( NoSource )
    {
    }

    inline bool isValid() const
    {
        return source > 0;
    }

    Source source;
    QskAspect::Aspect aspect;
};

#ifndef QT_NO_DEBUG_STREAM

class QDebug;
QSK_EXPORT QDebug operator<<( QDebug, const QskSkinHintStatus& );

#endif

class QSK_EXPORT QskSkinnable
{
  public:
    QskSkinnable();
    virtual ~QskSkinnable();

    void setSkinlet( const QskSkinlet* skinlet );
    const QskSkinlet* skinlet() const;

    void setColor( QskAspect::Aspect, Qt::GlobalColor );
    void setColor( QskAspect::Aspect, QRgb );
    void setColor( QskAspect::Aspect, const QColor& );
    bool resetColor( QskAspect::Aspect );
    QColor color( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    void setMetric( QskAspect::Aspect, qreal metric );
    bool resetMetric( QskAspect::Aspect );
    qreal metric( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    void setFlagHint( QskAspect::Aspect, int flag );
    bool resetFlagHint( QskAspect::Aspect );
    int flagHint( QskAspect::Aspect ) const;
    template< typename T > T flagHint( QskAspect::Aspect, T = T() ) const;

    QSizeF strutSizeHint( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;
    void setStrutSizeHint( QskAspect::Aspect, const QSizeF& );
    void setStrutSizeHint( QskAspect::Aspect, qreal width, qreal height );

    void setMarginHint( QskAspect::Aspect, qreal );
    void setMarginHint( QskAspect::Aspect, const QMarginsF& );
    bool resetMarginHint( QskAspect::Aspect );
    QMarginsF marginHint( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    void setPaddingHint( QskAspect::Aspect, qreal );
    void setPaddingHint( QskAspect::Aspect, const QMarginsF& );
    bool resetPaddingHint( QskAspect::Aspect );
    QMarginsF paddingHint( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    void setGradientHint( QskAspect::Aspect, const QskGradient& );
    QskGradient gradientHint( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    void setBoxShapeHint( QskAspect::Aspect, const QskBoxShapeMetrics& );
    bool resetBoxShapeHint( QskAspect::Aspect );
    QskBoxShapeMetrics boxShapeHint( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    void setBoxBorderMetricsHint( QskAspect::Aspect, const QskBoxBorderMetrics& );
    bool resetBoxBorderMetricsHint( QskAspect::Aspect );
    QskBoxBorderMetrics boxBorderMetricsHint(
        QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    void setBoxBorderColorsHint( QskAspect::Aspect, const QskBoxBorderColors& );
    bool resetBoxBorderColorsHint( QskAspect::Aspect );
    QskBoxBorderColors boxBorderColorsHint( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    void setIntervalHint( QskAspect::Aspect, const QskIntervalF& );
    QskIntervalF intervalHint( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    void setSpacingHint( QskAspect::Aspect, qreal );
    bool resetSpacingHint( QskAspect::Aspect );
    qreal spacingHint( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    void setAlignmentHint( QskAspect::Aspect, Qt::Alignment );
    bool resetAlignmentHint( QskAspect::Aspect );
    Qt::Alignment alignmentHint( QskAspect::Aspect, Qt::Alignment = Qt::Alignment() ) const;

    void setFontRole( QskAspect::Aspect, int role );
    int fontRole( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    QFont effectiveFont( QskAspect::Aspect ) const;

    void setGraphicRole( QskAspect::Aspect, int role );
    int graphicRole( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    QskColorFilter effectiveGraphicFilter( QskAspect::Aspect ) const;

    void setAnimation( QskAspect::Aspect, QskAnimationHint );
    QskAnimationHint animation( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    bool resetHint( QskAspect::Aspect );

    QskAnimationHint effectiveAnimation( QskAspect::Type, QskAspect::Subcontrol,
        QskAspect::State, QskSkinHintStatus* status = nullptr ) const;

    QVariant effectiveHint( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;
    virtual QskAspect::Placement effectivePlacement() const;

    QskSkinHintStatus hintStatus( QskAspect::Aspect ) const;

    QskAspect::State skinState() const;
    const char* skinStateAsPrintable() const;
    const char* skinStateAsPrintable( QskAspect::State ) const;

    QSizeF outerBoxSize( QskAspect::Aspect, const QSizeF& innerBoxSize ) const;
    QSizeF innerBoxSize( QskAspect::Aspect, const QSizeF& outerBoxSize ) const;

    QRectF innerBox( QskAspect::Aspect, const QRectF& outerBox ) const;
    QRectF outerBox( QskAspect::Aspect, const QRectF& innerBox ) const;

    QMarginsF innerPadding( QskAspect::Aspect, const QSizeF& ) const;

    const QskSkinlet* effectiveSkinlet() const;
    QskSkin* effectiveSkin() const;

    void startTransition( QskAspect::Aspect,
        QskAnimationHint, QVariant from, QVariant to );

    virtual QskAspect::Subcontrol effectiveSubcontrol( QskAspect::Subcontrol ) const;

    QskControl* controlCast();
    const QskControl* controlCast() const;

    virtual QskControl* owningControl() const = 0;
    virtual const QMetaObject* metaObject() const = 0;

    void debug( QskAspect::Aspect ) const;
    void debug( QskAspect::State ) const;
    void debug( QDebug, QskAspect::Aspect ) const;
    void debug( QDebug, QskAspect::State ) const;

    void setSkinState( QskAspect::State, bool animated = true );
    void setSkinStateFlag( QskAspect::State, bool on = true );

  protected:
    virtual void updateNode( QSGNode* );
    virtual bool isTransitionAccepted( QskAspect::Aspect ) const;

    QskSkinHintTable& hintTable();
    const QskSkinHintTable& hintTable() const;

  private:
    QVariant animatedValue( QskAspect::Aspect, QskSkinHintStatus* ) const;
    const QVariant& storedHint( QskAspect::Aspect, QskSkinHintStatus* = nullptr ) const;

    class PrivateData;
    std::unique_ptr< PrivateData > m_data;
};

template< typename T >
inline T QskSkinnable::flagHint( QskAspect::Aspect aspect, T defaultValue ) const
{
    const auto& hint = effectiveHint( aspect );
    if ( hint.isValid() && hint.canConvert< int >() )
        return static_cast< T >( hint.value< int >() );

    return defaultValue;
}

inline Qt::Alignment QskSkinnable::alignmentHint(
    QskAspect::Aspect aspect, Qt::Alignment defaultAlignment ) const
{
    return flagHint< Qt::Alignment >( aspect | QskAspect::Alignment, defaultAlignment );
}

inline QskAspect::Placement QskSkinnable::effectivePlacement() const
{
    return QskAspect::NoPlacement;
}

inline bool QskSkinnable::resetColor( QskAspect::Aspect aspect )
{
    return resetHint( aspect | QskAspect::Color );
}

inline bool QskSkinnable::resetMetric( QskAspect::Aspect aspect )
{
    return resetHint( aspect | QskAspect::Metric );
}

inline bool QskSkinnable::resetFlagHint( QskAspect::Aspect aspect )
{
    return resetHint( aspect | QskAspect::Flag );
}

#endif