#include <CCControlSlider.h>

Inheritance diagram for ControlSlider:

Public Member Functions
	ControlSlider ()
virtual	~ControlSlider ()
virtual bool	initWithSprites (Sprite backgroundSprite, Sprite progressSprite, Sprite *thumbSprite)
	Initializes a slider with a background sprite, a progress bar and a thumb item. More...

local	initWithSprites ( local backgroundSprite, local progressSprite, local thumbSprite)
	Initializes a slider with a background sprite, a progress bar and a thumb item. More...

virtual void	needsLayout ()
	Updates the control layout using its current internal state. More...

virtual void	setMaximumValue (float val)
var	setMaximumValue ( var val)
local	setMaximumValue ( local val)
virtual void	setEnabled (bool enabled)
	Tells whether the control is enabled. More...

var	setEnabled ( var enabled)
	Tells whether the control is enabled. More...

local	setEnabled ( local enabled)
	Tells whether the control is enabled. More...

virtual bool	isTouchInside (Touch *touch)
	Returns a boolean value that indicates whether a touch is inside the bounds of the receiver. More...

var	isTouchInside ( var touch)
	Returns a boolean value that indicates whether a touch is inside the bounds of the receiver. More...

local	isTouchInside ( local touch)
	Returns a boolean value that indicates whether a touch is inside the bounds of the receiver. More...

Point	locationFromTouch (Touch *touch)
var	locationFromTouch ( var touch)
local	locationFromTouch ( local touch)
virtual void	setValue (float val)
var	setValue ( var val)
local	setValue ( local val)
virtual void	setMinimumValue (float val)
var	setMinimumValue ( var val)
local	setMinimumValue ( local val)
virtual float	getValue (void)
	getValue More...

virtual float	getMinimumValue (void)
	getMinimumValue More...

local	getMinimumValue ()
	getMinimumValue More...

virtual float	getMaximumValue (void)
	getMaximumValue More...

var	getMaximumValue ()
	getMaximumValue More...

local	getMaximumValue ()
	getMaximumValue More...

virtual Sprite *	getThumbSprite (void)
	getThumbSprite More...

var	getThumbSprite ()
	getThumbSprite More...

local	getThumbSprite ()
	getThumbSprite More...

virtual void	setThumbSprite (Sprite *var)
	setThumbSprite More...

var	setThumbSprite ( var var)
	setThumbSprite More...

local	setThumbSprite ( local var)
	setThumbSprite More...

virtual Sprite *	getProgressSprite (void)
	getProgressSprite More...

virtual void	setProgressSprite (Sprite *var)
	setProgressSprite More...

virtual Sprite *	getBackgroundSprite (void)
	getBackgroundSprite More...

var	getBackgroundSprite ()
	getBackgroundSprite More...

local	getBackgroundSprite ()
	getBackgroundSprite More...

virtual void	setBackgroundSprite (Sprite *var)
	setBackgroundSprite More...

Public Member Functions inherited from Control
	Control ()
virtual bool	init (void)
	Initializes the instance of Node. More...

local	init ()
	Initializes the instance of Node. More...

virtual	~Control ()
virtual bool	isEnabled () const
virtual void	setSelected (bool bSelected)
	A Boolean value that determines the control selected state. More...

local	setSelected ( local bSelected)
	A Boolean value that determines the control selected state. More...

virtual bool	isSelected () const
virtual void	setHighlighted (bool bHighlighted)
	A Boolean value that determines whether the control is highlighted. More...

virtual bool	isHighlighted () const
bool	hasVisibleParents () const
var	hasVisibleParents ()
local	hasVisibleParents ()
virtual void	sendActionsForControlEvents (EventType controlEvents)
	Sends action messages for the given control events. More...

local	sendActionsForControlEvents ( local controlEvents)
	Sends action messages for the given control events. More...

virtual void	addTargetWithActionForControlEvents (Object *target, Handler action, EventType controlEvents)
	Adds a target and action for a particular event (or events) to an internal dispatch table. More...

local	addTargetWithActionForControlEvents ( local target, local action, local controlEvents)
	Adds a target and action for a particular event (or events) to an internal dispatch table. More...

virtual void	removeTargetWithActionForControlEvents (Object *target, Handler action, EventType controlEvents)
	Removes a target and action for a particular event (or events) from an internal dispatch table. More...

virtual Point	getTouchLocation (Touch *touch)
	Returns a point corresponding to the touh location converted into the control space coordinates. More...

virtual void	onTouchCancelled (Touch touch, Event event)
local	onTouchCancelled ( local touch, local event)
virtual bool	isOpacityModifyRGB () const override
	Returns whether or not the opacity will be applied using glColor(R,G,B,opacity) or glColor(opacity, opacity, opacity, opacity) More...

virtual void	setOpacityModifyRGB (bool bOpacityModifyRGB) override
	Changes the OpacityModifyRGB property. More...

var	setOpacityModifyRGB ( var bOpacityModifyRGB)
	Changes the OpacityModifyRGB property. More...

local	setOpacityModifyRGB ( local bOpacityModifyRGB)
	Changes the OpacityModifyRGB property. More...

virtual void	onEnter () override
	Event callback that is invoked every time when Node enters the 'stage'. More...

virtual void	onExit () override
	Event callback that is invoked every time the Node leaves the 'stage'. More...

virtual State	getState (void)
	getState More...

var	getState ()
	getState More...

local	getState ()
	getState More...

Public Member Functions inherited from LayerRGBA
	CREATE_FUNC (LayerRGBA)
	LayerRGBA ()
virtual	~LayerRGBA ()
virtual GLubyte	getOpacity () const override
	Returns the opacity. More...

virtual GLubyte	getDisplayedOpacity () const override
	Returns the displayed opacity. More...

virtual void	setOpacity (GLubyte opacity) override
	Changes the opacity. More...

virtual void	updateDisplayedOpacity (GLubyte parentOpacity) override
	recursive method that updates the displayed opacity. More...

virtual bool	isCascadeOpacityEnabled () const override
	whether or not opacity should be propagated to its children. More...

virtual void	setCascadeOpacityEnabled (bool cascadeOpacityEnabled) override
virtual const Color3B &	getColor () const override
	Returns color that is currently used. More...

virtual const Color3B &	getDisplayedColor () const override
	Returns the displayed color. More...

virtual void	setColor (const Color3B &color) override
	Changes the color with R,G,B bytes. More...

virtual void	updateDisplayedColor (const Color3B &parentColor) override
	recursive method that updates display color More...

virtual bool	isCascadeColorEnabled () const override
	whether or not color should be propagated to its children. More...

virtual void	setCascadeColorEnabled (bool cascadeColorEnabled) override
Public Member Functions inherited from Layer
	Layer ()
virtual	~Layer ()
virtual CC_DEPRECATED_ATTRIBUTE bool	ccTouchBegan (Touch pTouch, Event pEvent) final
local	ccTouchBegan ( local pTouch, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchMoved (Touch pTouch, Event pEvent) final
local	ccTouchMoved ( local pTouch, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchEnded (Touch pTouch, Event pEvent) final
local	ccTouchEnded ( local pTouch, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchCancelled (Touch pTouch, Event pEvent) final
local	ccTouchCancelled ( local pTouch, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchesBegan (Set pTouches, Event pEvent) final
local	ccTouchesBegan ( local pTouches, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchesMoved (Set pTouches, Event pEvent) final
local	ccTouchesMoved ( local pTouches, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchesEnded (Set pTouches, Event pEvent) final
local	ccTouchesEnded ( local pTouches, local pEvent)
virtual CC_DEPRECATED_ATTRIBUTE void	ccTouchesCancelled (Set pTouches, Event pEvent) final
local	ccTouchesCancelled ( local pTouches, local pEvent)
virtual void	onTouchesBegan (const std::vector< Touch * > &touches, Event *event)
virtual void	onTouchesMoved (const std::vector< Touch * > &touches, Event *event)
local	onTouchesMoved ( local touches, local event)
virtual void	onTouchesEnded (const std::vector< Touch * > &touches, Event *event)
local	onTouchesEnded ( local touches, local event)
virtual void	onTouchesCancelled (const std::vector< Touch * > &touches, Event *event)
var	onTouchesCancelled ( var touches, var event)
local	onTouchesCancelled ( local touches, local event)
virtual CC_DEPRECATED_ATTRIBUTE void	didAccelerate (Acceleration *accelerationValue) final
local	didAccelerate ( local accelerationValue)
virtual void	onAcceleration (Acceleration acc, Event event)
virtual CC_DEPRECATED_ATTRIBUTE void	registerWithTouchDispatcher () final
	If isTouchEnabled, this method is called onEnter. More...

local	registerWithTouchDispatcher ()
	If isTouchEnabled, this method is called onEnter. More...

virtual bool	isTouchEnabled () const
	whether or not it will receive Touch events. More...

virtual void	setTouchEnabled (bool value)
local	setTouchEnabled ( local value)
virtual void	setTouchMode (Touch::DispatchMode mode)
local	setTouchMode ( local mode)
virtual Touch::DispatchMode	getTouchMode () const
local	getTouchMode ()
virtual void	setSwallowsTouches (bool swallowsTouches)
	swallowsTouches of the touch events. More...

local	setSwallowsTouches ( local swallowsTouches)
	swallowsTouches of the touch events. More...

virtual bool	isSwallowsTouches () const
virtual bool	isAccelerometerEnabled () const
	whether or not it will receive Accelerometer events You can enable / disable accelerometer events with this property. More...

virtual void	setAccelerometerEnabled (bool value)
virtual void	setAccelerometerInterval (double interval)
local	setAccelerometerInterval ( local interval)
virtual bool	isKeyboardEnabled () const
	whether or not it will receive keyboard or keypad events You can enable / disable accelerometer events with this property. More...

virtual void	setKeyboardEnabled (bool value)
virtual void	keyPressed (int keyCode) final
	Please use onKeyPressed instead. More...

virtual void	keyReleased (int keyCode) final
	Please use onKeyReleased instead. More...

local	keyReleased ( local keyCode)
	Please use onKeyReleased instead. More...

virtual void	onKeyPressed (EventKeyboard::KeyCode keyCode, Event *event)
var	onKeyPressed ( var keyCode, var event)
local	onKeyPressed ( local keyCode, local event)
virtual void	onKeyReleased (EventKeyboard::KeyCode keyCode, Event *event)
local	onKeyReleased ( local keyCode, local event)
virtual CC_DEPRECATED_ATTRIBUTE bool	isKeypadEnabled () const final
local	isKeypadEnabled ()
virtual CC_DEPRECATED_ATTRIBUTE void	setKeypadEnabled (bool value)
local	setKeypadEnabled ( local value)
virtual CC_DEPRECATED_ATTRIBUTE void	keyBackClicked () final
var	keyBackClicked ()
local	keyBackClicked ()
virtual CC_DEPRECATED_ATTRIBUTE void	keyMenuClicked () final
local	keyMenuClicked ()
virtual void	onEnterTransitionDidFinish () override
	Event callback that is invoked when the Node enters in the 'stage'. More...

Public Member Functions inherited from Node
virtual Camera *	getCamera ()
	Returns a camera object that lets you move the node using a gluLookAt. More...

virtual bool	isRunning () const
	Returns whether or not the node accepts event callbacks. More...

void	scheduleUpdateWithPriorityLua (int handler, int priority)
	Schedules for lua script. More...

virtual void	cleanup ()
	Stops all running actions and schedulers. More...

var	cleanup ()
	Stops all running actions and schedulers. More...

local	cleanup ()
	Stops all running actions and schedulers. More...

virtual void	draw ()
	Override this method to draw your own node. More...

local	draw ()
	Override this method to draw your own node. More...

virtual void	visit ()
	Visits this node's children and draw them recursively. More...

local	visit ()
	Visits this node's children and draw them recursively. More...

virtual Rect	getBoundingBox () const
	Returns a "local" axis aligned bounding box of the node. More...

local	getBoundingBox ()
	Returns a "local" axis aligned bounding box of the node. More...

virtual CC_DEPRECATED_ATTRIBUTE Rect	boundingBox () const
local	boundingBox ()
virtual void	setZOrder (int zOrder)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

local	setZOrder ( local zOrder)
	Sets the Z order which stands for the drawing order, and reorder this node in its parent's children array. More...

virtual void	_setZOrder (int z)
	Sets the z order which stands for the drawing order. More...

virtual int	getZOrder () const
	Gets the Z order of this node. More...

virtual void	setVertexZ (float vertexZ)
	Sets the real OpenGL Z vertex. More...

local	setVertexZ ( local vertexZ)
	Sets the real OpenGL Z vertex. More...

virtual float	getVertexZ () const
	Gets OpenGL Z vertex of this node. More...

virtual void	setScaleX (float scaleX)
	Changes the scale factor on X axis of this node. More...

var	setScaleX ( var scaleX)
	Changes the scale factor on X axis of this node. More...

local	setScaleX ( local scaleX)
	Changes the scale factor on X axis of this node. More...

virtual float	getScaleX () const
	Returns the scale factor on X axis of this node. More...

virtual void	setScaleY (float scaleY)
	Changes the scale factor on Y axis of this node. More...

var	setScaleY ( var scaleY)
	Changes the scale factor on Y axis of this node. More...

local	setScaleY ( local scaleY)
	Changes the scale factor on Y axis of this node. More...

virtual float	getScaleY () const
	Returns the scale factor on Y axis of this node. More...

virtual void	setScale (float scale)
	Changes both X and Y scale factor of the node. More...

local	setScale ( local scale)
	Changes both X and Y scale factor of the node. More...

virtual float	getScale () const
	Gets the scale factor of the node, when X and Y have the same scale factor. More...

virtual void	setPosition (const Point &position)
	Changes the position (x,y) of the node in OpenGL coordinates. More...

virtual const Point &	getPosition () const
	Gets the position (x,y) of the node in OpenGL coordinates. More...

local	getPosition ()
	Gets the position (x,y) of the node in OpenGL coordinates. More...

virtual void	setPosition (float x, float y)
	Sets position in a more efficient way. More...

virtual void	getPosition (float x, float y) const
	Gets position in a more efficient way, returns two number instead of a Point object. More...

virtual void	setPositionX (float x)
	Gets/Sets x or y coordinate individually for position. More...

virtual float	getPositionX (void) const
local	getPositionX ()
virtual void	setPositionY (float y)
local	setPositionY ( local y)
virtual float	getPositionY (void) const
local	getPositionY ()
virtual void	setSkewX (float fSkewX)
	Changes the X skew angle of the node in degrees. More...

virtual float	getSkewX () const
	Returns the X skew angle of the node in degrees. More...

virtual void	setSkewY (float fSkewY)
	Changes the Y skew angle of the node in degrees. More...

local	setSkewY ( local fSkewY)
	Changes the Y skew angle of the node in degrees. More...

virtual float	getSkewY () const
	Returns the Y skew angle of the node in degrees. More...

virtual void	setAnchorPoint (const Point &anchorPoint)
	Sets the anchor point in percent. More...

local	setAnchorPoint ( local anchorPoint)
	Sets the anchor point in percent. More...

virtual const Point &	getAnchorPoint () const
	Returns the anchor point in percent. More...

local	getAnchorPoint ()
	Returns the anchor point in percent. More...

virtual const Point &	getAnchorPointInPoints () const
	Returns the anchorPoint in absolute pixels. More...

virtual void	setContentSize (const Size &contentSize)
	Sets the untransformed size of the node. More...

local	setContentSize ( local contentSize)
	Sets the untransformed size of the node. More...

virtual const Size &	getContentSize () const
	Returns the untransformed size of the node. More...

virtual void	setVisible (bool visible)
	Sets whether the node is visible. More...

local	setVisible ( local visible)
	Sets whether the node is visible. More...

virtual bool	isVisible () const
	Determines if the node is visible. More...

var	isVisible ()
	Determines if the node is visible. More...

local	isVisible ()
	Determines if the node is visible. More...

virtual void	setRotation (float rotation)
	Sets the rotation (angle) of the node in degrees. More...

virtual float	getRotation () const
	Returns the rotation of the node in degrees. More...

virtual void	setRotationX (float rotationX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...

local	setRotationX ( local rotationX)
	Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More...

virtual float	getRotationX () const
	Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More...

virtual void	setRotationY (float rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

local	setRotationY ( local rotationY)
	Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual float	getRotationY () const
	Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More...

virtual void	setOrderOfArrival (int orderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

var	setOrderOfArrival ( var orderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

local	setOrderOfArrival ( local orderOfArrival)
	Sets the arrival order when this node has a same ZOrder with other children. More...

virtual int	getOrderOfArrival () const
	Returns the arrival order, indecates which children is added previously. More...

CC_DEPRECATED_ATTRIBUTE void	setGLServerState (int serverState)
CC_DEPRECATED_ATTRIBUTE int	getGLServerState () const
virtual void	ignoreAnchorPointForPosition (bool ignore)
	Sets whether the anchor point will be (0,0) when you position this node. More...

virtual bool	isIgnoreAnchorPointForPosition () const
	Gets whether the anchor point will be (0,0) when you position this node. More...

virtual void	addChild (Node *child)
	Adds a child to the container with z-order as 0. More...

virtual void	addChild (Node *child, int zOrder)
	Adds a child to the container with a z-order. More...

virtual void	addChild (Node *child, int zOrder, int tag)
	Adds a child to the container with z order and tag. More...

Node *	getChildByTag (int tag)
	Gets a child from the container with its tag. More...

virtual Array *	getChildren ()
	Return an array of children. More...

virtual const Array *	getChildren () const
unsigned int	getChildrenCount () const
	Get the amount of children. More...

local	getChildrenCount ()
	Get the amount of children. More...

virtual void	setParent (Node *parent)
	Sets the parent node. More...

var	setParent ( var parent)
	Sets the parent node. More...

local	setParent ( local parent)
	Sets the parent node. More...

virtual Node *	getParent ()
	Returns a pointer to the parent node. More...

var	getParent ()
	Returns a pointer to the parent node. More...

local	getParent ()
	Returns a pointer to the parent node. More...

virtual const Node *	getParent () const
local	getParent ()
virtual void	removeFromParent ()
	Removes this node itself from its parent node with a cleanup. More...

local	removeFromParent ()
	Removes this node itself from its parent node with a cleanup. More...

virtual void	removeFromParentAndCleanup (bool cleanup)
	Removes this node itself from its parent node. More...

local	removeFromParent ( local cleanup)
	Removes this node itself from its parent node. More...

virtual void	removeChild (Node *child, bool cleanup=true)
	Removes a child from the container. More...

var	removeChild ( var child, var true)
	Removes a child from the container. More...

local	removeChild ( local child, local true)
	Removes a child from the container. More...

virtual void	removeChildByTag (int tag, bool cleanup=true)
	Removes a child from the container by tag value. More...

local	removeChildByTag ( local tag, local true)
	Removes a child from the container by tag value. More...

virtual void	removeAllChildren ()
	Removes all children from the container with a cleanup. More...

virtual void	removeAllChildrenWithCleanup (bool cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

local	removeAllChildren ( local cleanup)
	Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...

virtual void	reorderChild (Node *child, int zOrder)
	Reorders a child according to a new z value. More...

var	reorderChild ( var child, var zOrder)
	Reorders a child according to a new z value. More...

local	reorderChild ( local child, local zOrder)
	Reorders a child according to a new z value. More...

virtual void	sortAllChildren ()
	Sorts the children array once before drawing, instead of every time when a child is added or reordered. More...

virtual GridBase *	getGrid ()
	Returns a grid object that is used when applying effects. More...

local	getGrid ()
	Returns a grid object that is used when applying effects. More...

virtual const GridBase *	getGrid () const
local	getGrid ()
virtual void	setGrid (GridBase *grid)
	Changes a grid object that is used when applying effects. More...

local	setGrid ( local grid)
	Changes a grid object that is used when applying effects. More...

virtual int	getTag () const
	Returns a tag that is used to identify the node easily. More...

virtual void	setTag (int tag)
	Changes the tag that is used to identify the node easily. More...

var	setTag ( var tag)
	Changes the tag that is used to identify the node easily. More...

local	setTag ( local tag)
	Changes the tag that is used to identify the node easily. More...

virtual void *	getUserData ()
	Returns a custom user data pointer. More...

virtual const void *	getUserData () const
virtual void	setUserData (void *userData)
	Sets a custom user data pointer. More...

virtual Object *	getUserObject ()
	Returns a user assigned Object. More...

virtual const Object *	getUserObject () const
virtual void	setUserObject (Object *userObject)
	Returns a user assigned Object. More...

local	setUserObject ( local userObject)
	Returns a user assigned Object. More...

virtual GLProgram *	getShaderProgram ()
	Return the shader program currently used for this node. More...

virtual const GLProgram *	getShaderProgram () const
local	getShaderProgram ()
virtual void	setShaderProgram (GLProgram *shaderProgram)
	Sets the shader program for this node. More...

var	setShaderProgram ( var shaderProgram)
	Sets the shader program for this node. More...

local	setShaderProgram ( local shaderProgram)
	Sets the shader program for this node. More...

virtual void	onExitTransitionDidStart ()
	Event callback that is called every time the Node leaves the 'stage'. More...

virtual void	setActionManager (ActionManager *actionManager)
	Sets the ActionManager object that is used by all actions. More...

virtual ActionManager *	getActionManager ()
	Gets the ActionManager object that is used by all actions. More...

local	getActionManager ()
	Gets the ActionManager object that is used by all actions. More...

virtual const ActionManager *	getActionManager () const
Action *	runAction (Action *action)
	Executes an action, and returns the action that is executed. More...

local	runAction ( local action)
	Executes an action, and returns the action that is executed. More...

void	stopAllActions ()
	Stops and removes all actions from the running action list . More...

void	stopAction (Action *action)
	Stops and removes an action from the running action list. More...

void	stopActionByTag (int tag)
	Removes an action from the running action list by its tag. More...

Action *	getActionByTag (int tag)
	Gets an action from the running action list by its tag. More...

unsigned int	getNumberOfRunningActions () const
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...

local	getNumberOfRunningActions ()
	Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More...

CC_DEPRECATED_ATTRIBUTE unsigned int	numberOfRunningActions () const
local	numberOfRunningActions ()
virtual void	setScheduler (Scheduler *scheduler)
	Sets a Scheduler object that is used to schedule all "updates" and timers. More...

virtual Scheduler *	getScheduler ()
	Gets a Sheduler object. More...

virtual const Scheduler *	getScheduler () const
local	getScheduler ()
bool	isScheduled (SEL_SCHEDULE selector)
	Checks whether a selector is scheduled. More...

void	scheduleUpdate (void)
	Schedules the "update" method. More...

void	scheduleUpdateWithPriority (int priority)
	Schedules the "update" method with a custom priority. More...

void	unscheduleUpdate (void)
void	schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay)
	Schedules a custom selector. More...

void	schedule (SEL_SCHEDULE selector, float interval)
	Schedules a custom selector with an interval time in seconds. More...

void	scheduleOnce (SEL_SCHEDULE selector, float delay)
	Schedules a selector that runs only once, with a delay of 0 or larger. More...

void	schedule (SEL_SCHEDULE selector)
	Schedules a custom selector, the scheduled selector will be ticked every frame. More...

void	unschedule (SEL_SCHEDULE selector)
	Unschedules a custom selector. More...

void	unscheduleAllSelectors (void)
	Unschedule all scheduled selectors: custom selectors, and the 'update' selector. More...

void	resumeSchedulerAndActions (void)
	Resumes all scheduled selectors and actions. More...

local	resumeSchedulerAndActions ()
	Resumes all scheduled selectors and actions. More...

void	pauseSchedulerAndActions (void)
	Pauses all scheduled selectors and actions. More...

virtual void	update (float delta)
local	update ( local delta)
void	transform ()
	Performs OpenGL view-matrix transformation based on position, scale, rotation and other attributes. More...

void	transformAncestors ()
	Performs OpenGL view-matrix transformation of it's ancestors. More...

virtual void	updateTransform ()
	Calls children's updateTransform() method recursively. More...

virtual const AffineTransform &	getNodeToParentTransform () const
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

local	getNodeToParentTransform ()
	Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More...

virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	nodeToParentTransform () const
local	nodeToParentTransform ()
virtual const AffineTransform &	getParentToNodeTransform () const
	Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More...

virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	parentToNodeTransform () const
local	parentToNodeTransform ()
virtual AffineTransform	getNodeToWorldTransform () const
	Returns the world affine transform matrix. More...

local	getNodeToWorldTransform ()
	Returns the world affine transform matrix. More...

virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	nodeToWorldTransform () const
local	nodeToWorldTransform ()
virtual AffineTransform	getWorldToNodeTransform () const
	Returns the inverse world affine transform matrix. More...

local	getWorldToNodeTransform ()
	Returns the inverse world affine transform matrix. More...

virtual CC_DEPRECATED_ATTRIBUTE AffineTransform	worldToNodeTransform () const
local	worldToNodeTransform ()
Point	convertToNodeSpace (const Point &worldPoint) const
	Converts a Point to node (local) space coordinates. More...

Point	convertToWorldSpace (const Point &nodePoint) const
	Converts a Point to world space coordinates. More...

Point	convertToNodeSpaceAR (const Point &worldPoint) const
	Converts a Point to node (local) space coordinates. More...

Point	convertToWorldSpaceAR (const Point &nodePoint) const
	Converts a local Point to world space coordinates.The result is in Points. More...

Point	convertTouchToNodeSpace (Touch *touch) const
	convenience methods which take a Touch instead of Point More...

Point	convertTouchToNodeSpaceAR (Touch *touch) const
	converts a Touch (world coordinates) into a local coordinate. More...

void	setAdditionalTransform (const AffineTransform &additionalTransform)
	Sets the additional transform. More...

Component *	getComponent (const char *pName)
	gets a component by its name More...

virtual bool	addComponent (Component *pComponent)
	adds a component More...

local	addComponent ( local pComponent)
	adds a component More...

virtual bool	removeComponent (const char *pName)
	removes a component by its name More...

virtual void	removeAllComponents ()
	removes all components More...

	Node (void)
	Default constructor. More...

virtual	~Node (void)
	Default destructor. More...

const char *	description (void) const
	Gets the description string. More...

Public Member Functions inherited from Object
	Object ()
	Constructor. More...

virtual	~Object ()
void	release ()
	Release the ownership immediately. More...

void	retain ()
	Retains the ownership. More...

Object *	autorelease ()
	Release the ownership sometime soon automatically. More...

bool	isSingleReference () const
	Returns a boolean value that indicates whether there is only one reference to the object. More...

unsigned int	retainCount () const
	Returns the object's current reference count. More...

virtual bool	isEqual (const Object *object)
	Returns a boolean value that indicates whether this object and a given object are equal. More...

virtual void	acceptVisitor (DataVisitor &visitor)

Static Public Member Functions
static ControlSlider *	create (const char bgFile, const char progressFile, const char *thumbFile)
	Creates slider with a background filename, a progress filename and a thumb image filename. More...

local	create ( local bgFile, local progressFile, local thumbFile)
	Creates slider with a background filename, a progress filename and a thumb image filename. More...

static ControlSlider *	create (Sprite backgroundSprite, Sprite pogressSprite, Sprite *thumbSprite)
	Creates a slider with a given background sprite and a progress bar and a thumb item. More...

local	create ( local backgroundSprite, local pogressSprite, local thumbSprite)
	Creates a slider with a given background sprite and a progress bar and a thumb item. More...

Static Public Member Functions inherited from Control
static Control *	create ()

Public Attributes
virtual float	getMinimumAllowedValue (void)\n\n public
	getMinimumAllowedValue More...

virtual float	getMaximumAllowedValue (void)\n\n public
	getMaximumAllowedValue More...

Protected Member Functions
void	sliderBegan (Point location)
var	sliderBegan ( var location)
local	sliderBegan ( local location)
void	sliderMoved (Point location)
var	sliderMoved ( var location)
local	sliderMoved ( local location)
void	sliderEnded (Point location)
var	sliderEnded ( var location)
local	sliderEnded ( local location)
virtual bool	onTouchBegan (Touch touch, Event pEvent)
var	onTouchBegan ( var touch, var pEvent)
local	onTouchBegan ( local touch, local pEvent)
virtual void	onTouchMoved (Touch pTouch, Event pEvent)
var	onTouchMoved ( var pTouch, var pEvent)
local	onTouchMoved ( local pTouch, local pEvent)
virtual void	onTouchEnded (Touch pTouch, Event pEvent)
var	onTouchEnded ( var pTouch, var pEvent)
local	onTouchEnded ( local pTouch, local pEvent)
float	valueForLocation (Point location)
	Returns the value for the given location. More...

var	valueForLocation ( var location)
	Returns the value for the given location. More...

local	valueForLocation ( local location)
	Returns the value for the given location. More...

Protected Member Functions inherited from Control
Invocation *	invocationWithTargetAndActionForControlEvent (Object *target, Handler action, EventType controlEvent)
	Returns an Invocation object able to construct messages using a given target-action pair. More...

Array *	dispatchListforControlEvent (EventType controlEvent)
	Returns the Invocation list for the given control event. More...

void	addTargetWithActionForControlEvent (Object *target, Handler action, EventType controlEvent)
	Adds a target and action for a particular event to an internal dispatch table. More...

void	removeTargetWithActionForControlEvent (Object *target, Handler action, EventType controlEvent)
	Removes a target and action for a particular event from an internal dispatch table. More...

Protected Attributes
float	_value
	Contains the receiver's current value. More...

float	_minimumValue
	Contains the minimum value of the receiver. More...

var	_minimumValue
	Contains the minimum value of the receiver. More...

local	_minimumValue
	Contains the minimum value of the receiver. More...

float	_maximumValue
	Contains the maximum value of the receiver. More...

var	_maximumValue
	Contains the maximum value of the receiver. More...

local	_maximumValue
	Contains the maximum value of the receiver. More...

float	_minimumAllowedValue
float	_maximumAllowedValue
Sprite *	_thumbSprite
Sprite *	_progressSprite
Sprite *	_backgroundSprite
local	_backgroundSprite
Protected Attributes inherited from Control
bool	_enabled
bool	_selected
var	_selected
local	_selected
bool	_highlighted
var	_highlighted
local	_highlighted
bool	_hasVisibleParents
	True if all of the controls parents are visible. More...

var	_hasVisibleParents
	True if all of the controls parents are visible. More...

local	_hasVisibleParents
	True if all of the controls parents are visible. More...

Dictionary *	_dispatchTable
	Table of connection between the ControlEvents and their associated target-actions pairs. More...

bool	_isOpacityModifyRGB
State	_state
	The current control state constant. More...

var	_state
	The current control state constant. More...

local	_state
	The current control state constant. More...

Protected Attributes inherited from LayerRGBA
GLubyte	_displayedOpacity
GLubyte	_realOpacity
Color3B	_displayedColor
Color3B	_realColor
bool	_cascadeOpacityEnabled
bool	_cascadeColorEnabled
Protected Attributes inherited from Layer
bool	_touchEnabled
var	_touchEnabled
local	_touchEnabled
bool	_accelerometerEnabled
var	_accelerometerEnabled
local	_accelerometerEnabled
bool	_keyboardEnabled
var	_keyboardEnabled
local	_keyboardEnabled
EventListenerTouch *	_touchListener
var	_touchListener
local	_touchListener
EventListenerKeyboard *	_keyboardListener
EventListenerAcceleration *	_accelerationListener
var	_accelerationListener
local	_accelerationListener
Protected Attributes inherited from Node
float	_rotationX
	rotation angle on x-axis More...

float	_rotationY
	rotation angle on y-axis More...

var	_rotationY
	rotation angle on y-axis More...

local	_rotationY
	rotation angle on y-axis More...

float	_scaleX
	scaling factor on x-axis More...

var	_scaleX
	scaling factor on x-axis More...

local	_scaleX
	scaling factor on x-axis More...

float	_scaleY
	scaling factor on y-axis More...

var	_scaleY
	scaling factor on y-axis More...

local	_scaleY
	scaling factor on y-axis More...

float	_vertexZ
	OpenGL real Z vertex. More...

Point	_position
	position of the node More...

float	_skewX
	skew angle on x-axis More...

var	_skewX
	skew angle on x-axis More...

local	_skewX
	skew angle on x-axis More...

float	_skewY
	skew angle on y-axis More...

var	_skewY
	skew angle on y-axis More...

local	_skewY
	skew angle on y-axis More...

Point	_anchorPointInPoints
	anchor point in points More...

var	_anchorPointInPoints
	anchor point in points More...

local	_anchorPointInPoints
	anchor point in points More...

Point	_anchorPoint
	anchor point normalized (NOT in points) More...

Size	_contentSize
	untransformed size of the node More...

local	_contentSize
	untransformed size of the node More...

AffineTransform	_additionalTransform
	transform More...

AffineTransform	_transform
	transform More...

var	_transform
	transform More...

local	_transform
	transform More...

AffineTransform	_inverse
	inverse transform More...

var	_inverse
	inverse transform More...

local	_inverse
	inverse transform More...

bool	_additionalTransformDirty
	The flag to check whether the additional transform is dirty. More...

bool	_transformDirty
	transform dirty flag More...

var	_transformDirty
	transform dirty flag More...

local	_transformDirty
	transform dirty flag More...

bool	_inverseDirty
	inverse transform dirty flag More...

var	_inverseDirty
	inverse transform dirty flag More...

local	_inverseDirty
	inverse transform dirty flag More...

Camera *	_camera
	a camera More...

GridBase *	_grid
	a grid More...

int	_ZOrder
	z-order value that affects the draw order More...

Array *	_children
	array of children nodes More...

var	_children
	array of children nodes More...

local	_children
	array of children nodes More...

Node *	_parent
	weak reference to parent node More...

int	_tag
	a tag. Can be any number you assigned just to identify this node More...

var	_tag
	a tag. Can be any number you assigned just to identify this node More...

local	_tag
	a tag. Can be any number you assigned just to identify this node More...

void *	_userData
	A user assingned void pointer, Can be point to any cpp object. More...

Object *	_userObject
	A user assigned Object. More...

local	_userObject
	A user assigned Object. More...

GLProgram *	_shaderProgram
	OpenGL shader. More...

int	_orderOfArrival
	used to preserve sequence while sorting children with the same zOrder More...

Scheduler *	_scheduler
	scheduler used to schedule timers and updates More...

ActionManager *	_actionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...

var	_actionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...

local	_actionManager
	a pointer to ActionManager singleton, which is used to handle all the actions More...

bool	_running
	is running More...

bool	_visible
	is this node visible More...

bool	_ignoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...

var	_ignoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...

local	_ignoreAnchorPointForPosition
	true if the Anchor Point will be (0,0) when you position the Node, false otherwise. More...

bool	_reorderChildDirty
	children order dirty flag More...

local	_reorderChildDirty
	children order dirty flag More...

bool	_isTransitionFinished
	flag to indicate whether the transition was finished More...

var	_isTransitionFinished
	flag to indicate whether the transition was finished More...

local	_isTransitionFinished
	flag to indicate whether the transition was finished More...

int	_scriptHandler
	script handler for onEnter() & onExit(), used in Javascript binding and Lua binding. More...

int	_updateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...

var	_updateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...

local	_updateScriptHandler
	script handler for update() callback per frame, which is invoked from lua & javascript. More...

ccScriptType	_scriptType
	type of script binding, lua or javascript More...

ComponentContainer *	_componentContainer
	Dictionary of components. More...

var	_componentContainer
	Dictionary of components. More...

local	_componentContainer
	Dictionary of components. More...

int	_eventPriority
	The scene graph based priority of event listener. More...

int	_oldEventPriority
	The old scene graph based priority of event listener. More...

var	_oldEventPriority
	The old scene graph based priority of event listener. More...

local	_oldEventPriority
	The old scene graph based priority of event listener. More...

Protected Attributes inherited from Object
unsigned int	_reference
	count of references More...

var	_reference
	count of references More...

local	_reference
	count of references More...

unsigned int	_autoReleaseCount
	count of autorelease More...

var	_autoReleaseCount
	count of autorelease More...

local	_autoReleaseCount
	count of autorelease More...

Additional Inherited Members
Public Types inherited from Control
enum	EventType { TOUCH_DOWN = 1 << 0, DRAG_INSIDE = 1 << 1, DRAG_OUTSIDE = 1 << 2, DRAG_ENTER = 1 << 3, DRAG_EXIT = 1 << 4, TOUCH_UP_INSIDE = 1 << 5, TOUCH_UP_OUTSIDE = 1 << 6, TOUCH_CANCEL = 1 << 7, VALUE_CHANGED = 1 << 8 }
	Kinds of possible events for the control objects. More...

enum	State { NORMAL = 1 << 0, HIGH_LIGHTED = 1 << 1, DISABLED = 1 << 2, SELECTED = 1 << 3 }
	The possible state for a control. More...

typedef void(Object::*	Handler )(Object *, EventType)
Static Public Attributes inherited from Node
static const int	INVALID_TAG = -1
	Default tag used for all the nodes. More...

var	INVALID_TAG = -1
	Default tag used for all the nodes. More...

local	INVALID_TAG = -1
	Default tag used for all the nodes. More...

Static Protected Attributes inherited from Node
static int	_globalEventPriorityIndex
	The index of global event priority. More...

Constructor & Destructor Documentation

ControlSlider ( )

var ctor ( )

local ControlSlider ( )

virtual ~ControlSlider ( )

virtual

Member Function Documentation

static ControlSlider* create	(	const char *	bgFile,
		const char *	progressFile,
		const char *	thumbFile
	)

static

Creates slider with a background filename, a progress filename and a thumb image filename.

var create	(	var	bgFile,
		var	progressFile,
		var	thumbFile
	)

static

Creates slider with a background filename, a progress filename and a thumb image filename.

local create	(	local	bgFile,
		local	progressFile,
		local	thumbFile
	)

static

Creates slider with a background filename, a progress filename and a thumb image filename.

static ControlSlider* create	(	Sprite *	backgroundSprite,
		Sprite *	pogressSprite,
		Sprite *	thumbSprite
	)

static

Creates a slider with a given background sprite and a progress bar and a thumb item.

See Also: initWithSprites

var create	(	var	backgroundSprite,
		var	pogressSprite,
		var	thumbSprite
	)

static

Creates a slider with a given background sprite and a progress bar and a thumb item.

See Also: initWithSprites

local create	(	local	backgroundSprite,
		local	pogressSprite,
		local	thumbSprite
	)

static

Creates a slider with a given background sprite and a progress bar and a thumb item.

See Also: initWithSprites

virtual Sprite* getBackgroundSprite ( void )

virtual

getBackgroundSprite

var getBackgroundSprite ( )

virtual

getBackgroundSprite

local getBackgroundSprite ( )

virtual

getBackgroundSprite

virtual float getMaximumValue ( void )

virtual

getMaximumValue

var getMaximumValue ( )

virtual

getMaximumValue

local getMaximumValue ( )

virtual

getMaximumValue

virtual float getMinimumValue ( void )

virtual

getMinimumValue

var getMinimumValue ( )

virtual

getMinimumValue

local getMinimumValue ( )

virtual

getMinimumValue

virtual Sprite* getProgressSprite ( void )

virtual

getProgressSprite

var getProgressSprite ( )

virtual

getProgressSprite

local getProgressSprite ( )

virtual

getProgressSprite

virtual Sprite* getThumbSprite ( void )

virtual

getThumbSprite

var getThumbSprite ( )

virtual

getThumbSprite

local getThumbSprite ( )

virtual

getThumbSprite

virtual float getValue ( void )

virtual

getValue

var getValue ( )

virtual

getValue

local getValue ( )

virtual

getValue

virtual bool initWithSprites	(	Sprite *	backgroundSprite,
		Sprite *	progressSprite,
		Sprite *	thumbSprite
	)

virtual

Initializes a slider with a background sprite, a progress bar and a thumb item.

Parameters

backgroundSprite	Sprite, that is used as a background.
progressSprite	Sprite, that is used as a progress bar.
thumbSprite	Sprite, that is used as a thumb.

var initWithSprites	(	var	backgroundSprite,
		var	progressSprite,
		var	thumbSprite
	)

virtual

Initializes a slider with a background sprite, a progress bar and a thumb item.

Parameters

backgroundSprite	Sprite, that is used as a background.
progressSprite	Sprite, that is used as a progress bar.
thumbSprite	Sprite, that is used as a thumb.

local initWithSprites	(	local	backgroundSprite,
		local	progressSprite,
		local	thumbSprite
	)

virtual

Initializes a slider with a background sprite, a progress bar and a thumb item.

Parameters

backgroundSprite	Sprite, that is used as a background.
progressSprite	Sprite, that is used as a progress bar.
thumbSprite	Sprite, that is used as a thumb.

virtual bool isTouchInside ( Touch * touch)

virtual

Returns a boolean value that indicates whether a touch is inside the bounds of the receiver.

The given touch must be relative to the world.

Parameters

touch A Touch object that represents a touch.

Returns: Whether a touch is inside the receiver's rect.

Reimplemented from Control.

var isTouchInside ( var touch)

virtual

Returns a boolean value that indicates whether a touch is inside the bounds of the receiver.

The given touch must be relative to the world.

Parameters

touch A Touch object that represents a touch.

Returns: Whether a touch is inside the receiver's rect.

Reimplemented from Control.

local isTouchInside ( local touch)

virtual

Returns a boolean value that indicates whether a touch is inside the bounds of the receiver.

The given touch must be relative to the world.

Parameters

touch A Touch object that represents a touch.

Returns: Whether a touch is inside the receiver's rect.

Reimplemented from Control.

Point locationFromTouch ( Touch * touch)

var locationFromTouch ( var touch)

local locationFromTouch ( local touch)

virtual void needsLayout ( )

virtual

Updates the control layout using its current internal state.

Reimplemented from Control.

var needsLayout ( )

virtual

Updates the control layout using its current internal state.

Reimplemented from Control.

local needsLayout ( )

virtual

Updates the control layout using its current internal state.

Reimplemented from Control.

virtual bool onTouchBegan	(	Touch *	touch,
		Event *	pEvent
	)

protectedvirtual

Reimplemented from Control.

var onTouchBegan	(	var	touch,
		var	pEvent
	)

protectedvirtual

Reimplemented from Control.

local onTouchBegan	(	local	touch,
		local	pEvent
	)

protectedvirtual

Reimplemented from Control.

virtual void onTouchEnded	(	Touch *	pTouch,
		Event *	pEvent
	)

protectedvirtual

Reimplemented from Control.

var onTouchEnded	(	var	pTouch,
		var	pEvent
	)

protectedvirtual

Reimplemented from Control.

local onTouchEnded	(	local	pTouch,
		local	pEvent
	)

protectedvirtual

Reimplemented from Control.

virtual void onTouchMoved	(	Touch *	pTouch,
		Event *	pEvent
	)

protectedvirtual

Reimplemented from Control.

var onTouchMoved	(	var	pTouch,
		var	pEvent
	)

protectedvirtual

Reimplemented from Control.

local onTouchMoved	(	local	pTouch,
		local	pEvent
	)

protectedvirtual

Reimplemented from Control.

virtual void setBackgroundSprite ( Sprite * var)

virtual

setBackgroundSprite

var setBackgroundSprite ( var var)

virtual

setBackgroundSprite

local setBackgroundSprite ( local var)

virtual

setBackgroundSprite

virtual void setEnabled ( bool bEnabled)

virtual

Tells whether the control is enabled.

Reimplemented from Control.

var setEnabled ( var bEnabled)

virtual

Tells whether the control is enabled.

Reimplemented from Control.

local setEnabled ( local bEnabled)

virtual

Tells whether the control is enabled.

Reimplemented from Control.

virtual void setMaximumValue ( float val)

virtual

var setMaximumValue ( var val)

virtual

local setMaximumValue ( local val)

virtual

virtual void setMinimumValue ( float val)

virtual

var setMinimumValue ( var val)

virtual

local setMinimumValue ( local val)

virtual

virtual void setProgressSprite ( Sprite * var)

virtual

setProgressSprite

var setProgressSprite ( var var)

virtual

setProgressSprite

local setProgressSprite ( local var)

virtual

setProgressSprite

virtual void setThumbSprite ( Sprite * var)

virtual

setThumbSprite

var setThumbSprite ( var var)

virtual

setThumbSprite

local setThumbSprite ( local var)

virtual

setThumbSprite

virtual void setValue ( float val)

virtual

var setValue ( var val)

virtual

local setValue ( local val)

virtual

void sliderBegan ( Point location)

protected

var sliderBegan ( var location)

protected

local sliderBegan ( local location)

protected

void sliderEnded ( Point location)

protected

var sliderEnded ( var location)

protected

local sliderEnded ( local location)

protected

void sliderMoved ( Point location)

protected

var sliderMoved ( var location)

protected

local sliderMoved ( local location)

protected

float valueForLocation ( Point location)

protected

Returns the value for the given location.

var valueForLocation ( var location)

protected

Returns the value for the given location.

local valueForLocation ( local location)

protected

Returns the value for the given location.

Member Data Documentation

Sprite* _backgroundSprite

protected

var _backgroundSprite

protected

local _backgroundSprite

protected

float _maximumAllowedValue

protected

var _maximumAllowedValue

protected

local _maximumAllowedValue

protected

float _maximumValue

protected

Contains the maximum value of the receiver.

The default value of this property is 1.0.

var _maximumValue

protected

Contains the maximum value of the receiver.

The default value of this property is 1.0.

local _maximumValue

protected

Contains the maximum value of the receiver.

The default value of this property is 1.0.

float _minimumAllowedValue

protected

var _minimumAllowedValue

protected

local _minimumAllowedValue

protected

float _minimumValue

protected

Contains the minimum value of the receiver.

The default value of this property is 0.0.

var _minimumValue

protected

Contains the minimum value of the receiver.

The default value of this property is 0.0.

local _minimumValue

protected

Contains the minimum value of the receiver.

The default value of this property is 0.0.

Sprite* _progressSprite

protected

var _progressSprite

protected

local _progressSprite

protected

Sprite* _thumbSprite

protected

var _thumbSprite

protected

local _thumbSprite

protected

float _value

protected

Contains the receiver's current value.

var _value

protected

Contains the receiver's current value.

local _value

protected

Contains the receiver's current value.

virtual float
getMaximumAllowedValue(void)\n\n
public

getMaximumAllowedValue

setMaximumAllowedValue

var public

getMaximumAllowedValue

setMaximumAllowedValue

local public

getMaximumAllowedValue

setMaximumAllowedValue

virtual float
getMinimumAllowedValue(void)\n\n
public

getMinimumAllowedValue

setMinimumAllowedValue

var public

getMinimumAllowedValue

setMinimumAllowedValue

local public

getMinimumAllowedValue

setMinimumAllowedValue

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

/Users/cocos2d/MyWork/cocos2d-x-develop/extensions/GUI/CCControlExtension/CCControlSlider.h

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation