DigitalSpaces::DICEGUIFrameWindow Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Public Member Functions
bool	isSizingEnabled ()
	Return whether this window is sizable. Note that this requires that the window have an enabled frame and that sizing itself is enabled.
bool	isFrameEnabled ()
	Return whether the frame for this window is enabled.
bool	isTitleBarEnabled ()
	Return whether the title bar for this window is enabled.
bool	isCloseButtonEnabled ()
	Return whether this close button for this window is enabled.
bool	isRollupEnabled ()
	Return whether roll up (a.k.a shading) is enabled for this window.
bool	isRolledup ()
	Return whether the window is currently rolled up (a.k.a shaded).
float	getSizingBorderThickness ()
	Return the thickness of the sizing border.
void	setSizingEnabled (bool setting)
	Enables or disables sizing for this window.
void	setFrameEnabled (bool setting)
	Enables or disables the frame for this window.
void	setTitleBarEnabled (bool setting)
	Enables or disables the title bar for the frame window.
void	setCloseButtonEnabled (bool setting)
	Enables or disables the close button for the frame window.
void	setRollupEnabled (bool setting)
	Enables or disables roll-up (shading) for this window.
void	toggleRollup ()
	Toggles the state of the window between rolled-up (shaded) and normal sizes. This requires roll-up to be enabled.
void	setSizingBorderThickness (float pixels)
	Set the size of the sizing border for this window.
void	offsetPixelPosition (in_Pairf *offset)
	Move the window by the pixel offsets specified in offset.
bool	isDragMovingEnabled ()
	Return whether this FrameWindow can be moved by dragging the title bar.
void	setDragMovingEnabled (bool setting)
	Set whether this FrameWindow can be moved by dragging the title bar.
DICEGUIImage *	getNSSizingCursorImage ()
	Return a pointer to the currently set Image to be used for the north-south sizing mouse cursor.
DICEGUIImage *	getEWSizingCursorImage ()
	Return a pointer to the currently set Image to be used for the east-west sizing mouse cursor.
DICEGUIImage *	getNWSESizingCursorImage ()
	Return a pointer to the currently set Image to be used for the northwest-southeast sizing mouse cursor.
DICEGUIImage *	getNESWSizingCursorImage ()
	Return a pointer to the currently set Image to be used for the northeast-southwest sizing mouse cursor.
void	setNSSizingCursorImage (DICEGUIImage *image)
	Set the Image to be used for the north-south sizing mouse cursor.
void	setEWSizingCursorImage (DICEGUIImage *image)
	Set the Image to be used for the east-west sizing mouse cursor.
void	setNWSESizingCursorImage (DICEGUIImage *image)
	Set the Image to be used for the northwest-southeast sizing mouse cursor.
void	setNESWSizingCursorImage (DICEGUIImage *image)
	Set the Image to be used for the northeast-southwest sizing mouse cursor.
void	setNSSizingCursorImage (const char *imageset, const char *image)
	Set the image to be used for the north-south sizing mouse cursor.
void	setEWSizingCursorImage (const char *imageset, const char *image)
	Set the image to be used for the east-west sizing mouse cursor.
void	setNWSESizingCursorImage (const char *imageset, const char *image)
	Set the image to be used for the northwest-southeast sizing mouse cursor.
void	setNESWSizingCursorImage (const char *imageset, const char *image)
	Set the image to be used for the northeast-southwest sizing mouse cursor.
DICEGUITitlebar *	getTitlebar ()
	Return a pointer to the Titlebar component widget for this FrameWindow.
DICEGUIButton *	getCloseButton ()
	Return a pointer to the close button component widget for this FrameWindow.

---

Member Function Documentation

bool DigitalSpaces::DICEGUIFrameWindow::isSizingEnabled

(

)

Return whether this window is sizable. Note that this requires that the window have an enabled frame and that sizing itself is enabled.

Returns:

true if the window can be sized, false if the window can not be sized

bool DigitalSpaces::DICEGUIFrameWindow::isFrameEnabled

(

)

Return whether the frame for this window is enabled.

Returns:

true if the frame for this window is enabled, false if the frame for this window is disabled.

bool DigitalSpaces::DICEGUIFrameWindow::isTitleBarEnabled

(

)

Return whether the title bar for this window is enabled.

Returns:

true if the window has a title bar and it is enabled, false if the window has no title bar or if the title bar is disabled.

bool DigitalSpaces::DICEGUIFrameWindow::isCloseButtonEnabled

(

)

Return whether this close button for this window is enabled.

Returns:

true if the window has a close button and it is enabled, false if the window either has no close button or if the close button is disabled.

bool DigitalSpaces::DICEGUIFrameWindow::isRollupEnabled

(

)

Return whether roll up (a.k.a shading) is enabled for this window.

Returns:

true if roll up is enabled, false if roll up is disabled.

bool DigitalSpaces::DICEGUIFrameWindow::isRolledup

(

)

Return whether the window is currently rolled up (a.k.a shaded).

Returns:

true if the window is rolled up, false if the window is not rolled up.

float DigitalSpaces::DICEGUIFrameWindow::getSizingBorderThickness

(

)

Return the thickness of the sizing border.

Returns:

float value describing the thickness of the sizing border in screen pixels.

void DigitalSpaces::DICEGUIFrameWindow::setSizingEnabled

(

bool

setting

)

Enables or disables sizing for this window.

Parameters:

setting

set to true to enable sizing (also requires frame to be enabled), or false to disable sizing.

Returns:

nothing

void DigitalSpaces::DICEGUIFrameWindow::setFrameEnabled

(

bool

setting

)

Enables or disables the frame for this window.

Parameters:

setting

set to true to enable the frame for this window, or false to disable the frame for this window.

Returns:

Nothing.

void DigitalSpaces::DICEGUIFrameWindow::setTitleBarEnabled

(

bool

setting

)

Enables or disables the title bar for the frame window.

Parameters:

setting

set to true to enable the title bar (if one is attached), or false to disable the title bar.

Returns:

Nothing.

void DigitalSpaces::DICEGUIFrameWindow::setCloseButtonEnabled

(

bool

setting

)

Enables or disables the close button for the frame window.

Parameters:

setting

Set to true to enable the close button (if one is attached), or false to disable the close button.

Returns:

Nothing.

void DigitalSpaces::DICEGUIFrameWindow::setRollupEnabled

(

bool

setting

)

Enables or disables roll-up (shading) for this window.

Parameters:

setting

Set to true to enable roll-up for the frame window, or false to disable roll-up.

Returns:

Nothing.

void DigitalSpaces::DICEGUIFrameWindow::toggleRollup

(

)

Toggles the state of the window between rolled-up (shaded) and normal sizes. This requires roll-up to be enabled.

Returns:

Nothing

void DigitalSpaces::DICEGUIFrameWindow::setSizingBorderThickness

(

float

pixels

)

Set the size of the sizing border for this window.

Parameters:

pixels

float value specifying the thickness for the sizing border in screen pixels.

Returns:

Nothing.

void DigitalSpaces::DICEGUIFrameWindow::offsetPixelPosition

(

in_Pairf *

offset

)

Move the window by the pixel offsets specified in offset.

This is intended for internal system use - it is the method by which the title bar moves the frame window.

Parameters:

offset

Vector2 object containing the offsets to apply (offsets are in screen pixels).

Returns:

Nothing.

bool DigitalSpaces::DICEGUIFrameWindow::isDragMovingEnabled

(

)

Return whether this FrameWindow can be moved by dragging the title bar.

Returns:

true if the Window will move when the user drags the title bar, false if the window will not move.

void DigitalSpaces::DICEGUIFrameWindow::setDragMovingEnabled

(

bool

setting

)

Set whether this FrameWindow can be moved by dragging the title bar.

Parameters:

setting

true if the Window should move when the user drags the title bar, false if the window should not move.

Returns:

Nothing.

DICEGUIImage* DigitalSpaces::DICEGUIFrameWindow::getNSSizingCursorImage

(

)

Return a pointer to the currently set Image to be used for the north-south sizing mouse cursor.

Returns:

Pointer to an Image object, or 0 for none.

DICEGUIImage* DigitalSpaces::DICEGUIFrameWindow::getEWSizingCursorImage

(

)

Return a pointer to the currently set Image to be used for the east-west sizing mouse cursor.

Returns:

Pointer to an Image object, or 0 for none.

DICEGUIImage* DigitalSpaces::DICEGUIFrameWindow::getNWSESizingCursorImage

(

)

Return a pointer to the currently set Image to be used for the northwest-southeast sizing mouse cursor.

Returns:

Pointer to an Image object, or 0 for none.

DICEGUIImage* DigitalSpaces::DICEGUIFrameWindow::getNESWSizingCursorImage

(

)

Return a pointer to the currently set Image to be used for the northeast-southwest sizing mouse cursor.

Returns:

Pointer to an Image object, or 0 for none.

void DigitalSpaces::DICEGUIFrameWindow::setNSSizingCursorImage

(

DICEGUIImage *

image

)

Set the Image to be used for the north-south sizing mouse cursor.

Parameters:

image

Pointer to an Image object, or 0 for none.

Returns:

Nothing.

void DigitalSpaces::DICEGUIFrameWindow::setEWSizingCursorImage

(

DICEGUIImage *

image

)

Set the Image to be used for the east-west sizing mouse cursor.

Parameters:

image

Pointer to an Image object, or 0 for none.

Returns:

Nothing.

void DigitalSpaces::DICEGUIFrameWindow::setNWSESizingCursorImage

(

DICEGUIImage *

image

)

Set the Image to be used for the northwest-southeast sizing mouse cursor.

Parameters:

image

Pointer to an Image object, or 0 for none.

Returns:

Nothing.

void DigitalSpaces::DICEGUIFrameWindow::setNESWSizingCursorImage

(

DICEGUIImage *

image

)

Set the Image to be used for the northeast-southwest sizing mouse cursor.

Parameters:

image

Pointer to an Image object, or 0 for none.

Returns:

Nothing.

void DigitalSpaces::DICEGUIFrameWindow::setNSSizingCursorImage	(	const char *	imageset,
		const char *	image
	)

Set the image to be used for the north-south sizing mouse cursor.

Parameters:

	imageset	String holding the name of the Imageset containing the Image to be used.
	image	String holding the name of the Image to be used.

Returns:

Nothing.

Exceptions:

UnknownObjectException

thrown if either imageset or image refer to non-existant entities.

void DigitalSpaces::DICEGUIFrameWindow::setEWSizingCursorImage	(	const char *	imageset,
		const char *	image
	)

Set the image to be used for the east-west sizing mouse cursor.

Parameters:

	imageset	String holding the name of the Imageset containing the Image to be used.
	image	String holding the name of the Image to be used.

Returns:

Nothing.

Exceptions:

UnknownObjectException

thrown if either imageset or image refer to non-existant entities.

void DigitalSpaces::DICEGUIFrameWindow::setNWSESizingCursorImage	(	const char *	imageset,
		const char *	image
	)

Set the image to be used for the northwest-southeast sizing mouse cursor.

Parameters:

	imageset	String holding the name of the Imageset containing the Image to be used.
	image	String holding the name of the Image to be used.

Returns:

Nothing.

Exceptions:

UnknownObjectException

thrown if either imageset or image refer to non-existant entities.

void DigitalSpaces::DICEGUIFrameWindow::setNESWSizingCursorImage	(	const char *	imageset,
		const char *	image
	)

Set the image to be used for the northeast-southwest sizing mouse cursor.

Parameters:

	imageset	String holding the name of the Imageset containing the Image to be used.
	image	String holding the name of the Image to be used.

Returns:

Nothing.

Exceptions:

UnknownObjectException

thrown if either imageset or image refer to non-existant entities.

DICEGUITitlebar* DigitalSpaces::DICEGUIFrameWindow::getTitlebar

(

)

Return a pointer to the Titlebar component widget for this FrameWindow.

Returns:

Pointer to a Titlebar object.

Exceptions:

UnknownObjectException

Thrown if the Titlebar component does not exist.

DICEGUIButton* DigitalSpaces::DICEGUIFrameWindow::getCloseButton

(

)

Return a pointer to the close button component widget for this FrameWindow.

Returns:

Pointer to a PushButton object.

Exceptions:

UnknownObjectException

Thrown if the close button component does not exist.

---

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

• CEGUIInterfaces/CEGUIInterfaces.h