QskStackBox.h

/******************************************************************************
 * QSkinny - Copyright (C) The authors
 *           SPDX-License-Identifier: BSD-3-Clause
 *****************************************************************************/
 
#ifndef QSK_STACK_BOX_H
#define QSK_STACK_BOX_H
 
#include "QskIndexedLayoutBox.h"
 
class QskStackBoxAnimator;
 
class QSK_EXPORT QskStackBox : public QskIndexedLayoutBox
{
    Q_OBJECT
 
    Q_PROPERTY( int currentIndex READ currentIndex
        WRITE setCurrentIndex NOTIFY currentIndexChanged )
 
    Q_PROPERTY( qreal transientIndex READ transientIndex
        NOTIFY transientIndexChanged )
 
    Q_PROPERTY( QQuickItem* currentItem READ currentItem
        WRITE setCurrentItem NOTIFY currentItemChanged )
 
    using Inherited = QskBox;
 
  public:
    explicit QskStackBox( QQuickItem* parent = nullptr );
    QskStackBox( bool autoAddChildren, QQuickItem* parent = nullptr );
 
    ~QskStackBox() override;
 
    bool isEmpty() const;
 
    int itemCount() const;
    QQuickItem* itemAtIndex( int index ) const;
    int indexOf( const QQuickItem* ) const;
 
    void addItem( QQuickItem* );
    void addItem( QQuickItem*, Qt::Alignment );
 
    void insertItem( int index, QQuickItem* );
    void insertItem( int index, QQuickItem*, Qt::Alignment );
 
    void removeItem( const QQuickItem* );
    void removeAt( int index );
 
    QQuickItem* currentItem() const;
    int currentIndex() const;
 
    qreal transientIndex() const;
 
    void setDefaultAlignment( Qt::Alignment );
    Qt::Alignment defaultAlignment() const;
 
    void setAnimator( QskStackBoxAnimator* );
    const QskStackBoxAnimator* animator() const;
    QskStackBoxAnimator* animator();
 
    QRectF geometryForItemAt( int index ) const;
 
    void dump() const;
 
  Q_SIGNALS:
    void defaultAlignmentChanged( Qt::Alignment );
 
  public Q_SLOTS:
    void setCurrentIndex( int index );
    void setCurrentItem( const QQuickItem* );
    void clear( bool autoDelete = false );
 
  Q_SIGNALS:
    void currentIndexChanged( int index );
    void transientIndexChanged( qreal index );
    void currentItemChanged( QQuickItem* );
 
  protected:
    bool event( QEvent* ) override;
    void updateLayout() override;
 
    QSizeF layoutSizeHint( Qt::SizeHint, const QSizeF& ) const override;
 
    QskStackBoxAnimator* effectiveAnimator();
 
  private:
    void autoAddItem( QQuickItem* ) override final;
    void autoRemoveItem( QQuickItem* ) override final;
 
    void removeItemInternal( int index, bool unparent );
 
    class PrivateData;
    std::unique_ptr< PrivateData > m_data;
};
 
inline bool QskStackBox::isEmpty() const
{
    return itemCount() <= 0;
}
 
#endif