sx::SXWidget Class Reference

#include <SXWidget.h>

Inheritance diagram for sx::SXWidget:

Signals
EXW void	finishedRendering ()
EXW void	wheelRotates (float degrees)

Public Member Functions
EXW	SXWidget ()
EXW	~SXWidget ()
EXW void	renderPeriodically (float time)
EXW void	stopRenderPeriodically ()
EXW void	addRenderListener (SXRenderListener &l)
EXW void	deleteRenderListener (SXRenderListener &l)
EXW void	deleteRenderListeners ()
EXW double	getTime () const
EXW double	getDeltaTime () const
EXW int	getMouseX () const
EXW int	getMouseY () const
EXW double	getMouseDeltaX () const
EXW double	getMouseDeltaY () const
EXW bool	hasKey (int key) const
EXW bool	hasMouseKey (MouseButton key) const
EXW int	getWidth () const
EXW int	getHeight () const
EXW void	stopRendering ()
EXW void	setMousePointer (int x, int y)
EXW void	setShowCursor (bool showCursor)

Friends
class	SXInternalWidget

Detailed Description

a Widget offering an environment for SXRenderListeners

Constructor & Destructor Documentation

EXW sx::SXWidget::SXWidget

(

)

constructor

EXW sx::SXWidget::~SXWidget

(

)

deconstructor

Member Function Documentation

EXW void sx::SXWidget::addRenderListener

(

SXRenderListener &

l

)

Adds a listener. The listener is removed, when the widget is removed.

EXW void sx::SXWidget::deleteRenderListener

(

SXRenderListener &

l

)

Removes a listener, if it's part of the widget. Otherwise the listener is not removed.

EXW void sx::SXWidget::deleteRenderListeners

(

)

removes all listeners, if the widget has not stopped rendering yet

EXW void sx::SXWidget::finishedRendering ( )

signal

fires after method stopRendering() deallocated all render listeners

EXW double sx::SXWidget::getDeltaTime ( ) const

virtual

See also

sx::SXRenderArea::getDeltaTime()

Implements sx::SXRenderArea.

EXW int sx::SXWidget::getHeight ( ) const

virtual

See also

sx::SXRenderArea::getHeight()

Implements sx::SXRenderArea.

EXW double sx::SXWidget::getMouseDeltaX ( ) const

virtual

See also

sx::SXRenderArea::getMouseDeltaX()

Implements sx::SXRenderArea.

EXW double sx::SXWidget::getMouseDeltaY ( ) const

virtual

See also

sx::SXRenderArea::getMouseDeltaY()

Implements sx::SXRenderArea.

EXW int sx::SXWidget::getMouseX ( ) const

virtual

See also

sx::SXRenderArea::getMouseX()

Implements sx::SXRenderArea.

EXW int sx::SXWidget::getMouseY ( ) const

virtual

See also

sx::SXRenderArea::getMouseY()

Implements sx::SXRenderArea.

EXW double sx::SXWidget::getTime ( ) const

virtual

See also

sx::SXRenderArea::getTime()

Implements sx::SXRenderArea.

EXW int sx::SXWidget::getWidth ( ) const

virtual

See also

sx::SXRenderArea::getWidth()

Implements sx::SXRenderArea.

EXW bool sx::SXWidget::hasKey ( int  key ) const

virtual

See also

sx::SXRenderArea::hasKey(int)

Implements sx::SXRenderArea.

EXW bool sx::SXWidget::hasMouseKey ( MouseButton  key ) const

virtual

See also

sx::SXRenderArea::hasMouseKey(MouseButton)

Implements sx::SXRenderArea.

EXW void sx::SXWidget::renderPeriodically

(

float

time

)

Makes the SXWidget render repeatedly. Parameter time specifies the amount of time from one frame to another in seconds.

EXW void sx::SXWidget::setMousePointer ( int  x, int  y  )

virtual

See also

sx::SXRenderArea::setMousePointer(int,int)

Implements sx::SXRenderArea.

EXW void sx::SXWidget::setShowCursor ( bool  showCursor )

virtual

See also

sx::SXRenderArea::setShowCursor(bool)

Implements sx::SXRenderArea.

EXW void sx::SXWidget::stopRendering ( )

virtual

See also

sx::SXRenderArea::stopRendering()

Implements sx::SXRenderArea.

EXW void sx::SXWidget::stopRenderPeriodically

(

)

Makes the SXWidget stop rendering repeatedly.

EXW void sx::SXWidget::wheelRotates ( float  degrees )

signal

Fires when the user rotates the mousewheel. The value of parameter degrees is equal to the angle the user rotated the mousewheel away from its position before in degrees. A positive value indicates, that the user rotated the wheel was rotated away from the user.

---

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

• fluid/res/include/sx/SXWidget.h