// SPDX-FileCopyrightText: 2023 flowln // // SPDX-License-Identifier: GPL-3.0-only #pragma once #include #include #include "modplatform/ModIndex.h" #include "modplatform/ResourceAPI.h" #include "ui/pages/BasePage.h" #include "ui/widgets/ProgressWidget.h" namespace Ui { class ResourcePage; } class BaseInstance; namespace ResourceDownload { class ResourceDownloadDialog; class ResourceModel; class ResourcePage : public QWidget, public BasePage { Q_OBJECT public: ~ResourcePage() override; /* Affects what the user sees */ [[nodiscard]] auto displayName() const -> QString override = 0; [[nodiscard]] auto icon() const -> QIcon override = 0; [[nodiscard]] auto id() const -> QString override = 0; [[nodiscard]] auto helpPage() const -> QString override = 0; [[nodiscard]] bool shouldDisplay() const override = 0; /* Used internally */ [[nodiscard]] virtual auto metaEntryBase() const -> QString = 0; [[nodiscard]] virtual auto debugName() const -> QString = 0; //: The plural version of 'resource' [[nodiscard]] virtual inline QString resourcesString() const { return tr("resources"); } //: The singular version of 'resources' [[nodiscard]] virtual inline QString resourceString() const { return tr("resource"); } /* Features this resource's page supports */ [[nodiscard]] virtual bool supportsFiltering() const = 0; void retranslate() override; void openedImpl() override; auto eventFilter(QObject* watched, QEvent* event) -> bool override; /** Get the current term in the search bar. */ [[nodiscard]] auto getSearchTerm() const -> QString; /** Programatically set the term in the search bar. */ void setSearchTerm(QString); [[nodiscard]] bool setCurrentPack(ModPlatform::IndexedPack); [[nodiscard]] auto getCurrentPack() const -> ModPlatform::IndexedPack; [[nodiscard]] auto getDialog() const -> const ResourceDownloadDialog* { return m_parent_dialog; } [[nodiscard]] auto getModel() const -> ResourceModel* { return m_model; } protected: ResourcePage(ResourceDownloadDialog* parent, BaseInstance&); void addSortings(); public slots: virtual void updateUi(); virtual void updateSelectionButton(); virtual void updateVersionList(); virtual void addResourceToDialog(ModPlatform::IndexedPack&, ModPlatform::IndexedVersion&); virtual void removeResourceFromDialog(ModPlatform::IndexedPack&, ModPlatform::IndexedVersion&); virtual void removeResourceFromPage(QString& name); protected slots: virtual void triggerSearch() {} void onSelectionChanged(QModelIndex first, QModelIndex second); void onVersionSelectionChanged(QString data); void onResourceSelected(); // NOTE: Can't use [[nodiscard]] here because of https://bugreports.qt.io/browse/QTBUG-58628 on Qt 5.12 /** Associates regex expressions to pages in the order they're given in the map. */ virtual QMap urlHandlers() const = 0; virtual void openUrl(const QUrl&); /** Whether the version is opted out or not. Currently only makes sense in CF. */ virtual bool optedOut(ModPlatform::IndexedVersion& ver) const { return false; }; public: BaseInstance& m_base_instance; protected: Ui::ResourcePage* m_ui; ResourceDownloadDialog* m_parent_dialog = nullptr; ResourceModel* m_model = nullptr; int m_selected_version_index = -1; ProgressWidget m_fetch_progress; // Used to do instant searching with a delay to cache quick changes QTimer m_search_timer; }; } // namespace ResourceDownload