ProgressJob.h

/*
 *  Copyright (C) 2015-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 "utils/Job.h"

#include <string>

class CGUIDialogProgress;
class CGUIDialogProgressBarHandle;

class CProgressJob : public CJob
{
public:
  ~CProgressJob() override;

  // implementation of CJob
  const char *GetType() const override { return "ProgressJob"; }
  bool operator==(const CJob* job) const override { return false; }
  bool ShouldCancel(unsigned int progress, unsigned int total) const override;

  bool DoModal();

  void SetProgressIndicators(CGUIDialogProgressBarHandle* progressBar, CGUIDialogProgress* progressDialog, bool updateProgress = true, bool updateInformation = true);

  bool HasProgressIndicator() const;

protected:
  CProgressJob();
  explicit CProgressJob(CGUIDialogProgressBarHandle* progressBar);

  bool IsModal() const { return m_modal; }

  CGUIDialogProgressBarHandle* GetProgressBar() const { return m_progress; }

  void SetProgressBar(CGUIDialogProgressBarHandle* progress) { m_progress = progress; }

  CGUIDialogProgress* GetProgressDialog() const { return m_progressDialog; }

  void SetProgressDialog(CGUIDialogProgress* progressDialog) { m_progressDialog = progressDialog; }

  bool GetAutoClose() { return m_autoClose; }

  void SetAutoClose(bool autoClose) { m_autoClose = autoClose; }

  bool GetUpdateProgress() { return m_updateProgress; }

  void SetUpdateProgress(bool updateProgress) { m_updateProgress = updateProgress; }

  bool GetUpdateInformation() { return m_updateInformation; }

  void SetUpdateInformation(bool updateInformation) { m_updateInformation = updateInformation; }

  void ShowProgressDialog() const;

  void SetTitle(const std::string &title);

  void SetText(const std::string &text);

  void SetProgress(float percentage) const;

  void SetProgress(int currentStep, int totalSteps) const;

  void MarkFinished();

  bool IsCancelled() const;

private:
  bool m_modal = false;
  bool m_autoClose = true;
  bool m_updateProgress = true;
  bool m_updateInformation = true;
  mutable CGUIDialogProgressBarHandle* m_progress;
  mutable CGUIDialogProgress* m_progressDialog;
};