qskinny/src/controls/QskPopup.h

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

#ifndef QSK_POPUP_H
#define QSK_POPUP_H 1

#include "QskControl.h"

class QSK_EXPORT QskPopup : public QskControl
{
    Q_OBJECT

    Q_PROPERTY( bool open READ isOpen WRITE setOpen NOTIFY openChanged )
    Q_PROPERTY( bool modal READ isModal WRITE setModal NOTIFY modalChanged )
    Q_PROPERTY( bool overlay READ hasOverlay WRITE setOverlay NOTIFY overlayChanged )

    Q_PROPERTY( bool faderEffect READ hasFaderEffect
        WRITE setFaderEffect NOTIFY faderEffectChanged )

    Q_PROPERTY( uint priority READ priority WRITE setPriority NOTIFY priorityChanged )

    using Inherited = QskControl;

  public:
    QSK_SUBCONTROLS( Overlay )
    QSK_STATES( Closed )

    enum PopupFlag
    {
        DeleteOnClose       = 1 << 0,
        CloseOnPressOutside = 1 << 1
    };

    Q_ENUM( PopupFlag )
    Q_DECLARE_FLAGS( PopupFlags, PopupFlag )

    QskPopup( QQuickItem* parent = nullptr );
    ~QskPopup() override;

    void setPopupFlags( PopupFlags );
    PopupFlags popupFlags() const;

    void setPopupFlag( PopupFlag, bool on = true );
    bool testPopupFlag( PopupFlag ) const;

    void setModal( bool on = true );
    bool isModal() const;

    void setOverlay( bool on = true );
    bool hasOverlay() const;

    // allows for stacking orders based on priorities
    void setPriority( uint );
    uint priority() const;

    void setFaderEffect( bool );
    bool hasFaderEffect() const;

    QskAspect::Aspect faderAspect() const;
    void setFaderAspect( QskAspect::Aspect );

    virtual QRectF overlayRect() const;

    bool isOpen() const;
    bool isFading() const;

  public Q_SLOTS:
    void open();
    void close();
    void setOpen( bool );

  Q_SIGNALS:
    void opened();
    void closed();
    void openChanged( bool );
    void fadingChanged( bool );

    void modalChanged( bool );
    void overlayChanged( bool );
    void priorityChanged( uint );
    void faderEffectChanged( bool );

  protected:
    void aboutToShow() override;

    bool event( QEvent* ) override;
    void focusInEvent( QFocusEvent* ) override;
    void focusOutEvent( QFocusEvent* ) override;
    void windowChangeEvent( QskWindowChangeEvent* ) override;

    void itemChange( QQuickItem::ItemChange,
        const QQuickItem::ItemChangeData& ) override;

    virtual QQuickItem* focusSuccessor() const;
    bool isTransitionAccepted( QskAspect::Aspect ) const override;

    void grabFocus( bool );

  private:
    void show() = delete;
    void hide() = delete;
    void setVisible( bool ) = delete;

    void updateInputGrabber();

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

Q_DECLARE_OPERATORS_FOR_FLAGS( QskPopup::PopupFlags )

#endif