PlatformTools Class Reference

Base class providing support for various platforms. More...

#include <platformtools.h>

Inheritance diagram for PlatformTools:

Collaboration diagram for PlatformTools:

Public Member Functions
virtual void	init (Application &application)
	Platform-dependent initialization. More...
virtual void	disableScreensaver ()
	Function to disable the screen saver. More...
virtual void	enableScreensaver ()
	Function to enable the screen saver. More...
virtual qint64	getFreeDiskSpace (const QString &path)
	Determine free disk space. More...

Static Public Member Functions
static PlatformTools &	getSingleton ()
static std::unique_ptr< PlatformTools > &	getPointerToInstance ()
	Function holding the instance pointer as a static unique pointer. More...

Protected Member Functions
	PlatformTools ()

Detailed Description

Base class providing support for various platforms.

This singleton class is used to access platform-dependent components. The platform-dependent components are defined as derived casses named XXXPlatformTools. To create an instance of these tools one has to instantiate a global object of the type

PlatformToolsInstanciator<XXXPlatformTools> instance;

Definition at line 40 of file platformtools.h.

Constructor & Destructor Documentation

PlatformTools::PlatformTools ( )

inlineprotected

Definition at line 43 of file platformtools.h.

Member Function Documentation

virtual void PlatformTools::disableScreensaver ( )

inlinevirtual

Function to disable the screen saver.

Reimplemented in IOSPlatformTools.

Definition at line 73 of file platformtools.h.

virtual void PlatformTools::enableScreensaver ( )

inlinevirtual

Function to enable the screen saver.

Reimplemented in IOSPlatformTools.

Definition at line 80 of file platformtools.h.

virtual qint64 PlatformTools::getFreeDiskSpace ( const QString &  path )

inlinevirtual

Determine free disk space.

Parameters

path	: Path of the location for which the free disk space has to be determined

Returns

: Free space as a qint64 in bytes.

Definition at line 93 of file platformtools.h.

static std::unique_ptr<PlatformTools>& PlatformTools::getPointerToInstance ( )

inlinestatic

Function holding the instance pointer as a static unique pointer.

Definition at line 107 of file platformtools.h.

static PlatformTools& PlatformTools::getSingleton ( )

inlinestatic

To access platform-dependent functions declare them as virtual functions here in this base, override them in the corresponding platform-dependent derived class and access them by calling

PlatformTools::getSingleton().<functionname>(<arguments>);

Definition at line 56 of file platformtools.h.

Here is the call graph for this function:

virtual void PlatformTools::init ( Application &  application )

inlinevirtual

Platform-dependent initialization.

Definition at line 66 of file platformtools.h.

---

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

• platformtools.h