xbmc/music/jobs/MusicLibraryImportJob.h

   1 /*
   2 *  Copyright (C) 2017-2018 Team Kodi
   3 *  This file is part of Kodi - https://kodi.tv
   4 *
   5 *  SPDX-License-Identifier: GPL-2.0-or-later
   6 *  See LICENSES/README.md for more information.
   7 */
   8
   9 #pragma once
  10
  11 #include "MusicLibraryProgressJob.h"
  12
  13 class CGUIDialogProgress;
  14
  15 /*!
  16 \brief Music library job implementation for importing data to the music library.
  17 */
  18 class CMusicLibraryImportJob : public CMusicLibraryProgressJob
  19 {
  20 public:
  21   /*!
  22   \brief Creates a new music library import job for the given xml file.
  23
  24   \param[in] xmlFile       xml file to import
  25   \param[in] progressDialog Progress dialog to be used to display the import progress
  26   */
  27   CMusicLibraryImportJob(const std::string &xmlFile, CGUIDialogProgress* progressDialog);
  28
  29   ~CMusicLibraryImportJob() override;
  30
  31   // specialization of CJob
  32   const char *GetType() const override { return "MusicLibraryImportJob"; }
  33   bool operator==(const CJob* job) const override;
  34
  35 protected:
  36   // implementation of CMusicLibraryJob
  37   bool Work(CMusicDatabase &db) override;
  38
  39 private:
  40   std::string m_xmlFile;
  41 };
  42