application.h File Reference

Classes

class  Application
 

Namespaces

 maxon
 

Enumerations

enum  SUBSYSTEM {
  UNDEFINED,
  CONSOLE,
  WINDOWS
}
 
enum  APPLICATION_URLTYPE {
  STARTUP_DIR,
  APPLICATION,
  APP_EXECUTABLE,
  CORELIBS_DIR,
  RESOURCE_DIR,
  TEMP_DIR,
  PREFS_DIR,
  GLOBALPREFS_DIR,
  DESKTOP_DIR,
  USER_HOME_DIR,
  USER_DOCUMENTS_DIR,
  SYSTEM_PROGRAMS_DIR,
  CURRENT_WORKING_DIR,
  CURRENT_MODULE_DIR,
  CURRENT_MODULE_RESOURCE_DIR,
  PREFS_DIR_STATIC
}
 
enum  APPLICATIONMODE {
  DONTWAIT,
  KEEPRUNNING,
  SHUTDOWN
}
 
enum  APPLICATIONFEATURE {
  NONE,
  COMMANDLINE
}
 

Functions

enum maxon::SUBSYSTEM MAXON_ENUM_LIST (SUBSYSTEM, "net.maxon.datatype.enum.subsystem")
 
enum maxon::APPLICATION_URLTYPE MAXON_ENUM_LIST (APPLICATION_URLTYPE, "net.maxon.datatype.enum.application_urltype")
 
enum maxon::APPLICATIONMODE MAXON_ENUM_LIST (APPLICATIONMODE, "net.maxon.datatype.enum.applicationmode")
 
enum maxon::APPLICATIONFEATURE MAXON_ENUM_FLAGS (APPLICATIONFEATURE)
 

Variables

 UNDEFINED
 
 CONSOLE
 
 WINDOWS
 
 STARTUP_DIR
 
 APPLICATION
 
 APP_EXECUTABLE
 
 CORELIBS_DIR
 
 RESOURCE_DIR
 
 TEMP_DIR
 
 PREFS_DIR
 
 GLOBALPREFS_DIR
 
 DESKTOP_DIR
 
 USER_HOME_DIR
 
 USER_DOCUMENTS_DIR
 
 SYSTEM_PROGRAMS_DIR
 
 CURRENT_WORKING_DIR
 
 CURRENT_MODULE_DIR
 
 CURRENT_MODULE_RESOURCE_DIR
 
 PREFS_DIR_STATIC
 
 DONTWAIT
 
 KEEPRUNNING
 
 SHUTDOWN
 
 NONE
 
 COMMANDLINE
 
class maxon::Application MAXON_ENUM_FLAGS
 

Variable Documentation

◆ UNDEFINED

UNDEFINED

Undefined SUBSYSTEM.

◆ CONSOLE

CONSOLE

(\/SUBSYSTEM:CONSOLE)

◆ WINDOWS

WINDOWS

(\/SUBSYSTEM:WINDOWS)

◆ STARTUP_DIR

STARTUP_DIR

The directory where the executable/bundle is placed in. The executable name is not part of the Url.

◆ APPLICATION

APPLICATION

The Url of the executable (Windows / Linux) or bundle (OS X / iOS).

◆ APP_EXECUTABLE

APP_EXECUTABLE

The Url of the inner executable. Under Windows / Linux this is identical to APPLICATION. Under OS X / iOS this is the Url inside the bundle.

◆ CORELIBS_DIR

CORELIBS_DIR

The directory where the core modules are placed in.

◆ RESOURCE_DIR

RESOURCE_DIR

The directory where the resource is placed in.

◆ TEMP_DIR

TEMP_DIR

Temporary directory where data can be read or written. The temporary directory is placed in various locations depending on the operating system.

◆ PREFS_DIR

PREFS_DIR

Preferences directory. The preferences directory is based on the startup Url of the application. If the parent directory location is changed, the preferences Url will change as well. The preferences directory is placed in various locations depending on the operating system.

◆ GLOBALPREFS_DIR

GLOBALPREFS_DIR

Global preferences directory. The global preferences Url is always in the same place for all applications on the same operating system.

◆ DESKTOP_DIR

DESKTOP_DIR

Users desktop directory.

◆ USER_HOME_DIR

USER_HOME_DIR

Users Home directory.

◆ USER_DOCUMENTS_DIR

USER_DOCUMENTS_DIR

Users documents directory.

◆ SYSTEM_PROGRAMS_DIR

SYSTEM_PROGRAMS_DIR

System application directory. This is where apps are installed by default (e.g. "C:\Program Files")

◆ CURRENT_WORKING_DIR

CURRENT_WORKING_DIR

Current working directory.

◆ CURRENT_MODULE_DIR

CURRENT_MODULE_DIR

Directory of the module that invoked this call.

◆ CURRENT_MODULE_RESOURCE_DIR

CURRENT_MODULE_RESOURCE_DIR

Resource directory of the module that invoked this call.

◆ PREFS_DIR_STATIC

PREFS_DIR_STATIC

Same as PREFS_DIR but without being able to set the path in the config. Cineware AE plug-in generates a lite.cert file at this location. Used for placing and reading the Lite certification file.

◆ DONTWAIT

DONTWAIT

Stops the execution as soon as all initializations are done, used for command line mode.

◆ KEEPRUNNING

KEEPRUNNING

Keeps the program running after all initializations.

◆ SHUTDOWN

SHUTDOWN

Quits the application and leave the main loop. Only working when APPLICATIONMODE::KEEPRUNNING was set before.

◆ NONE

NONE

◆ COMMANDLINE

COMMANDLINE

application runs as headless command line version.