DigitalSpaces::DICEGUIWindow Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Detailed Description

{AAB065FE-7BB6-4db1-A4CB-D1E1A639B69F}


Public Member Functions
void	removeProperty (const char *name)
	Removes a Property from the PropertySet.
void	clearProperties ()
	Removes all Property objects from the PropertySet.
bool	isPropertyPresent (const char *name)
	Checks to see if a Property with the given name is in the PropertySet.
const char *	getPropertyHelp (const char *name)
	Return the help text for the specified Property.
const char *	getProperty (const char *name)
	Gets the current value of the specified Property.
void	setProperty (const char name, const char value)
	Sets the current value of a Property.
bool	isPropertyDefault (const char *name)
	Returns whether a Property is at it's default value.
const char *	getPropertyDefault (const char *name)
	Returns the default value of a Property as a String.
const char *	getType ()
	return a String object holding the type name for this Window.
const char *	getName ()
	return a String object holding the name of this Window.
bool	isDestroyedByParent ()
	returns whether or not this Window is set to be destroyed when its parent window is destroyed.
bool	isAlwaysOnTop ()
	returns whether or not this Window is an always on top Window. Also known as a top-most window.
bool	isDisabled ()
	return whether the Window is currently disabled
bool	isDisabled (bool localOnly)
bool	isVisible ()
	return true if the Window is currently visible.
bool	isVisible (bool localOnly)
bool	isActive ()
	return true if this is the active Window. An active window is a window that may receive user inputs.
bool	isClippedByParent ()
	return true if this Window is clipped so that its rendering will not pass outside of its parent Window area.
unsigned int	getID ()
	return the ID code currently assigned to this Window by client code.
unsigned long	getChildCount ()
	return the number of child Window objects currently attached to this Window.
bool	isChild (const char *name)
	returns whether a Window with the specified name is currently attached to this Window as a child.
bool	isChild (unsigned int ID)
	returns whether at least one window with the given ID code is attached to this Window as a child.
bool	isChildRecursive (unsigned int ID)
	returns whether at least one window with the given ID code is attached to this Window or any of it's children as a child.
bool	isChild (DICEGUIWindow *window)
	return true if the given Window is a child of this window.
DICEGUIWindow *	getChild (const char *name)
	return a pointer to the child window with the specified name.
DICEGUIWindow *	getChild (unsigned int ID)
	return a pointer to the first attached child window with the specified ID value.
DICEGUIWindow *	getChildRecursive (unsigned int ID)
	return a pointer to the first attached child window with the specified ID value. Children are traversed recursively.
DICEGUIWindow *	getChildAtIdx (unsigned long idx)
	return a pointer to the child window that is attached to 'this' at the given index.
DICEGUIWindow *	getActiveChild ()
	return a pointer to the Window that currently has input focus starting with this Window.
bool	isAncestor (const char *name)
	return true if the specified Window is some ancestor of this Window
bool	isAncestor (unsigned int ID)
	return true if any Window with the given ID is some ancestor of this Window.
bool	isAncestor (DICEGUIWindow *window)
	return true if the specified Window is some ancestor of this Window.
DICEGUIFont *	getFont (bool useDefault)
	return the active Font object for the Window.
const char *	getText ()
	return the current text for the Window
bool	inheritsAlpha ()
	return true if the Window inherits alpha from its parent(s).
float	getAlpha ()
	return the current alpha value set for this Window
float	getEffectiveAlpha ()
	return the effective alpha value that will be used when rendering this window, taking into account inheritance of parent window(s) alpha.
void	getPixelRect (out_Vector4f *rect)
	return a Rect object describing the Window area in screen space.
void	getInnerRect (out_Vector4f *rect)
	return a Rect object describing the clipped inner area for this window.
void	getUnclippedPixelRect (out_Vector4f *rect)
	return a Rect object describing the Window area unclipped, in screen space.
void	getUnclippedInnerRect (out_Vector4f *rect)
	Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering.
DICEGUIWindow *	getCaptureWindow ()
	return the Window that currently has inputs captured.
bool	isCapturedByThis ()
	return true if this Window has input captured.
bool	isCapturedByAncestor ()
	return true if an ancestor window has captured inputs.
bool	isCapturedByChild ()
	return true if a child window has captured inputs.
bool	isHit (in_Pairf *position)
	check if the given pixel position would hit this window.
DICEGUIWindow *	getChildAtPosition (in_Pairf *position)
	return the child Window that is hit by the given pixel position
DICEGUIWindow *	getTargetChildAtPosition (in_Pairf *position)
	return the child Window that is 'hit' by the given position, and is allowed to handle mouse events.
DICEGUIWindow *	getParent ()
	return the parent of this Window.
DICEGUIImage *	getMouseCursor ()
	Return a pointer to the mouse cursor image to use when the mouse cursor is within this window's area.
DICEGUIImage *	getMouseCursor (bool useDefault)
void	getPixelSize (out_Pairf *size)
	Return the window size in pixels.
void *	getUserData ()
	Return the user data set for this Window.
bool	restoresOldCapture ()
	Return whether this window is set to restore old input capture when it loses input capture.
bool	isZOrderingEnabled ()
	Return whether z-order changes are enabled or disabled for this Window.
bool	wantsMultiClickEvents ()
	Return whether this window will receive multi-click events or multiple 'down' events instead.
bool	isMouseAutoRepeatEnabled ()
	Return whether mouse button down event autorepeat is enabled for this window.
float	getAutoRepeatDelay ()
	Return the current auto-repeat delay setting for this window.
float	getAutoRepeatRate ()
	Return the current auto-repeat rate setting for this window.
bool	distributesCapturedInputs ()
	Return whether the window wants inputs passed to its attached child windows when the window has inputs captured.
bool	isUsingDefaultTooltip ()
	Return whether this Window is using the system default Tooltip for its Tooltip window.
DICEGUITooltip *	getTooltip ()
	Return a pointer to the Tooltip object used by this Window. The value returned may point to the system default Tooltip, a custom Window specific Tooltip, or be NULL.
const char *	getTooltipType ()
	Return the custom tooltip type.
const char *	getTooltipText ()
	Return the current tooltip text set for this Window.
bool	inheritsTooltipText ()
	Return whether this window inherits Tooltip text from its parent when its own tooltip text is not set.
bool	isRiseOnClickEnabled ()
	Return whether this window will rise to the top of the z-order when clicked with the left mouse button.
bool	testClassName (const char *class_name)
	Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
CEGUIVerticalAlignment	getVerticalAlignment ()
	Get the vertical alignment.
CEGUIHorizontalAlignment	getHorizontalAlignment ()
	Get the horizontal alignment.
DICEGUIRenderCache *	getRenderCache ()
	Return the RenderCache object for this Window.
const char *	getLookNFeel ()
	Get the name of the LookNFeel assigned to this window.
bool	getModalState ()
	Get whether or not this Window is the modal target.
const char *	getUserString (const char *name)
	Returns a named user string.
bool	isUserStringDefined (const char *name)
	Return whether a user string with the specified name exists.
DICEGUIWindow *	getActiveSibling ()
	Returns the active sibling window.
void	getParentPixelSize (out_Pairf *size)
	Return the pixel size of the parent element. This always returns a valid object.
float	getParentPixelWidth ()
	Return the pixel Width of the parent element. This always returns a valid number.
float	getParentPixelHeight ()
	Return the pixel Height of the parent element. This always returns a valid number.
bool	isMousePassThroughEnabled ()
	Returns whether this window should ignore mouse event and pass them through to and other windows behind it. In effect making the window transparent to the mouse.
bool	isAutoWindow ()
	Returns whether this window is an auto-child window. All auto-child windows have "__auto_" in their name, but this is faster.
bool	isWritingXMLAllowed ()
	Returns whether this window is allowed to write XML.
void	rename (const char *new_name)
	Renames the window.
void	initialiseComponents ()
	Initialises the Window based object ready for use.
void	setDestroyedByParent (bool setting)
	Set whether or not this Window will automatically be destroyed when its parent Window is destroyed.
void	setAlwaysOnTop (bool setting)
	Set whether this window is always on top, or not.
void	setEnabled (bool setting)
	Set whether this window is enabled or disabled. A disabled window normally can not be interacted with, and may have different rendering.
void	enable ()
	enable the Window to allow interaction.
void	disable ()
	disable the Window to prevent interaction.
void	setVisible (bool setting)
	Set whether the Window is visible or hidden.
void	show ()
	show the Window
void	hide ()
	hide the Window.
void	activate ()
	Activate the Window giving it input focus and bringing it to the top of all windows with the same always-on-top settig as this Window.
void	deactivate ()
	Deactivate the window. No further inputs will be received by the window until it is re-activated either programmatically or by the user interacting with the gui.
void	setClippedByParent (bool setting)
	Set whether this Window will be clipped by its parent window(s).
void	setID (unsigned int ID)
	Set the current ID for the Window.
void	setText (const char *text)
	Set the current text string for the Window.
void	setFont (DICEGUIFont *font)
	Set the font used by this Window.
void	setFont (const char *name)
	Set the font used by this Window.
void	addChildWindow (const char *name)
	Add the named Window as a child of this Window. If the Window name is already attached to a Window, it is detached before being added to this Window.
void	addChildWindow (DICEGUIWindow *window)
	Add the specified Window as a child of this Window. If the Window window is already attached to a Window, it is detached before being added to this Window.
void	removeChildWindow (const char *name)
	Remove the named Window from this windows child list.
void	removeChildWindow (DICEGUIWindow *window)
	Remove the specified Window form this windows child list.
void	removeChildWindow (unsigned int ID)
	Remove the first child Window with the specified ID. If there is more than one attached Window objects with the specified ID, only the fist one encountered will be removed.
void	moveToFront ()
	Move the Window to the top of the z order.
void	moveToBack ()
	Move the Window to the bottom of the Z order.
bool	captureInput ()
	Captures input to this window.
void	releaseInput ()
	Releases input capture from this Window. If this Window does not have inputs captured, nothing happens.
void	setRestoreCapture (bool setting)
	Set whether this window will remember and restore the previous window that had inputs captured.
void	setAlpha (float alpha)
	Set the current alpha value for this window.
void	setInheritsAlpha (bool setting)
	Sets whether this Window will inherit alpha from its parent windows.
void	requestRedraw ()
	Signal the System object to redraw (at least) this Window on the next render cycle.
void	setMouseCursor (DICEGUIImage *image)
	Set the mouse cursor image to be used when the mouse enters this window.
void	setMouseCursor (CEGUIMouseCursorImage image)
	Set the mouse cursor image to be used when the mouse enters this window.
void	setMouseCursor (const char imageset, const char image_name)
	Set the mouse cursor image to be used when the mouse enters this window.
void	setUserData (void *user_data)
	Set the user data set for this Window.
void	setZOrderingEnabled (bool setting)
	Set whether z-order changes are enabled or disabled for this Window.
void	setWantsMultiClickEvents (bool setting)
	Set whether this window will receive multi-click events or multiple 'down' events instead.
void	setMouseAutoRepeatEnabled (bool setting)
	Set whether mouse button down event autorepeat is enabled for this window.
void	setAutoRepeatDelay (float delay)
	Set the current auto-repeat delay setting for this window.
void	setAutoRepeatRate (float rate)
	Set the current auto-repeat rate setting for this window.
void	setDistributesCapturedInputs (bool setting)
	Set whether the window wants inputs passed to its attached child windows when the window has inputs captured.
void	notifyDragDropItemEnters (DICEGUIDragContainer *item)
	Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
void	notifyDragDropItemLeaves (DICEGUIDragContainer *item)
	Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
void	notifyDragDropItemDropped (DICEGUIDragContainer *item)
	Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
void	destroy ()
	Internal destroy method which actually just adds the window and any parent destructed child windows to the dead pool.
void	setTooltip (DICEGUITooltip *tooltip)
	Set the custom Tooltip object for this Window. This value may be 0 to indicate that the Window should use the system default Tooltip object.
void	setTooltipType (const char *tooltipType)
	Set the custom Tooltip to be used by this Window by specifying a Window type.
void	setTooltipText (const char *tip)
	Set the tooltip text for this window.
void	setInheritsTooltipText (bool setting)
	Set whether this window inherits Tooltip text from its parent when its own tooltip text is not set.
void	setRiseOnClickEnabled (bool setting)
	Set whether this window will rise to the top of the z-order when clicked with the left mouse button.
void	setVerticalAlignment (CEGUIVerticalAlignment alignment)
	Set the vertical alignment.
void	setHorizontalAlignment (CEGUIHorizontalAlignment alignment)
	Set the horizontal alignment.
void	setLookNFeel (const char *look)
	Set the LookNFeel that shoule be used for this window.
void	setModalState (bool state)
	Set the modal state for this Window.
void	performChildWindowLayout ()
	method called to perform extended laying out of attached child windows.
void	setUserString (const char name, const char value)
	Sets the value a named user string, creating it as required.
void	setArea (in_Pairf xpos, in_Pairf ypos, in_Pairf width, in_Pairf height)
	Set the window area.
void	setArea (in_Vector4f pos, in_Vector4f size)
	Set the window area.
void	setPosition (in_Vector4f *pos)
	Set the window area.
void	setXPosition (in_Pairf *x)
	Set the window's X position.
void	setYPosition (in_Pairf *y)
	Set the window's Y position.
void	setSize (in_Vector4f *size)
	Set the window's size.
void	setWidth (in_Pairf *width)
	Set the window's width.
void	setHeight (in_Pairf *height)
	Set the window's height.
void	setMaxSize (in_Vector4f *size)
	Set the window's maximum size.
void	setMinSize (in_Vector4f *size)
	Set the window's minimum size.
void	getPosition (out_Vector4f *position)
	Return the windows area.
void	getXPosition (out_Pairf *position)
	Get the window's X position.
void	getYPosition (out_Pairf *position)
	Get the window's Y position.
void	getSize (out_Vector4f *size)
	Get the window's size.
void	getWidth (out_Pairf *width)
	Get the window's width.
void	getHeight (out_Pairf *height)
	Get the window's height.
void	getMaxSize (out_Vector4f *max_size)
	Get the window's maximum size.
void	getMinSize (out_Vector4f *min_size)
	Get the window's minimum size.
void	render ()
	Causes the Window object to render itself and all of it's attached children.
void	update (float elapsed)
	Cause window to update itself and any attached children. Client code does not need to call this method; to ensure full, and proper updates, call the injectTimePulse methodname method provided by the System class.
void	beginInitialisation ()
	Writes an xml representation of this window object to out_stream.
void	endInitialisation ()
	Sets the internal 'initialising' flag to false. This is called automatically by the layout XML handler when it is done creating a window. That is after all properties and children have been loaded and just before the next sibling gets created.
void	setMousePassThroughEnabled (bool setting)
	Sets whether this window should ignore mouse events and pass them through to any windows behind it. In effect making the window transparent to the mouse.
void	setWindowRenderer (const char *name)
	Assign the WindowRenderer to specify the Look'N'Feel specification to be used.
DICEGUIWindowRenderer *	getWindowRenderer ()
	Get the currently assigned WindowRenderer. (Look'N'Feel specification).
const char *	getWindowRendererName ()
	Get the factory name of the currently assigned WindowRenderer. (Look'N'Feel specification).
void	setWritingXMLAllowed (bool allow)
	Sets whether this window is allowed to write XML.
void	notifyScreenAreaChanged ()
	Recursively inform all children that the screen area has changed, and needs to be re-cached.

Member Function Documentation

void DigitalSpaces::DICEGUIWindow::removeProperty ( const char * name )

Removes a Property from the PropertySet.

Parameters:

name

String containing the name of the Property to be removed. If Property name is not in the set, nothing happens.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::clearProperties ( )

Removes all Property objects from the PropertySet.

Returns:: Nothing.

bool DigitalSpaces::DICEGUIWindow::isPropertyPresent ( const char * name )

Checks to see if a Property with the given name is in the PropertySet.

Parameters:

name

String containing the name of the Property to check for.

Returns:: true if a Property named name is in the PropertySet. false if no Property named name is in the PropertySet.

const char* DigitalSpaces::DICEGUIWindow::getPropertyHelp ( const char * name )

Return the help text for the specified Property.

Parameters:

name

String holding the name of the Property who's help text is to be returned.

Returns:: String object containing the help text for the Property name.

Exceptions:

UnknownObjectException

Thrown if no Property named name is in the PropertySet.

const char* DigitalSpaces::DICEGUIWindow::getProperty ( const char * name )

Gets the current value of the specified Property.

Parameters:

name

String containing the name of the Property who's value is to be returned.

Returns:: String object containing a textual representation of the requested Property.

Exceptions:

UnknownObjectException

Thrown if no Property named name is in the PropertySet.

void DigitalSpaces::DICEGUIWindow::setProperty	(	const char *	name,
		const char *	value
	)

Sets the current value of a Property.

Parameters:

	name	String containing the name of the Property who's value is to be set.
	value	String containing a textual representation of the new value for the Property

Returns:: Nothing

Exceptions:

	UnknownObjectException	Thrown if no Property named name is in the PropertySet.
	InvalidRequestException	Thrown when the Property was unable to interpret the content of value.

bool DigitalSpaces::DICEGUIWindow::isPropertyDefault ( const char * name )

Returns whether a Property is at it's default value.

Parameters:

name

String containing the name of the Property who's default state is to be tested.

Returns:

true if the property has it's default value.
false if the property has been modified from it's default value.

const char* DigitalSpaces::DICEGUIWindow::getPropertyDefault ( const char * name )

Returns the default value of a Property as a String.

Parameters:

name

String containing the name of the Property who's default string is to be returned.

Returns:: String object containing a textual representation of the default value for this property.

const char* DigitalSpaces::DICEGUIWindow::getType ( )

return a String object holding the type name for this Window.

Returns:: String object holding the Window type.

const char* DigitalSpaces::DICEGUIWindow::getName ( )

return a String object holding the name of this Window.

Returns:: String object holding the unique Window name.

bool DigitalSpaces::DICEGUIWindow::isDestroyedByParent ( )

returns whether or not this Window is set to be destroyed when its parent window is destroyed.

Returns:

true if the Window will be destroyed when its parent is destroyed.
false if the Window will remain when its parent is destroyed.

bool DigitalSpaces::DICEGUIWindow::isAlwaysOnTop ( )

returns whether or not this Window is an always on top Window. Also known as a top-most window.

Returns:

true if this Window is always drawn on top of other normal windows.
false if the Window has normal z-order behaviour.

bool DigitalSpaces::DICEGUIWindow::isDisabled ( )

return whether the Window is currently disabled

Parameters:

localOnly

States whether to only return the state set for this window, and not to factor in inherited state from ancestor windows.

Returns:

true if the window is disabled.
false if the window is enabled.

bool DigitalSpaces::DICEGUIWindow::isDisabled ( bool localOnly )

bool DigitalSpaces::DICEGUIWindow::isVisible ( )

return true if the Window is currently visible.

When true is returned from this function does not mean that the window is not completely obscured by other windows, just that the window will be processed when rendering, and is not explicitly marked as hidden.

Parameters:

localOnly

States whether to only return the state set for this window, and not to factor in inherited state from ancestor windows.

Returns:

true if the window will be drawn.
false if the window is hidden and therefore ignored when rendering.

bool DigitalSpaces::DICEGUIWindow::isVisible ( bool localOnly )

bool DigitalSpaces::DICEGUIWindow::isActive ( )

return true if this is the active Window. An active window is a window that may receive user inputs.

Mouse events are always sent to the window containing the mouse cursor regardless of what this function reports (unless a window has captured inputs). The active state mainly determines where send other, for example keyboard, inputs.

Returns:

true if the window is active and may be sent inputs by the system.
false if the window is inactive and will not be sent inputs.

bool DigitalSpaces::DICEGUIWindow::isClippedByParent ( )

return true if this Window is clipped so that its rendering will not pass outside of its parent Window area.

Returns:

true if the window will be clipped by its parent Window.
false if the windows rendering may pass outside its parents area

unsigned int DigitalSpaces::DICEGUIWindow::getID ( )

return the ID code currently assigned to this Window by client code.

Returns:: unsigned int value equal to the currently assigned ID code for this Window.

unsigned long DigitalSpaces::DICEGUIWindow::getChildCount ( )

return the number of child Window objects currently attached to this Window.

Returns:: unsigned long value equal to the number of Window objects directly attached to this Window as children.

bool DigitalSpaces::DICEGUIWindow::isChild ( const char * name )

returns whether a Window with the specified name is currently attached to this Window as a child.

Parameters:

name

String object containing the name of the Window to look for.

Returns:

true if a Window named name is currently attached to this Window.
false if no such child Window is attached.

bool DigitalSpaces::DICEGUIWindow::isChild ( unsigned int ID )

returns whether at least one window with the given ID code is attached to this Window as a child.

Note:: ID codes are client assigned and may or may not be unique, and as such, the return from this function will only have meaning to the client code.

Parameters:

ID

unsigned int ID code to look for.

Returns:

true if at least one child window was found with the ID code ID
false if no child window was found with the ID code ID.

bool DigitalSpaces::DICEGUIWindow::isChildRecursive ( unsigned int ID )

returns whether at least one window with the given ID code is attached to this Window or any of it's children as a child.

Note:: ID codes are client assigned and may or may not be unique, and as such, the return from this function will only have meaning to the client code.

WARNING! This function can be very expensive and should only be used when you have no other option available. If you decide to use it anyway, make sure the window hierarchy from the entry point is small.

Parameters:

ID

unsigned int ID code to look for.

Returns:

true if at least one child window was found with the ID code ID
false if no child window was found with the ID code ID.

bool DigitalSpaces::DICEGUIWindow::isChild ( DICEGUIWindow * window )

return true if the given Window is a child of this window.

Parameters:

window

Pointer to the Window object to look for.

Returns:

true if Window object window is attached to this window as a child.
false if Window object window is not a child of this Window.

DICEGUIWindow* DigitalSpaces::DICEGUIWindow::getChild ( const char * name )

return a pointer to the child window with the specified name.

This function will throw an exception if no child object with the given name is attached. This decision was made (over returning NULL if no window was found) so that client code can assume that if the call returns it has a valid window pointer. We provide the isChild() functions for checking if a given window is attached.

Parameters:

name

String object holding the name of the child window for which a pointer is to be returned.

Returns:: Pointer to the Window object attached to this window that has the name name.

Exceptions:

UnknownObjectException

thrown if no window named name is attached to this Window.

DICEGUIWindow* DigitalSpaces::DICEGUIWindow::getChild ( unsigned int ID )

return a pointer to the first attached child window with the specified ID value.

This function will throw an exception if no child object with the given ID is attached. This decision was made (over returning NULL if no window was found) so that client code can assume that if the call returns it has a valid window pointer. We provide the isChild() functions for checking if a given window is attached.

Parameters:

ID

unsigned int value specifying the ID code of the window to return a pointer to.

Returns:: Pointer to the (first) Window object attached to this window that has the ID code ID.

Exceptions:

UnknownObjectException

thrown if no window with the ID code ID is attached to this Window.

DICEGUIWindow* DigitalSpaces::DICEGUIWindow::getChildRecursive ( unsigned int ID )

return a pointer to the first attached child window with the specified ID value. Children are traversed recursively.

Contrary to the non recursive version of this function, this one will not throw an exception, but return 0 in case no child was found.

Note:: WARNING! This function can be very expensive and should only be used when you have no other option available. If you decide to use it anyway, make sure the window hierarchy from the entry point is small.

Parameters:

ID

unsigned int value specifying the ID code of the window to return a pointer to.

Returns:: Pointer to the (first) Window object attached to this window that has the ID code ID. If no child is found with the ID code ID, 0 is returned.

DICEGUIWindow* DigitalSpaces::DICEGUIWindow::getChildAtIdx ( unsigned long idx )

return a pointer to the child window that is attached to 'this' at the given index.

Parameters:

idx

Index of the child window whos pointer should be returned. This value is not bounds checked, client code should ensure that this is less than the value returned by getChildCount().

Returns:: Pointer to the child window currently attached at index position idx

DICEGUIWindow* DigitalSpaces::DICEGUIWindow::getActiveChild ( )

return a pointer to the Window that currently has input focus starting with this Window.

Returns:: Pointer to the window that is active (has input focus) starting at this window. The function will return 'this' if this Window is active and either no children are attached or if none of the attached children are active. Returns NULL if this Window (and therefore all children) are not active.

bool DigitalSpaces::DICEGUIWindow::isAncestor ( const char * name )

return true if the specified Window is some ancestor of this Window

Parameters:

name

String object holding the name of the Window to check for.

Returns:

true if a Window named name is an ancestor (parent, or parent of parent, etc) of this Window.
false if a Window named name is in no way an ancestor of this window.

bool DigitalSpaces::DICEGUIWindow::isAncestor ( unsigned int ID )

return true if any Window with the given ID is some ancestor of this Window.

Parameters:

ID

unsigned int value specifying the ID to look for.

Returns:

true if an ancestor (parent, or parent of parent, etc) was found with the ID code ID.
false if no ancestor window has the ID code ID.

bool DigitalSpaces::DICEGUIWindow::isAncestor ( DICEGUIWindow * window )

return true if the specified Window is some ancestor of this Window.

Parameters:

window

Pointer to the Window object to look for.

Returns:

true if window was found to be an ancestor (parent, or parent of parent, etc) of this Window.
false if window is not an ancestor of this window.

DICEGUIFont* DigitalSpaces::DICEGUIWindow::getFont ( bool useDefault )

return the active Font object for the Window.

Parameters:

useDefault

Sepcifies whether to return the default font if this Window has no preferred font set.

Returns:: Pointer to the Font being used by this Window. If the window has no assigned font, and useDefault is true, then the default system font is returned.

const char* DigitalSpaces::DICEGUIWindow::getText ( )

return the current text for the Window

Returns:: The String object that holds the current text for this Window.

bool DigitalSpaces::DICEGUIWindow::inheritsAlpha ( )

return true if the Window inherits alpha from its parent(s).

Returns:

true if the Window inherits alpha from its parent(s)
false if the alpha for this Window is independant from its parents.

float DigitalSpaces::DICEGUIWindow::getAlpha ( )

return the current alpha value set for this Window

Note:: The alpha value set for any given window may or may not be the final alpha value that is used when rendering. All window objects, by default, inherit alpha from thier parent window(s) - this will blend child windows, relatively, down the line of inheritance. This behaviour can be overridden via the setInheritsAlpha() method. To return the true alpha value that will be applied when rendering, use the getEffectiveAlpha() method.

Returns:: the currently set alpha value for this Window. The value returned Will be between 0.0f and 1.0f.

float DigitalSpaces::DICEGUIWindow::getEffectiveAlpha ( )

return the effective alpha value that will be used when rendering this window, taking into account inheritance of parent window(s) alpha.

Returns:: the effective alpha that will be applied to this Window when rendering. The value returned Will be between 0.0f and 1.0f.

void DigitalSpaces::DICEGUIWindow::getPixelRect ( out_Vector4f * rect )

return a Rect object describing the Window area in screen space.

Returns:: Rect object that describes the area covered by the Window. The values in the returned Rect are in screen pixels. The returned Rect is clipped as appropriate and depending upon the 'ClippedByParent' setting.

void DigitalSpaces::DICEGUIWindow::getInnerRect ( out_Vector4f * rect )

return a Rect object describing the clipped inner area for this window.

Returns:: Rect object that describes, in appropriately clipped screen pixel co-ordinates, the window object's inner rect area.

void DigitalSpaces::DICEGUIWindow::getUnclippedPixelRect ( out_Vector4f * rect )

return a Rect object describing the Window area unclipped, in screen space.

Returns:: Rect object that describes the area covered by the Window. The values in the returned Rect are in screen pixels. The returned rect is fully unclipped.

void DigitalSpaces::DICEGUIWindow::getUnclippedInnerRect ( out_Vector4f * rect )

Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering.

Returns:: Rect object that describes, in unclipped screen pixel co-ordinates, the window object's inner rect area.

DICEGUIWindow* DigitalSpaces::DICEGUIWindow::getCaptureWindow ( )

return the Window that currently has inputs captured.

Returns:: Pointer to the Window object that currently has inputs captured, or NULL if no Window has captured input.

bool DigitalSpaces::DICEGUIWindow::isCapturedByThis ( )

return true if this Window has input captured.

Returns:

true if this Window has captured inputs.
false if some other Window, or no Window, has captured inputs.

bool DigitalSpaces::DICEGUIWindow::isCapturedByAncestor ( )

return true if an ancestor window has captured inputs.

Returns:

true if input is captured by a Window that is some ancestor (parent, parent of parent, etc) of this Window.
false if no ancestor of this window has captured input.

bool DigitalSpaces::DICEGUIWindow::isCapturedByChild ( )

return true if a child window has captured inputs.

Returns:

true if input is captured by a Window that is a child of this Window.
false if no child of this window has not captured input.

bool DigitalSpaces::DICEGUIWindow::isHit ( in_Pairf * position )

check if the given pixel position would hit this window.

Parameters:

position

Vector2 object describing the position to check. The position describes a pixel offset from the top-left corner of the display.

Returns:

true if position hits this Window.
false if position does not hit this window.

DICEGUIWindow* DigitalSpaces::DICEGUIWindow::getChildAtPosition ( in_Pairf * position )

return the child Window that is hit by the given pixel position

Parameters:

position

Vector2 object describing the position to check. The position describes a pixel offset from the top-left corner of the display.

Returns:: Pointer to the child Window that was hit according to the location position, or 0 if no child of this window was hit.

DICEGUIWindow* DigitalSpaces::DICEGUIWindow::getTargetChildAtPosition ( in_Pairf * position )

return the child Window that is 'hit' by the given position, and is allowed to handle mouse events.

Parameters:

position

Vector2 object describing the position to check. The position describes a pixel offset from the top-left corner of the display.

Returns:: Pointer to the child Window that was hit according to the location position, or 0 if no child of this window was hit.

DICEGUIWindow* DigitalSpaces::DICEGUIWindow::getParent ( )

return the parent of this Window.

Returns:: Pointer to the Window object that is the parent of this Window. This value can be NULL, in which case the Window is a GUI sheet / root.

DICEGUIImage* DigitalSpaces::DICEGUIWindow::getMouseCursor ( )

Return a pointer to the mouse cursor image to use when the mouse cursor is within this window's area.

Parameters:

useDefault

Sepcifies whether to return the default mouse cursor image if this window specifies no preferred mouse cursor image.

Returns:: Pointer to the mouse cursor image that will be used when the mouse enters this window's area. May return NULL indicating no cursor will be drawn for this window.

DICEGUIImage* DigitalSpaces::DICEGUIWindow::getMouseCursor ( bool useDefault )

void DigitalSpaces::DICEGUIWindow::getPixelSize ( out_Pairf * size )

Return the window size in pixels.

Returns:: Size object describing this windows size in pixels.

void* DigitalSpaces::DICEGUIWindow::getUserData ( )

Return the user data set for this Window.

Each Window can have some client assigned data attached to it, this data is not used by the GUI system in any way. Interpretation of the data is entirely application specific.

Returns:: pointer to the user data that is currently set for this window.

bool DigitalSpaces::DICEGUIWindow::restoresOldCapture ( )

Return whether this window is set to restore old input capture when it loses input capture.

This is only really useful for certain sub-components for widget writers.

Returns:

true if the window will restore the previous capture window when it loses input capture.
false if the window will set the capture window to NULL when it loses input capture (this is the default behaviour).

bool DigitalSpaces::DICEGUIWindow::isZOrderingEnabled ( )

Return whether z-order changes are enabled or disabled for this Window.

Returns:

true if z-order changes are enabled for this window. moveToFront/moveToBack work normally as expected.
false: z-order changes are disabled for this window. moveToFront/moveToBack are ignored for this window.

bool DigitalSpaces::DICEGUIWindow::wantsMultiClickEvents ( )

Return whether this window will receive multi-click events or multiple 'down' events instead.

Returns:

true if the Window will receive double-click and triple-click events.
false if the Window will receive multiple mouse button down events instead of double/triple click events.

bool DigitalSpaces::DICEGUIWindow::isMouseAutoRepeatEnabled ( )

Return whether mouse button down event autorepeat is enabled for this window.

Returns:

true if autorepeat of mouse button down events is enabled for this window.
false if autorepeat of mouse button down events is not enabled for this window.

float DigitalSpaces::DICEGUIWindow::getAutoRepeatDelay ( )

Return the current auto-repeat delay setting for this window.

Returns:: float value indicating the delay, in seconds, defore the first repeat mouse button down event will be triggered when autorepeat is enabled.

float DigitalSpaces::DICEGUIWindow::getAutoRepeatRate ( )

Return the current auto-repeat rate setting for this window.

Returns:: float value indicating the rate, in seconds, at which repeat mouse button down events will be generated after the initial delay has expired.

bool DigitalSpaces::DICEGUIWindow::distributesCapturedInputs ( )

Return whether the window wants inputs passed to its attached child windows when the window has inputs captured.

Returns:

true if System should pass captured input events to child windows.
false if System should pass captured input events to this window only.

bool DigitalSpaces::DICEGUIWindow::isUsingDefaultTooltip ( )

Return whether this Window is using the system default Tooltip for its Tooltip window.

Returns:

true if the Window will use the system default tooltip.
false if the window has a custom Tooltip object.

DICEGUITooltip* DigitalSpaces::DICEGUIWindow::getTooltip ( )

Return a pointer to the Tooltip object used by this Window. The value returned may point to the system default Tooltip, a custom Window specific Tooltip, or be NULL.

Returns:: Pointer to a Tooltip based object, or NULL.

const char* DigitalSpaces::DICEGUIWindow::getTooltipType ( )

Return the custom tooltip type.

Returns:: String object holding the current custom tooltip window type, or an empty string if no custom tooltip is set.

const char* DigitalSpaces::DICEGUIWindow::getTooltipText ( )

Return the current tooltip text set for this Window.

Returns:: String object holding the current tooltip text set for this window.

bool DigitalSpaces::DICEGUIWindow::inheritsTooltipText ( )

Return whether this window inherits Tooltip text from its parent when its own tooltip text is not set.

Returns:

true if the window inherits tooltip text from its parent when its own text is not set.
false if the window does not inherit tooltip text from its parent (and shows no tooltip when no text is set).

bool DigitalSpaces::DICEGUIWindow::isRiseOnClickEnabled ( )

Return whether this window will rise to the top of the z-order when clicked with the left mouse button.

Returns:

true if the window will come to the top of other windows when the left mouse button is pushed within its area.
false if the window does not change z-order position when the left mouse button is pushed within its area.

bool DigitalSpaces::DICEGUIWindow::testClassName ( const char * class_name )

Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.

Parameters:

class_name

The class name that is to be checked.

Returns:: true if this window was inherited from class_name. false if not.

CEGUIVerticalAlignment DigitalSpaces::DICEGUIWindow::getVerticalAlignment ( )

Get the vertical alignment.

Returns the vertical alignment for the window. This setting affects how the windows position is interpreted relative to its parent.

Returns:: One of the VerticalAlignment enumerated values.

CEGUIHorizontalAlignment DigitalSpaces::DICEGUIWindow::getHorizontalAlignment ( )

Get the horizontal alignment.

Returns the horizontal alignment for the window. This setting affects how the windows position is interpreted relative to its parent.

Returns:: One of the HorizontalAlignment enumerated values.

DICEGUIRenderCache* DigitalSpaces::DICEGUIWindow::getRenderCache ( )

Return the RenderCache object for this Window.

Returns:: Reference to the RenderCache object for this Window.

const char* DigitalSpaces::DICEGUIWindow::getLookNFeel ( )

Get the name of the LookNFeel assigned to this window.

Returns:: String object holding the name of the look assigned to this window. Returns the empty string if no look is assigned.

bool DigitalSpaces::DICEGUIWindow::getModalState ( )

Get whether or not this Window is the modal target.

Returns:: Returns true if this Window is the modal target, otherwise false.

const char* DigitalSpaces::DICEGUIWindow::getUserString ( const char * name )

Returns a named user string.

Parameters:

name

String object holding the name of the string to be returned.

Returns:: String object holding the data stored for the requested user string.

Exceptions:

UnknownObjectException

thrown if a user string named name does not exist.

bool DigitalSpaces::DICEGUIWindow::isUserStringDefined ( const char * name )

Return whether a user string with the specified name exists.

Parameters:

name

String object holding the name of the string to be checked.

Returns:

true if a user string named name exists.
false if no such user string exists.

DICEGUIWindow* DigitalSpaces::DICEGUIWindow::getActiveSibling ( )

Returns the active sibling window.

This searches the immediate children of this window's parent, and returns a pointer to the active window. The method will return this if we are the immediate child of our parent that is active. If our parent is not active, or if no immediate child of our parent is active then 0 is returned. If this window has no parent, and this window is not active then 0 is returned, else this is returned.

Returns:: A pointer to the immediate child window attached to our parent that is currently active, or 0 if no immediate child of our parent is active.

void DigitalSpaces::DICEGUIWindow::getParentPixelSize ( out_Pairf * size )

Return the pixel size of the parent element. This always returns a valid object.

Returns:: Size object that describes the pixel dimensions of this Window objects parent

float DigitalSpaces::DICEGUIWindow::getParentPixelWidth ( )

Return the pixel Width of the parent element. This always returns a valid number.

Returns:: float value that is equal to the pixel width of this Window objects parent

float DigitalSpaces::DICEGUIWindow::getParentPixelHeight ( )

Return the pixel Height of the parent element. This always returns a valid number.

Returns:: float value that is equal to the pixel height of this Window objects parent

bool DigitalSpaces::DICEGUIWindow::isMousePassThroughEnabled ( )

Returns whether this window should ignore mouse event and pass them through to and other windows behind it. In effect making the window transparent to the mouse.

Returns:: true if mouse pass through is enabled. false if mouse pass through is not enabled.

bool DigitalSpaces::DICEGUIWindow::isAutoWindow ( )

Returns whether this window is an auto-child window. All auto-child windows have "__auto_" in their name, but this is faster.

bool DigitalSpaces::DICEGUIWindow::isWritingXMLAllowed ( )

Returns whether this window is allowed to write XML.

void DigitalSpaces::DICEGUIWindow::rename ( const char * new_name )

Renames the window.

Parameters:

new_name

String object holding the new name for the window.

Exceptions:

AlreadyExistsException

thrown if a Window named new_name already exists in the system.

void DigitalSpaces::DICEGUIWindow::initialiseComponents ( )

Initialises the Window based object ready for use.

Note:: This must be called for every window created. Normally this is handled automatically by the WindowManager.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::setDestroyedByParent ( bool setting )

Set whether or not this Window will automatically be destroyed when its parent Window is destroyed.

Parameters:

setting

true to have the Window auto-destroyed when its parent is destroyed (default behaviour)
false to have the Window remain after its parent is destroyed.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::setAlwaysOnTop ( bool setting )

Set whether this window is always on top, or not.

Parameters:

setting

true to have the Window appear on top of all other non always on top windows
false to allow the window to be covered by other normal windows.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::setEnabled ( bool setting )

Set whether this window is enabled or disabled. A disabled window normally can not be interacted with, and may have different rendering.

Parameters:

setting

true to enable the Window
false to disable the Window.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::enable ( )

enable the Window to allow interaction.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::disable ( )

disable the Window to prevent interaction.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::setVisible ( bool setting )

Set whether the Window is visible or hidden.

Parameters:

setting

true to make the Window visible.
false to make the Window hidden.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::show ( )

show the Window

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::hide ( )

hide the Window.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::activate ( )

Activate the Window giving it input focus and bringing it to the top of all windows with the same always-on-top settig as this Window.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::deactivate ( )

Deactivate the window. No further inputs will be received by the window until it is re-activated either programmatically or by the user interacting with the gui.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setClippedByParent ( bool setting )

Set whether this Window will be clipped by its parent window(s).

Parameters:

setting

true to have the Window clipped so that rendering is constrained to within the area of its parent(s).
false to have rendering constrained to the screen only.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::setID ( unsigned int ID )

Set the current ID for the Window.

Parameters:

ID

Client assigned ID code for this Window. The GUI system assigns no meaning to any IDs, they are a device purely for client code usage.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::setText ( const char * text )

Set the current text string for the Window.

Parameters:

text

String object containing the text that is to be set as the Window text.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::setFont ( DICEGUIFont * font )

Set the font used by this Window.

Parameters:

font

Pointer to the Font object to be used by this Window. If font is NULL, the default font will be used.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::setFont ( const char * name )

Set the font used by this Window.

Parameters:

name

String object holding the name of the Font object to be used by this Window. If name == "", the default font will be used.

Returns:: Nothing

Exceptions:

UnknownObjectException

thrown if the specified Font is unknown within the system.

void DigitalSpaces::DICEGUIWindow::addChildWindow ( const char * name )

Add the named Window as a child of this Window. If the Window name is already attached to a Window, it is detached before being added to this Window.

Parameters:

name

String object holding the name of the Window to be added.

Returns:: Nothing.

Exceptions:

	UnknownObjectException	thrown if no Window named name exists.
	InvalidRequestException	thrown if Window name is an ancestor of this Window, to prevent cyclic Window structures.

void DigitalSpaces::DICEGUIWindow::addChildWindow ( DICEGUIWindow * window )

Add the specified Window as a child of this Window. If the Window window is already attached to a Window, it is detached before being added to this Window.

Parameters:

window

Pointer to the Window object to be added.

Returns:: Nothing

Exceptions:

InvalidRequestException

thrown if Window window is an ancestor of this Window, to prevent cyclic Window structures.

void DigitalSpaces::DICEGUIWindow::removeChildWindow ( const char * name )

Remove the named Window from this windows child list.

Parameters:

name

String object holding the name of the Window to be removed. If the Window specified is not attached to this Window, nothing happens.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::removeChildWindow ( DICEGUIWindow * window )

Remove the specified Window form this windows child list.

Parameters:

window

Pointer to the Window object to be removed. If the window is not attached to this Window, then nothing happens.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::removeChildWindow ( unsigned int ID )

Remove the first child Window with the specified ID. If there is more than one attached Window objects with the specified ID, only the fist one encountered will be removed.

Parameters:

ID

ID number assigned to the Window to be removed. If no Window with ID code ID is attached, nothing happens.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::moveToFront ( )

Move the Window to the top of the z order.

If the Window is a non always-on-top window it is moved the the top of all other non always-on-top sibling windows, and the process repeated for all ancestors.
If the Window is an always-on-top window it is moved to the of of all sibling Windows, and the process repeated for all ancestors.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::moveToBack ( )

Move the Window to the bottom of the Z order.

If the window is non always-on-top the Window is sent to the very bottom of its sibling windows and the process repeated for all ancestors.
If the window is always-on-top, the Window is sent to the bottom of all sibling always-on-top windows and the process repeated for all ancestors.

Returns:: Nothing

bool DigitalSpaces::DICEGUIWindow::captureInput ( )

Captures input to this window.

Returns:

true if input was successfully captured to this window.
false if input could not be captured to this window (maybe because the window is not active).

void DigitalSpaces::DICEGUIWindow::releaseInput ( )

Releases input capture from this Window. If this Window does not have inputs captured, nothing happens.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::setRestoreCapture ( bool setting )

Set whether this window will remember and restore the previous window that had inputs captured.

Parameters:

setting

true: The window will remember and restore the previous capture window. The CaptureLost event is not fired on the previous window when this window steals input capture. When this window releases capture, the old capture window is silently restored.

false: Input capture works as normal, each window losing capture is signalled via CaptureLost, and upon the final release of capture, no previous setting is restored (this is the default behaviour).

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::setAlpha ( float alpha )

Set the current alpha value for this window.

Note:: The alpha value set for any given window may or may not be the final alpha value that is used when rendering. All window objects, by default, inherit alpha from thier parent window(s) - this will blend child windows, relatively, down the line of inheritance. This behaviour can be overridden via the setInheritsAlpha() method. To return the true alpha value that will be applied when rendering, use the getEffectiveAlpha() method.

Parameters:

alpha

The new alpha value for the window. Value should be between 0.0f and 1.0f.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::setInheritsAlpha ( bool setting )

Sets whether this Window will inherit alpha from its parent windows.

Parameters:

setting

true if the Window should use inherited alpha.
false if the Window should have an independant alpha value.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::requestRedraw ( )

Signal the System object to redraw (at least) this Window on the next render cycle.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::setMouseCursor ( DICEGUIImage * image )

Set the mouse cursor image to be used when the mouse enters this window.

Parameters:

image

Pointer to the Image object to use as the mouse cursor image when the mouse enters the area for this Window.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setMouseCursor ( CEGUIMouseCursorImage image )

Set the mouse cursor image to be used when the mouse enters this window.

Parameters:

image

One of the MouseCursorImage enumerated values.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setMouseCursor	(	const char *	imageset,
		const char *	image_name
	)

Set the mouse cursor image to be used when the mouse enters this window.

Parameters:

	imageset	String object that contains the name of the Imageset that contains the image to be used.
	image_name	String object that contains the name of the Image on imageset that is to be used.

Returns:: Nothing.

Exceptions:

UnknownObjectException

thrown if imageset is not known, or if imageset contains no Image named image_name.

void DigitalSpaces::DICEGUIWindow::setUserData ( void * user_data )

Set the user data set for this Window.

Each Window can have some client assigned data attached to it, this data is not used by the GUI system in any way. Interpretation of the data is entirely application specific.

Parameters:

user_data

pointer to the user data that is to be set for this window.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setZOrderingEnabled ( bool setting )

Set whether z-order changes are enabled or disabled for this Window.

Parameters:

setting

true if z-order changes are enabled for this window. moveToFront/moveToBack work normally as expected.
false: z-order changes are disabled for this window. moveToFront/moveToBack are ignored for this window.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setWantsMultiClickEvents ( bool setting )

Set whether this window will receive multi-click events or multiple 'down' events instead.

Parameters:

setting

true if the Window will receive double-click and triple-click events.
false if the Window will receive multiple mouse button down events instead of double/triple click events.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setMouseAutoRepeatEnabled ( bool setting )

Set whether mouse button down event autorepeat is enabled for this window.

Parameters:

setting

true to enable autorepeat of mouse button down events.
false to disable autorepeat of mouse button down events.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setAutoRepeatDelay ( float delay )

Set the current auto-repeat delay setting for this window.

Parameters:

delay

float value indicating the delay, in seconds, defore the first repeat mouse button down event should be triggered when autorepeat is enabled.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setAutoRepeatRate ( float rate )

Set the current auto-repeat rate setting for this window.

Parameters:

rate

float value indicating the rate, in seconds, at which repeat mouse button down events should be generated after the initial delay has expired.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setDistributesCapturedInputs ( bool setting )

Set whether the window wants inputs passed to its attached child windows when the window has inputs captured.

Parameters:

setting

true if System should pass captured input events to child windows.
false if System should pass captured input events to this window only.

void DigitalSpaces::DICEGUIWindow::notifyDragDropItemEnters ( DICEGUIDragContainer * item )

Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.

void DigitalSpaces::DICEGUIWindow::notifyDragDropItemLeaves ( DICEGUIDragContainer * item )

Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.

void DigitalSpaces::DICEGUIWindow::notifyDragDropItemDropped ( DICEGUIDragContainer * item )

Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.

void DigitalSpaces::DICEGUIWindow::destroy ( )

Internal destroy method which actually just adds the window and any parent destructed child windows to the dead pool.

This is virtual to allow for specialised cleanup which may be required in some advanced cases. If you override this for the above reason, you MUST call this base class version.

Note:: You never have to call this method yourself, use WindowManager to destroy your Window objects (which will call this for you).

void DigitalSpaces::DICEGUIWindow::setTooltip ( DICEGUITooltip * tooltip )

Set the custom Tooltip object for this Window. This value may be 0 to indicate that the Window should use the system default Tooltip object.

Parameters:

tooltip

Pointer to a valid Tooltip based object which should be used as the tooltip for this Window, or 0 to indicate that the Window should use the system default Tooltip object. Note that when passing a pointer to a Tooltip object, ownership of the Tooltip does not pass to this Window object.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setTooltipType ( const char * tooltipType )

Set the custom Tooltip to be used by this Window by specifying a Window type.

The Window will internally attempt to create an instance of the specified window type (which must be derived from the base Tooltip class). If the Tooltip creation fails, the error is logged and the Window will revert to using either the existing custom Tooltip or the system default Tooltip.

Parameters:

tooltipType

String object holding the name of the Tooltip based Window type which should be used as the Tooltip for this Window.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setTooltipText ( const char * tip )

Set the tooltip text for this window.

Parameters:

tip

String object holding the text to be displayed in the tooltip for this Window.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setInheritsTooltipText ( bool setting )

Set whether this window inherits Tooltip text from its parent when its own tooltip text is not set.

Parameters:

setting

true if the window should inherit tooltip text from its parent when its own text is not set.
false if the window should not inherit tooltip text from its parent (and so show no tooltip when no text is set).

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setRiseOnClickEnabled ( bool setting )

Set whether this window will rise to the top of the z-order when clicked with the left mouse button.

Parameters:

setting

true if the window should come to the top of other windows when the left mouse button is pushed within its area.
false if the window should not change z-order position when the left mouse button is pushed within its area.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setVerticalAlignment ( CEGUIVerticalAlignment alignment )

Set the vertical alignment.

Modifies the vertical alignment for the window. This setting affects how the windows position is interpreted relative to its parent.

Parameters:

alignment

One of the VerticalAlignment enumerated values.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setHorizontalAlignment ( CEGUIHorizontalAlignment alignment )

Set the horizontal alignment.

Modifies the horizontal alignment for the window. This setting affects how the windows position is interpreted relative to its parent.

Parameters:

alignment

One of the HorizontalAlignment enumerated values.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setLookNFeel ( const char * look )

Set the LookNFeel that shoule be used for this window.

Parameters:

look

String object holding the name of the look to be assigned to the window.

Returns:: Nothing.

Exceptions:

UnknownObjectException

thrown if the look'n'feel specified by look does not exist.

Note:: Once a look'n'feel has been assigned it is locked - as in cannot be changed.

void DigitalSpaces::DICEGUIWindow::setModalState ( bool state )

Set the modal state for this Window.

Parameters:

state

Boolean value defining if this Window should be the modal target.

true if this Window should be activated and set as the modal target.
false if the modal target should be cleared if this Window is currently the modal target.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::performChildWindowLayout ( )

method called to perform extended laying out of attached child windows.

The system may call this at various times (like when it is resized for example), and it may be invoked directly where required.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setUserString	(	const char *	name,
		const char *	value
	)

Sets the value a named user string, creating it as required.

Parameters:

	name	String object holding the name of the string to be returned.
	value	String object holding the value to be assigned to the user string.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::setArea	(	in_Pairf *	xpos,
		in_Pairf *	ypos,
		in_Pairf *	width,
		in_Pairf *	height
	)

Set the window area.

Sets the area occupied by this window. The defined area is offset from the top-left corner of this windows parent window or from the top-left corner of the display if this window has no parent (i.e. it is the root window).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
In the scripting language this is setAreaPairs

Parameters:

	xpos	UDim describing the new x co-ordinate (left edge) of the window area.
	ypos	UDim describing the new y co-ordinate (top-edge) of the window area.
	width	UDim describing the new width of the window area.
	height	UDim describing the new height of the window area.

void DigitalSpaces::DICEGUIWindow::setArea	(	in_Vector4f *	pos,
		in_Vector4f *	size
	)

Set the window area.

Sets the area occupied by this window. The defined area is offset from the top-left corner of this windows parent window or from the top-left corner of the display if this window has no parent (i.e. it is the root window).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.
In the scripting language this is setAreaVectors

Parameters:

	pos	UVector2 describing the new position (top-left corner) of the window area.
	size	UVector2 describing the new size of the window area.

void DigitalSpaces::DICEGUIWindow::setPosition ( in_Vector4f * pos )

Set the window area.

Sets the area occupied by this window. The defined area is offset from the top-left corner of this windows parent window or from the top-left corner of the display if this window has no parent (i.e. it is the root window).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Parameters:

area

URect describing the new area rectangle of the window area.

Set the window's position. Sets the position of the area occupied by this window. The position is offset from the top-left corner of this windows parent window or from the top-left corner of the display if this window has no parent (i.e. it is the root window).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Parameters:

pos

UVector2 describing the new position (top-left corner) of the window area.

void DigitalSpaces::DICEGUIWindow::setXPosition ( in_Pairf * x )

Set the window's X position.

Sets the x position (left edge) of the area occupied by this window. The position is offset from the left edge of this windows parent window or from the left edge of the display if this window has no parent (i.e. it is the root window).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Parameters:

x

UDim describing the new x position of the window area.

void DigitalSpaces::DICEGUIWindow::setYPosition ( in_Pairf * y )

Set the window's Y position.

Sets the y position (top edge) of the area occupied by this window. The position is offset from the top edge of this windows parent window or from the top edge of the display if this window has no parent (i.e. it is the root window).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Parameters:

y

UDim describing the new y position of the window area.

void DigitalSpaces::DICEGUIWindow::setSize ( in_Vector4f * size )

Set the window's size.

Sets the size of the area occupied by this window.

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Parameters:

size

UVector2 describing the new size of the window area.

void DigitalSpaces::DICEGUIWindow::setWidth ( in_Pairf * width )

Set the window's width.

Sets the width of the area occupied by this window.

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Parameters:

width

UDim describing the new width of the window area.

void DigitalSpaces::DICEGUIWindow::setHeight ( in_Pairf * height )

Set the window's height.

Sets the height of the area occupied by this window.

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Parameters:

height

UDim describing the new height of the window area.

void DigitalSpaces::DICEGUIWindow::setMaxSize ( in_Vector4f * size )

Set the window's maximum size.

Sets the maximum size that this windows area may occupy (whether size changes occur by user interaction, general system operation, or by direct setting by client code).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Parameters:

size

UVector2 describing the new maximum size of the window area.

void DigitalSpaces::DICEGUIWindow::setMinSize ( in_Vector4f * size )

Set the window's minimum size.

Sets the minimum size that this windows area may occupy (whether size changes occur by user interaction, general system operation, or by direct setting by client code).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Parameters:

size

UVector2 describing the new minimum size of the window area.

void DigitalSpaces::DICEGUIWindow::getPosition ( out_Vector4f * position )

Return the windows area.

Returns the area occupied by this window. The defined area is offset from the top-left corner of this windows parent window or from the top-left corner of the display if this window has no parent (i.e. it is the root window).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Returns:: URect describing the rectangle of the window area.

Get the window's position. Gets the position of the area occupied by this window. The position is offset from the top-left corner of this windows parent window or from the top-left corner of the display if this window has no parent (i.e. it is the root window).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Returns:: UVector2 describing the position (top-left corner) of the window area.

void DigitalSpaces::DICEGUIWindow::getXPosition ( out_Pairf * position )

Get the window's X position.

Gets the x position (left edge) of the area occupied by this window. The position is offset from the left edge of this windows parent window or from the left edge of the display if this window has no parent (i.e. it is the root window).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Returns:: UDim describing the x position of the window area.

void DigitalSpaces::DICEGUIWindow::getYPosition ( out_Pairf * position )

Get the window's Y position.

Gets the y position (top edge) of the area occupied by this window. The position is offset from the top edge of this windows parent window or from the top edge of the display if this window has no parent (i.e. it is the root window).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Returns:: UDim describing the y position of the window area.

void DigitalSpaces::DICEGUIWindow::getSize ( out_Vector4f * size )

Get the window's size.

Gets the size of the area occupied by this window.

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Returns:: UVector2 describing the size of the window area.

void DigitalSpaces::DICEGUIWindow::getWidth ( out_Pairf * width )

Get the window's width.

Gets the width of the area occupied by this window.

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Returns:: UDim describing the width of the window area.

void DigitalSpaces::DICEGUIWindow::getHeight ( out_Pairf * height )

Get the window's height.

Gets the height of the area occupied by this window.

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Returns:: UDim describing the height of the window area.

void DigitalSpaces::DICEGUIWindow::getMaxSize ( out_Vector4f * max_size )

Get the window's maximum size.

Gets the maximum size that this windows area may occupy (whether size changes occur by user interaction, general system operation, or by direct setting by client code).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Returns:: UVector2 describing the maximum size of the window area.

void DigitalSpaces::DICEGUIWindow::getMinSize ( out_Vector4f * min_size )

Get the window's minimum size.

Gets the minimum size that this windows area may occupy (whether size changes occur by user interaction, general system operation, or by direct setting by client code).

Note:: This method makes use of "Unified Dimensions". These contain both parent relative and absolute pixel components, which are used in determining the final value used.

Returns:: UVector2 describing the minimum size of the window area.

void DigitalSpaces::DICEGUIWindow::render ( )

Causes the Window object to render itself and all of it's attached children.

Returns:: Nothing

void DigitalSpaces::DICEGUIWindow::update ( float elapsed )

Cause window to update itself and any attached children. Client code does not need to call this method; to ensure full, and proper updates, call the injectTimePulse methodname method provided by the System class.

Note:: The update order is such that 'this' window is updated prior to any child windows, this is so that child windows that access the parent in their update code get the correct updated state.

Parameters:

elapsed

float value indicating the number of seconds passed since the last update.

Returns:: Nothing.

void DigitalSpaces::DICEGUIWindow::beginInitialisation ( )

Writes an xml representation of this window object to out_stream.

Parameters:

xml_stream

Stream where xml data should be output.

Returns:: Nothing.

Sets the internal 'initialising' flag to true. This can be use to optimize initialisation of some widgets, and is called automatically by the layout XML handler when it has created a window. That is just after the window has been created, but before any children or properties are read.

void DigitalSpaces::DICEGUIWindow::endInitialisation ( )

Sets the internal 'initialising' flag to false. This is called automatically by the layout XML handler when it is done creating a window. That is after all properties and children have been loaded and just before the next sibling gets created.

void DigitalSpaces::DICEGUIWindow::setMousePassThroughEnabled ( bool setting )

Sets whether this window should ignore mouse events and pass them through to any windows behind it. In effect making the window transparent to the mouse.

Parameters:

setting

true if mouse pass through is enabled. false if mouse pass through is not enabled.

void DigitalSpaces::DICEGUIWindow::setWindowRenderer ( const char * name )

Assign the WindowRenderer to specify the Look'N'Feel specification to be used.

Parameters:

name

The factory name of the WindowRenderer to use.

Note:: Once a window renderer has been assigned it is locked - as in cannot be changed.

DICEGUIWindowRenderer* DigitalSpaces::DICEGUIWindow::getWindowRenderer ( )

Get the currently assigned WindowRenderer. (Look'N'Feel specification).

Returns:: A pointer to the assigned window renderer object. 0 if no window renderer is assigned.

const char* DigitalSpaces::DICEGUIWindow::getWindowRendererName ( )

Get the factory name of the currently assigned WindowRenderer. (Look'N'Feel specification).

Returns:: The factory name of the currently assigned WindowRenderer. If no WindowRenderer is assigned an empty string is returned.

void DigitalSpaces::DICEGUIWindow::setWritingXMLAllowed ( bool allow )

Sets whether this window is allowed to write XML.

void DigitalSpaces::DICEGUIWindow::notifyScreenAreaChanged ( )

Recursively inform all children that the screen area has changed, and needs to be re-cached.

The documentation for this struct was generated from the following file:

CEGUIInterfaces/CEGUIInterfaces.h

DigitalSpaces::DICEGUIWindow Struct Reference [CEGUI]

Detailed Description

Public Member Functions

Member Function Documentation

DigitalSpaces::DICEGUIWindow Struct Reference
[CEGUI]