openshot-audio
0.1.7
|
#include <juce_gui_basics.h>
Public Member Functions | |
ThreadWithProgressWindow (const String &windowTitle, bool hasProgressBar, bool hasCancelButton, int timeOutMsWhenCancelling=10000, const String &cancelButtonText=String(), Component *componentToCentreAround=nullptr) | |
~ThreadWithProgressWindow () | |
bool | runThread (int threadPriority=5) |
void | launchThread (int threadPriority=5) |
void | setProgress (double newProgress) |
void | setStatusMessage (const String &newStatusMessage) |
AlertWindow * | getAlertWindow () const noexcept |
virtual void | threadComplete (bool userPressedCancel) |
![]() | |
Thread (const String &threadName) | |
virtual | ~Thread () |
virtual void | run ()=0 |
void | startThread () |
void | startThread (int priority) |
bool | stopThread (int timeOutMilliseconds) |
bool | isThreadRunning () const |
void | signalThreadShouldExit () |
bool | threadShouldExit () const |
bool | waitForThreadToExit (int timeOutMilliseconds) const |
bool | setPriority (int priority) |
void | setAffinityMask (uint32 affinityMask) |
bool | wait (int timeOutMilliseconds) const |
void | notify () const |
ThreadID | getThreadId () const noexcept |
const String & | getThreadName () const |
Additional Inherited Members | |
![]() | |
typedef void * | ThreadID |
![]() | |
static bool | setCurrentThreadPriority (int priority) |
static void JUCE_CALLTYPE | setCurrentThreadAffinityMask (uint32 affinityMask) |
static void JUCE_CALLTYPE | sleep (int milliseconds) |
static void JUCE_CALLTYPE | yield () |
static ThreadID JUCE_CALLTYPE | getCurrentThreadId () |
static Thread *JUCE_CALLTYPE | getCurrentThread () |
static void JUCE_CALLTYPE | setCurrentThreadName (const String &newThreadName) |
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.
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.
windowTitle | the title to go at the top of the dialog box |
hasProgressBar | whether the dialog box should have a progress bar (see setProgress() ) |
hasCancelButton | whether the dialog box should have a cancel button |
timeOutMsWhenCancelling | when 'cancel' is pressed, this is how long to wait for the thread to stop before killing it forcibly (see Thread::stopThread() ) |
cancelButtonText | the text that should be shown in the cancel button (if it has one). Leave this empty for the default "Cancel" |
componentToCentreAround | if this is non-null, the window will be positioned so that it's centred around this component. |
ThreadWithProgressWindow::~ThreadWithProgressWindow | ( | ) |
Destructor.
|
inlinenoexcept |
Returns the AlertWindow that is being used.
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.
threadPriority | the priority to use when starting the thread - see Thread::startThread() for values |
bool ThreadWithProgressWindow::runThread | ( | int | threadPriority = 5 | ) |
Starts the thread and waits for it to finish.
This will start the thread, make the dialog box appear, and wait until either the thread finishes normally, or until the cancel button is pressed.
Before returning, the dialog box will be hidden.
threadPriority | the 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.
newProgress | the progress, from 0.0 to 1.0 |
void ThreadWithProgressWindow::setStatusMessage | ( | const String & | newStatusMessage | ) |
The thread can call this to change the message that's displayed in the dialog box.
|
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.