DsSlider Class Reference

DsSlider is a class that represents a slider that can be used to adjust a value. More...

#include <ds_slider.h>

Inheritance diagram for DsSlider:

Public Member Functions
	DsSlider (DsView *parent, const DsPoint &pos, const DsSize &size, bool inverted=false)
	Creates a DsSlider object.
	~DsSlider ()
	Destructor.
void	drawTrackSurfaces (void)
	Creates a surface and pre-draws the track.
void	drawKnobSurface (void)
	Creates a surface and pre-draws the knob.
void	setTrackBorderColor (DsColor color)
	Sets the track border color.
void	setTrackBorderThickness (uint8_t thickness)
	Sets the track border thickness.
void	setTrackProportion (float proportion)
	Sets proportion of the track width versus the knob diameter.
void	setKnobBorderColor (DsColor color)
	Sets the knob border color.
void	setKnobBorderThickness (uint8_t thickness)
	Sets the knob border thickness.
void	setTrackColors (DsColor color, DsColor color_active)
	Sets the track color.
void	setKnobColor (DsColor color)
	Sets the knob color.
void	setTrackSurfaces (DsSurface *surface, DsSurface *surface_active)
	Sets the surfaces used for drawing the track.
void	setKnobSurface (DsSurface *surface, uint32_t diameter)
	Sets the surfaces used for drawing the knob.
Public Member Functions inherited from DsView
	DsView (DsView *parent, const DsPoint &pos=DsPoint(), const DsSize &size=DsSize())
	Creates a DsView with an optional position and size.
	DsView (DsView *parent, DsOrientation layout_orientation)
	Creates a DsView with the auto-layout mode active. This view can align it's children automatically.
void	addChild (DsView *view)
	Adds a child to the current DsView.
void	removeChild (DsView *view)
	Removes a child to the current DsView.
void	removeAllChildren (void)
	Removes all children of the current DsView.
void	bringFront (void)
	Brings the current view to the top of the drawing order.
void	sendBack (void)
	Sends the current view to the bottom of the drawing order.
DsView *	getParent (void) const
	Returns the parent of the current view.
void	setParent (DsView *parent)
	Sets a new parent to the view.
const DsPoint &	getPosition (void) const
	Returns the position of the view in parent coordinates.
DsFPoint	getCenterPoint (void) const
	Returns the center point of the view in current coordinates.
DsPoint	translatePositionInParentCoordinates (const DsView *parent, DsPoint pos) const
	Translates position (x, y) in parent coordinate system.
DsPoint	translatePositionInParentCoordinates (uint32_t parent_level, DsPoint pos) const
	Translates position (x, y) in parent coordinate system.
DsPoint	getPositionInParentCoordinates (const DsView *parent) const
	Returns the position in the parent's coordinate system.
void	setPosition (const DsPoint &pos)
	Sets the position of the view in parent coordinates.
void	setCenterPosition (const DsPoint &pos)
	Sets the position of the center of the view in parent coordinates.
void	centerVertically (DsView *view)
	Aligns vertically the center of the current view with the center of another view.
void	centerHorizontally (DsView *view)
	Aligns horizontally the center of the current view with the center of another view.
const DsSize &	getParentSize (void) const
	Returns the size of the parent view.
const DsSize &	getSize (void) const
	Returns the size of the view.
void	setMinimumSize (const DsSize &size)
	Returns the minimum size of the view.
void	setSize (const DsSize &size)
	Sets the size of the view.
void	setWidth (int32_t width)
	Sets the width of the view.
void	setHeight (int32_t height)
	Sets the height of the view.
DsRect	getRegion (void) const
	Returns a rectangle describing the space occupied by the current view in it's own coordinate system (X and Y coordinates are 0).
DsRect	getRegionInParentCoordinates (const DsView *parent) const
	Returns a rectangle describing the space occupied by the current view in the parent's coordinate system.
void	alignInParent (void)
	Aligns the view relative to it's parent.
void	alignInParent (const DsAlignment &alignment, int32_t padding_top, int32_t padding_left, int32_t padding_bottom, int32_t padding_right)
	Aligns the view relative to it's parent.
DsView *	setPaddingTop (int16_t padding, uint16_t proportion=0)
	Sets the top padding used by the auto-layout.
DsView *	setPaddingBottom (int16_t padding, uint16_t proportion=0)
	Sets the bottom padding used by the auto-layout.
DsView *	setPaddingLeft (int32_t padding, uint16_t proportion=0)
	Sets the left padding used by the auto-layout.
DsView *	setPaddingRight (int16_t padding, uint16_t proportion=0)
	Sets the right padding used by the auto-layout.
DsView *	setPadding (int16_t padding, uint16_t proportion=0)
	Sets the padding used by the auto-layout.
DsView *	setPaddingHorizontal (int16_t padding, uint16_t proportion=0)
	Sets the horizontal padding used by the auto-layout.
DsView *	setPaddingVertical (int16_t padding, uint16_t proportion=0)
	Sets the vertical padding used by the auto-layout.
DsView *	setProportion (uint32_t proportion)
	Sets the view proportion used by the auto-layout.
DsAlignment	getParentAlignment (void) const
	Returns parent alignment mode of the view.
DsView *	setParentAlignment (const DsAlignment &alignment)
	Sets parent alignment mode of the view.
void	reserveSpace (bool state)
	Configures if during auto-layout the view will reserve space even if it's hidden.
void	setAutoLayout (DsOrientation orientation, bool enable)
	Enables or disables the auto-layout mode and sets the primary orientation.
virtual DsSize	fitContent (void)
	Calculates the minimum size required by the view.
void	doLayout (void)
	Runs the auto-layout algorithm.
void	setBackgroundColor (DsColor color)
	Sets the background color of the view.
void	setBackgroundImage (const DsSurface *surface)
	Sets the background image.
void	setPanelColor (DsColor color)
	Sets the color of the panel.
void	setPanelBorderColor (DsColor color)
	Sets the color of the panel border.
void	setPanelCornerRadius (uint16_t radius)
	Sets the radius of the panel corners.
void	setPanelBorderThickness (uint8_t thickness)
	Sets the thickness of the panel border.
DsScreen &	getScreen (void)
	Returns a reference to the screen to which this view belongs.
bool	isFocused (void)
	Is the view focused?
bool	getIsVisible (void) const
	Is the view visibility enabled?
bool	isVisible (void) const
	Is the view actually visible on the screen?
bool	isParentVisible (void) const
	Is the parent view actually visible on the screen?
bool	show (void)
	Shortcut to setVisible(true).
bool	hide (void)
	Shortcut to setVisible(false).
bool	setVisible (bool is_visible)
	Changes the visibility of the view.
virtual void	onShow (void)
	This virtual method is called when the view becomes visible on the screen.
virtual void	onHide (void)
	This virtual method is called when the view becomes invisible (hidden) on the screen.
void	enable (bool state)
	Enables or disables the view.
bool	isEnabled (void) const
	Is the view enabled?
void	enableTouch (bool state)
	Enables or disables processing of touch events.
bool	isTouchEnabled (void) const
	Is the view enabled to process touch events?
void	sendTap (DsPoint pos)
	Sends a tap event to the view.
void	setOnTapCallback (const lambda< void(const DsPoint &p)> &cb)
	Sets the lambda to be executed when the user taps on the view.
void	setOnLongTapCallback (const lambda< void(const DsPoint &p)> &cb)
	Sets the lambda to be executed when the user taps the view and holds for a specific time (set with setLongTapDetection()).
void	setOnTouchActiveCallback (const lambda< void(const DsPoint &p)> &cb)
	Sets the lambda to be executed when the user touches the view.
void	setOnTouchReleaseCallback (const lambda< void(void)> &cb)
	Sets the lambda to be executed when the user touch is released.
void	setLongTapDetection (uint32_t delay_ms)
	Configures the long tap detection.
bool	isInputInside (void) const
	Returns if there is user input (touch) inside the view.
const DsPoint &	getTouchPosition (void) const
	Returns the location of the user touch input inside the view.
void	enableHorizontalScroll (bool state)
	Enables or disables the horizontal scroll of the view contents.
void	enableVerticalScroll (bool state)
	Enables or disables the vertical scroll of the view contents.
void	setScrollbarColor (DsColor color)
	Configure the color of the scroll bars.
virtual void	invalidate (void)
	Invalidates the view.
virtual void	invalidateRegion (DsRect region)
	Invalidates only a region of the view.
void	addStateObserver (StateObserver *observer)
	Adds a state observer object.
void	removeStateObserver (StateObserver *observer)
	Removes a state observer object.
Public Member Functions inherited from DsValueBase
void	setValueRange (float min, float max)
	Sets the value range.
void	setValue (float value)
	Sets the value.
float	getValue (void) const
	Returns the value.
void	setOnChangeCallback (const lambda< void(float value, bool in_motion, bool user_input)> &cb)

Additional Inherited Members
Protected Member Functions inherited from DsView
virtual void	onChildAdd (DsView *child)
	This virtual method will be called when a new child had been added to the view.
virtual void	onPaintOver (DsRenderer &renderer)
	This virtual method will be called when the view needs to repaint it's content, but after the view and it's children had been painted.
virtual void	onVSync (void)
	This virtual method is be called at every vertical sync period.
virtual void	onKeyboard (int32_t key)
	This virtual method is called when there is a keyboard event that needs to be processed.
void	inputCapture (void)
	Captures the touch input.
bool	isInputCaptured (void) const
	Is the input captured?
void	skipInput (void)
	Skips receiving touch inputs until the end of the current touch event.
void	forAllChildren (const lambda< void(DsView *child)> &lambda)
	Calls the supplied lambda for every view in the children list.
void	forAllChildrenBackwards (const lambda< void(DsView *child)> &lambda)
	Calls the supplied lambda for every view in the children list.
Protected Member Functions inherited from DsValueBase
float	getNormalizedValue (float value)
void	notifyValueChange (bool in_motion)
Protected Attributes inherited from DsView
DsPoint	mScrollPosition
DsPoint	mPreviousScrollPosition
DsPoint	mScrollPositionBase
DsColor	mScrollbarColor
DsPoint	mTouchPos
uint32_t	mTouchTimestamp
Protected Attributes inherited from DsValueBase
float	mMinValue
float	mMaxValue
float	mValue

Detailed Description

DsSlider is a class that represents a slider that can be used to adjust a value.

The slider can be in either vertical or horizontal orientation. It consists of a knob with diameter equal to the smallest of the width/height and a track that spans the length of the slider (the size in the orientation dimension). The track is specified as a proportion of the knob diameter. Both the knob and the track can have a border of a different color. The slider can be operated by touching and dragging the knob.

Constructor & Destructor Documentation

DsSlider()

DsSlider::DsSlider	(	DsView *	parent,
		const DsPoint &	pos,
		const DsSize &	size,
		bool	inverted = false
	)

Creates a DsSlider object.

Parameters

parent	The parent view
pos	The position of the view in the parent coordinate system
size	The size of the view
inverted	If true, the slider will be inverted left-right or top-bottom, depending on the orientation

Member Function Documentation

drawKnobSurface()

void DsSlider::drawKnobSurface

(

void

)

Creates a surface and pre-draws the knob.

This will speed up the rendering at the expense memory used.

drawTrackSurfaces()

void DsSlider::drawTrackSurfaces

(

void

)

Creates a surface and pre-draws the track.

This will speed up the rendering at the expense memory used.

setKnobBorderColor()

void DsSlider::setKnobBorderColor

(

DsColor

color

)

Sets the knob border color.

Parameters

color

Knob border color

setKnobBorderThickness()

void DsSlider::setKnobBorderThickness

(

uint8_t

thickness

)

Sets the knob border thickness.

Parameters

color

Knob border thickness in pixels

setKnobColor()

void DsSlider::setKnobColor

(

DsColor

color

)

Sets the knob color.

Parameters

color

Knob color

setKnobSurface()

void DsSlider::setKnobSurface	(	DsSurface *	surface,
		uint32_t	diameter
	)

Sets the surfaces used for drawing the knob.

This can be used for drawing a custom knob.

Parameters

surface	Surface of the knob
diameter	Diameter of the knob (not including shadows or areas that are transparent). This is used for calculating the maximum range of knob movement.

setTrackBorderColor()

void DsSlider::setTrackBorderColor

(

DsColor

color

)

Sets the track border color.

Parameters

color

Track border color

setTrackBorderThickness()

void DsSlider::setTrackBorderThickness

(

uint8_t

thickness

)

Sets the track border thickness.

Parameters

color

Track border thickness in pixels

setTrackColors()

void DsSlider::setTrackColors	(	DsColor	color,
		DsColor	color_active
	)

Sets the track color.

Parameters

color	Color of the inactive track
color_active	Color of the active track

setTrackProportion()

void DsSlider::setTrackProportion

(

float

proportion

)

Sets proportion of the track width versus the knob diameter.

Parameters

proportion

Track proportion [0 .. 1]. The default value is 0.4.

setTrackSurfaces()

void DsSlider::setTrackSurfaces	(	DsSurface *	surface,
		DsSurface *	surface_active
	)

Sets the surfaces used for drawing the track.

This can be used for drawing a custom track. The surfaces contain the full length track (typically the length of the slider in the orientation direction).

Parameters

surface	Surface of the inactive track
surface_active	Surface of the active track

---

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

• inc/ds_slider.h