gchooser.h

/*
 * File: gchooser.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 event support
 * @version 2018/09/07
 * - added doc comments for new documentation generation
 * @version 2018/09/04
 * - added GComboBox alias
 * @version 2018/08/23
 * - renamed to gchooser.h to replace Java version
 * @version 2018/06/28
 * - initial version
 */


#ifndef _gchooser_h
#define _gchooser_h

#include <initializer_list>
#include <string>
#include <vector>
#include <QComboBox>

#include "ginteractor.h"

namespace sgl {

class _Internal_QComboBox;

class GChooser : public GInteractor {
public:
    GChooser(QWidget* parent = nullptr);

    GChooser(const std::initializer_list<string>& items, QWidget* parent = nullptr);

    GChooser(const std::vector<string>& items, QWidget* parent = nullptr);

    ~GChooser() override;

    virtual void addItem(const string& item);

    virtual void addItems(const std::initializer_list<string>& items);

    virtual void addItems(const std::vector<string>& items);

    virtual void clearItems();

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

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

    virtual string getItem(int index) const;

    virtual int getItemCount() const;

    virtual int getSelectedIndex() const;

    virtual string getSelectedItem() const;

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

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

    virtual bool isEditable() const;

    virtual bool isEmpty() const;

    virtual void setEditable(bool editable);

    virtual void setItem(int index, const string& item);

    virtual void setSelectedIndex(int index);

    virtual void setSelectedItem(const string& item);

    virtual int size() const;

protected:
    string getActionEventType() const override;

private:
    Q_DISABLE_COPY(GChooser)

    _Internal_QComboBox* _iqcomboBox;

    void checkIndex(const string& member, int index, int min = 0, int max = -1) const;

    friend class _Internal_QComboBox;
};

class _Internal_QComboBox : public QComboBox, public _Internal_QWidget {
    Q_OBJECT

public:
    _Internal_QComboBox(GChooser* gchooser, QWidget* parent = nullptr);
    void detach() override;
    void keyPressEvent(QKeyEvent* event) override;
    void keyReleaseEvent(QKeyEvent* event) override;
    QSize sizeHint() const override;

public slots:
    void handleChange();

private:
    GChooser* _gchooser;

    friend class GChooser;
};

// alias GComboBox for GChooser for name compatibility with Java and Qt
typedef GChooser GComboBox;

} // namespace sgl

#endif // _gchooser_h