GUIDialogProgress.h

/*
 *  Copyright (C) 2005-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 "GUIDialogBoxBase.h"
#include "IProgressCallback.h"

#include <array>

class CGUIDialogProgress :
      public CGUIDialogBoxBase, public IProgressCallback
{
public:
  CGUIDialogProgress(void);
  ~CGUIDialogProgress(void) override;

  void Reset();
  void Open(const std::string &param = "");
  bool OnMessage(CGUIMessage& message) override;
  bool OnBack(int actionID) override;
  void OnWindowLoaded() override;
  void Progress();
  bool IsCanceled() const { return m_iChoice == CHOICE_CANCELED; }
  void SetPercentage(int iPercentage);
  int GetPercentage() const { return m_percentage; }
  void ShowProgressBar(bool bOnOff);

  void ShowChoice(int iChoice, const CVariant& label);

  static constexpr int CHOICE_NONE = -2;
  static constexpr int CHOICE_CANCELED = -1;
  int GetChoice() const;

  bool Wait(int progresstime = 10);

  bool WaitOnEvent(CEvent& event);

  // Implements IProgressCallback
  void SetProgressMax(int iMax) override;
  void SetProgressAdvance(int nSteps=1) override;
  bool Abort() override;

  void SetCanCancel(bool bCanCancel);

protected:
  void OnInitWindow() override;
  int GetDefaultLabelID(int controlId) const override;
  void Process(unsigned int currentTime, CDirtyRegionList &dirtyregions) override;

  bool m_bCanCancel;

  int  m_iCurrent;
  int  m_iMax;
  int m_percentage;
  bool m_showProgress;

  std::array<bool, DIALOG_MAX_CHOICES> m_supportedChoices = {};
  int m_iChoice = CHOICE_NONE;

private:
  void UpdateControls();
};