qinputdialog.h

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
#ifndef QINPUTDIALOG_H
#define QINPUTDIALOG_H
 
#include <QtWidgets/qtwidgetsglobal.h>
#include <QtCore/qstring.h>
#include <QtWidgets/qlineedit.h>
 
#include <QtWidgets/qdialog.h>
 
QT_REQUIRE_CONFIG(inputdialog);
 
QT_BEGIN_NAMESPACE
 
class QInputDialogPrivate;
 
class Q_WIDGETS_EXPORT QInputDialog : public QDialog
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QInputDialog)
    QDOC_PROPERTY(InputMode inputMode READ inputMode WRITE setInputMode)
    QDOC_PROPERTY(QString labelText READ labelText WRITE setLabelText)
    QDOC_PROPERTY(InputDialogOptions options READ options WRITE setOptions)
    QDOC_PROPERTY(QString textValue READ textValue WRITE setTextValue NOTIFY textValueChanged)
    QDOC_PROPERTY(int intValue READ intValue WRITE setIntValue NOTIFY intValueChanged)
    QDOC_PROPERTY(int doubleValue READ doubleValue WRITE setDoubleValue NOTIFY doubleValueChanged)
    QDOC_PROPERTY(QLineEdit::EchoMode textEchoMode READ textEchoMode WRITE setTextEchoMode)
    QDOC_PROPERTY(bool comboBoxEditable READ isComboBoxEditable WRITE setComboBoxEditable)
    QDOC_PROPERTY(QStringList comboBoxItems READ comboBoxItems WRITE setComboBoxItems)
    QDOC_PROPERTY(int intMinimum READ intMinimum WRITE setIntMinimum)
    QDOC_PROPERTY(int intMaximum READ intMaximum WRITE setIntMaximum)
    QDOC_PROPERTY(int intStep READ intStep WRITE setIntStep)
    QDOC_PROPERTY(double doubleMinimum READ doubleMinimum WRITE setDoubleMinimum)
    QDOC_PROPERTY(double doubleMaximum READ doubleMaximum WRITE setDoubleMaximum)
    QDOC_PROPERTY(int doubleDecimals READ doubleDecimals WRITE setDoubleDecimals)
    QDOC_PROPERTY(QString okButtonText READ okButtonText WRITE setOkButtonText)
    QDOC_PROPERTY(QString cancelButtonText READ cancelButtonText WRITE setCancelButtonText)
    QDOC_PROPERTY(double doubleStep READ doubleStep WRITE setDoubleStep)
 
public:
    enum InputDialogOption {
        NoButtons                    = 0x00000001,
        UseListViewForComboBoxItems  = 0x00000002,
        UsePlainTextEditForTextInput = 0x00000004
    };
 
    Q_DECLARE_FLAGS(InputDialogOptions, InputDialogOption)
 
    enum InputMode {
        TextInput,
        IntInput,
        DoubleInput
    };
 
    QInputDialog(QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags());
    ~QInputDialog();
 
    void setInputMode(InputMode mode);
    InputMode inputMode() const;
 
    void setLabelText(const QString &text);
    QString labelText() const;
 
    void setOption(InputDialogOption option, bool on = true);
    bool testOption(InputDialogOption option) const;
    void setOptions(InputDialogOptions options);
    InputDialogOptions options() const;
 
    void setTextValue(const QString &text);
    QString textValue() const;
 
    void setTextEchoMode(QLineEdit::EchoMode mode);
    QLineEdit::EchoMode textEchoMode() const;
 
    void setComboBoxEditable(bool editable);
    bool isComboBoxEditable() const;
 
    void setComboBoxItems(const QStringList &items);
    QStringList comboBoxItems() const;
 
    void setIntValue(int value);
    int intValue() const;
 
    void setIntMinimum(int min);
    int intMinimum() const;
 
    void setIntMaximum(int max);
    int intMaximum() const;
 
    void setIntRange(int min, int max);
 
    void setIntStep(int step);
    int intStep() const;
 
    void setDoubleValue(double value);
    double doubleValue() const;
 
    void setDoubleMinimum(double min);
    double doubleMinimum() const;
 
    void setDoubleMaximum(double max);
    double doubleMaximum() const;
 
    void setDoubleRange(double min, double max);
 
    void setDoubleDecimals(int decimals);
    int doubleDecimals() const;
 
    void setOkButtonText(const QString &text);
    QString okButtonText() const;
 
    void setCancelButtonText(const QString &text);
    QString cancelButtonText() const;
 
    using QDialog::open;
    void open(QObject *receiver, const char *member);
 
    QSize minimumSizeHint() const override;
    QSize sizeHint() const override;
 
    void setVisible(bool visible) override;
 
    static QString getText(QWidget *parent, const QString &title, const QString &label,
                           QLineEdit::EchoMode echo = QLineEdit::Normal,
                           const QString &text = QString(), bool *ok = nullptr,
                           Qt::WindowFlags flags = Qt::WindowFlags(),
                           Qt::InputMethodHints inputMethodHints = Qt::ImhNone);
    static QString getMultiLineText(QWidget *parent, const QString &title, const QString &label,
                                    const QString &text = QString(), bool *ok = nullptr,
                                    Qt::WindowFlags flags = Qt::WindowFlags(),
                                    Qt::InputMethodHints inputMethodHints = Qt::ImhNone);
    static QString getItem(QWidget *parent, const QString &title, const QString &label,
                           const QStringList &items, int current = 0, bool editable = true,
                           bool *ok = nullptr, Qt::WindowFlags flags = Qt::WindowFlags(),
                           Qt::InputMethodHints inputMethodHints = Qt::ImhNone);
 
    static int getInt(QWidget *parent, const QString &title, const QString &label, int value = 0,
                      int minValue = -2147483647, int maxValue = 2147483647,
                      int step = 1, bool *ok = nullptr, Qt::WindowFlags flags = Qt::WindowFlags());
 
    static double getDouble(QWidget *parent, const QString &title, const QString &label, double value = 0,
                            double minValue = -2147483647, double maxValue = 2147483647,
                            int decimals = 1, bool *ok = nullptr, Qt::WindowFlags flags = Qt::WindowFlags(),
                            double step = 1);
 
    void setDoubleStep(double step);
    double doubleStep() const;
 
Q_SIGNALS:
    void textValueChanged(const QString &text);
    void textValueSelected(const QString &text);
    void intValueChanged(int value);
    void intValueSelected(int value);
    void doubleValueChanged(double value);
    void doubleValueSelected(double value);
 
public:
    void done(int result) override;
 
private:
    Q_DISABLE_COPY(QInputDialog)
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS(QInputDialog::InputDialogOptions)
 
QT_END_NAMESPACE
 
#endif // QINPUTDIALOG_H