qskinny/src/controls/QskComboBox.h

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

#ifndef QSK_COMBO_BOX_H
#define QSK_COMBO_BOX_H

#include "QskControl.h"

class QskGraphic;

class QSK_EXPORT QskComboBox : public QskControl
{
    Q_OBJECT

    Q_PROPERTY( int currentIndex READ currentIndex
        WRITE setCurrentIndex NOTIFY currentIndexChanged )

    Q_PROPERTY( QString currentText READ currentText
        NOTIFY currentIndexChanged )

    Q_PROPERTY( int count READ count NOTIFY countChanged )

    Q_PROPERTY( QString placeholderText READ placeholderText
        WRITE setPlaceholderText NOTIFY placeholderTextChanged )

    Q_PROPERTY( int indexInPopup READ indexInPopup
        NOTIFY indexInPopupChanged )

    using Inherited = QskControl;

  public:
    QSK_SUBCONTROLS( Panel, Graphic, Text, PopupIndicator )
    QSK_STATES( PopupOpen )

    QskComboBox( QQuickItem* parent = nullptr );

    ~QskComboBox() override;

    void setPopupOpen( bool );
    bool isPopupOpen() const;

    QskGraphic graphic() const;

    void setTextOptions( const QskTextOptions& );
    QskTextOptions textOptions() const;

    void addOption( const QString& text );
    void addOption( const QUrl& graphicSource, const QString& text );
    void addOption( const QString& graphicSource, const QString& text );
    void addOption( const QskGraphic&, const QString& text );

    void clear();

    int currentIndex() const;
    QString currentText() const;

    // "highlightedIndex" ( see Qt's combo boxes ) is not very intuitive
    virtual int indexInPopup() const;

    int count() const;
    QVariantList optionAt( int ) const;
    QString textAt( int ) const;

    QString placeholderText() const;
    void setPlaceholderText( const QString& );

  public Q_SLOTS:
    void setCurrentIndex( int );

  Q_SIGNALS:
    void currentIndexChanged( int );
    void indexInPopupChanged( int );

    void countChanged( int );
    void placeholderTextChanged( const QString& );

  protected:
    void mousePressEvent( QMouseEvent* ) override;
    void mouseReleaseEvent( QMouseEvent* ) override;

    void keyPressEvent( QKeyEvent* ) override;
    void keyReleaseEvent( QKeyEvent* ) override;

    void wheelEvent( QWheelEvent* ) override;

    /*
        open/close a menu - needs to be overloaded when using a custom popup
        don't forget to modify indexInPopup/indexInPopupChanged as well
     */
    virtual void openPopup();
    virtual void closePopup();

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

#endif