CGUIDialogBusy Class Reference

#include <GUIDialogBusy.h>

Inheritance diagram for CGUIDialogBusy:

Static Public Member Functions
static bool	Wait (IRunnable *runnable, unsigned int displaytime, bool allowCancel)
	Wait for a runnable to execute off-thread. Creates a thread to run the given runnable, and while waiting it displays the busy dialog.
static bool	WaitOnEvent (CEvent &event, unsigned int displaytime=100, bool allowCancel=true)
	Wait on an event while displaying the busy dialog. Throws up the busy dialog after the given time.

Friends
class	CGUIWindowManager

Member Function Documentation

Wait()

bool CGUIDialogBusy::Wait ( IRunnable * runnable, unsigned int displaytime, bool allowCancel )

static

Wait for a runnable to execute off-thread. Creates a thread to run the given runnable, and while waiting it displays the busy dialog.

Parameters

runnable	the IRunnable to run.
displaytime	the time in ms to wait prior to showing the busy dialog (defaults to 100ms)
allowCancel	whether the user can cancel the wait, defaults to true.

Returns

true if the runnable completes, false if the user cancels early.

WaitOnEvent()

bool CGUIDialogBusy::WaitOnEvent ( CEvent & event, unsigned int displaytime = 100, bool allowCancel = true )

static

Wait on an event while displaying the busy dialog. Throws up the busy dialog after the given time.

Parameters

event	the CEvent to wait on.
displaytime	the time in ms to wait prior to showing the busy dialog (defaults to 100ms)
allowCancel	whether the user can cancel the wait, defaults to true.

Returns

true if the event completed, false if cancelled.

Friends And Related Symbol Documentation

CGUIWindowManager

friend class CGUIWindowManager

friend

---

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

• GUIDialogBusy.h
• GUIDialogBusy.cpp