JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
ThreadWithProgressWindow Class Reference

A thread that automatically pops up a modal dialog box with a progress bar and cancel button while it's busy running. More...

Inherits Thread, and Timer.

Public Member Functions

 ThreadWithProgressWindow (const String &windowTitle, bool hasProgressBar, bool hasCancelButton, int timeOutMsWhenCancelling=10000, const String &cancelButtonText=String(), Component *componentToCentreAround=nullptr)
 Creates the thread.
 
 ~ThreadWithProgressWindow ()
 Destructor.
 
void launchThread (int threadPriority=5)
 Starts the thread and returns.
 
void setProgress (double newProgress)
 The thread should call this periodically to update the position of the progress bar.
 
void setStatusMessage (const String &newStatusMessage)
 The thread can call this to change the message that's displayed in the dialog box.
 
AlertWindowgetAlertWindow () const noexcept
 Returns the AlertWindow that is being used.
 
virtual void threadComplete (bool userPressedCancel)
 This method is called (on the message thread) when the operation has finished.
 
- Public Member Functions inherited from Thread
 Thread (const String &threadName)
 Creates a thread.
 
virtual ~Thread ()
 Destructor.
 
virtual void run ()=0
 Must be implemented to perform the thread's actual code.
 
void startThread ()
 Starts the thread running.
 
void startThread (int priority)
 Starts the thread with a given priority.
 
bool stopThread (int timeOutMilliseconds)
 Attempts to stop the thread running.
 
bool isThreadRunning () const
 Returns true if the thread is currently active.
 
void signalThreadShouldExit ()
 Sets a flag to tell the thread it should stop.
 
bool threadShouldExit () const
 Checks whether the thread has been told to stop running.
 
bool waitForThreadToExit (int timeOutMilliseconds) const
 Waits for the thread to stop.
 
bool setPriority (int priority)
 Changes the thread's priority.
 
void setAffinityMask (uint32 affinityMask)
 Sets the affinity mask for the thread.
 
bool wait (int timeOutMilliseconds) const
 Makes the thread wait for a notification.
 
void notify () const
 Wakes up the thread.
 
ThreadID getThreadId () const noexcept
 Returns the ID of this thread.
 
const StringgetThreadName () const
 Returns the name of the thread.
 

Additional Inherited Members

- Public Types inherited from Thread
typedef void * ThreadID
 A value type used for thread IDs.
 
- Static Public Member Functions inherited from Thread
static bool setCurrentThreadPriority (int priority)
 Changes the priority of the caller thread.
 
static void JUCE_CALLTYPE setCurrentThreadAffinityMask (uint32 affinityMask)
 Changes the affinity mask for the caller thread.
 
static void JUCE_CALLTYPE sleep (int milliseconds)
 
static void JUCE_CALLTYPE yield ()
 Yields the calling thread's current time-slot.
 
static ThreadID JUCE_CALLTYPE getCurrentThreadId ()
 Returns an id that identifies the caller thread.
 
static Thread *JUCE_CALLTYPE getCurrentThread ()
 Finds the thread object that is currently running.
 
static void JUCE_CALLTYPE setCurrentThreadName (const String &newThreadName)
 Changes the name of the caller thread.
 
- Private Member Functions inherited from Timer
virtual ~Timer ()
 Destructor.
 
void startTimer (int intervalInMilliseconds) noexcept
 Starts the timer and sets the length of interval required.
 
void startTimerHz (int timerFrequencyHz) noexcept
 Starts the timer with an interval specified in Hertz.
 
void stopTimer () noexcept
 Stops the timer.
 
bool isTimerRunning () const noexcept
 Returns true if the timer is currently running.
 
int getTimerInterval () const noexcept
 Returns the timer's interval.
 
 Timer () noexcept
 Creates a Timer.
 
 Timer (const Timer &other) noexcept
 Creates a copy of another timer.
 
- Static Private Member Functions inherited from Timer
static void JUCE_CALLTYPE callPendingTimersSynchronously ()
 For internal use only: invokes any timers that need callbacks.
 

Detailed Description

A thread that automatically pops up a modal dialog box with a progress bar and cancel button while it's busy running.

These are handy for performing some sort of task while giving the user feedback about how long there is to go, etc.

E.g.

class MyTask : public ThreadWithProgressWindow
{
public:
MyTask() : ThreadWithProgressWindow ("busy...", true, true)
{
}
void run()
{
for (int i = 0; i < thingsToDo; ++i)
{
// must check this as often as possible, because this is
// how we know if the user's pressed 'cancel'
break;
// this will update the progress bar on the dialog box
setProgress (i / (double) thingsToDo);
// ... do the business here...
}
}
};
void doTheTask()
{
MyTask m;
if (m.runThread())
{
// thread finished normally..
}
else
{
// user pressed the cancel button..
}
}
See Also
Thread, AlertWindow

Constructor & Destructor Documentation

ThreadWithProgressWindow::ThreadWithProgressWindow ( const String windowTitle,
bool  hasProgressBar,
bool  hasCancelButton,
int  timeOutMsWhenCancelling = 10000,
const String cancelButtonText = String(),
Component componentToCentreAround = nullptr 
)

Creates the thread.

Initially, the dialog box won't be visible, it'll only appear when the runThread() method is called.

Parameters
windowTitlethe title to go at the top of the dialog box
hasProgressBarwhether the dialog box should have a progress bar (see setProgress() )
hasCancelButtonwhether the dialog box should have a cancel button
timeOutMsWhenCancellingwhen 'cancel' is pressed, this is how long to wait for the thread to stop before killing it forcibly (see Thread::stopThread() )
cancelButtonTextthe text that should be shown in the cancel button (if it has one). Leave this empty for the default "Cancel"
componentToCentreAroundif this is non-null, the window will be positioned so that it's centred around this component.
ThreadWithProgressWindow::~ThreadWithProgressWindow ( )

Destructor.

Member Function Documentation

void ThreadWithProgressWindow::launchThread ( int  threadPriority = 5)

Starts the thread and returns.

This will start the thread and make the dialog box appear in a modal state. When the thread finishes normally, or the cancel button is pressed, the window will be hidden and the threadComplete() method will be called.

Parameters
threadPrioritythe priority to use when starting the thread - see Thread::startThread() for values
void ThreadWithProgressWindow::setProgress ( double  newProgress)

The thread should call this periodically to update the position of the progress bar.

Parameters
newProgressthe progress, from 0.0 to 1.0
See Also
setStatusMessage
void ThreadWithProgressWindow::setStatusMessage ( const String newStatusMessage)

The thread can call this to change the message that's displayed in the dialog box.

AlertWindow* ThreadWithProgressWindow::getAlertWindow ( ) const
noexcept

Returns the AlertWindow that is being used.

virtual void ThreadWithProgressWindow::threadComplete ( bool  userPressedCancel)
virtual

This method is called (on the message thread) when the operation has finished.

You may choose to use this callback to delete the ThreadWithProgressWindow object.


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