Application Class Reference 系统

#include <application.h>

详细描述

应用程序 wide functions. Implement this interface to be able to link against the kernel library.

静态公共成员函数

static MAXON_FUNCTION Result < Url GetUrl ( APPLICATION_URLTYPE urlType)
static MAXON_METHOD Result < Url GetTempUrl (const Url &directory)
static MAXON_METHOD Result < BaseArray < Url > >  GetModulePaths ()
static MAXON_METHOD Int   GetCommandLineArgCount ()
static MAXON_METHOD String   GetCommandLineArg ( Int idx)
static MAXON_METHOD DataDictionary  GetMachineInfo ()
static MAXON_METHOD APPLICATIONMODE   GetApplicationMode ()
static MAXON_METHOD Bool   SetApplicationMode ( APPLICATIONMODE mode)
static MAXON_METHOD Bool   GetFeature ( APPLICATIONFEATURE feature)
static MAXON_METHOD void  SetFeature ( APPLICATIONFEATURE feature, Bool value)
static MAXON_METHOD Result < void >  GetVersion ( Int &version, String &buildID)

Static Protected Member Functions

static MAXON_METHOD Result < Url GetUrlI ( APPLICATION_URLTYPE urlType)

私有成员函数

  MAXON_INTERFACE_NONVIRTUAL ( 应用程序 , MAXON_REFERENCE_NONE , "net.maxon.interface.application")

成员函数文档编制

◆  MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL ( 应用程序   ,
MAXON_REFERENCE_NONE   ,
"net.maxon.interface.application"   
)
private

◆  GetUrl()

static MAXON_FUNCTION Result < Url > GetUrl ( APPLICATION_URLTYPE   urlType )
static

Returns the requested url.

参数
[in] urlType Type of the url, see APPLICATION_URLTYPE .
返回
Url containing the requested.

◆  GetTempUrl()

static MAXON_METHOD Result < Url > GetTempUrl ( const Url directory )
static

Returns a new unique url for a temporary file. A typical use for this is Url tempfile = Application::GetTempUrl(tempDirectory);

参数
[in] directory Directory url where the temporary file should be created in.
返回
Url pointing to the temporary file.

◆  GetModulePaths()

static MAXON_METHOD Result < BaseArray < Url > > GetModulePaths ( )
static

Returns all module paths configured through g_modulePath, g_additionalModulePath and user preferences.

返回
Array containing all paths that are searched for modules.

◆  GetCommandLineArgCount()

static MAXON_METHOD Int GetCommandLineArgCount ( )
static

Returns the number of command line arguments delivered to the app on startup.

返回
Number of arguments to request via GetCommandLineArg() .

◆  GetCommandLineArg()

static MAXON_METHOD String GetCommandLineArg ( Int   idx )
static

Returns a command line argument.

参数
[in] idx The index of the argument. (0 >= idx < GetCommandLineArgCount() ).
返回
The requested argument.

◆  GetMachineInfo()

static MAXON_METHOD DataDictionary GetMachineInfo ( )
static

Returns information about the system and processor. See maxon::MACHINEINFO for DataDictionary properties.

◆  GetApplicationMode()

static MAXON_METHOD APPLICATIONMODE GetApplicationMode ( )
static

Retrieves the current application mode. This mode defines the behavior after the startup is done.

返回
The current application mode.

◆  SetApplicationMode()

static MAXON_METHOD Bool SetApplicationMode ( APPLICATIONMODE   mode )
static

Sets a new application mode. This mode defines the behavior after the startup is done. Please note that it's only possible to raise the mode from APPLICATIONMODE::DONTWAIT to APPLICATIONMODE::KEEPRUNNING .

参数
[in] mode The new mode to be set.
返回
True if the function changed the mode successfully.

◆  GetFeature()

static MAXON_METHOD Bool GetFeature ( APPLICATIONFEATURE   feature )
static

◆  SetFeature()

static MAXON_METHOD void SetFeature ( APPLICATIONFEATURE   feature ,
Bool   value  
)
static

◆  GetVersion()

static MAXON_METHOD Result <void> GetVersion ( Int version ,
String buildID  
)
static

Gets the version number and build ID.

参数
[out] version The version number will be assigned to this value.
[out] buildID Variable that will hold the buildID.

◆  GetUrlI()

static MAXON_METHOD Result < Url > GetUrlI ( APPLICATION_URLTYPE   urlType )
static protected