summaryrefslogtreecommitdiffstats
path: root/xbmc/music/dialogs/GUIDialogInfoProviderSettings.h
diff options
context:
space:
mode:
Diffstat (limited to 'xbmc/music/dialogs/GUIDialogInfoProviderSettings.h')
-rw-r--r--xbmc/music/dialogs/GUIDialogInfoProviderSettings.h92
1 files changed, 92 insertions, 0 deletions
diff --git a/xbmc/music/dialogs/GUIDialogInfoProviderSettings.h b/xbmc/music/dialogs/GUIDialogInfoProviderSettings.h
new file mode 100644
index 0000000..56a33b5
--- /dev/null
+++ b/xbmc/music/dialogs/GUIDialogInfoProviderSettings.h
@@ -0,0 +1,92 @@
+/*
+ * Copyright (C) 2017-2018 Team Kodi
+ * This file is part of Kodi - https://kodi.tv
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ * See LICENSES/README.md for more information.
+ */
+
+#pragma once
+
+#include "addons/Addon.h"
+#include "addons/Scraper.h"
+#include "settings/dialogs/GUIDialogSettingsManualBase.h"
+
+#include <map>
+#include <utility>
+
+class CFileItemList;
+
+// Enumeration of what combination of items to apply the scraper settings
+enum INFOPROVIDERAPPLYOPTIONS
+{
+ INFOPROVIDER_DEFAULT = 0x0000,
+ INFOPROVIDER_ALLVIEW = 0x0001,
+ INFOPROVIDER_THISITEM = 0x0002
+};
+
+class CGUIDialogInfoProviderSettings : public CGUIDialogSettingsManualBase
+{
+public:
+ CGUIDialogInfoProviderSettings();
+
+ // specialization of CGUIWindow
+ bool HasListItems() const override { return true; }
+
+ const ADDON::ScraperPtr& GetAlbumScraper() const { return m_albumscraper; }
+ void SetAlbumScraper(ADDON::ScraperPtr scraper) { m_albumscraper = std::move(scraper); }
+ const ADDON::ScraperPtr& GetArtistScraper() const { return m_artistscraper; }
+ void SetArtistScraper(ADDON::ScraperPtr scraper) { m_artistscraper = std::move(scraper); }
+
+ /*! \brief Show dialog to change information provider for either artists or albums (not both).
+ Has a list to select how settings are to be applied - as system default, to just current item or to all the filtered items on the node.
+ This does not save the settings itself, that is left to the caller
+ \param scraper [in/out] the selected scraper addon and settings. Scraper content must be artists or albums.
+ \return 0 settings apply as system default, 1 to all items on node, 2 to just the selected item or -1 if dialog cancelled or error occurs
+ */
+ static int Show(ADDON::ScraperPtr& scraper);
+
+ /*! \brief Show dialog to change the music scraping settings including default information providers for both artists or albums.
+ This saves the settings when the dialog is confirmed.
+ \return true if the dialog is confirmed, false otherwise
+ */
+ static bool Show();
+
+protected:
+ // specializations of CGUIWindow
+ void OnInitWindow() override;
+
+ // implementations of ISettingCallback
+ void OnSettingChanged(const std::shared_ptr<const CSetting>& setting) override;
+ void OnSettingAction(const std::shared_ptr<const CSetting>& setting) override;
+
+ // specialization of CGUIDialogSettingsBase
+ bool AllowResettingSettings() const override { return false; }
+ bool Save() override;
+ void SetupView() override;
+
+ // specialization of CGUIDialogSettingsManualBase
+ void InitializeSettings() override;
+
+private:
+ void SetLabel2(const std::string &settingid, const std::string &label);
+ void ToggleState(const std::string &settingid, bool enabled);
+ using CGUIDialogSettingsManualBase::SetFocus;
+ void SetFocus(const std::string &settingid);
+ void ResetDefaults();
+
+ /*!
+ * @brief The currently selected album scraper
+ */
+ ADDON::ScraperPtr m_albumscraper;
+ /*!
+ * @brief The currently selected artist scraper
+ */
+ ADDON::ScraperPtr m_artistscraper;
+
+ std::string m_strArtistInfoPath;
+ bool m_showSingleScraper = false;
+ CONTENT_TYPE m_singleScraperType = CONTENT_NONE;
+ bool m_fetchInfo;
+ unsigned int m_applyToItems = INFOPROVIDER_THISITEM;
+};