summaryrefslogtreecommitdiffstats
path: root/xbmc/video/jobs/VideoLibraryCleaningJob.h
blob: f85682c5c4e6c59c986ad177f0fb8187b79fe47e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*
 *  Copyright (C) 2014-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 "video/jobs/VideoLibraryProgressJob.h"

#include <set>

class CGUIDialogProgressBarHandle;

/*!
 \brief Video library job implementation for cleaning the video library.
*/
class CVideoLibraryCleaningJob : public CVideoLibraryProgressJob
{
public:
  /*!
   \brief Creates a new video library cleaning job for the given paths.

   \param[in] paths Set with database IDs of paths to be cleaned
   \param[in] showDialog Whether to show a modal dialog or not
  */
  CVideoLibraryCleaningJob(const std::set<int>& paths = std::set<int>(), bool showDialog = false);

  /*!
  \brief Creates a new video library cleaning job for the given paths.

  \param[in] paths Set with database IDs of paths to be cleaned
  \param[in] progressBar Progress bar to be used to display the cleaning progress
  */
  CVideoLibraryCleaningJob(const std::set<int>& paths, CGUIDialogProgressBarHandle* progressBar);
  ~CVideoLibraryCleaningJob() override;

  // specialization of CJob
  const char *GetType() const override { return "VideoLibraryCleaningJob"; }
  bool operator==(const CJob* job) const override;

protected:
  // implementation of CVideoLibraryJob
  bool Work(CVideoDatabase &db) override;

private:
  std::set<int> m_paths;
  bool m_showDialog;
};