CEGUI::DefaultWindow Class Reference

Window class intended to be used as a simple, generic Window. More...

Inheritance diagram for CEGUI::DefaultWindow:

Collaboration diagram for CEGUI::DefaultWindow:

List of all members.

Public Member Functions
	DefaultWindow (const String &type, const String &name)
	Constructor for DefaultWindows.
virtual	~DefaultWindow (void)
	Destructor for DefaultWindows.
Static Public Attributes
static const String	WidgetTypeName
	The unique typename of this widget.
Protected Member Functions
void	updateMouseEventHandled (MouseEventArgs &e) const
	helper to update mouse input handled state
bool	moveToFront_impl (bool wasClicked)
	Implements move to front behavior.
void	onMouseMove (MouseEventArgs &e)
	Handler called when the mouse cursor has been moved within this window's area.
void	onMouseWheel (MouseEventArgs &e)
	Handler called when the mouse wheel (z-axis) position changes within this window's area.
void	onMouseButtonDown (MouseEventArgs &e)
	Handler called when a mouse button has been depressed within this window's area.
void	onMouseButtonUp (MouseEventArgs &e)
	Handler called when a mouse button has been released within this window's area.
void	onMouseClicked (MouseEventArgs &e)
	Handler called when a mouse button has been clicked (that is depressed and then released, within a specified time) within this window's area.
void	onMouseDoubleClicked (MouseEventArgs &e)
	Handler called when a mouse button has been double-clicked within this window's area.
void	onMouseTripleClicked (MouseEventArgs &e)
	Handler called when a mouse button has been triple-clicked within this window's area.

---

Detailed Description

Window class intended to be used as a simple, generic Window.

This class does no rendering and so appears totally transparent. This window defaults to position 0.0f, 0.0f with a size of 1.0f x 1.0f.

/par This Window has been used as the root GUI-sheet (root window) but it's usage has been extended beyond that. That's why it's name has been changed to "DefaultWindow" for 0.8.

---

Member Function Documentation

bool CEGUI::DefaultWindow::moveToFront_impl

(

bool

wasClicked

)

[protected, virtual]

Implements move to front behavior.

Returns:

Should return true if some action was taken, or false if there was nothing to be done.

Reimplemented from CEGUI::Window.

void CEGUI::DefaultWindow::onMouseButtonDown

(

MouseEventArgs &

e

)

[protected, virtual]

Handler called when a mouse button has been depressed within this window's area.

Parameters:

e	MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

void CEGUI::DefaultWindow::onMouseButtonUp

(

MouseEventArgs &

e

)

[protected, virtual]

Handler called when a mouse button has been released within this window's area.

Parameters:

e	MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

void CEGUI::DefaultWindow::onMouseClicked

(

MouseEventArgs &

e

)

[protected, virtual]

Handler called when a mouse button has been clicked (that is depressed and then released, within a specified time) within this window's area.

Parameters:

e	MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

void CEGUI::DefaultWindow::onMouseDoubleClicked

(

MouseEventArgs &

e

)

[protected, virtual]

Handler called when a mouse button has been double-clicked within this window's area.

Parameters:

e	MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

void CEGUI::DefaultWindow::onMouseMove

(

MouseEventArgs &

e

)

[protected, virtual]

Handler called when the mouse cursor has been moved within this window's area.

Parameters:

e	MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

void CEGUI::DefaultWindow::onMouseTripleClicked

(

MouseEventArgs &

e

)

[protected, virtual]

Handler called when a mouse button has been triple-clicked within this window's area.

Parameters:

e	MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

void CEGUI::DefaultWindow::onMouseWheel

(

MouseEventArgs &

e

)

[protected, virtual]

Handler called when the mouse wheel (z-axis) position changes within this window's area.

Parameters:

e	MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.