Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.
CGUIDialogCache Class Reference

#include <GUIDialogCache.h>

Inheritance diagram for CGUIDialogCache:
CThread XFILE::IFileCallback

Public Member Functions

 CGUIDialogCache (DWORD dwDelay=0, const std::string &strHeader="", const std::string &strMsg="")
 
 ~CGUIDialogCache () override
 
void SetHeader (const std::string &strHeader)
 
void SetHeader (int nHeader)
 
void SetMessage (const std::string &strMessage)
 
bool IsCanceled () const
 
void ShowProgressBar (bool bOnOff)
 
void SetPercentage (int iPercentage)
 
void Close (bool bForceClose=false)
 
void Process () override
 
bool OnFileCallback (void *pContext, int ipercent, float avgSpeed) override
 
- Public Member Functions inherited from CThread
 CThread (IRunnable *pRunnable, const char *ThreadName)
 
virtual ~CThread ()
 
void Create (bool bAutoDelete=false, unsigned stacksize=0)
 
void Sleep (unsigned int milliseconds)
 
int GetSchedRRPriority (void)
 
bool SetPrioritySched_RR (int iPriority)
 
bool IsAutoDelete () const
 
virtual void StopThread (bool bWait=true)
 
bool IsRunning () const
 
bool IsCurrentThread () const
 
int GetMinPriority (void)
 
int GetMaxPriority (void)
 
int GetNormalPriority (void)
 
int GetPriority (void)
 
bool SetPriority (const int iPriority)
 
bool WaitForThreadExit (unsigned int milliseconds)
 
float GetRelativeUsage ()
 
int64_t GetAbsoluteUsage ()
 
virtual void OnException ()
 
- Public Member Functions inherited from XFILE::IFileCallback
virtual ~IFileCallback ()=default
 

Protected Member Functions

void OpenDialog ()
 
- Protected Member Functions inherited from CThread
 CThread (const char *ThreadName)
 
virtual void OnStartup ()
 
virtual void OnExit ()
 
WaitResponse AbortableWait (CEvent &event, int timeoutMillis=-1)
 

Protected Attributes

XbmcThreads::EndTime m_endtime
 
CGUIDialogProgressm_pDlg
 
std::string m_strHeader
 
std::string m_strLinePrev
 
std::string m_strLinePrev2
 
bool bSentCancel
 
- Protected Attributes inherited from CThread
std::atomic< bool > m_bStop
 

Additional Inherited Members

- Static Public Member Functions inherited from CThread
static bool IsCurrentThread (const ThreadIdentifier tid)
 
static ThreadIdentifier GetCurrentThreadId ()
 
static ThreadIdentifier GetDisplayThreadId (const ThreadIdentifier tid)
 
static CThreadGetCurrentThread ()
 
- Protected Types inherited from CThread
enum  WaitResponse { WAIT_INTERRUPTED = -1 , WAIT_SIGNALED = 0 , WAIT_TIMEDOUT = 1 }
 

Constructor & Destructor Documentation

◆ CGUIDialogCache()

CGUIDialogCache::CGUIDialogCache ( DWORD  dwDelay = 0,
const std::string &  strHeader = "",
const std::string &  strMsg = "" 
)

◆ ~CGUIDialogCache()

CGUIDialogCache::~CGUIDialogCache ( )
override

Member Function Documentation

◆ Close()

void CGUIDialogCache::Close ( bool  bForceClose = false)

◆ IsCanceled()

bool CGUIDialogCache::IsCanceled ( ) const

◆ OnFileCallback()

bool CGUIDialogCache::OnFileCallback ( void pContext,
int  ipercent,
float  avgSpeed 
)
overridevirtual

Implements XFILE::IFileCallback.

◆ OpenDialog()

void CGUIDialogCache::OpenDialog ( )
protected

◆ Process()

void CGUIDialogCache::Process ( void  )
overridevirtual

Reimplemented from CThread.

◆ SetHeader() [1/2]

void CGUIDialogCache::SetHeader ( const std::string &  strHeader)

◆ SetHeader() [2/2]

void CGUIDialogCache::SetHeader ( int  nHeader)

◆ SetMessage()

void CGUIDialogCache::SetMessage ( const std::string &  strMessage)

◆ SetPercentage()

void CGUIDialogCache::SetPercentage ( int  iPercentage)

◆ ShowProgressBar()

void CGUIDialogCache::ShowProgressBar ( bool  bOnOff)

Member Data Documentation

◆ bSentCancel

bool CGUIDialogCache::bSentCancel
protected

◆ m_endtime

XbmcThreads::EndTime CGUIDialogCache::m_endtime
protected

◆ m_pDlg

CGUIDialogProgress* CGUIDialogCache::m_pDlg
protected

◆ m_strHeader

std::string CGUIDialogCache::m_strHeader
protected

◆ m_strLinePrev

std::string CGUIDialogCache::m_strLinePrev
protected

◆ m_strLinePrev2

std::string CGUIDialogCache::m_strLinePrev2
protected

The documentation for this class was generated from the following files: