openshot-audio  0.1.2
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
JUCEApplicationBase Class Referenceabstract

#include <juce_ApplicationBase.h>

Inheritance diagram for JUCEApplicationBase:
JUCEApplication

Classes

struct  MultipleInstanceHandler
 

Public Types

typedef JUCEApplicationBase *(* CreateInstanceFunction) ()
 

Public Member Functions

virtual ~JUCEApplicationBase ()
 
virtual const String getApplicationName ()=0
 
virtual const String getApplicationVersion ()=0
 
virtual bool moreThanOneInstanceAllowed ()=0
 
virtual void initialise (const String &commandLineParameters)=0
 
virtual void shutdown ()=0
 
virtual void anotherInstanceStarted (const String &commandLine)=0
 
virtual void systemRequestedQuit ()=0
 
virtual void suspended ()=0
 
virtual void resumed ()=0
 
virtual void unhandledException (const std::exception *, const String &sourceFilename, int lineNumber)=0
 
void setApplicationReturnValue (int newReturnValue) noexcept
 
int getApplicationReturnValue () const noexcept
 
bool isInitialising () const noexcept
 
virtual bool initialiseApp ()
 
int shutdownApp ()
 
bool sendCommandLineToPreexistingInstance ()
 

Static Public Member Functions

static JUCEApplicationBasegetInstance () noexcept
 
static void quit ()
 
static StringArray JUCE_CALLTYPE getCommandLineParameterArray ()
 
static String JUCE_CALLTYPE getCommandLineParameters ()
 
static bool isStandaloneApp () noexcept
 
static int main ()
 
static int main (int argc, const char *argv[])
 
static void appWillTerminateByForce ()
 
static void JUCE_CALLTYPE sendUnhandledException (const std::exception *, const char *sourceFile, int lineNumber)
 

Static Public Attributes

static CreateInstanceFunction createInstance = 0
 

Protected Member Functions

 JUCEApplicationBase ()
 

Friends

struct MultipleInstanceHandler
 
struct ContainerDeletePolicy< MultipleInstanceHandler >
 

Detailed Description

Abstract base class for application classes.

Note that in the juce_gui_basics module, there's a utility class JUCEApplication which derives from JUCEApplicationBase, and takes care of a few chores. Most of the time you'll want to derive your class from JUCEApplication rather than using JUCEApplicationBase directly, but if you're not using the juce_gui_basics module then you might need to go straight to this base class.

Any application that wants to run an event loop must declare a subclass of JUCEApplicationBase, and implement its various pure virtual methods.

It then needs to use the START_JUCE_APPLICATION macro somewhere in a CPP file to declare an instance of this class and generate suitable platform-specific boilerplate code to launch the app.

e.g.

class MyJUCEApp : public JUCEApplication
{
public:
MyJUCEApp() {}
~MyJUCEApp() {}
void initialise (const String& commandLine) override
{
myMainWindow = new MyApplicationWindow();
myMainWindow->setBounds (100, 100, 400, 500);
myMainWindow->setVisible (true);
}
void shutdown() override
{
myMainWindow = nullptr;
}
const String getApplicationName() override
{
return "Super JUCE-o-matic";
}
const String getApplicationVersion() override
{
return "1.0";
}
private:
};
// this generates boilerplate code to launch our app class:
See also
JUCEApplication, START_JUCE_APPLICATION

Member Typedef Documentation

typedef JUCEApplicationBase*(* JUCEApplicationBase::CreateInstanceFunction) ()

Constructor & Destructor Documentation

JUCEApplicationBase::JUCEApplicationBase ( )
protected
JUCEApplicationBase::~JUCEApplicationBase ( )
virtual

Destructor.

Member Function Documentation

virtual void JUCEApplicationBase::anotherInstanceStarted ( const String commandLine)
pure virtual

Indicates that the user has tried to start up another instance of the app.

This will get called even if moreThanOneInstanceAllowed() is false.

Implemented in JUCEApplication.

void JUCEApplicationBase::appWillTerminateByForce ( )
static
virtual const String JUCEApplicationBase::getApplicationName ( )
pure virtual

Returns the application's name.

int JUCEApplicationBase::getApplicationReturnValue ( ) const
inlinenoexcept

Returns the value that has been set as the application's exit code.

See also
setApplicationReturnValue
virtual const String JUCEApplicationBase::getApplicationVersion ( )
pure virtual

Returns the application's version number.

StringArray JUCEApplicationBase::getCommandLineParameterArray ( )
static

Returns the application's command line parameters as a set of strings.

See also
getCommandLineParameters
String JUCEApplicationBase::getCommandLineParameters ( )
static

Returns the application's command line parameters as a single string.

See also
getCommandLineParameterArray
static JUCEApplicationBase* JUCEApplicationBase::getInstance ( )
inlinestaticnoexcept

Returns the global instance of the application object that's running.

virtual void JUCEApplicationBase::initialise ( const String commandLineParameters)
pure virtual

Called when the application starts.

This will be called once to let the application do whatever initialisation it needs, create its windows, etc.

After the method returns, the normal event-dispatch loop will be run, until the quit() method is called, at which point the shutdown() method will be called to let the application clear up anything it needs to delete.

If during the initialise() method, the application decides not to start-up after all, it can just call the quit() method and the event loop won't be run.

Parameters
commandLineParametersthe line passed in does not include the name of the executable, just the parameter list. To get the parameters as an array, you can call JUCEApplication::getCommandLineParameters()
See also
shutdown, quit
bool JUCEApplicationBase::initialiseApp ( )
virtual
bool JUCEApplicationBase::isInitialising ( ) const
inlinenoexcept

Returns true if the application hasn't yet completed its initialise() method and entered the main event loop.

This is handy for things like splash screens to know when the app's up-and-running properly.

static bool JUCEApplicationBase::isStandaloneApp ( )
inlinestaticnoexcept

Returns true if this executable is running as an app (as opposed to being a plugin or other kind of shared library.

int JUCEApplicationBase::main ( )
static
int JUCEApplicationBase::main ( int  argc,
const char *  argv[] 
)
static
virtual bool JUCEApplicationBase::moreThanOneInstanceAllowed ( )
pure virtual

Checks whether multiple instances of the app are allowed.

If you application class returns true for this, more than one instance is permitted to run (except on the Mac where this isn't possible).

If it's false, the second instance won't start, but it you will still get a callback to anotherInstanceStarted() to tell you about this - which gives you a chance to react to what the user was trying to do.

Implemented in JUCEApplication.

void JUCEApplicationBase::quit ( )
static

Signals that the main message loop should stop and the application should terminate.

This isn't synchronous, it just posts a quit message to the main queue, and when this message arrives, the message loop will stop, the shutdown() method will be called, and the app will exit.

Note that this will cause an unconditional quit to happen, so if you need an extra level before this, e.g. to give the user the chance to save their work and maybe cancel the quit, you'll need to handle this in the systemRequestedQuit() method - see that method's help for more info.

See also
MessageManager
virtual void JUCEApplicationBase::resumed ( )
pure virtual

This method is called when the application is being woken from background mode by the operating system.

Implemented in JUCEApplication.

bool JUCEApplicationBase::sendCommandLineToPreexistingInstance ( )
void JUCEApplicationBase::sendUnhandledException ( const std::exception *  e,
const char *  sourceFile,
int  lineNumber 
)
static
void JUCEApplicationBase::setApplicationReturnValue ( int  newReturnValue)
noexcept

Sets the value that should be returned as the application's exit code when the app quits.

This is the value that's returned by the main() function. Normally you'd leave this as 0 unless you want to indicate an error code.

See also
getApplicationReturnValue
virtual void JUCEApplicationBase::shutdown ( )
pure virtual
int JUCEApplicationBase::shutdownApp ( )
virtual void JUCEApplicationBase::suspended ( )
pure virtual

This method is called when the application is being put into background mode by the operating system.

Implemented in JUCEApplication.

virtual void JUCEApplicationBase::systemRequestedQuit ( )
pure virtual

Called when the operating system is trying to close the application.

The default implementation of this method is to call quit(), but it may be overloaded to ignore the request or do some other special behaviour instead. For example, you might want to offer the user the chance to save their changes before quitting, and give them the chance to cancel.

If you want to send a quit signal to your app, this is the correct method to call, because it means that requests that come from the system get handled in the same way as those from your own application code. So e.g. you'd call this method from a "quit" item on a menu bar.

Implemented in JUCEApplication.

virtual void JUCEApplicationBase::unhandledException ( const std::exception *  ,
const String sourceFilename,
int  lineNumber 
)
pure virtual

If any unhandled exceptions make it through to the message dispatch loop, this callback will be triggered, in case you want to log them or do some other type of error-handling.

If the type of exception is derived from the std::exception class, the pointer passed-in will be valid. If the exception is of unknown type, this pointer will be null.

Implemented in JUCEApplication.

Friends And Related Function Documentation

friend struct MultipleInstanceHandler
friend

Member Data Documentation

JUCEApplicationBase::CreateInstanceFunction JUCEApplicationBase::createInstance = 0
static

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