WindowLayout Class Reference

#include <WindowLayout.h>

Inherits MemoryPoolObject.

Public Member Functions
	WindowLayout (void)
AsciiString	getFilename (void)
	return source window filename
Bool	load (AsciiString filename)
	create windows and load from .wnd file
void	hide (Bool hide)
	hide/unhide all windows on this screen
Bool	isHidden (void)
	return visible state of screen
void	bringForward (void)
	bring all windows in this screen forward
void	addWindow (GameWindow *window)
	add window to screen
void	removeWindow (GameWindow *window)
	remove window from screen
void	destroyWindows (void)
	destroy all windows in this screen
GameWindow *	getFirstWindow (void)
	get first window in list for screen
void	runInit (void *userData=NULL)
	run the init method if available
void	runUpdate (void *userData=NULL)
	run the update method if available
void	runShutdown (void *userData=NULL)
	run the shutdown method if available
void	setInit (WindowLayoutInitFunc init)
	set the init callback
void	setUpdate (WindowLayoutUpdateFunc update)
	set the update callback
void	setShutdown (WindowLayoutShutdownFunc shutdown)
	set the shutdown callback
Public Member Functions inherited from MemoryPoolObject
void	deleteInstance ()

Protected Member Functions
GameWindow *	findWindow (GameWindow *window)
	find window in this layout
Protected Member Functions inherited from MemoryPoolObject
virtual	~MemoryPoolObject ()
void *	operator new (size_t s)
void	operator delete (void *p)
virtual MemoryPool *	getObjectMemoryPool ()=0

Protected Attributes
AsciiString	m_filenameString
	layout filename
GameWindow *	m_windowList
	list of windows in this layout
GameWindow *	m_windowTail
	end of m_windowList
Int	m_windowCount
	how man windows are in the list
Bool	m_hidden
	visible state of this screen
WindowLayoutInitFunc	m_init
	init callback
WindowLayoutUpdateFunc	m_update
	update callback
WindowLayoutShutdownFunc	m_shutdown
	shutdown callback

Detailed Description

The representation of a screen layout loaded from a .wnd layout script file

Definition at line 53 of file WindowLayout.h.

Constructor & Destructor Documentation

WindowLayout()

WindowLayout::WindowLayout

(

void

)

Definition at line 46 of file WindowLayout.cpp.

Member Function Documentation

addWindow()

void WindowLayout::addWindow

(

GameWindow *

window

)

add window to screen

Add window to this layout

Definition at line 100 of file WindowLayout.cpp.

bringForward()

void WindowLayout::bringForward

(

void

)

bring all windows in this screen forward

Bring all windows in this layout forward

Definition at line 267 of file WindowLayout.cpp.

destroyWindows()

void WindowLayout::destroyWindows

(

void

)

destroy all windows in this screen

Destroy all the windows in a layout

Definition at line 174 of file WindowLayout.cpp.

findWindow()

GameWindow * WindowLayout::findWindow ( GameWindow * window )

protected

find window in this layout

Find window within this layout

Definition at line 298 of file WindowLayout.cpp.

getFilename()

AsciiString WindowLayout::getFilename ( void )

inline

return source window filename

Definition at line 113 of file WindowLayout.h.

getFirstWindow()

GameWindow * WindowLayout::getFirstWindow ( void )

inline

get first window in list for screen

Definition at line 114 of file WindowLayout.h.

hide()

void WindowLayout::hide

(

Bool

hide

)

hide/unhide all windows on this screen

Set the hidden/visible status of all the windows in this layout

Definition at line 80 of file WindowLayout.cpp.

isHidden()

Bool WindowLayout::isHidden ( void )

inline

return visible state of screen

Definition at line 115 of file WindowLayout.h.

load()

Bool WindowLayout::load

(

AsciiString

filename

)

create windows and load from .wnd file

Create the windows using the .wnd file script and load all windows into this layout

Definition at line 199 of file WindowLayout.cpp.

removeWindow()

void WindowLayout::removeWindow

(

GameWindow *

window

)

remove window from screen

Remove window from this layout

Definition at line 136 of file WindowLayout.cpp.

runInit()

void WindowLayout::runInit ( void * userData = NULL )

inline

run the init method if available

Definition at line 117 of file WindowLayout.h.

runShutdown()

void WindowLayout::runShutdown ( void * userData = NULL )

inline

run the shutdown method if available

Definition at line 119 of file WindowLayout.h.

runUpdate()

void WindowLayout::runUpdate ( void * userData = NULL )

inline

run the update method if available

Definition at line 118 of file WindowLayout.h.

setInit()

void WindowLayout::setInit ( WindowLayoutInitFunc init )

inline

set the init callback

Definition at line 121 of file WindowLayout.h.

setShutdown()

void WindowLayout::setShutdown ( WindowLayoutShutdownFunc shutdown )

inline

set the shutdown callback

Definition at line 123 of file WindowLayout.h.

setUpdate()

void WindowLayout::setUpdate ( WindowLayoutUpdateFunc update )

inline

set the update callback

Definition at line 122 of file WindowLayout.h.

Member Data Documentation

m_filenameString

AsciiString WindowLayout::m_filenameString

protected

layout filename

Definition at line 94 of file WindowLayout.h.

m_hidden

Bool WindowLayout::m_hidden

protected

visible state of this screen

Definition at line 98 of file WindowLayout.h.

m_init

WindowLayoutInitFunc WindowLayout::m_init

protected

init callback

Definition at line 106 of file WindowLayout.h.

m_shutdown

WindowLayoutShutdownFunc WindowLayout::m_shutdown

protected

shutdown callback

Definition at line 108 of file WindowLayout.h.

m_update

WindowLayoutUpdateFunc WindowLayout::m_update

protected

update callback

Definition at line 107 of file WindowLayout.h.

m_windowCount

Int WindowLayout::m_windowCount

protected

how man windows are in the list

Definition at line 97 of file WindowLayout.h.

m_windowList

GameWindow* WindowLayout::m_windowList

protected

list of windows in this layout

Definition at line 95 of file WindowLayout.h.

m_windowTail

GameWindow* WindowLayout::m_windowTail

protected

end of m_windowList

Definition at line 96 of file WindowLayout.h.

---

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

• Code/GameEngine/Include/GameClient/WindowLayout.h
• Code/GameEngine/Source/GameClient/GUI/WindowLayout.cpp