SallyAPI::GUI::CAppBase Class Reference

Application base. More...

#include <AppBase.h>

Inheritance diagram for SallyAPI::GUI::CAppBase:

List of all members.

Public Member Functions
	CAppBase (SallyAPI::GUI::CGUIBaseObject *parent, int graphicId, const std::string &explicidAppName)
	Constructor.
virtual	~CAppBase ()
	Destructor.
int	GetGraphicId ()
	Gets the graphic identifier.
std::string	GetExplicitAppName ()
	Gets the explicit application name.
std::string	GetPropertyString (const std::string &ID, const std::string &defaultReturn="")
	Gets a property string.
int	GetPropertyInt (const std::string &ID, int defaultReturn=-1)
	Gets a property int.
bool	GetPropertyBool (const std::string &ID, bool defaultReturn=false)
	Gets a property bool.
void	SetPropertyString (const std::string &ID, const std::string &s)
	Sets a property string.
void	SetPropertyInt (const std::string &ID, int i)
	Sets a property int.
void	SetPropertyBool (const std::string &ID, bool i)
	Sets a property bool.
int	GetPictureID (int iPicture)
	Gets a picture identifier.
virtual void	SendMessageToParent (SallyAPI::GUI::CGUIBaseObject *reporter, int reporterId, int messageId, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL)
	Send message to parent.
Protected Attributes
int	m_iGraphicId
std::string	m_strExplicitAppName

---

Detailed Description

Application base.

Author:

Christian Knobloch

Date:

19.04.2010

---

Constructor & Destructor Documentation

CAppBase::CAppBase	(	SallyAPI::GUI::CGUIBaseObject *	parent,
		int	graphicId,
		const std::string &	explicidAppName
	)

Constructor.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

[in,out]	parent	If non-null, the parent.
	graphicId	Identifier for the graphic.
	explicidAppName	Name of the explicid application.

CAppBase::~CAppBase

(

)

[virtual]

Destructor.

Author:

Christian Knobloch

Date:

19.04.2010

---

Member Function Documentation

std::string CAppBase::GetExplicitAppName

(

)

Gets the explicit application name.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The explicit application name.

int CAppBase::GetGraphicId

(

)

Gets the graphic identifier.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The graphic identifier.

int CAppBase::GetPictureID

(

int

iPicture

)

Gets a picture identifier.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

iPicture

The picture.

Returns:

The picture identifier.

bool CAppBase::GetPropertyBool	(	const std::string &	ID,
		bool	defaultReturn = false
	)

Gets a property bool.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

ID	The identifier.
defaultReturn	Default return.

Returns:

true if it succeeds, false if it fails.

int CAppBase::GetPropertyInt	(	const std::string &	ID,
		int	defaultReturn = -1
	)

Gets a property int.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

ID	The identifier.
defaultReturn	Default return.

Returns:

The property int.

std::string CAppBase::GetPropertyString	(	const std::string &	ID,
		const std::string &	defaultReturn = ""
	)

Gets a property string.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

ID	The identifier.
defaultReturn	Default return.

Returns:

The property string.

void CAppBase::SendMessageToParent	(	SallyAPI::GUI::CGUIBaseObject *	reporter,
		int	reporterId,
		int	messageId,
		SallyAPI::GUI::SendMessage::CParameterBase *	messageParameter = NULL
	)		[virtual]

Send message to parent.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

[in,out]	reporter	If non-null, the reporter.
	reporterId	Identifier for the reporter.
	messageId	Identifier for the message.
[in,out]	messageParameter	If non-null, the message parameter.

Reimplemented from SallyAPI::GUI::CForm.

Reimplemented in SallyAPI::GUI::CApplicationWindow, SallyAPI::GUI::CPopUpWindow, SallyAPI::GUI::CGameWindow, SallyAPI::GUI::CMessageBox, SallyAPI::GUI::COpenDialog, SallyAPI::GUI::CInputBox, SallyAPI::GUI::CWizardPanel, SallyAPI::GUI::CQuestionBox, and SallyAPI::GUI::CConfigPanel.

void SallyAPI::GUI::CAppBase::SetPropertyBool	(	const std::string &	ID,
		bool	i
	)

Sets a property bool.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

ID	The identifier.
i	true to.

void SallyAPI::GUI::CAppBase::SetPropertyInt	(	const std::string &	ID,
		int	i
	)

Sets a property int.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

ID	The identifier.
i	The index.

void SallyAPI::GUI::CAppBase::SetPropertyString	(	const std::string &	ID,
		const std::string &	s
	)

Sets a property string.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

ID	The identifier.
s	The.

---

Member Data Documentation

int SallyAPI::GUI::CAppBase::m_iGraphicId [protected]

std::string SallyAPI::GUI::CAppBase::m_strExplicitAppName [protected]

---

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

• D:/source/c++/Programme/sally/sally/sallyAPI/AppBase.h
• D:/source/c++/Programme/sally/sally/sallyAPI/AppBase.cpp