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.

DigitalSpaces::DICEGUIWindow Struct Reference [CEGUI]

Detailed Description

Public Member Functions

Member Function Documentation

DigitalSpaces::DICEGUIWindow Struct Reference
[CEGUI]