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

Represents the current executable's process. More...

Public Types

enum  ProcessPriority { LowPriority = 0, NormalPriority = 1, HighPriority = 2, RealtimePriority = 3 }
 

Static Public Member Functions

static void JUCE_CALLTYPE setPriority (const ProcessPriority priority)
 Changes the current process's priority.
 
static void JUCE_CALLTYPE terminate ()
 Kills the current process immediately.
 
static bool JUCE_CALLTYPE isForegroundProcess ()
 Returns true if this application process is the one that the user is currently using.
 
static void JUCE_CALLTYPE makeForegroundProcess ()
 Attempts to make the current process the active one.
 
static void JUCE_CALLTYPE hide ()
 Hides the application (on an OS that supports this, e.g.
 
static void JUCE_CALLTYPE raisePrivilege ()
 Raises the current process's privilege level.
 
static void JUCE_CALLTYPE lowerPrivilege ()
 Lowers the current process's privilege level.
 
static bool JUCE_CALLTYPE isRunningUnderDebugger ()
 Returns true if this process is being hosted by a debugger.
 
static bool JUCE_CALLTYPE openDocument (const String &documentURL, const String &parameters)
 Tries to launch the OS's default reader application for a given file or URL.
 
static bool JUCE_CALLTYPE openEmailWithAttachments (const String &targetEmailAddress, const String &emailSubject, const String &bodyText, const StringArray &filesToAttach)
 Tries to launch the OS's default email application to let the user create a message.
 
static void *JUCE_CALLTYPE getCurrentModuleInstanceHandle () noexcept
 WINDOWS ONLY - This returns the HINSTANCE of the current module.
 
static void JUCE_CALLTYPE setCurrentModuleInstanceHandle (void *newHandle) noexcept
 WINDOWS ONLY - Sets a new module handle to be used by the library.
 
static void setDockIconVisible (bool isVisible)
 OSX ONLY - Shows or hides the OSX dock icon for this app.
 

Detailed Description

Represents the current executable's process.

This contains methods for controlling the current application at the process-level.

See Also
Thread, JUCEApplicationBase

Member Enumeration Documentation

Enumerator:
LowPriority 
NormalPriority 
HighPriority 
RealtimePriority 

Member Function Documentation

static void JUCE_CALLTYPE Process::setPriority ( const ProcessPriority  priority)
static

Changes the current process's priority.

Parameters
prioritythe process priority, where 0=low, 1=normal, 2=high, 3=realtime
static void JUCE_CALLTYPE Process::terminate ( )
static

Kills the current process immediately.

This is an emergency process terminator that kills the application immediately - it's intended only for use only when something goes horribly wrong.

See Also
JUCEApplicationBase::quit
static bool JUCE_CALLTYPE Process::isForegroundProcess ( )
static

Returns true if this application process is the one that the user is currently using.

static void JUCE_CALLTYPE Process::makeForegroundProcess ( )
static

Attempts to make the current process the active one.

(This is not possible on some platforms).

static void JUCE_CALLTYPE Process::hide ( )
static

Hides the application (on an OS that supports this, e.g.

OSX)

static void JUCE_CALLTYPE Process::raisePrivilege ( )
static

Raises the current process's privilege level.

Does nothing if this isn't supported by the current OS, or if process privilege level is fixed.

static void JUCE_CALLTYPE Process::lowerPrivilege ( )
static

Lowers the current process's privilege level.

Does nothing if this isn't supported by the current OS, or if process privilege level is fixed.

static bool JUCE_CALLTYPE Process::isRunningUnderDebugger ( )
static

Returns true if this process is being hosted by a debugger.

static bool JUCE_CALLTYPE Process::openDocument ( const String documentURL,
const String parameters 
)
static

Tries to launch the OS's default reader application for a given file or URL.

static bool JUCE_CALLTYPE Process::openEmailWithAttachments ( const String targetEmailAddress,
const String emailSubject,
const String bodyText,
const StringArray filesToAttach 
)
static

Tries to launch the OS's default email application to let the user create a message.

static void* JUCE_CALLTYPE Process::getCurrentModuleInstanceHandle ( )
staticnoexcept

WINDOWS ONLY - This returns the HINSTANCE of the current module.

The return type is a void* to avoid being dependent on windows.h - just cast it to a HINSTANCE to use it.

In a normal JUCE application, this will be automatically set to the module handle of the executable.

If you've built a DLL and plan to use any JUCE messaging or windowing classes, you'll need to make sure you call the setCurrentModuleInstanceHandle() to provide the correct module handle in your DllMain() function, because the system relies on the correct instance handle when opening windows.

static void JUCE_CALLTYPE Process::setCurrentModuleInstanceHandle ( void *  newHandle)
staticnoexcept

WINDOWS ONLY - Sets a new module handle to be used by the library.

The parameter type is a void* to avoid being dependent on windows.h, but it actually expects a HINSTANCE value.

See Also
getCurrentModuleInstanceHandle()
static void Process::setDockIconVisible ( bool  isVisible)
static

OSX ONLY - Shows or hides the OSX dock icon for this app.


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