SallyAPI::GUI::CWindow Class Reference

Form for viewing the c. More...

#include <Window.h>

Inheritance diagram for SallyAPI::GUI::CWindow:

List of all members.

Public Member Functions
	CWindow ()
	Default constructor.
virtual	~CWindow ()
	Destructor.
virtual void	ProcessKeyboard (char KeyboardState[256], char KeyboardStatePressed[256])
	Process a keyboard.
virtual bool	CharInputPressed (char c)
	Char input pressed.
virtual bool	KeyDown (int c)
	Key down.
virtual bool	ProcessMouseDoubleClick (int x, int y)
	Process a mouse double click.
virtual bool	ProcessMouseUp (int x, int y)
	Process a mouse up.
virtual bool	ProcessMouseDown (int x, int y)
	Process a mouse down.
virtual bool	ProcessMouseMove (int x, int y)
	Process a mouse move.
virtual void	SendMessageToParent (SallyAPI::GUI::CGUIBaseObject *reporter, int reporterId, int messageId, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL)
	Send message to parent.
virtual void	SendMessageToChilds (SallyAPI::GUI::CGUIBaseObject *reporter, int reporterId, int messageId, SallyAPI::GUI::SendMessage::CParameterBase *messageParameter=NULL)
	Send message to childs.
virtual CWindowMessage	GetMessage ()
	Gets the message.
virtual void	Timer (float timeDelta)
	Timers.
virtual void	GetAbsolutPosition (int *x, int *y)
	Gets an absolut position.
virtual void	Render ()
	Renders this object.
virtual void	Update ()
	Updates this object.
virtual void	SaveConfig ()
	Is called before Sally is closed. Here you save your config.
void	AddChild (SallyAPI::GUI::CControl *control)
	Adds a child.
void	RemoveChild (std::list< SallyAPI::GUI::CControl * >::iterator iter)
	Removes the child described by iter.
void	RemoveChild (SallyAPI::GUI::CControl *control)
	Removes the child described by control.
Protected Member Functions
virtual void	RenderControl ()
	Renders a control.
virtual void	UpdateControl ()
	Updates a control.
Protected Attributes
std::list< CControl * >	m_GUIControlList
std::list< CWindowMessage * >	m_iMessages

---

Detailed Description

Form for viewing the c.

Author:

Christian Knobloch

Date:

19.04.2010

---

Constructor & Destructor Documentation

CWindow::CWindow

(

)

Default constructor.

Author:

Christian Knobloch

Date:

19.04.2010

CWindow::~CWindow

(

)

[virtual]

Destructor.

Author:

Christian Knobloch

Date:

19.04.2010

---

Member Function Documentation

void CWindow::AddChild

(

SallyAPI::GUI::CControl *

control

)

Adds a child.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

[in,out]

control

If non-null, the control.

bool CWindow::CharInputPressed

(

char

c

)

[virtual]

Char input pressed.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

c	The character.

Returns:

true if it succeeds, false if it fails.

void CWindow::GetAbsolutPosition	(	int *	x,
		int *	y
	)		[virtual]

Gets an absolut position.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

[in,out]	x	If non-null, the x coordinate.
[in,out]	y	If non-null, the y coordinate.

Reimplemented from SallyAPI::GUI::CGUIBaseObject.

CWindowMessage CWindow::GetMessage

(

)

[virtual]

Gets the message.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The message.

bool CWindow::KeyDown

(

int

c

)

[virtual]

Key down.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

c

The.

Returns:

true if it succeeds, false if it fails.

void CWindow::ProcessKeyboard	(	char	KeyboardState[256],
		char	KeyboardStatePressed[256]
	)		[virtual]

Process a keyboard.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

KeyboardState	State of the keyboard.
KeyboardStatePressed	The keyboard state pressed.

bool CWindow::ProcessMouseDoubleClick	(	int	iX,
		int	iY
	)		[virtual]

Process a mouse double click.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

iX	The x coordinate.
iY	The y coordinate.

Returns:

true if it succeeds, false if it fails.

bool CWindow::ProcessMouseDown	(	int	iX,
		int	iY
	)		[virtual]

Process a mouse down.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

iX	The x coordinate.
iY	The y coordinate.

Returns:

true if it succeeds, false if it fails.

bool CWindow::ProcessMouseMove	(	int	iX,
		int	iY
	)		[virtual]

Process a mouse move.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

iX	The x coordinate.
iY	The y coordinate.

Returns:

true if it succeeds, false if it fails.

bool CWindow::ProcessMouseUp	(	int	iX,
		int	iY
	)		[virtual]

Process a mouse up.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

iX	The x coordinate.
iY	The y coordinate.

Returns:

true if it succeeds, false if it fails.

void CWindow::RemoveChild

(

std::list< SallyAPI::GUI::CControl * >::iterator

iter

)

Removes the child described by iter.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

[in,out]

iter

If non-null, the iterator.

void CWindow::RemoveChild

(

SallyAPI::GUI::CControl *

control

)

Removes the child described by control.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

[in,out]

control

If non-null, the control.

void CWindow::Render

(

)

[virtual]

Renders this object.

Author:

Christian Knobloch

Date:

19.04.2010

Reimplemented from SallyAPI::GUI::CGUIBaseObject.

void CWindow::RenderControl

(

)

[protected, virtual]

Renders a control.

Author:

Christian Knobloch

Date:

19.04.2010

Implements SallyAPI::GUI::CGUIBaseObject.

void CWindow::SaveConfig

(

)

[virtual]

Is called before Sally is closed. Here you save your config.

Author:

Christian Knobloch

Date:

25.05.2010

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

Send message to childs.

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.

Implements SallyAPI::GUI::CGUIBaseObject.

void CWindow::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.

Implements SallyAPI::GUI::CGUIBaseObject.

void CWindow::Timer

(

float

timeDelta

)

[virtual]

Timers.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

timeDelta

The time delta.

Reimplemented from SallyAPI::GUI::CGUIBaseObject.

void CWindow::Update

(

)

[virtual]

Updates this object.

Author:

Christian Knobloch

Date:

30.04.2010

Reimplemented from SallyAPI::GUI::CGUIBaseObject.

void CWindow::UpdateControl

(

)

[protected, virtual]

Updates a control.

Author:

Christian Knobloch

Date:

30.04.2010

Implements SallyAPI::GUI::CGUIBaseObject.

---

Member Data Documentation

std::list<CControl*> SallyAPI::GUI::CWindow::m_GUIControlList [protected]

std::list<CWindowMessage*> SallyAPI::GUI::CWindow::m_iMessages [protected]

---

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

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