#include <GameWindow.h>

Public Member Functions
	GameWindow (void)

virtual void	winDrawBorder (void)=0
	draw border for this window only, NO child windows or anything

Int	winSetWindowId (Int id)
	set id for this window

Int	winGetWindowId (void)
	return window id for this window

Int	winSetSize (Int width, Int height)
	set size

Int	winGetSize (Int width, Int height)
	return size

Int	winActivate (void)
	pop window to top of list and activate

Int	winBringToTop (void)
	bring this window to the top of the win list

Int	winEnable (Bool enable)

Bool	winGetEnabled (void)
	Is window enabled?

Int	winHide (Bool hide)
	hide/unhide a window

Bool	winIsHidden (void)
	is this window hidden/

UnsignedInt	winSetStatus (UnsignedInt status)
	set status bits

UnsignedInt	winClearStatus (UnsignedInt status)
	clear status bits

UnsignedInt	winGetStatus (void)
	get status bits

UnsignedInt	winGetStyle (void)
	get style bits

Int	winNextTab (void)
	advance focus to next window

Int	winPrevTab (void)
	change focus to previous window

Int	winSetPosition (Int x, Int y)
	set window position

Int	winGetPosition (Int x, Int y)
	get window position

Int	winGetScreenPosition (Int x, Int y)
	get screen coordinates

Int	winGetRegion (IRegion2D *region)
	get window region

Int	winSetCursorPosition (Int x, Int y)
	set window cursor position

Int	winGetCursorPosition (Int x, Int y)
	get window cursor position

Int	winSetEnabledImage (Int index, const Image *image)

Int	winSetEnabledColor (Int index, Color color)

Int	winSetEnabledBorderColor (Int index, Color color)

const Image *	winGetEnabledImage (Int index)

Color	winGetEnabledColor (Int index)

Color	winGetEnabledBorderColor (Int index)

Int	winSetDisabledImage (Int index, const Image *image)

Int	winSetDisabledColor (Int index, Color color)

Int	winSetDisabledBorderColor (Int index, Color color)

const Image *	winGetDisabledImage (Int index)

Color	winGetDisabledColor (Int index)

Color	winGetDisabledBorderColor (Int index)

Int	winSetHiliteImage (Int index, const Image *image)

Int	winSetHiliteColor (Int index, Color color)

Int	winSetHiliteBorderColor (Int index, Color color)

const Image *	winGetHiliteImage (Int index)

Color	winGetHiliteColor (Int index)

Color	winGetHiliteBorderColor (Int index)

Int	winDrawWindow (void)
	draws the default background

void	winSetDrawOffset (Int x, Int y)
	set offset for drawing background image data

void	winGetDrawOffset (Int x, Int y)
	get draw offset

void	winSetHiliteState (Bool state)
	set hilite state

void	winSetTooltip (UnicodeString tip)
	set tooltip text

Int	getTooltipDelay ()
	get tooltip delay

void	setTooltipDelay (Int delay)
	set tooltip delay

virtual Int	winSetText (UnicodeString newText)
	set text string

UnicodeString	winGetText (void)
	get text string

Int	winGetTextLength ()
	get number of chars in text string

GameFont *	winGetFont (void)
	get the font being used by this window

virtual void	winSetFont (GameFont *font)
	set font for window

void	winSetEnabledTextColors (Color color, Color borderColor)

void	winSetDisabledTextColors (Color color, Color borderColor)

void	winSetIMECompositeTextColors (Color color, Color borderColor)

void	winSetHiliteTextColors (Color color, Color borderColor)

Color	winGetEnabledTextColor (void)

Color	winGetEnabledTextBorderColor (void)

Color	winGetDisabledTextColor (void)

Color	winGetDisabledTextBorderColor (void)

Color	winGetIMECompositeTextColor (void)

Color	winGetIMECompositeBorderColor (void)

Color	winGetHiliteTextColor (void)

Color	winGetHiliteTextBorderColor (void)

Int	winSetInstanceData (WinInstanceData *data)
	copy over instance data

WinInstanceData *	winGetInstanceData (void)
	get instance data

void *	winGetUserData (void)
	get the window user data

void	winSetUserData (void *userData)
	set the user data

Int	winSetParent (GameWindow *parent)
	set parent

GameWindow *	winGetParent (void)
	get parent

Bool	winIsChild (GameWindow *child)
	verifies parent

GameWindow *	winGetChild (void)
	get the child window

Int	winSetOwner (GameWindow *owner)
	set owner

GameWindow *	winGetOwner (void)
	get window's owner

void	winSetNext (GameWindow *next)
	set next pointer

void	winSetPrev (GameWindow *prev)
	set prev pointer

GameWindow *	winGetNext (void)
	get next window in window list

GameWindow *	winGetPrev (void)
	get previous window in window list

void	winSetNextInLayout (GameWindow *next)
	set next in layout

void	winSetPrevInLayout (GameWindow *prev)
	set prev in layout

void	winSetLayout (WindowLayout *layout)
	set layout

WindowLayout *	winGetLayout (void)
	get layout layout

GameWindow *	winGetNextInLayout (void)
	get next window in layout

GameWindow *	winGetPrevInLayout (void)
	get prev window in layout

Int	winSetSystemFunc (GameWinSystemFunc system)
	set system

Int	winSetInputFunc (GameWinInputFunc input)
	set input

Int	winSetDrawFunc (GameWinDrawFunc draw)
	set draw

Int	winSetTooltipFunc (GameWinTooltipFunc tooltip)
	set tooltip

Int	winSetCallbacks (GameWinInputFunc input, GameWinDrawFunc draw, GameWinTooltipFunc tooltip)
	set draw, input, tooltip

Bool	winPointInWindow (Int x, Int y)

GameWindow *	winPointInChild (Int x, Int y, Bool ignoreEnableCheck=FALSE, Bool playDisabledSound=FALSE)

GameWindow *	winPointInAnyChild (Int x, Int y, Bool ignoreHidden, Bool ignoreEnableCheck=FALSE)

GameWinInputFunc	winGetInputFunc (void)

GameWinSystemFunc	winGetSystemFunc (void)

GameWinDrawFunc	winGetDrawFunc (void)

GameWinTooltipFunc	winGetTooltipFunc (void)

void	winSetEditData (GameWindowEditData *editData)

GameWindowEditData *	winGetEditData (void)

Public Member Functions inherited from MemoryPoolObject
void	deleteInstance ()

Protected Member Functions
void	freeImages (void)
	'images' should be taken care of when we hide ourselves or are destroyed

Bool	isEnabled (void)
	see if we and our parents are enabled

void	normalizeWindowRegion (void)
	put UL corner in window region.lo

GameWindow *	findFirstLeaf (void)
	return first leaf of branch

GameWindow *	findLastLeaf (void)
	return last leaf of branch

GameWindow *	findPrevLeaf (void)
	return prev leav in tree

GameWindow *	findNextLeaf (void)
	return next leaf in tree

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
Int	m_status

ICoord2D	m_size

IRegion2D	m_region

Int	m_cursorX

Int	m_cursorY

void *	m_userData

WinInstanceData	m_instData

void *	m_inputData

GameWinInputFunc	m_input
	callback for input

GameWinSystemFunc	m_system
	callback for system messages

GameWinDrawFunc	m_draw
	callback for drawing

GameWinTooltipFunc	m_tooltip
	callback for tooltip execution

GameWindow *	m_next

GameWindow *	m_prev

GameWindow *	m_parent

GameWindow *	m_child

GameWindow *	m_nextLayout
	next in layout

GameWindow *	m_prevLayout
	prev in layout

WindowLayout *	m_layout
	layout this window is a part of

GameWindowEditData *	m_editData

Friends
class	GameWindowManager
	< this abstract class needs memory pool hooks

Detailed Description

Class definition for a game window. These are the basic elements of the whole windowing sytem, all windows are GameWindows, as are all GUI controls etc.

Definition at line 230 of file GameWindow.h.

Constructor & Destructor Documentation

◆ GameWindow()

GameWindow::GameWindow ( void )

Definition at line 86 of file GameWindow.cpp.

Member Function Documentation

◆ findFirstLeaf()

GameWindow * GameWindow::findFirstLeaf ( void )

protected

return first leaf of branch

Returns the first leaf of the branch

Definition at line 171 of file GameWindow.cpp.

◆ findLastLeaf()

GameWindow * GameWindow::findLastLeaf ( void )

protected

return last leaf of branch

Returns the last leaf of the branch

Definition at line 190 of file GameWindow.cpp.

◆ findNextLeaf()

GameWindow * GameWindow::findNextLeaf ( void )

protected

return next leaf in tree

Returns the next leaf of the tree

Definition at line 283 of file GameWindow.cpp.

◆ findPrevLeaf()

GameWindow * GameWindow::findPrevLeaf ( void )

protected

return prev leav in tree

Returns the prev leaf of the tree

Definition at line 216 of file GameWindow.cpp.

◆ freeImages()

void GameWindow::freeImages ( void )

inlineprotected

'images' should be taken care of when we hide ourselves or are destroyed

Definition at line 382 of file GameWindow.h.

◆ getTooltipDelay()

Int GameWindow::getTooltipDelay ( )

inline

get tooltip delay

Definition at line 299 of file GameWindow.h.

◆ isEnabled()

Bool GameWindow::isEnabled ( void )

protected

see if we and our parents are enabled

◆ normalizeWindowRegion()

void GameWindow::normalizeWindowRegion ( void )

protected

put UL corner in window region.lo

Puts the upper left corner in the window's region.lo field

Definition at line 144 of file GameWindow.cpp.

◆ setTooltipDelay()

void GameWindow::setTooltipDelay ( Int delay )

inline

set tooltip delay

Definition at line 300 of file GameWindow.h.

◆ winActivate()

Int GameWindow::winActivate ( void )

pop window to top of list and activate

Pop window to top of window list AND activate it

Definition at line 461 of file GameWindow.cpp.

◆ winBringToTop()

Int GameWindow::winBringToTop ( void )

bring this window to the top of the win list

Bring this window to the top of the window list, if we have a parent we will go to the top of the child list for that parent

Definition at line 406 of file GameWindow.cpp.

◆ winClearStatus()

UnsignedInt GameWindow::winClearStatus ( UnsignedInt status )

clear status bits

Allows the user to directly clear a window's status flags.

Definition at line 734 of file GameWindow.cpp.

◆ winDrawBorder()

virtual void GameWindow::winDrawBorder ( void )

pure virtual

draw border for this window only, NO child windows or anything

Implemented in W3DGameWindow.

◆ winDrawWindow()

Int GameWindow::winDrawWindow ( void )

draws the default background

Draws the default background for the specified window.

Definition at line 1377 of file GameWindow.cpp.

◆ winEnable()

Int GameWindow::winEnable ( Bool enable )

enable/disable a window, a disbled window can be seen but accepts no input

Enable or disable a window based on the enable parameter. A disabled window can be seen but accepts no input.

Definition at line 640 of file GameWindow.cpp.

◆ winGetChild()

GameWindow * GameWindow::winGetChild ( void )

get the child window

Get the child window of this window

Definition at line 1182 of file GameWindow.cpp.

◆ winGetCursorPosition()

Int GameWindow::winGetCursorPosition	(	Int *	x,
		Int *	y )

get window cursor position

Get the window's cursor postion

Definition at line 528 of file GameWindow.cpp.

◆ winGetDisabledBorderColor()

Color GameWindow::winGetDisabledBorderColor ( Int index )

inline

Definition at line 283 of file GameWindow.h.

◆ winGetDisabledColor()

Color GameWindow::winGetDisabledColor ( Int index )

inline

Definition at line 282 of file GameWindow.h.

◆ winGetDisabledImage()

const Image * GameWindow::winGetDisabledImage ( Int index )

inline

Definition at line 281 of file GameWindow.h.

◆ winGetDisabledTextBorderColor()

Color GameWindow::winGetDisabledTextBorderColor ( void )

Get the disabled text color

Definition at line 968 of file GameWindow.cpp.

◆ winGetDisabledTextColor()

Color GameWindow::winGetDisabledTextColor ( void )

Get the disabled text color

Definition at line 958 of file GameWindow.cpp.

◆ winGetDrawFunc()

GameWinDrawFunc GameWindow::winGetDrawFunc ( void )

Definition at line 1779 of file GameWindow.cpp.

◆ winGetDrawOffset()

void GameWindow::winGetDrawOffset	(	Int *	x,
		Int *	y )

get draw offset

Get offset for drawing images

Definition at line 792 of file GameWindow.cpp.

◆ winGetEditData()

GameWindowEditData * GameWindow::winGetEditData ( void )

Definition at line 1797 of file GameWindow.cpp.

◆ winGetEnabled()

Bool GameWindow::winGetEnabled ( void )

Is window enabled?

Enable or disable a window based on the enable parameter. A disabled window can be seen but accepts no input.

Definition at line 665 of file GameWindow.cpp.

◆ winGetEnabledBorderColor()

Color GameWindow::winGetEnabledBorderColor ( Int index )

inline

Definition at line 276 of file GameWindow.h.

◆ winGetEnabledColor()

Color GameWindow::winGetEnabledColor ( Int index )

inline

Definition at line 275 of file GameWindow.h.

◆ winGetEnabledImage()

const Image * GameWindow::winGetEnabledImage ( Int index )

inline

Definition at line 274 of file GameWindow.h.

◆ winGetEnabledTextBorderColor()

Color GameWindow::winGetEnabledTextBorderColor ( void )

Get the enabled text color

Definition at line 948 of file GameWindow.cpp.

◆ winGetEnabledTextColor()

Color GameWindow::winGetEnabledTextColor ( void )

Get the enabled text color

Definition at line 938 of file GameWindow.cpp.

◆ winGetFont()

GameFont * GameWindow::winGetFont ( void )

get the font being used by this window

Get the font being used by this window

Definition at line 839 of file GameWindow.cpp.

◆ winGetHiliteBorderColor()

Color GameWindow::winGetHiliteBorderColor ( Int index )

inline

Definition at line 290 of file GameWindow.h.

◆ winGetHiliteColor()

Color GameWindow::winGetHiliteColor ( Int index )

inline

Definition at line 289 of file GameWindow.h.

◆ winGetHiliteImage()

const Image * GameWindow::winGetHiliteImage ( Int index )

inline

Definition at line 288 of file GameWindow.h.

◆ winGetHiliteTextBorderColor()

Color GameWindow::winGetHiliteTextBorderColor ( void )

Get the hilite text color

Definition at line 1008 of file GameWindow.cpp.

◆ winGetHiliteTextColor()

Color GameWindow::winGetHiliteTextColor ( void )

Get the hilite text color

Definition at line 998 of file GameWindow.cpp.

◆ winGetIMECompositeBorderColor()

Color GameWindow::winGetIMECompositeBorderColor ( void )

Get the IME composite border color

Definition at line 988 of file GameWindow.cpp.

◆ winGetIMECompositeTextColor()

Color GameWindow::winGetIMECompositeTextColor ( void )

Get the IME composite text color

Definition at line 978 of file GameWindow.cpp.

◆ winGetInputFunc()

GameWinInputFunc GameWindow::winGetInputFunc ( void )

Definition at line 1752 of file GameWindow.cpp.

◆ winGetInstanceData()

WinInstanceData * GameWindow::winGetInstanceData ( void )

get instance data

Return pointer to the instance data for this window

Definition at line 1052 of file GameWindow.cpp.

◆ winGetLayout()

WindowLayout * GameWindow::winGetLayout ( void )

get layout layout

Get layout this window is a part of, if any

Definition at line 1281 of file GameWindow.cpp.

◆ winGetNext()

GameWindow * GameWindow::winGetNext ( void )

get next window in window list

Gets the next window

Definition at line 1227 of file GameWindow.cpp.

◆ winGetNextInLayout()

GameWindow * GameWindow::winGetNextInLayout ( void )

get next window in layout

Get next window in layout list if any

Definition at line 1289 of file GameWindow.cpp.

◆ winGetOwner()

GameWindow * GameWindow::winGetOwner ( void )

get window's owner

Gets the window's owner

Definition at line 1207 of file GameWindow.cpp.

◆ winGetParent()

GameWindow * GameWindow::winGetParent ( void )

get parent

Gets the window's parent

Definition at line 1151 of file GameWindow.cpp.

◆ winGetPosition()

Int GameWindow::winGetPosition	(	Int *	x,
		Int *	y )

get window position

Get the window's postion

Definition at line 499 of file GameWindow.cpp.

◆ winGetPrev()

GameWindow * GameWindow::winGetPrev ( void )

get previous window in window list

Get the previous window

Definition at line 1247 of file GameWindow.cpp.

◆ winGetPrevInLayout()

GameWindow * GameWindow::winGetPrevInLayout ( void )

get prev window in layout

Get prev window in layout list if any

Definition at line 1297 of file GameWindow.cpp.

◆ winGetRegion()

Int GameWindow::winGetRegion ( IRegion2D * region )

get window region

Get the window region

Definition at line 570 of file GameWindow.cpp.

◆ winGetScreenPosition()

Int GameWindow::winGetScreenPosition	(	Int *	x,
		Int *	y )

get screen coordinates

Get the window's postion in screen coordinates

Definition at line 547 of file GameWindow.cpp.

◆ winGetSize()

Int GameWindow::winGetSize	(	Int *	width,
		Int *	height )

return size

Get the window's size

Definition at line 622 of file GameWindow.cpp.

◆ winGetStatus()

UnsignedInt GameWindow::winGetStatus ( void )

get status bits

Returns a window's status flags.

Definition at line 748 of file GameWindow.cpp.

◆ winGetStyle()

UnsignedInt GameWindow::winGetStyle ( void )

get style bits

Returns a window's style flags.

Definition at line 758 of file GameWindow.cpp.

◆ winGetSystemFunc()

GameWinSystemFunc GameWindow::winGetSystemFunc ( void )

Definition at line 1761 of file GameWindow.cpp.

◆ winGetText()

UnicodeString GameWindow::winGetText ( void )

get text string

Get text from a window ... this works for static text windows and edit boxes

Definition at line 820 of file GameWindow.cpp.

◆ winGetTextLength()

Int GameWindow::winGetTextLength ( )

get number of chars in text string

Definition at line 829 of file GameWindow.cpp.

◆ winGetTooltipFunc()

GameWinTooltipFunc GameWindow::winGetTooltipFunc ( void )

Definition at line 1770 of file GameWindow.cpp.

◆ winGetUserData()

void * GameWindow::winGetUserData ( void )

get the window user data

Return the user data stored

Definition at line 1062 of file GameWindow.cpp.

◆ winGetWindowId()

Int GameWindow::winGetWindowId ( void )

return window id for this window

Gets the window's id

Definition at line 1104 of file GameWindow.cpp.

◆ winHide()

Int GameWindow::winHide ( Bool hide )

hide/unhide a window

Hide or show a window based on the hide parameter. A hidden window can't be seen and accepts no input.

Definition at line 675 of file GameWindow.cpp.

◆ winIsChild()

Bool GameWindow::winIsChild ( GameWindow * child )

verifies parent

Determins if a window is a child/grand-child of a parent

Definition at line 1161 of file GameWindow.cpp.

◆ winIsHidden()

Bool GameWindow::winIsHidden ( void )

is this window hidden/

Am I hidden?

Definition at line 709 of file GameWindow.cpp.

◆ winNextTab()

Int GameWindow::winNextTab ( void )

advance focus to next window

Go to next window in tab chain

Definition at line 333 of file GameWindow.cpp.

◆ winPointInAnyChild()

GameWindow * GameWindow::winPointInAnyChild	(	Int	x,
		Int	y,
		Bool	ignoreHidden,
		Bool	ignoreEnableCheck = FALSE )

finds the child which contains the mouse pointer - reguardless of the enabled status of the child

Find the child in which the cursor resides; regardless of whether or not the window is actually enabled

Definition at line 1446 of file GameWindow.cpp.

◆ winPointInChild()

GameWindow * GameWindow::winPointInChild	(	Int	x,
		Int	y,
		Bool	ignoreEnableCheck = FALSE,
		Bool	playDisabledSound = FALSE )

is point inside this window? also return TRUE if point is in a child given a piont, return the child window which contains the mouse pointer, if the point is not in a chilc, the function returns the 'window' paramater back to the caller

Given a window and the mouse coordinates, return the child window which contains the mouse pointer. Child windows are relative to their parents

Definition at line 1392 of file GameWindow.cpp.

◆ winPointInWindow()

Bool GameWindow::winPointInWindow	(	Int	x,
		Int	y )

Check to see if the given point is inside the window. Will still return true if the point is actually in a child.

Definition at line 584 of file GameWindow.cpp.

◆ winPrevTab()

Int GameWindow::winPrevTab ( void )

change focus to previous window

Go to previous window in tab chain

Definition at line 368 of file GameWindow.cpp.

◆ winSetCallbacks()

Int GameWindow::winSetCallbacks	(	GameWinInputFunc	input,
		GameWinDrawFunc	draw,
		GameWinTooltipFunc	tooltip )

set draw, input, tooltip

Sets the window's input, tooltip, and redraw callback functions.

Definition at line 1361 of file GameWindow.cpp.

◆ winSetCursorPosition()

Int GameWindow::winSetCursorPosition	(	Int	x,
		Int	y )

set window cursor position

Set the window's cursor postion

Definition at line 516 of file GameWindow.cpp.

◆ winSetDisabledBorderColor()

Int GameWindow::winSetDisabledBorderColor	(	Int	index,
		Color	color )

set border color for state at this index

Definition at line 1669 of file GameWindow.cpp.

◆ winSetDisabledColor()

Int GameWindow::winSetDisabledColor	(	Int	index,
		Color	color )

set color for disabled state at index

Definition at line 1648 of file GameWindow.cpp.

◆ winSetDisabledImage()

Int GameWindow::winSetDisabledImage	(	Int	index,
		const Image *	image )

Set an disabled image into the draw data for the disabled state

Definition at line 1627 of file GameWindow.cpp.

◆ winSetDisabledTextColors()

void GameWindow::winSetDisabledTextColors	(	Color	color,
		Color	borderColor )

Set the text colors for the disabled state

Definition at line 897 of file GameWindow.cpp.

◆ winSetDrawFunc()

Int GameWindow::winSetDrawFunc ( GameWinDrawFunc draw )

set draw

Sets the window's redraw callback functions.

Definition at line 1334 of file GameWindow.cpp.

◆ winSetDrawOffset()

void GameWindow::winSetDrawOffset	(	Int	x,
		Int	y )

set offset for drawing background image data

Set offset for drawing images

Definition at line 781 of file GameWindow.cpp.

◆ winSetEditData()

void GameWindow::winSetEditData ( GameWindowEditData * editData )

Definition at line 1788 of file GameWindow.cpp.

◆ winSetEnabledBorderColor()

Int GameWindow::winSetEnabledBorderColor	(	Int	index,
		Color	color )

set border color for state at this index

Definition at line 1606 of file GameWindow.cpp.

◆ winSetEnabledColor()

Int GameWindow::winSetEnabledColor	(	Int	index,
		Color	color )

set color for enabled state at index

Definition at line 1585 of file GameWindow.cpp.

◆ winSetEnabledImage()

Int GameWindow::winSetEnabledImage	(	Int	index,
		const Image *	image )

Set an enabled image into the draw data for the enabled state

Definition at line 1564 of file GameWindow.cpp.

◆ winSetEnabledTextColors()

void GameWindow::winSetEnabledTextColors	(	Color	color,
		Color	borderColor )

Set the text colors for the enabled state

Definition at line 883 of file GameWindow.cpp.

◆ winSetFont()

void GameWindow::winSetFont ( GameFont * font )

virtual

set font for window

Set font for text in this window

Reimplemented in W3DGameWindow.

Definition at line 849 of file GameWindow.cpp.

◆ winSetHiliteBorderColor()

Int GameWindow::winSetHiliteBorderColor	(	Int	index,
		Color	color )

set border color for state at this index

Definition at line 1732 of file GameWindow.cpp.

◆ winSetHiliteColor()

Int GameWindow::winSetHiliteColor	(	Int	index,
		Color	color )

set color for hilite state at index

Definition at line 1711 of file GameWindow.cpp.

◆ winSetHiliteImage()

Int GameWindow::winSetHiliteImage	(	Int	index,
		const Image *	image )

Set an hilite image into the draw data for the hilite state

Definition at line 1690 of file GameWindow.cpp.

◆ winSetHiliteState()

void GameWindow::winSetHiliteState ( Bool state )

set hilite state

Set whether window is highlighted or not

Definition at line 768 of file GameWindow.cpp.

◆ winSetHiliteTextColors()

void GameWindow::winSetHiliteTextColors	(	Color	color,
		Color	borderColor )

Set the text colors for the Hilite state

Definition at line 911 of file GameWindow.cpp.

◆ winSetIMECompositeTextColors()

void GameWindow::winSetIMECompositeTextColors	(	Color	color,
		Color	borderColor )

Set the text colors for the IME Composite state

Definition at line 925 of file GameWindow.cpp.

◆ winSetInputFunc()

Int GameWindow::winSetInputFunc ( GameWinInputFunc input )

set input

Sets the window's input callback functions.

Definition at line 1319 of file GameWindow.cpp.

◆ winSetInstanceData()

Int GameWindow::winSetInstanceData ( WinInstanceData * data )

copy over instance data

Sets the window's instance data which includes parameters such as background color.

Definition at line 1019 of file GameWindow.cpp.

◆ winSetLayout()

void GameWindow::winSetLayout ( WindowLayout * layout )

set layout

Set this window as belonging to layout 'layout'

Definition at line 1273 of file GameWindow.cpp.

◆ winSetNext()

void GameWindow::winSetNext ( GameWindow * next )

set next pointer

Set next pointer

Definition at line 1217 of file GameWindow.cpp.

◆ winSetNextInLayout()

void GameWindow::winSetNextInLayout ( GameWindow * next )

set next in layout

Set next window in layout

Definition at line 1257 of file GameWindow.cpp.

◆ winSetOwner()

Int GameWindow::winSetOwner ( GameWindow * owner )

set owner

Sets the window's owner

Definition at line 1192 of file GameWindow.cpp.

◆ winSetParent()

Int GameWindow::winSetParent ( GameWindow * parent )

set parent

Sets this window's parent

Definition at line 1114 of file GameWindow.cpp.

◆ winSetPosition()

Int GameWindow::winSetPosition	(	Int	x,
		Int	y )

set window position

Set the window's position

Definition at line 481 of file GameWindow.cpp.

◆ winSetPrev()

void GameWindow::winSetPrev ( GameWindow * prev )

set prev pointer

Set prev pointer

Definition at line 1237 of file GameWindow.cpp.

◆ winSetPrevInLayout()

void GameWindow::winSetPrevInLayout ( GameWindow * prev )

set prev in layout

Set previous window in layout pointer

Definition at line 1265 of file GameWindow.cpp.

◆ winSetSize()

Int GameWindow::winSetSize	(	Int	width,
		Int	height )

set size

Set the window's size

Definition at line 602 of file GameWindow.cpp.

◆ winSetStatus()

UnsignedInt GameWindow::winSetStatus ( UnsignedInt status )

set status bits

Allows the user to directly set a window's status flags.

Definition at line 719 of file GameWindow.cpp.

◆ winSetSystemFunc()

Int GameWindow::winSetSystemFunc ( GameWinSystemFunc system )

set system

Sets the window's input, system, and redraw callback functions.

Definition at line 1305 of file GameWindow.cpp.

◆ winSetText()

Int GameWindow::winSetText ( UnicodeString newText )

virtual

set text string

Sets the text in a window

Reimplemented in W3DGameWindow.

Definition at line 807 of file GameWindow.cpp.

◆ winSetTooltip()

void GameWindow::winSetTooltip ( UnicodeString tip )

set tooltip text

Sets the window's tooltip text

Definition at line 1082 of file GameWindow.cpp.

◆ winSetTooltipFunc()

Int GameWindow::winSetTooltipFunc ( GameWinTooltipFunc tooltip )

set tooltip

Sets a window's tooltip callback

Definition at line 1349 of file GameWindow.cpp.

◆ winSetUserData()

void GameWindow::winSetUserData ( void * data )

set the user data

Set the user data stored

Definition at line 1072 of file GameWindow.cpp.

◆ winSetWindowId()

Int GameWindow::winSetWindowId ( Int id )

set id for this window

Sets the window's id

Definition at line 1092 of file GameWindow.cpp.

Friends And Related Symbol Documentation

◆ GameWindowManager

friend class GameWindowManager

friend

< this abstract class needs memory pool hooks

Definition at line 234 of file GameWindow.h.

Member Data Documentation

◆ m_child

GameWindow* GameWindow::m_child

protected

Definition at line 413 of file GameWindow.h.

◆ m_cursorX

Int GameWindow::m_cursorX

protected

Definition at line 398 of file GameWindow.h.

◆ m_cursorY

Int GameWindow::m_cursorY

protected

Definition at line 399 of file GameWindow.h.

◆ m_draw

GameWinDrawFunc GameWindow::m_draw

protected

callback for drawing

Definition at line 408 of file GameWindow.h.

◆ m_editData

GameWindowEditData* GameWindow::m_editData

protected

Definition at line 425 of file GameWindow.h.

◆ m_input

GameWinInputFunc GameWindow::m_input

protected

callback for input

Definition at line 406 of file GameWindow.h.

◆ m_inputData

void* GameWindow::m_inputData

protected

Definition at line 403 of file GameWindow.h.

◆ m_instData

WinInstanceData GameWindow::m_instData

protected

Definition at line 402 of file GameWindow.h.

◆ m_layout

WindowLayout* GameWindow::m_layout

protected

layout this window is a part of

Definition at line 422 of file GameWindow.h.

◆ m_next

GameWindow* GameWindow::m_next

protected

Definition at line 411 of file GameWindow.h.

◆ m_nextLayout

GameWindow* GameWindow::m_nextLayout

protected

next in layout

Definition at line 420 of file GameWindow.h.

◆ m_parent

GameWindow* GameWindow::m_parent

protected

Definition at line 412 of file GameWindow.h.

◆ m_prev

GameWindow * GameWindow::m_prev

protected

Definition at line 411 of file GameWindow.h.

◆ m_prevLayout

GameWindow* GameWindow::m_prevLayout

protected

prev in layout

Definition at line 421 of file GameWindow.h.

◆ m_region

IRegion2D GameWindow::m_region

protected

Definition at line 396 of file GameWindow.h.

◆ m_size

ICoord2D GameWindow::m_size

protected

Definition at line 395 of file GameWindow.h.

◆ m_status

Int GameWindow::m_status

protected

Definition at line 394 of file GameWindow.h.

◆ m_system

GameWinSystemFunc GameWindow::m_system

protected

callback for system messages

Definition at line 407 of file GameWindow.h.

◆ m_tooltip

GameWinTooltipFunc GameWindow::m_tooltip

protected

callback for tooltip execution

Definition at line 409 of file GameWindow.h.

◆ m_userData

void* GameWindow::m_userData

protected

Definition at line 401 of file GameWindow.h.

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

Code/GameEngine/Include/GameClient/GameWindow.h
Code/GameEngine/Source/GameClient/GUI/GameWindow.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GameWindow()

Member Function Documentation

◆ findFirstLeaf()

◆ findLastLeaf()

◆ findNextLeaf()

◆ findPrevLeaf()

◆ freeImages()

◆ getTooltipDelay()

◆ isEnabled()

◆ normalizeWindowRegion()

◆ setTooltipDelay()

◆ winActivate()

◆ winBringToTop()

◆ winClearStatus()

◆ winDrawBorder()

◆ winDrawWindow()

◆ winEnable()

◆ winGetChild()

◆ winGetCursorPosition()

◆ winGetDisabledBorderColor()

◆ winGetDisabledColor()

◆ winGetDisabledImage()

◆ winGetDisabledTextBorderColor()

◆ winGetDisabledTextColor()

◆ winGetDrawFunc()

◆ winGetDrawOffset()

◆ winGetEditData()

◆ winGetEnabled()

◆ winGetEnabledBorderColor()

◆ winGetEnabledColor()

◆ winGetEnabledImage()

◆ winGetEnabledTextBorderColor()

◆ winGetEnabledTextColor()

◆ winGetFont()

◆ winGetHiliteBorderColor()

◆ winGetHiliteColor()

◆ winGetHiliteImage()

◆ winGetHiliteTextBorderColor()

◆ winGetHiliteTextColor()

◆ winGetIMECompositeBorderColor()

◆ winGetIMECompositeTextColor()

◆ winGetInputFunc()

◆ winGetInstanceData()

◆ winGetLayout()

◆ winGetNext()

◆ winGetNextInLayout()

◆ winGetOwner()

◆ winGetParent()

◆ winGetPosition()

◆ winGetPrev()

◆ winGetPrevInLayout()

◆ winGetRegion()

◆ winGetScreenPosition()

◆ winGetSize()

◆ winGetStatus()

◆ winGetStyle()

◆ winGetSystemFunc()

◆ winGetText()

◆ winGetTextLength()

◆ winGetTooltipFunc()

◆ winGetUserData()

◆ winGetWindowId()

◆ winHide()

◆ winIsChild()

◆ winIsHidden()

◆ winNextTab()

◆ winPointInAnyChild()

◆ winPointInChild()

◆ winPointInWindow()

◆ winPrevTab()

◆ winSetCallbacks()

◆ winSetCursorPosition()

◆ winSetDisabledBorderColor()

◆ winSetDisabledColor()