PLCore::FrontendContext Class Reference

Frontend context. More...

#include <FrontendContext.h>

Inheritance diagram for PLCore::FrontendContext:

List of all members.

Public Member Functions
PLCORE_API	FrontendContext ()
	Constructor.
virtual PLCORE_API	~FrontendContext ()
	Destructor.
String	GetName () const
	Get frontend executable name.
void	SetName (const String &sName)
	Set frontend executable name.
String	GetFrontend () const
	Returns the name of the frontend RTTI class to use.
void	SetFrontend (const String &sFrontend)
	Sets the name of the frontend RTTI class to use.
String	GetFrontendConstructor () const
	Returns the name of the frontend RTTI class constructor to use.
void	SetFrontendConstructor (const String &sFrontendConstructor)
	Sets the name of the frontend RTTI class constructor to use.
String	GetFrontendConstructorParameters () const
	Returns the parameters for the frontend RTTI class constructor.
void	SetFrontendConstructorParameters (const String &sFrontendConstructorParameters)
	Sets the parameters for the frontend RTTI class constructor.
String	GetFrontendParameters () const
	Returns the parameters for the instanced frontend RTTI class.
void	SetFrontendParameters (const String &sFrontendParameters)
	Sets the parameters for the instanced frontend RTTI class.
String	GetFrontendImplementation () const
	Returns the name of the frontend implementation RTTI class to use.
void	SetFrontendImplementation (const String &sFrontendImplementation)
	Sets the name of the frontend implementation RTTI class to use.
String	GetFrontendImplementationConstructor () const
	Returns the name of the frontend implementation RTTI class constructor to use.
void	SetFrontendImplementationConstructor (const String &sFrontendImplementationConstructor)
	Sets the name of the frontend implementation RTTI class constructor to use.
String	GetFrontendImplementationConstructorParameters () const
	Returns the parameters for the frontend implementation RTTI class constructor.
void	SetFrontendImplementationConstructorParameters (const String &sFrontendImplementationConstructorParameters)
	Sets the parameters for the frontend implementation RTTI class constructor.
String	GetFrontendImplementationParameters () const
	Returns the parameters for the instanced frontend implementation RTTI class.
void	SetFrontendImplementationParameters (const String &sFrontendImplementationParameters)
	Sets the parameters for the instanced frontend implementation RTTI class.
Protected Attributes
String	m_sName
String	m_sFrontend
String	m_sFrontendConstructor
String	m_sFrontendConstructorParameters
String	m_sFrontendParameters
String	m_sFrontendImplementation
String	m_sFrontendImplementationConstructor
String	m_sFrontendImplementationConstructorParameters
String	m_sFrontendImplementationParameters

---

Detailed Description

Frontend context.

Remarks:

The frontend context stores data and information for an frontend, such as startup information (what was the current directory when the frontend started) or paths to needed resources.

---

Constructor & Destructor Documentation

PLCORE_API PLCore::FrontendContext::FrontendContext

(

)

Constructor.

virtual PLCORE_API PLCore::FrontendContext::~FrontendContext

(

)

[virtual]

Destructor.

---

Member Function Documentation

String PLCore::FrontendContext::GetName

(

)

const [inline]

Get frontend executable name.

Returns:

Name of the frontend executable (default: "")

Remarks:

The name of the frontend executable (one can also call it "host", the running executable) is used as default whenever a name is required (log, configuration, window title and so on).

void PLCore::FrontendContext::SetName

(

const String &

sName

)

[inline]

Set frontend executable name.

Parameters:

[in]

sName

Name of the frontend executable (default: "")

See also:

• GetName()

String PLCore::FrontendContext::GetFrontend

(

)

const [inline]

Returns the name of the frontend RTTI class to use.

Returns:

The name of the frontend RTTI class to use (default: "PLCore::FrontendPixelLight")

void PLCore::FrontendContext::SetFrontend

(

const String &

sFrontend

)

[inline]

Sets the name of the frontend RTTI class to use.

Parameters:

[in]

sFrontend

The name of the frontend RTTI class to use (default: "PLCore::FrontendPixelLight")

String PLCore::FrontendContext::GetFrontendConstructor

(

)

const [inline]

Returns the name of the frontend RTTI class constructor to use.

Returns:

The name of the frontend RTTI class constructor to use (default: "")

void PLCore::FrontendContext::SetFrontendConstructor

(

const String &

sFrontendConstructor

)

[inline]

Sets the name of the frontend RTTI class constructor to use.

Parameters:

[in]

The

name of the frontend RTTI class constructor to use (default: "")

String PLCore::FrontendContext::GetFrontendConstructorParameters

(

)

const [inline]

Returns the parameters for the frontend RTTI class constructor.

Returns:

Parameters for the frontend RTTI class constructor (default: "")

void PLCore::FrontendContext::SetFrontendConstructorParameters

(

const String &

sFrontendConstructorParameters

)

[inline]

Sets the parameters for the frontend RTTI class constructor.

Parameters:

[in]

sFrontendConstructorParameters

Parameters for the frontend RTTI class constructor (default: "")

String PLCore::FrontendContext::GetFrontendParameters

(

)

const [inline]

Returns the parameters for the instanced frontend RTTI class.

Returns:

The parameters for the instanced frontend RTTI class (default: "")

void PLCore::FrontendContext::SetFrontendParameters

(

const String &

sFrontendParameters

)

[inline]

Sets the parameters for the instanced frontend RTTI class.

Parameters:

[in]

sFrontendParameters

The parameters for the instanced frontend RTTI class (default: "")

String PLCore::FrontendContext::GetFrontendImplementation

(

)

const [inline]

Returns the name of the frontend implementation RTTI class to use.

Returns:

The name of the frontend implementation RTTI class to use (default: "PLFrontendOS::Frontend")

void PLCore::FrontendContext::SetFrontendImplementation

(

const String &

sFrontendImplementation

)

[inline]

Sets the name of the frontend implementation RTTI class to use.

Parameters:

[in]

sFrontendImplementation

The name of the frontend implementation RTTI class to use (default: "PLFrontendOS::Frontend")

String PLCore::FrontendContext::GetFrontendImplementationConstructor

(

)

const [inline]

Returns the name of the frontend implementation RTTI class constructor to use.

Returns:

The name of the frontend implementation RTTI class constructor to use (default: "")

void PLCore::FrontendContext::SetFrontendImplementationConstructor

(

const String &

sFrontendImplementationConstructor

)

[inline]

Sets the name of the frontend implementation RTTI class constructor to use.

Parameters:

[in]

sFrontendImplementationConstructor

The name of the frontend implementation RTTI class constructor to use (default: "")

String PLCore::FrontendContext::GetFrontendImplementationConstructorParameters

(

)

const [inline]

Returns the parameters for the frontend implementation RTTI class constructor.

Returns:

The parameters for the frontend implementation RTTI class constructor (default: "")

void PLCore::FrontendContext::SetFrontendImplementationConstructorParameters

(

const String &

sFrontendImplementationConstructorParameters

)

[inline]

Sets the parameters for the frontend implementation RTTI class constructor.

Parameters:

[in]

sFrontendImplementationConstructorParameters

The parameters for the frontend implementation RTTI class constructor (default: "")

String PLCore::FrontendContext::GetFrontendImplementationParameters

(

)

const [inline]

Returns the parameters for the instanced frontend implementation RTTI class.

Returns:

The parameters for the instanced frontend implementation RTTI class (default: "")

void PLCore::FrontendContext::SetFrontendImplementationParameters

(

const String &

sFrontendImplementationParameters

)

[inline]

Sets the parameters for the instanced frontend implementation RTTI class.

Parameters:

[in]

sFrontendImplementationParameters

The parameters for the instanced frontend implementation RTTI class (default: "")

---

Member Data Documentation

String PLCore::FrontendContext::m_sName [protected]

Name of the frontend executable (default: "")

String PLCore::FrontendContext::m_sFrontend [protected]

Name of the frontend RTTI class to use (default: "PLCore::FrontendPixelLight")

String PLCore::FrontendContext::m_sFrontendConstructor [protected]

Name of the frontend RTTI class constructor to use (default: "")

String PLCore::FrontendContext::m_sFrontendConstructorParameters [protected]

Parameters for the frontend RTTI class constructor (default: "")

String PLCore::FrontendContext::m_sFrontendParameters [protected]

Parameters for the instanced frontend RTTI class (default: "")

String PLCore::FrontendContext::m_sFrontendImplementation [protected]

Name of the frontend implementation RTTI class to use (default: "PLFrontendOS::Frontend")

String PLCore::FrontendContext::m_sFrontendImplementationConstructor [protected]

Name of the frontend implementation RTTI class constructor to use (default: "")

String PLCore::FrontendContext::m_sFrontendImplementationConstructorParameters [protected]

Parameters for the frontend implementation RTTI class constructor (default: "")

String PLCore::FrontendContext::m_sFrontendImplementationParameters [protected]

Parameters for the instanced frontend implementation RTTI class (default: "")

---

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

• FrontendContext.h
• FrontendContext.inl