ApplicationResource Class Reference

High-Level functions for communicating with the operating system or getting general information about the application. More...

#include <ApplicationResource.h>

Collaboration diagram for ApplicationResource:

Public Types
enum class	InstanceType { e_system , e_desktop , e_session , e_trustee }

Static Public Member Functions
static TranslatedString	ApplicationNameAndVersion ()
static Time	BuildTime ()
static void	CloseApp (bool relaunch=false, const String &relaunch_options="--relaunch")
static String	CreateExclusionName (String guid, InstanceType kind=InstanceType::e_system)
static void	FactoryResetApp ()
static Buffer< uint01 >	GetAppBundledResource (void *handle, const String &type, const String &name)
static File	GetDefaultOSApplicationForExtension (const String &extension)
static TranslatedString	GetErrorString (sint08 result)
static HardwareInformation	GetHardwareInformation ()
static TranslatedString	GetLastErrorString ()
static OSInformation	GetOSInformation ()
static Buffer< VideoCardInformation >	GetVideoCardInfo ()
static bool	IsFirstTimeRunning ()
static void	LogApplicationInformation (ProgressInfo *log)
static void	LogComputerInformation (ProgressInfo *log)
static void	LogOSInformation (ProgressInfo *log)
static void	LogUserSettings (ProgressInfo *log, bool log_only_non_defaults)
static void	OpenExplorerWindow (const String &location)
static void	OpenFile (const File &file)
static void	OpenOSBluetoothDialog ()
static void	OpenOSClockDialog ()
static void	OpenOSFileSystemDialog ()
static void	OpenOSLocationDialog ()
static void	OpenOSPrinterDialog ()
static void	OpenOSWifiDialog ()
static String	OSUserName ()
static void	ReadUserOptions ()
static void	SaveUserOptions (bool is_shutting_down)
static void	SendFile (const File &file)
static UUID	SessionID ()
static Time	SessionStartTime ()
static void	SetFolderIcon (const File &folder, const File &icon)
static void	ShareFileWithMediaServer (const File &file)

Static Public Attributes
static Resource< String >	activation_code
static Resource< TranslatedString >	application_name
static Resource< String >	application_version
static ApplicationOption< Time >	current_run_time
static ApplicationOption< bool >	has_finished_initial_setup
static Resource< bool >	is_development_version
static ApplicationOption< String >	last_application_version
static bool	last_proper_shutdown
static Time	last_run_time
static ApplicationOption< bool >	proper_shutdown
static Resource< Buffer< String > >	startup_options
static Resource< String >	user_email
static Resource< String >	username

Detailed Description

High-Level functions for communicating with the operating system or getting general information about the application.

---

Member Enumeration Documentation

InstanceType

enum class InstanceType

strong

Enumerator
e_system
e_desktop
e_session
e_trustee

Member Function Documentation

ApplicationNameAndVersion()

static TranslatedString ApplicationNameAndVersion ( )

static

BuildTime()

static Time BuildTime ( )

static

CloseApp()

static void CloseApp ( bool relaunch = false, const String & relaunch_options = "--relaunch" )

static

CreateExclusionName()

static String CreateExclusionName ( String guid, InstanceType kind = InstanceType::e_system )

static

FactoryResetApp()

static void FactoryResetApp ( )

static

GetAppBundledResource()

static Buffer< uint01 > GetAppBundledResource ( void * handle, const String & type, const String & name )

static

GetDefaultOSApplicationForExtension()

static File GetDefaultOSApplicationForExtension ( const String & extension )

static

GetErrorString()

static TranslatedString GetErrorString ( sint08 result )

static

GetHardwareInformation()

static HardwareInformation GetHardwareInformation ( )

static

GetLastErrorString()

static TranslatedString GetLastErrorString ( )

static

GetOSInformation()

static OSInformation GetOSInformation ( )

static

GetVideoCardInfo()

static Buffer< VideoCardInformation > GetVideoCardInfo ( )

static

IsFirstTimeRunning()

static bool IsFirstTimeRunning ( )

static

LogApplicationInformation()

static void LogApplicationInformation ( ProgressInfo * log )

static

LogComputerInformation()

static void LogComputerInformation ( ProgressInfo * log )

static

LogOSInformation()

static void LogOSInformation ( ProgressInfo * log )

static

LogUserSettings()

static void LogUserSettings ( ProgressInfo * log, bool log_only_non_defaults )

static

OpenExplorerWindow()

static void OpenExplorerWindow ( const String & location )

static

OpenFile()

static void OpenFile ( const File & file )

static

OpenOSBluetoothDialog()

static void OpenOSBluetoothDialog ( )

static

OpenOSClockDialog()

static void OpenOSClockDialog ( )

static

OpenOSFileSystemDialog()

static void OpenOSFileSystemDialog ( )

static

OpenOSLocationDialog()

static void OpenOSLocationDialog ( )

static

OpenOSPrinterDialog()

static void OpenOSPrinterDialog ( )

static

OpenOSWifiDialog()

static void OpenOSWifiDialog ( )

static

OSUserName()

static String OSUserName ( )

static

ReadUserOptions()

static void ReadUserOptions ( )

static

SaveUserOptions()

static void SaveUserOptions ( bool is_shutting_down )

static

SendFile()

static void SendFile ( const File & file )

static

SessionID()

static UUID SessionID ( )

static

SessionStartTime()

static Time SessionStartTime ( )

static

SetFolderIcon()

static void SetFolderIcon ( const File & folder, const File & icon )

static

ShareFileWithMediaServer()

static void ShareFileWithMediaServer ( const File & file )

static

Member Data Documentation

activation_code

Resource<String> activation_code

static

application_name

Resource<TranslatedString> application_name

static

application_version

Resource<String> application_version

static

current_run_time

ApplicationOption<Time> current_run_time

static

has_finished_initial_setup

ApplicationOption<bool> has_finished_initial_setup

static

is_development_version

Resource<bool> is_development_version

static

last_application_version

ApplicationOption<String> last_application_version

static

last_proper_shutdown

bool last_proper_shutdown

static

last_run_time

Time last_run_time

static

proper_shutdown

ApplicationOption<bool> proper_shutdown

static

startup_options

Resource<Buffer<String> > startup_options

static

user_email

Resource<String> user_email

static

username

Resource<String> username

static

---

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

• Base/Headers/ApplicationResource.h