summaryrefslogtreecommitdiffstats
path: root/xbmc/pvr/guilib/PVRGUIProgressHandler.h
blob: 6e7b72f20e51ceac9edf24793cd8f9f45a4700fa (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
52
53
54
55
56
57
58
59
/*
 *  Copyright (C) 2017-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 "threads/CriticalSection.h"
#include "threads/Thread.h"

#include <string>

namespace PVR
{
  class CPVRGUIProgressHandler : private CThread
  {
  public:
    CPVRGUIProgressHandler() = delete;

    /*!
     * @brief Creates and asynchronously shows a progress dialog with the given title.
     * @param strTitle The title for the progress dialog.
     */
    explicit CPVRGUIProgressHandler(const std::string& strTitle);

    ~CPVRGUIProgressHandler() override = default;

    /*!
     * @brief Update the progress dialogs's content.
     * @param strText The new progress text.
     * @param fProgress The new progress value, in a range from 0.0 to 100.0.
     */
    void UpdateProgress(const std::string& strText, float fProgress);

    /*!
     * @brief Update the progress dialogs's content.
     * @param strText The new progress text.
     * @param iCurrent The new current progress value, must be less or equal iMax.
     * @param iMax The new maximum progress value, must be greater or equal iCurrent.
     */
    void UpdateProgress(const std::string& strText, int iCurrent, int iMax);

  protected:
    // CThread implementation
    void Process() override;

  private:
    CCriticalSection m_critSection;
    const std::string m_strTitle;
    std::string m_strText;
    float m_fProgress{0.0f};
    bool m_bChanged{false};
    bool m_bCreated{false};
  };

} // namespace PVR