// Copyright (C) 2018 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 QPLATFORMDIALOGHELPER_H

#define QPLATFORMDIALOGHELPER_H

//

//  W A R N I N G

//  -------------

//

// This file is part of the QPA API and is not meant to be used

// in applications. Usage of this API may make your code

// source and binary incompatible with future versions of Qt.

//

#include <QtGui/qtguiglobal.h>

#include <QtCore/QtGlobal>

#include <QtCore/QObject>

#include <QtCore/QList>

#include <QtCore/QSharedDataPointer>

#include <QtCore/QSharedPointer>

#include <QtCore/QDir>

#include <QtCore/QUrl>

#include <QtGui/QRgb>

Q_MOC_INCLUDE(<QFont>)

Q_MOC_INCLUDE(<QColor>)

QT_BEGIN_NAMESPACE

class QString;

class QColor;

class QFont;

class QWindow;

class QVariant;

class QUrl;

class QColorDialogOptionsPrivate;

class QFontDialogOptionsPrivate;

class QFileDialogOptionsPrivate;

class QMessageDialogOptionsPrivate;

#define QPLATFORMDIALOGHELPERS_HAS_CREATE

class Q_GUI_EXPORT QPlatformDialogHelper : public QObject

{

    Q_OBJECT

public:

    enum StyleHint {

        DialogIsQtWindow

    };

    enum DialogCode { Rejected, Accepted };

    enum StandardButton {

        // keep this in sync with QDialogButtonBox::StandardButton and QMessageBox::StandardButton

        NoButton           = 0x00000000,

        Ok                 = 0x00000400,

        Save               = 0x00000800,

        SaveAll            = 0x00001000,

        Open               = 0x00002000,

        Yes                = 0x00004000,

        YesToAll           = 0x00008000,

        No                 = 0x00010000,

        NoToAll            = 0x00020000,

        Abort              = 0x00040000,

        Retry              = 0x00080000,

        Ignore             = 0x00100000,

        Close              = 0x00200000,

        Cancel             = 0x00400000,

        Discard            = 0x00800000,

        Help               = 0x01000000,

        Apply              = 0x02000000,

        Reset              = 0x04000000,

        RestoreDefaults    = 0x08000000,

        FirstButton        = Ok,                // internal

        LastButton         = RestoreDefaults,   // internal

        LowestBit          = 10,                // internal: log2(FirstButton)

        HighestBit         = 27                 // internal: log2(LastButton)

    };

    Q_DECLARE_FLAGS(StandardButtons, StandardButton)

    Q_FLAG(StandardButtons)

Unexecuted instantiation: qt_getEnumMetaObject(QFlags<QPlatformDialogHelper::StandardButton>)

Unexecuted instantiation: qt_getEnumName(QFlags<QPlatformDialogHelper::StandardButton>)

    enum ButtonRole {

        // keep this in sync with QDialogButtonBox::ButtonRole and QMessageBox::ButtonRole

        // TODO Qt 6: make the enum copies explicit, and make InvalidRole == 0 so that

        // AcceptRole can be or'ed with flags, and EOL can be the same as InvalidRole (null-termination)

        InvalidRole = -1,

        AcceptRole,

        RejectRole,

        DestructiveRole,

        ActionRole,

        HelpRole,

        YesRole,

        NoRole,

        ResetRole,

        ApplyRole,

        NRoles,

        RoleMask        = 0x0FFFFFFF,

        AlternateRole   = 0x10000000,

        Stretch         = 0x20000000,

        Reverse         = 0x40000000,

        EOL             = InvalidRole

    };

    Q_ENUM(ButtonRole)

Unexecuted instantiation: qt_getEnumMetaObject(QPlatformDialogHelper::ButtonRole)

Unexecuted instantiation: qt_getEnumName(QPlatformDialogHelper::ButtonRole)

    enum ButtonLayout {

        // keep this in sync with QDialogButtonBox::ButtonLayout

        UnknownLayout = -1,

        WinLayout,

        MacLayout,

        KdeLayout,

        GnomeLayout,

        AndroidLayout

    };

    Q_ENUM(ButtonLayout)

Unexecuted instantiation: qt_getEnumMetaObject(QPlatformDialogHelper::ButtonLayout)

Unexecuted instantiation: qt_getEnumName(QPlatformDialogHelper::ButtonLayout)

    QPlatformDialogHelper();

    ~QPlatformDialogHelper();

    virtual QVariant styleHint(StyleHint hint) const;

    virtual void exec() = 0;

    virtual bool show(Qt::WindowFlags windowFlags,

                          Qt::WindowModality windowModality,

                          QWindow *parent) = 0;

    virtual void hide() = 0;

    static QVariant defaultStyleHint(QPlatformDialogHelper::StyleHint hint);

    static const int *buttonLayout(Qt::Orientation orientation = Qt::Horizontal, ButtonLayout policy = UnknownLayout);

    static ButtonRole buttonRole(StandardButton button);

Q_SIGNALS:

    void accept();

    void reject();

};

QT_END_NAMESPACE

QT_DECL_METATYPE_EXTERN_TAGGED(QPlatformDialogHelper::StandardButton,

Unexecuted instantiation: int qRegisterNormalizedMetaType<QPlatformDialogHelper::StandardButton>(QByteArray const&)

Unexecuted instantiation: QMetaTypeId<QPlatformDialogHelper::StandardButton>::qt_metatype_id()

                               QPlatformDialogHelper__StandardButton, Q_GUI_EXPORT)

QT_DECL_METATYPE_EXTERN_TAGGED(QPlatformDialogHelper::ButtonRole,

Unexecuted instantiation: int qRegisterNormalizedMetaType<QPlatformDialogHelper::ButtonRole>(QByteArray const&)

Unexecuted instantiation: QMetaTypeId<QPlatformDialogHelper::ButtonRole>::qt_metatype_id()

                               QPlatformDialogHelper__ButtonRole, Q_GUI_EXPORT)

QT_BEGIN_NAMESPACE

class Q_GUI_EXPORT QColorDialogOptions

{

    Q_GADGET

    Q_DISABLE_COPY(QColorDialogOptions)

protected:

    explicit QColorDialogOptions(QColorDialogOptionsPrivate *dd);

    ~QColorDialogOptions();

public:

    enum ColorDialogOption {

        ShowAlphaChannel    = 0x00000001,

        NoButtons           = 0x00000002,

        DontUseNativeDialog = 0x00000004,

        NoEyeDropperButton  = 0x00000008

    };

    Q_DECLARE_FLAGS(ColorDialogOptions, ColorDialogOption)

    Q_FLAG(ColorDialogOptions)

Unexecuted instantiation: qt_getEnumMetaObject(QFlags<QColorDialogOptions::ColorDialogOption>)

Unexecuted instantiation: qt_getEnumName(QFlags<QColorDialogOptions::ColorDialogOption>)

    static QSharedPointer<QColorDialogOptions> create();

    QSharedPointer<QColorDialogOptions> clone() const;

    QString windowTitle() const;

    void setWindowTitle(const QString &);

    void setOption(ColorDialogOption option, bool on = true);

    bool testOption(ColorDialogOption option) const;

    void setOptions(ColorDialogOptions options);

    ColorDialogOptions options() const;

    static int customColorCount();

    static QRgb customColor(int index);

    static QRgb *customColors();

    static void setCustomColor(int index, QRgb color);

    static QRgb *standardColors();

    static QRgb standardColor(int index);

    static void setStandardColor(int index, QRgb color);

private:

    QColorDialogOptionsPrivate *d;

};

class Q_GUI_EXPORT QPlatformColorDialogHelper : public QPlatformDialogHelper

{

    Q_OBJECT

public:

    const QSharedPointer<QColorDialogOptions> &options() const;

    void setOptions(const QSharedPointer<QColorDialogOptions> &options);

    virtual void setCurrentColor(const QColor &) = 0;

    virtual QColor currentColor() const = 0;

Q_SIGNALS:

    void currentColorChanged(const QColor &color);

    void colorSelected(const QColor &color);

private:

    QSharedPointer<QColorDialogOptions> m_options;

};

class Q_GUI_EXPORT QFontDialogOptions

{

    Q_GADGET

    Q_DISABLE_COPY(QFontDialogOptions)

protected:

    explicit QFontDialogOptions(QFontDialogOptionsPrivate *dd);

    ~QFontDialogOptions();

public:

    enum FontDialogOption {

        NoButtons           = 0x00000001,

        DontUseNativeDialog = 0x00000002,

        ScalableFonts       = 0x00000004,

        NonScalableFonts    = 0x00000008,

        MonospacedFonts     = 0x00000010,

        ProportionalFonts   = 0x00000020

    };

    Q_DECLARE_FLAGS(FontDialogOptions, FontDialogOption)

    Q_FLAG(FontDialogOptions)

Unexecuted instantiation: qt_getEnumMetaObject(QFlags<QFontDialogOptions::FontDialogOption>)

Unexecuted instantiation: qt_getEnumName(QFlags<QFontDialogOptions::FontDialogOption>)

    static QSharedPointer<QFontDialogOptions> create();

    QSharedPointer<QFontDialogOptions> clone() const;

    QString windowTitle() const;

    void setWindowTitle(const QString &);

    void setOption(FontDialogOption option, bool on = true);

    bool testOption(FontDialogOption option) const;

    void setOptions(FontDialogOptions options);

    FontDialogOptions options() const;

private:

    QFontDialogOptionsPrivate *d;

};

class Q_GUI_EXPORT QPlatformFontDialogHelper : public QPlatformDialogHelper

{

    Q_OBJECT

public:

    virtual void setCurrentFont(const QFont &) = 0;

    virtual QFont currentFont() const = 0;

    const QSharedPointer<QFontDialogOptions> &options() const;

    void setOptions(const QSharedPointer<QFontDialogOptions> &options);

Q_SIGNALS:

    void currentFontChanged(const QFont &font);

    void fontSelected(const QFont &font);

private:

    QSharedPointer<QFontDialogOptions> m_options;

};

class Q_GUI_EXPORT QFileDialogOptions

{

    Q_GADGET

    Q_DISABLE_COPY(QFileDialogOptions)

protected:

    QFileDialogOptions(QFileDialogOptionsPrivate *dd);

    ~QFileDialogOptions();

public:

    enum ViewMode { Detail, List };

    Q_ENUM(ViewMode)

Unexecuted instantiation: qt_getEnumMetaObject(QFileDialogOptions::ViewMode)

Unexecuted instantiation: qt_getEnumName(QFileDialogOptions::ViewMode)

    enum FileMode { AnyFile, ExistingFile, Directory, ExistingFiles, DirectoryOnly };

    Q_ENUM(FileMode)

Unexecuted instantiation: qt_getEnumMetaObject(QFileDialogOptions::FileMode)

Unexecuted instantiation: qt_getEnumName(QFileDialogOptions::FileMode)

    enum AcceptMode { AcceptOpen, AcceptSave };

    Q_ENUM(AcceptMode)

Unexecuted instantiation: qt_getEnumMetaObject(QFileDialogOptions::AcceptMode)

Unexecuted instantiation: qt_getEnumName(QFileDialogOptions::AcceptMode)

    enum DialogLabel { LookIn, FileName, FileType, Accept, Reject, DialogLabelCount };

    Q_ENUM(DialogLabel)

Unexecuted instantiation: qt_getEnumMetaObject(QFileDialogOptions::DialogLabel)

Unexecuted instantiation: qt_getEnumName(QFileDialogOptions::DialogLabel)

    // keep this in sync with QFileDialog::Options

    enum FileDialogOption

    {

        ShowDirsOnly                = 0x00000001,

        DontResolveSymlinks         = 0x00000002,

        DontConfirmOverwrite        = 0x00000004,

        DontUseNativeDialog         = 0x00000008,

        ReadOnly                    = 0x00000010,

        HideNameFilterDetails       = 0x00000020,

        DontUseCustomDirectoryIcons = 0x00000040

    };

    Q_DECLARE_FLAGS(FileDialogOptions, FileDialogOption)

    Q_FLAG(FileDialogOptions)

Unexecuted instantiation: qt_getEnumMetaObject(QFlags<QFileDialogOptions::FileDialogOption>)

Unexecuted instantiation: qt_getEnumName(QFlags<QFileDialogOptions::FileDialogOption>)

    static QSharedPointer<QFileDialogOptions> create();

    QSharedPointer<QFileDialogOptions> clone() const;

    QString windowTitle() const;

    void setWindowTitle(const QString &);

    void setOption(FileDialogOption option, bool on = true);

    bool testOption(FileDialogOption option) const;

    void setOptions(FileDialogOptions options);

    FileDialogOptions options() const;

    QDir::Filters filter() const;

    void setFilter(QDir::Filters filters);

    void setViewMode(ViewMode mode);

    ViewMode viewMode() const;

    void setFileMode(FileMode mode);

    FileMode fileMode() const;

    void setAcceptMode(AcceptMode mode);

    AcceptMode acceptMode() const;

    void setSidebarUrls(const QList<QUrl> &urls);

    QList<QUrl> sidebarUrls() const;

    bool useDefaultNameFilters() const;

    void setUseDefaultNameFilters(bool d);

    void setNameFilters(const QStringList &filters);

    QStringList nameFilters() const;

    void setMimeTypeFilters(const QStringList &filters);

    QStringList mimeTypeFilters() const;

    void setDefaultSuffix(const QString &suffix);

    QString defaultSuffix() const;

    void setHistory(const QStringList &paths);

    QStringList history() const;

    void setLabelText(DialogLabel label, const QString &text);

    QString labelText(DialogLabel label) const;

    bool isLabelExplicitlySet(DialogLabel label);

    QUrl initialDirectory() const;

    void setInitialDirectory(const QUrl &);

    QString initiallySelectedMimeTypeFilter() const;

    void setInitiallySelectedMimeTypeFilter(const QString &);

    QString initiallySelectedNameFilter() const;

    void setInitiallySelectedNameFilter(const QString &);

    QList<QUrl> initiallySelectedFiles() const;

    void setInitiallySelectedFiles(const QList<QUrl> &);

    void setSupportedSchemes(const QStringList &schemes);

    QStringList supportedSchemes() const;

    static QString defaultNameFilterString();

private:

    QFileDialogOptionsPrivate *d;

};

class Q_GUI_EXPORT QPlatformFileDialogHelper : public QPlatformDialogHelper

{

    Q_OBJECT

public:

    virtual bool defaultNameFilterDisables() const = 0;

    virtual void setDirectory(const QUrl &directory) = 0;

    virtual QUrl directory() const = 0;

    virtual void selectFile(const QUrl &filename) = 0;

    virtual QList<QUrl> selectedFiles() const = 0;

    virtual void setFilter() = 0;

    virtual void selectMimeTypeFilter(const QString &filter);

    virtual void selectNameFilter(const QString &filter) = 0;

    virtual QString selectedMimeTypeFilter() const;

    virtual QString selectedNameFilter() const = 0;

    virtual bool isSupportedUrl(const QUrl &url) const;

    const QSharedPointer<QFileDialogOptions> &options() const;

    void setOptions(const QSharedPointer<QFileDialogOptions> &options);

    static QStringList cleanFilterList(const QString &filter);

    static const char filterRegExp[];

Q_SIGNALS:

    void fileSelected(const QUrl &file);

    void filesSelected(const QList<QUrl> &files);

    void currentChanged(const QUrl &path);

    void directoryEntered(const QUrl &directory);

    void filterSelected(const QString &filter);

private:

    QSharedPointer<QFileDialogOptions> m_options;

};

class Q_GUI_EXPORT QMessageDialogOptions

{

    Q_GADGET

    Q_DISABLE_COPY(QMessageDialogOptions)

protected:

    QMessageDialogOptions(QMessageDialogOptionsPrivate *dd);

    ~QMessageDialogOptions();

public:

    // Keep in sync with QMessageBox Option

    enum class Option {

        DontUseNativeDialog = 0x00000001,

    };

    Q_DECLARE_FLAGS(Options, Option)

    Q_FLAG(Options)

Unexecuted instantiation: qt_getEnumMetaObject(QFlags<QMessageDialogOptions::Option>)

Unexecuted instantiation: qt_getEnumName(QFlags<QMessageDialogOptions::Option>)

    // Keep in sync with QMessageBox::Icon

    enum StandardIcon { NoIcon, Information, Warning, Critical, Question };

    Q_ENUM(StandardIcon)

Unexecuted instantiation: qt_getEnumMetaObject(QMessageDialogOptions::StandardIcon)

Unexecuted instantiation: qt_getEnumName(QMessageDialogOptions::StandardIcon)

    static QSharedPointer<QMessageDialogOptions> create();

    QSharedPointer<QMessageDialogOptions> clone() const;

    QString windowTitle() const;

    void setWindowTitle(const QString &);

    void setStandardIcon(StandardIcon icon);

    StandardIcon standardIcon() const;

    void setIconPixmap(const QPixmap &pixmap);

    QPixmap iconPixmap() const;

    void setText(const QString &text);

    QString text() const;

    void setInformativeText(const QString &text);

    QString informativeText() const;

    void setDetailedText(const QString &text);

    QString detailedText() const;

    void setOption(Option option, bool on = true);

    bool testOption(Option option) const;

    void setOptions(Options options);

    Options options() const;

    void setStandardButtons(QPlatformDialogHelper::StandardButtons buttons);

    QPlatformDialogHelper::StandardButtons standardButtons() const;

    struct CustomButton {

        explicit CustomButton(

                int id = -1, const QString &label = QString(),

                QPlatformDialogHelper::ButtonRole role = QPlatformDialogHelper::InvalidRole,

                void *button = nullptr) :

            label(label), role(role), id(id), button(button)

        {}

        QString label;

        QPlatformDialogHelper::ButtonRole role;

        int id;

        void *button; // strictly internal use only

    };

    int addButton(const QString &label, QPlatformDialogHelper::ButtonRole role,

                  void *buttonImpl = nullptr, int buttonId = 0);

    void removeButton(int id);

    const QList<CustomButton> &customButtons();

    const CustomButton *customButton(int id);

    void clearCustomButtons();

    void setCheckBox(const QString &label, Qt::CheckState state);

    QString checkBoxLabel() const;

    Qt::CheckState checkBoxState() const;

    void setEscapeButton(int id);

    int escapeButton() const;

    void setDefaultButton(int id);

    int defaultButton() const;

private:

    QMessageDialogOptionsPrivate *d;

};

class Q_GUI_EXPORT QPlatformMessageDialogHelper : public QPlatformDialogHelper

{

    Q_OBJECT

public:

    const QSharedPointer<QMessageDialogOptions> &options() const;

    void setOptions(const QSharedPointer<QMessageDialogOptions> &options);

Q_SIGNALS:

    void clicked(QPlatformDialogHelper::StandardButton button, QPlatformDialogHelper::ButtonRole role);

    void checkBoxStateChanged(Qt::CheckState state);

private:

    QSharedPointer<QMessageDialogOptions> m_options;

};

QT_END_NAMESPACE

#endif // QPLATFORMDIALOGHELPER_H