qskinny/src/inputpanel/QskInputPanel.h

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

#ifndef QSK_INPUT_PANEL_H
#define QSK_INPUT_PANEL_H

#include "QskGlobal.h"
#include "QskBox.h"

class QString;
class QLocale;

template class QVector< QString >;

class QSK_EXPORT QskInputPanel: public QskBox
{
    Q_OBJECT

    using Inherited = QskBox;

    Q_PROPERTY( bool inputProxy READ hasInputProxy
        WRITE setInputProxy NOTIFY inputProxyChanged )

    Q_PROPERTY( QString inputPrompt READ inputPrompt
        WRITE setInputPrompt NOTIFY inputPromptChanged )


public:
    QSK_SUBCONTROLS( Panel )

    enum Action
    {
        Compose = 0x10,
        SelectCandidate = 0x11
    };
    Q_ENUM( Action )

    QskInputPanel( QQuickItem* parent = nullptr );
    virtual ~QskInputPanel() override;

    bool hasInputProxy() const;
    QString inputPrompt() const;

    bool isCandidatesEnabled() const;
    QVector< QString > candidates() const;

    virtual qreal heightForWidth( qreal width ) const override;
    virtual qreal widthForHeight( qreal height ) const override;

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

    void updateInputProxy( const QQuickItem* );

Q_SIGNALS:
    void inputProxyChanged( bool );
    void inputPromptChanged( const QString& );

public Q_SLOTS:
    void setInputPrompt( const QString& );
    void setInputProxy( bool );
    void setCandidatesEnabled( bool );
    void setCandidates( const QVector< QString >& );

protected:
    virtual void keyPressEvent( QKeyEvent* ) override;
    virtual void keyReleaseEvent( QKeyEvent* ) override;

private:
    void commitKey( int key );
    void commitCandidate( int );

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

QSK_EXPORT QString qskNativeLocaleString( const QLocale& );

#endif