tageditor/gui/tagfieldedit.h

#ifndef QTGUI_TAGFIELDLINEEDIT_H
#define QTGUI_TAGFIELDLINEEDIT_H

#include "./previousvaluehandling.h"

#include <c++utilities/application/global.h>

#include <QPair>
#include <QWidget>

QT_FORWARD_DECLARE_CLASS(QVBoxLayout)
QT_FORWARD_DECLARE_CLASS(QLabel)

#define TAGEDITOR_ENUM_CLASS enum class
namespace TagParser {
class TagValue;
class Tag;
TAGEDITOR_ENUM_CLASS KnownField : unsigned int;
TAGEDITOR_ENUM_CLASS TagDataType : unsigned int;
TAGEDITOR_ENUM_CLASS TagTextEncoding : unsigned int;
} // namespace TagParser
#undef TAGEDITOR_ENUM_CLASS

namespace QtUtilities {
class ButtonOverlay;
class ClearLineEdit;
class ClearComboBox;
class ClearSpinBox;
class ClearPlainTextEdit;
class IconButton;
} // namespace QtUtilities

namespace QtGui {

class PicturePreviewSelection;

class TagFieldEdit : public QWidget {
    Q_OBJECT

public:
    explicit TagFieldEdit(const QList<TagParser::Tag *> &tags, TagParser::KnownField field, QWidget *parent = nullptr);
    ~TagFieldEdit() override;

    const QList<TagParser::Tag *> &tags() const;
    TagParser::KnownField field() const;
    void setTagField(const QList<TagParser::Tag *> &tags, TagParser::KnownField field,
        PreviousValueHandling previousValueHandling = PreviousValueHandling::Clear, bool preventUiUpdate = false);
    TagParser::TagValue value(TagParser::TagTextEncoding encoding, bool includeDescription) const;
    bool setValue(const TagParser::TagValue &value, PreviousValueHandling previousValueHandling = PreviousValueHandling::Clear);
    bool hasDescription() const;
    bool canApply(TagParser::KnownField field) const;
    bool isLocked() const;
    void setLocked(bool locked);
    void toggleLocked();
    bool hasAutoCorrectionBeenApplied() const;

public Q_SLOTS:
    void clear();
    void apply();
    void restore();
    void setCoverButtonsHidden(bool hideCoverButtons);

Q_SIGNALS:
    void returnPressed();

protected:
    bool eventFilter(QObject *obj, QEvent *event) override;

private Q_SLOTS:
    void handleRestoreButtonClicked();
    void handleRestoreButtonDestroyed(QObject *obj = nullptr);
    void handleLockButtonDestroyed(QObject *obj = nullptr);

private:
    TagParser::TagDataType determineDataType();
    void setupUi();
    QtUtilities::ClearLineEdit *setupLineEdit();
    QtUtilities::ClearPlainTextEdit *setupPlainTextEdit();
    QtUtilities::ClearComboBox *setupGenreComboBox();
    QtUtilities::ClearSpinBox *setupSpinBox();
    QPair<QtUtilities::ClearSpinBox *, QtUtilities::ClearSpinBox *> &setupPositionInSetSpinBoxes();
    PicturePreviewSelection *setupPictureSelection();
    QWidget *setupFileSelection();
    QtUtilities::ClearLineEdit *setupDescriptionLineEdit();
    QLabel *setupTypeNotSupportedLabel();
    bool updateValue(PreviousValueHandling previousValueHandling = PreviousValueHandling::Clear);
    bool updateValue(TagParser::Tag *tag, PreviousValueHandling previousValueHandling = PreviousValueHandling::Clear);
    bool updateValue(
        const TagParser::TagValue &value, PreviousValueHandling previousValueHandling = PreviousValueHandling::Clear, bool resetRestoreButton = true);
    QAction *setupRestoreAction();
    QAction *setupLockAction();
    void showRestoreAction();
    QString applyAutoCorrection(const QString &textValue);
    void concretizePreviousValueHandling(PreviousValueHandling &previousValueHandling);

    QVBoxLayout *m_layout;
    const QList<TagParser::Tag *> *m_tags;
    TagParser::KnownField m_field;
    TagParser::TagDataType m_dataType;
    QList<QWidget *> m_widgets;
    QtUtilities::ClearLineEdit *m_lineEdit;
    QtUtilities::ClearComboBox *m_comboBox;
    QPair<QtUtilities::ClearSpinBox *, QtUtilities::ClearSpinBox *> m_spinBoxes;
    PicturePreviewSelection *m_pictureSelection;
    QtUtilities::ClearPlainTextEdit *m_plainTextEdit;
    QtUtilities::ClearLineEdit *m_descriptionLineEdit;
    QAction *m_restoreAction;
    QAction *m_lockAction;
    bool m_isLocked;
    bool m_autoCorrectionApplied;
};

/// \brief Returns the currently assigned tags.
inline const QList<TagParser::Tag *> &TagFieldEdit::tags() const
{
    return *m_tags;
}

/// \brief Returns the currently assigned field.
inline TagParser::KnownField TagFieldEdit::field() const
{
    return m_field;
}

/// \brief Returns whether the tag field edit is locked to keep the current value when switching files.
inline bool TagFieldEdit::isLocked() const
{
    return m_isLocked;
}

/// \brief Toggles whether the tag field edit is locked to keep the current value when switching files.
inline void TagFieldEdit::toggleLocked()
{
    setLocked(!isLocked());
}

/// \brief Returns whether auto correction has been applied.
inline bool TagFieldEdit::hasAutoCorrectionBeenApplied() const
{
    return m_autoCorrectionApplied;
}

} // namespace QtGui

#endif // QTGUI_TAGFIELDLINEEDIT_H