#include <slider.h>

Inheritance diagram for gcn::Slider:

Public Types
enum	{ HORIZONTAL = 0, VERTICAL }

Public Member Functions
	Slider (double scaleEnd=1.0)

	Slider (double scaleStart, double scaleEnd)

virtual	~Slider ()

virtual void	setScale (double scaleStart, double scaleEnd)

virtual double	getScaleStart () const

virtual void	setScaleStart (double scaleStart)

virtual double	getScaleEnd () const

virtual void	setScaleEnd (double scaleEnd)

virtual double	getValue () const

virtual void	setValue (double value)

virtual void	drawMarker (gcn::Graphics *graphics)

virtual void	setMarkerLength (int length)

virtual int	getMarkerLength () const

virtual void	setOrientation (unsigned int orientation)

virtual unsigned int	getOrientation () const

virtual void	setStepLength (double length)

virtual double	getStepLength () const

virtual void	draw (gcn::Graphics *graphics)

virtual void	drawBorder (gcn::Graphics *graphics)

virtual void	lostFocus ()

virtual void	mousePress (int x, int y, int button)

virtual void	mouseRelease (int x, int y, int button)

virtual void	mouseMotion (int x, int y)

virtual bool	keyPress (const Key &key)

Public Member Functions inherited from gcn::Widget
	Widget ()

virtual	~Widget ()

virtual void	logic ()

virtual BasicContainer *	getParent () const

virtual void	setWidth (int width)

virtual int	getWidth () const

virtual void	setHeight (int height)

virtual int	getHeight () const

virtual void	setSize (int width, int height)

virtual void	setX (int x)

virtual int	getX () const

virtual void	setY (int y)

virtual int	getY () const

virtual void	setPosition (int x, int y)

virtual void	setDimension (const Rectangle &dimension)

virtual void	setBorderSize (unsigned int borderSize)

virtual unsigned int	getBorderSize () const

virtual const Rectangle &	getDimension () const

virtual void	setFocusable (bool focusable)

virtual bool	isFocusable () const

virtual bool	hasFocus () const

virtual void	setEnabled (bool enabled)

virtual bool	isEnabled () const

virtual void	gotFocus ()

virtual bool	hasMouse () const

virtual void	setVisible (bool visible)

virtual bool	isVisible () const

virtual void	setBaseColor (const Color &color)

virtual const Color &	getBaseColor () const

virtual void	setForegroundColor (const Color &color)

virtual const Color &	getForegroundColor () const

virtual void	setBackgroundColor (const Color &color)

virtual const Color &	getBackgroundColor () const

virtual void	setDisabledColor (const Color &color)

virtual const Color &	getDisabledColor () const

virtual void	_mouseInputMessage (const MouseInput &mouseInput)

virtual bool	_keyInputMessage (const KeyInput &keyInput)

virtual void	hotKeyPress ()

virtual void	hotKeyRelease ()

virtual void	_mouseInMessage ()

virtual void	_mouseOutMessage ()

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

virtual void	_setFocusHandler (FocusHandler *focusHandler)

virtual FocusHandler *	_getFocusHandler ()

virtual void	addActionListener (ActionListener *actionListener)

virtual void	removeActionListener (ActionListener *actionListener)

virtual void	addMouseListener (MouseListener *mouseListener)

virtual void	removeMouseListener (MouseListener *mouseListener)

virtual void	addKeyListener (KeyListener *keyListener)

virtual void	removeKeyListener (KeyListener *keyListener)

virtual void	setEventId (const std::string &eventId)

virtual const std::string &	getEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

virtual void	_setParent (BasicContainer *parent)

Font *	getFont () const

virtual void	setFont (Font *font)

virtual void	fontChanged ()

virtual int	getHotKey () const

virtual void	setHotKey (const int key)

virtual void	setHotKey (const char *key)

virtual bool	isTabInEnabled () const

virtual void	setTabInEnabled (bool enabled)

virtual bool	isTabOutEnabled () const

virtual void	setTabOutEnabled (bool enabled)

virtual bool	isDragged () const

virtual void	requestModalFocus ()

virtual void	releaseModalFocus ()

virtual bool	hasModalFocus () const

virtual void	setDirty (bool dirty)

virtual bool	getDirty () const

Public Member Functions inherited from gcn::MouseListener
virtual	~MouseListener ()

virtual void	mouseIn ()

virtual void	mouseOut ()

virtual void	mouseClick (int, int, int, int)

virtual void	mouseWheelUp (int, int)

virtual void	mouseWheelDown (int, int)

Public Member Functions inherited from gcn::KeyListener
virtual	~KeyListener ()

virtual bool	keyRelease (const Key &)

virtual void	hotKeyPress (const Key &)

virtual void	hotKeyRelease (const Key &)

Protected Member Functions
virtual double	markerPositionToValue (int v) const

virtual int	valueToMarkerPosition (double value) const

virtual int	getMarkerPosition () const

Protected Member Functions inherited from gcn::Widget
void	generateAction ()

Protected Member Functions inherited from gcn::MouseListener
	MouseListener ()

Protected Member Functions inherited from gcn::KeyListener
	KeyListener ()

Protected Attributes
bool	mMouseDrag

double	mValue

double	mStepLength

int	mMarkerLength

double	mScaleStart

double	mScaleEnd

unsigned int	mOrientation

Protected Attributes inherited from gcn::Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Color	mDisabledColor

FocusHandler *	mFocusHandler

BasicContainer *	mParent

Rectangle	mDimension

unsigned int	mBorderSize

std::string	mEventId

int	mClickTimeStamp

int	mClickCount

int	mClickButton

bool	mHasMouse

bool	mFocusable

bool	mVisible

bool	mTabIn

bool	mTabOut

bool	mEnabled

Font *	mCurrentFont

int	mHotKey

bool	mDirty

Additional Inherited Members
Static Public Member Functions inherited from gcn::Widget
static void	setGlobalFont (Font *font)

static bool	widgetExists (const Widget *widget)

Protected Types inherited from gcn::Widget
typedef std::list< MouseListener * >	MouseListenerList

typedef MouseListenerList::iterator	MouseListenerIterator

typedef std::list< KeyListener * >	KeyListenerList

typedef KeyListenerList::iterator	KeyListenerIterator

typedef std::list< ActionListener * >	ActionListenerList

typedef ActionListenerList::iterator	ActionListenerIterator

Static Protected Attributes inherited from gcn::Widget
static DefaultFont	mDefaultFont

static Font *	mGlobalFont = NULL

static std::list< Widget * >	mWidgets

Detailed Description

A slider able to slide between different values. You can set the scale of the slider yourself so that it ranges between, for example, -1.0 and 2.0.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Draw orientations for the slider. It can be drawn verticaly or horizontaly.

Enumerator
HORIZONTAL
VERTICAL

Constructor & Destructor Documentation

◆ Slider() [1/2]

gcn::Slider::Slider ( double scaleEnd = 1.0 )

Constructor. Scale start is 0.

Parameters

scaleEnd the end of the slider scale.

◆ Slider() [2/2]

gcn::Slider::Slider	(	double	scaleStart,
		double	scaleEnd
	)

Constructor.

Parameters

scaleStart	the start of the scale.
scaleEnd	the end of the scale.

◆ ~Slider()

virtual gcn::Slider::~Slider ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ draw()

void gcn::Slider::draw ( gcn::Graphics * graphics )

virtual

Draws the Widget. It is called by the parent widget when it is time for the Widget to draw itself. The graphics object is set up so that all drawing is relative to the Widget, i.e coordinate (0,0) is the top-left corner of the Widget. It is not possible to draw outside of a Widgets dimension.

Parameters

graphics a Graphics object to draw with.

Implements gcn::Widget.

Reimplemented in ImageSlider.

◆ drawBorder()

void gcn::Slider::drawBorder ( gcn::Graphics * )

virtual

Draws a the Widget border. A border is drawn around a Widget. The width and height of the border is therefore the Widgets height+2*bordersize. Think of a painting that has a certain size, the border surrounds the painting.

Parameters

graphics a Graphics object to draw with.

Reimplemented from gcn::Widget.

◆ drawMarker()

void gcn::Slider::drawMarker ( gcn::Graphics * graphics )

virtual

Draws the marker.

Parameters

graphics a graphics object to draw with.

Reimplemented in ImageSlider.

◆ getMarkerLength()

int gcn::Slider::getMarkerLength ( ) const

virtual

Gets the length of the marker.

Returns: the length of the marker.

◆ getMarkerPosition()

int gcn::Slider::getMarkerPosition ( ) const

protectedvirtual

Gets the marker position for the current value.

Returns: the marker position for the current value.

◆ getOrientation()

unsigned int gcn::Slider::getOrientation ( ) const

virtual

Gets the orientation of the slider. Se the enum in this class.

Returns: the orientation of the slider.

◆ getScaleEnd()

double gcn::Slider::getScaleEnd ( ) const

virtual

Gets the scale end.

Returns: the scale end.

◆ getScaleStart()

double gcn::Slider::getScaleStart ( ) const

virtual

Gets the scale start.

Returns: the scale start.

◆ getStepLength()

double gcn::Slider::getStepLength ( ) const

virtual

Gets the step length.

Returns: the step length.

◆ getValue()

double gcn::Slider::getValue ( ) const

virtual

Gets the current value.

Returns: the current value.

◆ keyPress()

bool gcn::Slider::keyPress ( const Key & )

virtual

Called if a key is pressed when the widget has keyboard focus. If a key is held down the widget will generate multiple key presses.

Parameters

key	the key pressed.

Reimplemented from gcn::KeyListener.

◆ lostFocus()

void gcn::Slider::lostFocus ( )

virtual

Called if the Widget loses focus.

Reimplemented from gcn::Widget.

◆ markerPositionToValue()

double gcn::Slider::markerPositionToValue ( int v ) const

protectedvirtual

Converts a marker position to a value.

Parameters

v	the position to convert.

Returns: the value corresponding to the position.

◆ mouseMotion()

void gcn::Slider::mouseMotion	(	int	,
		int
	)

virtual

Called when the mouse moves and the mouse is in the Widget area or if the Widget has focus.

Parameters

x	the x coordinate of the mouse relative to the Widget itself.
y	the y coordinate of the mouse relative to the Widget itself.

Reimplemented from gcn::MouseListener.

◆ mousePress()

void gcn::Slider::mousePress	(	int	,
		int	,
		int
	)

virtual

Called when a mouse button is pressed when the mouse is in the Widget area or if the Widget has focus.

NOTE: A mouse press is NOT equal to a mouse click. Use mouseClickMessage to check for mouse clicks.

Parameters

x	the x coordinate of the mouse relative to the Widget itself.
y	the y coordinate of the mouse relative to the Widget itself.
button	the button pressed.

Reimplemented from gcn::MouseListener.

◆ mouseRelease()

void gcn::Slider::mouseRelease	(	int	,
		int	,
		int
	)

virtual

Called when a mouse button is released when the mouse is in the Widget area or if the Widget has focus.

Parameters

x	the x coordinate of the mouse relative to the Widget itself.
y	the y coordinate of the mouse relative to the Widget itself.
button	the button released.

Reimplemented from gcn::MouseListener.

◆ setMarkerLength()

void gcn::Slider::setMarkerLength ( int length )

virtual

Sets the length of the marker.

Parameters

length new length for the marker.

◆ setOrientation()

void gcn::Slider::setOrientation ( unsigned int orientation )

virtual

Sets the orientation of the slider. A slider can be drawn verticaly or horizontaly. For orientation, see the enum in this class.

Parameters

orientation the orientation.

◆ setScale()

void gcn::Slider::setScale	(	double	scaleStart,
		double	scaleEnd
	)

virtual

Sets the scale.

Parameters

scaleStart	the start of the scale.
scaleEnd	the end of the scale.

◆ setScaleEnd()

void gcn::Slider::setScaleEnd ( double scaleEnd )

virtual

Sets the scale end.

Parameters

scaleEnd the end of the scale.

◆ setScaleStart()

void gcn::Slider::setScaleStart ( double scaleStart )

virtual

Sets the scale start.

Parameters

scaleStart the start of the scale.

◆ setStepLength()

void gcn::Slider::setStepLength ( double length )

virtual

Sets the step length. Step length is used when the keys left and right are pressed.

Parameters

length the step length.

◆ setValue()

void gcn::Slider::setValue ( double value )

virtual

Sets the current value.

Parameters

value a scale value.

◆ valueToMarkerPosition()

int gcn::Slider::valueToMarkerPosition ( double value ) const

protectedvirtual

Converts a value to a marker position.

Parameters

value the value to convert.

Returns: the position corresponding to the value.

Member Data Documentation

◆ mMarkerLength

int gcn::Slider::mMarkerLength

protected

◆ mMouseDrag

bool gcn::Slider::mMouseDrag

protected

◆ mOrientation

unsigned int gcn::Slider::mOrientation

protected

◆ mScaleEnd

double gcn::Slider::mScaleEnd

protected

◆ mScaleStart

double gcn::Slider::mScaleStart

protected

◆ mStepLength

double gcn::Slider::mStepLength

protected

◆ mValue

double gcn::Slider::mValue

protected

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

src/guichan/include/guichan/widgets/slider.h
src/guichan/widgets/slider.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Slider() [1/2]

◆ Slider() [2/2]

◆ ~Slider()

Member Function Documentation

◆ draw()

◆ drawBorder()

◆ drawMarker()

◆ getMarkerLength()

◆ getMarkerPosition()

◆ getOrientation()

◆ getScaleEnd()

◆ getScaleStart()

◆ getStepLength()

◆ getValue()

◆ keyPress()

◆ lostFocus()

◆ markerPositionToValue()

◆ mouseMotion()

◆ mousePress()

◆ mouseRelease()

◆ setMarkerLength()

◆ setOrientation()

◆ setScale()

◆ setScaleEnd()

◆ setScaleStart()

◆ setStepLength()

◆ setValue()

◆ valueToMarkerPosition()

Member Data Documentation

◆ mMarkerLength

◆ mMouseDrag

◆ mOrientation

◆ mScaleEnd

◆ mScaleStart

◆ mStepLength

◆ mValue