gtextfield.h

/*
 * File: gtextfield.h
 * ------------------
 *
 * @author Marty Stepp
 * @version 2021/04/09
 * - added sgl namespace
 * @version 2021/04/03
 * - removed dependency on custom collections
 * @version 2019/04/23
 * - added key events
 * @version 2018/09/08
 * - added doc comments for new documentation generation
 * @version 2018/08/23
 * - renamed to gtextfield.h to replace Java version
 * @version 2018/06/29
 * - added textChange event
 * @version 2018/06/25
 * - initial version
 */


#ifndef _gtextfield_h
#define _gtextfield_h

#include <initializer_list>
#include <string>
#include <QLineEdit>
#include <QSpinBox>
#include <QDoubleSpinBox>
#include <QString>

#include "ginteractor.h"

namespace sgl {

class _Internal_QLineEdit;
class _Internal_QSpinBox;
class _Internal_QDoubleSpinBox;

class GTextField : public GInteractor {
public:
    enum InputType {
        INPUT_TYPE_TEXT,
        INPUT_TYPE_INTEGER,
        INPUT_TYPE_REAL
    };

    GTextField(const string& text = "", int charsWide = 0, QWidget* parent = nullptr);

    GTextField(int charsWide, QWidget* parent = nullptr);

    GTextField(int value, int min, int max, int step = 1, QWidget* parent = nullptr);

    GTextField(double value, double min, double max, double step, QWidget* parent = nullptr);

    ~GTextField() override;

    virtual int getCharsWide() const;

    virtual InputType getInputType() const;

    /* @inherit */
    _Internal_QWidget* getInternalWidget() const override;

    virtual int getMaxLength() const;

    virtual string getPlaceholder() const;

    virtual string getText() const;

    /* @inherit */
    string getType() const override;

    virtual string getValue() const;

    virtual bool getValueAsBool() const;

    virtual char getValueAsChar() const;

    virtual double getValueAsDouble() const;

    virtual int getValueAsInt() const;

    virtual int getValueAsInteger() const;

    /* @inherit */
    QWidget* getWidget() const override;

    virtual bool isAutocompleteEnabled() const;

    virtual bool isEditable() const;

    virtual void removeTextChangeListener();

    virtual void setAutocompleteList(std::initializer_list<string> strings);

    virtual void setAutocompleteList(const std::vector<string>& strings);

    virtual void setAutocompleteEnabled(bool enabled);

    virtual void setCharsWide(int charsWide);

    virtual void setEditable(bool value);

    virtual void setMaxLength(int maxLength);

    virtual void setPlaceholder(const string& text);

    virtual void setText(const string& text);

    virtual void setTextChangeListener(GEventListener func);

    virtual void setTextChangeListener(GEventListenerVoid func);

    virtual void setValue(bool value);

    virtual void setValue(char value);

    virtual void setValue(double value);

    virtual void setValue(int value);

    virtual void setValue(const string& value);

    virtual bool valueIsBool() const;

    virtual bool valueIsChar() const;

    virtual bool valueIsDouble() const;

    virtual bool valueIsInt() const;

    virtual bool valueIsInteger() const;

    virtual bool valueIsReal() const;

protected:
    string getActionEventType() const override;

private:
    Q_DISABLE_COPY(GTextField)

    // pointers to the internal Qt text field;
    // at most one of these will be non-null for a given instance
    _Internal_QLineEdit* _iqlineedit;
    _Internal_QSpinBox* _iqspinbox;
    _Internal_QDoubleSpinBox* _iqdoublespinbox;

    // type of text field; helps tell us which of the above internal Qt widgets
    // will be non-null
    InputType _inputType;

    friend class _Internal_QLineEdit;
    friend class _Internal_QSpinBox;
    friend class _Internal_QDoubleSpinBox;
};

class _Internal_QLineEdit : public QLineEdit, public _Internal_QWidget {
    Q_OBJECT

public:
    _Internal_QLineEdit(GTextField* gtextField, QWidget* parent = nullptr);
    void detach() override;
    void keyPressEvent(QKeyEvent* event) override;
    void keyReleaseEvent(QKeyEvent* event) override;
    QSize sizeHint() const override;

public slots:
    void handleTextChange(const QString&);

private:
    GTextField* _gtextfield;

    friend class GTextField;
};

class _Internal_QSpinBox : public QSpinBox, public _Internal_QWidget {
    Q_OBJECT

public:
    _Internal_QSpinBox(GTextField* qgtextField, int min, int max, int step = 1, QWidget* parent = nullptr);
    void detach() override;
    void keyPressEvent(QKeyEvent* event) override;
    void keyReleaseEvent(QKeyEvent* event) override;
    virtual QLineEdit* lineEdit() const;
    QSize sizeHint() const override;

public slots:
    void handleTextChange(const QString&);

private:
    GTextField* _gtextfield;

    friend class GTextField;
};

class _Internal_QDoubleSpinBox : public QDoubleSpinBox, public _Internal_QWidget {
    Q_OBJECT

public:
    _Internal_QDoubleSpinBox(GTextField* qgtextField, double min, double max, double step = 0.1, QWidget* parent = nullptr);
    void detach() override;
    void keyPressEvent(QKeyEvent* event) override;
    void keyReleaseEvent(QKeyEvent* event) override;
    virtual QLineEdit* lineEdit() const;
    QSize sizeHint() const override;

public slots:
    void handleTextChange(const QString&);

private:
    GTextField* _gtextfield;

    friend class GTextField;
};

} // namespace sgl

#endif // _gtextfield_h