API Documentation
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | Static Public Attributes | List of all members
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:
[legend]

Public Types

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

Static Public Member Functions

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

Static Public Attributes

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

Detailed Description

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

Class: ApplicationResource

autotoc_md55

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: