Progress.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 "../../AddonBase.h"
#include "../../c-api/gui/dialogs/progress.h"
 
#ifdef __cplusplus
 
namespace kodi
{
namespace gui
{
namespace dialogs
{
 
//==============================================================================
class ATTR_DLL_LOCAL CProgress
{
public:
  //============================================================================
  CProgress()
  {
    using namespace ::kodi::addon;
    m_DialogHandle = CPrivateBase::m_interface->toKodi->kodi_gui->dialogProgress->new_dialog(
        CPrivateBase::m_interface->toKodi->kodiBase);
    if (!m_DialogHandle)
      kodi::Log(ADDON_LOG_FATAL,
                "kodi::gui::dialogs::CProgress can't create window class from Kodi !!!");
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  ~CProgress()
  {
    using namespace ::kodi::addon;
    if (m_DialogHandle)
      CPrivateBase::m_interface->toKodi->kodi_gui->dialogProgress->delete_dialog(
          CPrivateBase::m_interface->toKodi->kodiBase, m_DialogHandle);
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void Open()
  {
    using namespace ::kodi::addon;
    CPrivateBase::m_interface->toKodi->kodi_gui->dialogProgress->open(
        CPrivateBase::m_interface->toKodi->kodiBase, m_DialogHandle);
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetHeading(const std::string& heading)
  {
    using namespace ::kodi::addon;
    CPrivateBase::m_interface->toKodi->kodi_gui->dialogProgress->set_heading(
        CPrivateBase::m_interface->toKodi->kodiBase, m_DialogHandle, heading.c_str());
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetLine(unsigned int iLine, const std::string& line)
  {
    using namespace ::kodi::addon;
    CPrivateBase::m_interface->toKodi->kodi_gui->dialogProgress->set_line(
        CPrivateBase::m_interface->toKodi->kodiBase, m_DialogHandle, iLine, line.c_str());
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetCanCancel(bool canCancel)
  {
    using namespace ::kodi::addon;
    CPrivateBase::m_interface->toKodi->kodi_gui->dialogProgress->set_can_cancel(
        CPrivateBase::m_interface->toKodi->kodiBase, m_DialogHandle, canCancel);
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  bool IsCanceled() const
  {
    using namespace ::kodi::addon;
    return CPrivateBase::m_interface->toKodi->kodi_gui->dialogProgress->is_canceled(
        CPrivateBase::m_interface->toKodi->kodiBase, m_DialogHandle);
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetPercentage(int percentage)
  {
    using namespace ::kodi::addon;
    CPrivateBase::m_interface->toKodi->kodi_gui->dialogProgress->set_percentage(
        CPrivateBase::m_interface->toKodi->kodiBase, m_DialogHandle, percentage);
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  int GetPercentage() const
  {
    using namespace ::kodi::addon;
    return CPrivateBase::m_interface->toKodi->kodi_gui->dialogProgress->get_percentage(
        CPrivateBase::m_interface->toKodi->kodiBase, m_DialogHandle);
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void ShowProgressBar(bool onOff)
  {
    using namespace ::kodi::addon;
    CPrivateBase::m_interface->toKodi->kodi_gui->dialogProgress->show_progress_bar(
        CPrivateBase::m_interface->toKodi->kodiBase, m_DialogHandle, onOff);
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetProgressMax(int max)
  {
    using namespace ::kodi::addon;
    CPrivateBase::m_interface->toKodi->kodi_gui->dialogProgress->set_progress_max(
        CPrivateBase::m_interface->toKodi->kodiBase, m_DialogHandle, max);
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  void SetProgressAdvance(int steps = 1)
  {
    using namespace ::kodi::addon;
    CPrivateBase::m_interface->toKodi->kodi_gui->dialogProgress->set_progress_advance(
        CPrivateBase::m_interface->toKodi->kodiBase, m_DialogHandle, steps);
  }
  //----------------------------------------------------------------------------
 
  //============================================================================
  bool Abort()
  {
    using namespace ::kodi::addon;
    return CPrivateBase::m_interface->toKodi->kodi_gui->dialogProgress->abort(
        CPrivateBase::m_interface->toKodi->kodiBase, m_DialogHandle);
  }
  //----------------------------------------------------------------------------
 
private:
  KODI_GUI_HANDLE m_DialogHandle;
};
 
} /* namespace dialogs */
} /* namespace gui */
} /* namespace kodi */
 
#endif /* __cplusplus */