cocos2d-x  2.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
UIScrollView Class Reference

#include <UIScrollView.h>

Inheritance diagram for UIScrollView:
Layout UIScrollInterface UIWidget CCObject CCCopying

Public Member Functions

 UIScrollView ()
 Default constructor. More...
 
virtual ~UIScrollView ()
 Default destructor. More...
 
local ~UIScrollView ()
 Default destructor. More...
 
void setDirection (SCROLLVIEW_DIR dir)
 Changes scroll direction of scrollview. More...
 
var setDirection ( var dir)
 Changes scroll direction of scrollview. More...
 
local setDirection ( local dir)
 Changes scroll direction of scrollview. More...
 
SCROLLVIEW_DIR getDirection ()
 Gets scroll direction of scrollview. More...
 
LayoutgetInnerContainer ()
 Gets inner container of scrollview. More...
 
var getInnerContainer ()
 Gets inner container of scrollview. More...
 
local getInnerContainer ()
 Gets inner container of scrollview. More...
 
void scrollToBottom ()
 Scroll inner container to bottom boundary of scrollview. More...
 
void scrollToTop ()
 Scroll inner container to top boundary of scrollview. More...
 
var scrollToTop ()
 Scroll inner container to top boundary of scrollview. More...
 
local scrollToTop ()
 Scroll inner container to top boundary of scrollview. More...
 
void setInnerContainerSize (const CCSize &size)
 Changes inner container size of scrollview. More...
 
var setInnerContainerSize ( var size)
 Changes inner container size of scrollview. More...
 
local setInnerContainerSize ( local size)
 Changes inner container size of scrollview. More...
 
const CCSizegetInnerContainerSize () const
 Gets inner container size of scrollview. More...
 
var getInnerContainerSize ()
 Gets inner container size of scrollview. More...
 
local getInnerContainerSize ()
 Gets inner container size of scrollview. More...
 
void addEventListener (CCObject *target, SEL_ScrollViewEvent selector)
 Add call back function called scrollview event triggered. More...
 
void addScrollToTopEvent (CCObject *target, SEL_ScrollToTopEvent selector)
 Add call back function called when scrollview scrolled to top. More...
 
var addScrollToTopEvent ( var target, var selector)
 Add call back function called when scrollview scrolled to top. More...
 
local addScrollToTopEvent ( local target, local selector)
 Add call back function called when scrollview scrolled to top. More...
 
void addScrollToBottomEvent (CCObject *target, SEL_ScrollToBottomEvent selector)
 Add call back function called when scrollview scrolled to bottom. More...
 
void addScrollToLeftEvent (CCObject *target, SEL_ScrollToLeftEvent selector)
 Add call back function called when scrollview scrolled to left. More...
 
var addScrollToLeftEvent ( var target, var selector)
 Add call back function called when scrollview scrolled to left. More...
 
local addScrollToLeftEvent ( local target, local selector)
 Add call back function called when scrollview scrolled to left. More...
 
void addScrollToRightEvent (CCObject *target, SEL_ScrollToRightEvent selector)
 Add call back function called when scrollview scrolled to right. More...
 
var addScrollToRightEvent ( var target, var selector)
 Add call back function called when scrollview scrolled to right. More...
 
local addScrollToRightEvent ( local target, local selector)
 Add call back function called when scrollview scrolled to right. More...
 
virtual bool addChild (UIWidget *widget)
 Adds a child to the container. More...
 
virtual void removeAllChildren ()
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual bool removeChild (UIWidget *child)
 Removes a child from the container with a cleanup. More...
 
var removeChild ( var child)
 Removes a child from the container with a cleanup. More...
 
local removeChild ( local child)
 Removes a child from the container with a cleanup. More...
 
virtual CCArraygetChildren ()
 Return an array of children. More...
 
virtual bool onTouchBegan (const CCPoint &touchPoint)
 A call back function called when widget is selected, and on touch began. More...
 
var onTouchBegan ( var touchPoint)
 A call back function called when widget is selected, and on touch began. More...
 
local onTouchBegan ( local touchPoint)
 A call back function called when widget is selected, and on touch began. More...
 
virtual void onTouchMoved (const CCPoint &touchPoint)
 A call back function called when widget is selected, and on touch moved. More...
 
local onTouchMoved ( local touchPoint)
 A call back function called when widget is selected, and on touch moved. More...
 
virtual void onTouchEnded (const CCPoint &touchPoint)
 A call back function called when widget is selected, and on touch ended. More...
 
var onTouchEnded ( var touchPoint)
 A call back function called when widget is selected, and on touch ended. More...
 
local onTouchEnded ( local touchPoint)
 A call back function called when widget is selected, and on touch ended. More...
 
virtual void onTouchCancelled (const CCPoint &touchPoint)
 A call back function called when widget is selected, and on touch canceled. More...
 
virtual void onTouchLongClicked (const CCPoint &touchPoint)
 A call back function called when widget is selected, and on touch long clicked. More...
 
virtual void update (float dt)
var update ( var dt)
local update ( local dt)
virtual void setLayoutType (LayoutType type)
 Sets LayoutType. More...
 
var setLayoutType ( var type)
 Sets LayoutType. More...
 
local setLayoutType ( local type)
 Sets LayoutType. More...
 
virtual LayoutType getLayoutType () const
 Gets LayoutType. More...
 
local getLayoutType ()
 Gets LayoutType. More...
 
virtual void doLayout ()
virtual const char * getDescription () const
 Returns the "class name" of widget. More...
 
var getDescription ()
 Returns the "class name" of widget. More...
 
local getDescription ()
 Returns the "class name" of widget. More...
 
- Public Member Functions inherited from Layout
 Layout ()
virtual ~Layout ()
 Default destructor. More...
 
virtual bool hitTest (const CCPoint &pt)
 Checks a point if is in widget's space. More...
 
void setBackGroundImage (const char *fileName, TextureResType texType=UI_TEX_TYPE_LOCAL)
 Sets a background image for layout. More...
 
void setBackGroundImageCapInsets (const CCRect &capInsets)
 Sets a background image capinsets for layout, if the background image is a scale9 render. More...
 
void setBackGroundColorType (LayoutBackGroundColorType type)
 Sets Color Type for layout. More...
 
void setBackGroundImageScale9Enabled (bool enabled)
 Sets background iamge use scale9 renderer. More...
 
void setBackGroundColor (const ccColor3B &color)
 Sets background color for layout, if color type is LAYOUT_COLOR_SOLID. More...
 
void setBackGroundColor (const ccColor3B &startColor, const ccColor3B &endColor)
 Sets background color for layout, if color type is LAYOUT_COLOR_GRADIENT. More...
 
void setBackGroundColorOpacity (int opacity)
 Sets background opacity layout. More...
 
void setBackGroundColorVector (const CCPoint &vector)
 Sets background color vector for layout, if color type is LAYOUT_COLOR_GRADIENT. More...
 
virtual void setColor (const ccColor3B &color)
 Sets color to widget. More...
 
virtual void setOpacity (int opacity)
 Sets opacity to widget. More...
 
void removeBackGroundImage ()
 Remove the background image of layout. More...
 
const CCSizegetBackGroundImageTextureSize () const
 Gets background image texture size. More...
 
virtual bool isClippingEnabled ()
 Gets if layout is clipping enabled. More...
 
virtual const CCSizegetContentSize () const
 Gets the content size of widget. More...
 
void setBackGroundImageScale9Enable (bool is)
 These methods will be removed. More...
 
- Public Member Functions inherited from UIWidget
 UIWidget (void)
virtual ~UIWidget ()
 Default destructor. More...
 
virtual void setEnabled (bool enabled)
 Sets whether the widget is enabled. More...
 
bool isEnabled () const
 Determines if the widget is enabled. More...
 
void setVisible (bool visible)
 Sets whether the widget is visible. More...
 
bool isVisible () const
 Determines if the widget is visible. More...
 
void setBright (bool bright)
 Sets whether the widget is bright. More...
 
bool isBright () const
 Determines if the widget is bright. More...
 
virtual void setTouchEnabled (bool enabled)
 Sets whether the widget is touch enabled. More...
 
void setBrightStyle (BrightStyle style)
 To set the bright style of widget. More...
 
bool isTouchEnabled () const
 Determines if the widget is touch enabled. More...
 
bool isFocused () const
 Determines if the widget is on focused. More...
 
void setFocused (bool fucosed)
 Sets whether the widget is on focused. More...
 
void setZOrder (int z)
 Sets the Z order which stands for the drawing order, and reorder this widget in its parent's children array. More...
 
int getZOrder ()
 Gets the Z order of this widget. More...
 
float getLeftInParent ()
 Gets the left boundary position of this widget. More...
 
float getBottomInParent ()
 Gets the bottom boundary position of this widget. More...
 
float getRightInParent ()
 Gets the right boundary position of this widget. More...
 
float getTopInParent ()
 Gets the top boundary position of this widget. More...
 
virtual void removeFromParent ()
 Removes this widget itself from its parent widget. More...
 
void disableUpdate ()
 Unschedules the "update" method. More...
 
virtual void reorderChild (UIWidget *child)
 Reorders a child according to a new z value. More...
 
UIWidgetgetChildByName (const char *name)
 Gets a child from the container with its name. More...
 
UIWidgetgetChildByTag (int tag)
 Gets a child from the container with its tag. More...
 
CCNodegetRenderer ()
 Gets the renderer of widget. More...
 
void addRenderer (CCNode *renderer, int zOrder)
 Add a CCNode for rendering. More...
 
void removeRenderer (CCNode *renderer, bool cleanup)
 Remove a CCNode from widget. More...
 
void setParent (UIWidget *parent)
 Sets the parent widget. More...
 
UIWidgetgetParent ()
 Returns a pointer to the parent widget. More...
 
void addTouchEventListener (CCObject *target, SEL_TouchEvent selector)
 Sets the touch event target/selector of the menu item. More...
 
void setPosition (const CCPoint &pos)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionPercent (const CCPoint &percent)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
const CCPointgetPosition ()
 Gets the position (x,y) of the widget in OpenGL coordinates. More...
 
const CCPointgetPositionPercent ()
 Gets the percent (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionType (PositionType type)
 Changes the position type of the widget. More...
 
PositionType getPositionType () const
 Gets the position type of the widget. More...
 
virtual void setAnchorPoint (const CCPoint &pt)
 Sets the anchor point in percent. More...
 
const CCPointgetAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual void setScale (float fScale)
 Changes both X and Y scale factor of the widget. More...
 
float getScale ()
 Gets the scale factor of the widget, when X and Y have the same scale factor. More...
 
virtual void setScaleX (float fScaleX)
 Changes the scale factor on X axis of this widget. More...
 
float getScaleX ()
 Returns the scale factor on X axis of this widget. More...
 
virtual void setScaleY (float fScaleY)
 Changes the scale factor on Y axis of this widget. More...
 
float getScaleY ()
 Returns the scale factor on Y axis of this widget. More...
 
void setRotation (float rotation)
 Sets the rotation (angle) of the widget in degrees. More...
 
float getRotation ()
 Returns the rotation of the widget in degrees. More...
 
void setRotationX (float rotationX)
 Sets the X rotation (angle) of the widget in degrees which performs a horizontal rotational skew. More...
 
float getRotationX ()
 Gets the X rotation (angle) of the widget in degrees which performs a horizontal rotation skew. More...
 
void setRotationY (float rotationY)
 Sets the Y rotation (angle) of the widget in degrees which performs a vertical rotational skew. More...
 
float getRotationY ()
 Gets the Y rotation (angle) of the widget in degrees which performs a vertical rotational skew. More...
 
virtual void setFlipX (bool flipX)
 Sets whether the widget should be flipped horizontally or not. More...
 
virtual bool isFlipX ()
 Returns the flag which indicates whether the widget is flipped horizontally or not. More...
 
virtual void setFlipY (bool flipY)
 Sets whether the widget should be flipped vertically or not. More...
 
virtual bool isFlipY ()
 Return the flag which indicates whether the widget is flipped vertically or not. More...
 
virtual const ccColor3BgetColor ()
 Gets color of widget. More...
 
virtual int getOpacity ()
 Gets opacity of widget. More...
 
virtual bool isCascadeOpacityEnabled ()
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual bool isCascadeColorEnabled ()
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
void setBlendFunc (ccBlendFunc blendFunc)
virtual void setActionManager (CCActionManager *actionManager)
virtual CCActionManagergetActionManager ()
CCActionrunAction (CCAction *action)
void stopAllActions (void)
void stopAction (CCAction *action)
void stopActionByTag (int tag)
CCActiongetActionByTag (int tag)
void didNotSelectSelf ()
 A call back function when widget lost of focus. More...
 
bool clippingParentAreaContainPoint (const CCPoint &pt)
const CCPointgetTouchStartPos ()
const CCPointgetTouchMovePos ()
const CCPointgetTouchEndPos ()
void setTag (int tag)
 Changes the tag that is used to identify the widget easily. More...
 
int getTag () const
 Returns a tag that is used to identify the widget easily. More...
 
void setName (const char *name)
 Changes the name that is used to identify the widget easily. More...
 
const char * getName () const
 Returns a name that is used to identify the widget easily. More...
 
WidgetType getWidgetType () const
 Returns a type that is widget's type. More...
 
virtual void setSize (const CCSize &size)
 Changes the size that is widget's size. More...
 
virtual void setSizePercent (const CCPoint &percent)
 Changes the percent that is widget's percent size. More...
 
void setSizeType (SizeType type)
 Changes the size type of widget. More...
 
SizeType getSizeType () const
 Gets the size type of widget. More...
 
const CCSizegetSize () const
 Returns size of widget. More...
 
const CCPointgetSizePercent () const
 Returns size percent of widget. More...
 
void setLayoutParameter (LayoutParameter *parameter)
 Sets a LayoutParameter to widget. More...
 
LayoutParametergetLayoutParameter ()
 Gets LayoutParameter of widget. More...
 
virtual void ignoreContentAdaptWithSize (bool ignore)
 Ignore the widget size. More...
 
bool isIgnoreContentAdaptWithSize () const
 Gets the widget if is ignore it's size. More...
 
CCPoint getWorldPosition ()
 Gets world position of widget. More...
 
CCPoint convertToWorldSpace (const CCPoint &pt)
 Converts a Point to world space coordinates. More...
 
virtual CCNodegetVirtualRenderer ()
 Gets the Virtual Renderer of widget. More...
 
void setUpdateEnabled (bool enable)
 Schedules the "update" method. More...
 
bool isUpdateEnabled ()
 is the "update" method scheduled. More...
 
virtual void onEnter ()
virtual void onExit ()
void setTouchEnable (bool enabled, bool containChildren=false)
 These methods will be removed. More...
 
void disable (bool containChildren=false)
void active (bool containChildren=false)
bool isActive ()
void setBright (bool bright, bool containChild)
CCRect getRect ()
CCNodegetValidNode ()
void setWidgetZOrder (int z)
int getWidgetZOrder ()
float getRelativeLeftPos ()
float getRelativeBottomPos ()
float getRelativeRightPos ()
float getRelativeTopPos ()
CCNodegetContainerNode ()
void setWidgetParent (UIWidget *parent)
UIWidgetgetWidgetParent ()
void setWidgetTag (int tag)
int getWidgetTag ()
void addCCNode (CCNode *node)
void removeCCNode (bool cleanup)
void addPushDownEvent (CCObject *target, SEL_PushEvent selector)
void addMoveEvent (CCObject *target, SEL_MoveEvent selector)
void addReleaseEvent (CCObject *target, SEL_ReleaseEvent selector)
void addCancelEvent (CCObject *target, SEL_CancelEvent selector)
bool removeChild (UIWidget *child, bool cleanup)
void removeFromParentAndCleanup (bool cleanup)
void removeAllChildrenAndCleanUp (bool cleanup)
void setActionTag (int tag)
int getActionTag ()
- Public Member Functions inherited from CCObject
 CCObject (void)
virtual ~CCObject (void)
void release (void)
void retain (void)
CCObjectautorelease (void)
CCObjectcopy (void)
bool isSingleReference (void) const
unsigned int retainCount (void) const
virtual bool isEqual (const CCObject *pObject)
virtual void acceptVisitor (CCDataVisitor &visitor)
- Public Member Functions inherited from CCCopying
virtual CCObjectcopyWithZone (CCZone *pZone)

Static Public Member Functions

static UIScrollViewcreate ()
 Allocates and initializes. More...
 
local create ()
 Allocates and initializes. More...
 
- Static Public Member Functions inherited from Layout
static Layoutcreate ()
 Allocates and initializes a layout. More...
 
- Static Public Member Functions inherited from UIWidget
static UIWidgetcreate ()
 Allocates and initializes a widget. More...
 

Protected Member Functions

virtual bool init ()
local init ()
virtual void initRenderer ()
var initRenderer ()
local initRenderer ()
void moveChildren (float offset)
void autoScrollChildren (float dt)
var autoScrollChildren ( var dt)
local autoScrollChildren ( local dt)
void startAutoScrollChildren (float v)
var startAutoScrollChildren ( var v)
local startAutoScrollChildren ( local v)
void stopAutoScrollChildren ()
float getCurAutoScrollDistance (float time)
var getCurAutoScrollDistance ( var time)
local getCurAutoScrollDistance ( local time)
virtual bool scrollChildren (float touchOffset)
var scrollChildren ( var touchOffset)
local scrollChildren ( local touchOffset)
void startRecordSlidAction ()
var startRecordSlidAction ()
local startRecordSlidAction ()
virtual void endRecordSlidAction ()
var endRecordSlidAction ()
local endRecordSlidAction ()
virtual void handlePressLogic (const CCPoint &touchPoint)
var handlePressLogic ( var touchPoint)
local handlePressLogic ( local touchPoint)
virtual void handleMoveLogic (const CCPoint &touchPoint)
virtual void handleReleaseLogic (const CCPoint &touchPoint)
virtual void interceptTouchEvent (int handleState, UIWidget *sender, const CCPoint &touchPoint)
var interceptTouchEvent ( var handleState, var sender, var touchPoint)
local interceptTouchEvent ( local handleState, local sender, local touchPoint)
virtual void checkChildInfo (int handleState, UIWidget *sender, const CCPoint &touchPoint)
void recordSlidTime (float dt)
virtual void releaseResoures ()
 Release texture resoures of widget. More...
 
void scrollToTopEvent ()
var scrollToTopEvent ()
local scrollToTopEvent ()
void scrollToBottomEvent ()
void scrollToLeftEvent ()
void scrollToRightEvent ()
var scrollToRightEvent ()
local scrollToRightEvent ()
void setMoveDirection (SCROLLVIEW_MOVE_DIR dir)
SCROLLVIEW_MOVE_DIR getMoveDirection ()
local getMoveDirection ()
virtual void onSizeChanged ()
virtual void setClippingEnable (bool is)
 These methods will be removed. More...
 
local setClippingEnable ( local is)
 These methods will be removed. More...
 
virtual void setClippingEnabled (bool able)
 Changes if layout can clip it's content and child. More...
 
- Protected Member Functions inherited from Layout
void addBackGroundImage ()
- Protected Member Functions inherited from UIWidget
virtual void onPressStateChangedToNormal ()
virtual void onPressStateChangedToPressed ()
virtual void onPressStateChangedToDisabled ()
void pushDownEvent ()
void moveEvent ()
void releaseUpEvent ()
void cancelUpEvent ()
void longClickEvent ()
void updateAnchorPoint ()
void updateSizeAndPosition ()

Protected Attributes

Layoutm_pInnerContainer
local m_pInnerContainer
SCROLLVIEW_DIR m_eDirection
var m_eDirection
local m_eDirection
SCROLLVIEW_MOVE_DIR m_eMoveDirection
var m_eMoveDirection
local m_eMoveDirection
float m_fTouchStartLocation
float m_fTouchEndLocation
var m_fTouchEndLocation
local m_fTouchEndLocation
float m_fTouchMoveStartLocation
var m_fTouchMoveStartLocation
local m_fTouchMoveStartLocation
float m_fTopBoundary
var m_fTopBoundary
local m_fTopBoundary
float m_fBottomBoundary
var m_fBottomBoundary
local m_fBottomBoundary
float m_fLeftBoundary
var m_fLeftBoundary
local m_fLeftBoundary
float m_fRightBoundary
var m_fRightBoundary
local m_fRightBoundary
bool m_bTopEnd
var m_bTopEnd
local m_bTopEnd
bool m_bBottomEnd
var m_bBottomEnd
local m_bBottomEnd
bool m_bLeftEnd
bool m_bRightEnd
var m_bRightEnd
local m_bRightEnd
bool m_bAutoScroll
var m_bAutoScroll
local m_bAutoScroll
float m_fAutoScrollOriginalSpeed
var m_fAutoScrollOriginalSpeed
local m_fAutoScrollOriginalSpeed
float m_fAutoScrollAcceleration
var m_fAutoScrollAcceleration
local m_fAutoScrollAcceleration
bool m_bBePressed
var m_bBePressed
local m_bBePressed
float m_fSlidTime
var m_fSlidTime
local m_fSlidTime
CCPoint moveChildPoint
var moveChildPoint
local moveChildPoint
float m_fChildFocusCancelOffset
var m_fChildFocusCancelOffset
local m_fChildFocusCancelOffset
CCObjectm_pEventListener
var m_pEventListener
local m_pEventListener
SEL_ScrollViewEvent m_pfnEventSelector
var m_pfnEventSelector
local m_pfnEventSelector
CCObjectm_pScrollToTopListener
var m_pScrollToTopListener
local m_pScrollToTopListener
SEL_ScrollToTopEvent m_pfnScrollToTopSelector
var m_pfnScrollToTopSelector
local m_pfnScrollToTopSelector
CCObjectm_pScrollToBottomListener
var m_pScrollToBottomListener
local m_pScrollToBottomListener
SEL_ScrollToBottomEvent m_pfnScrollToBottomSelector
CCObjectm_pScrollToLeftListener
var m_pScrollToLeftListener
local m_pScrollToLeftListener
SEL_ScrollToLeftEvent m_pfnScrollToLeftSelector
var m_pfnScrollToLeftSelector
local m_pfnScrollToLeftSelector
CCObjectm_pScrollToRightListener
var m_pScrollToRightListener
local m_pScrollToRightListener
SEL_ScrollToRightEvent m_pfnScrollToRightSelector
- Protected Attributes inherited from Layout
bool m_bClippingEnabled
bool m_bBackGroundScale9Enable
CCNodem_pBackGroundImage
std::string m_strBackGroundImageFileName
CCRect m_backGroundImageCapInsets
LayoutBackGroundColorType m_colorType
TextureResType m_eBGImageTexType
CCLayerColorm_pColorRender
CCLayerGradientm_pGradientRender
ccColor3B m_cColor
ccColor3B m_gStartColor
ccColor3B m_gEndColor
CCPoint m_AlongVector
int m_nCOpacity
CCSize m_backGroundImageTextureSize
LayoutType m_eLayoutType
- Protected Attributes inherited from UIWidget
bool m_bEnabled
 Highest control of widget. More...
 
bool m_bVisible
 is this widget visible More...
 
bool m_bBright
 is this widget bright More...
 
bool m_bTouchEnabled
 is this widget touch endabled More...
 
bool m_bTouchPassedEnabled
 is the touch event should be passed More...
 
bool m_bFocus
 is the widget on focus More...
 
int m_nWidgetZOrder
 z-order value that affects the draw order and touch order More...
 
CCPoint m_anchorPoint
 anchor point normalized More...
 
UIWidgetm_pWidgetParent
 parent of widget More...
 
BrightStyle m_eBrightStyle
 bright style More...
 
bool m_bUpdateEnabled
 is "update" method scheduled More...
 
CCNodem_pRenderer
 base renderer More...
 
CCPoint m_touchStartPos
 touch began point More...
 
CCPoint m_touchMovePos
 touch moved point More...
 
CCPoint m_touchEndPos
 touch ended point More...
 
CCObjectm_pTouchEventListener
SEL_TouchEvent m_pfnTouchEventSelector
int m_nWidgetTag
std::string m_strName
WidgetType m_WidgetType
int m_nActionTag
CCSize m_size
CCSize m_customSize
LayoutParameterm_pLayoutParameter
bool m_bIgnoreSize
CCArraym_children
bool m_bAffectByClipping
CCSchedulerm_pScheduler
SizeType m_eSizeType
CCPoint m_sizePercent
PositionType m_ePositionType
CCPoint m_positionPercent
bool m_bIsRunning
CCObjectm_pPushListener
SEL_PushEvent m_pfnPushSelector
CCObjectm_pMoveListener
SEL_MoveEvent m_pfnMoveSelector
CCObjectm_pReleaseListener
SEL_ReleaseEvent m_pfnReleaseSelector
CCObjectm_pCancelListener
SEL_ReleaseEvent m_pfnCancelSelector
- Protected Attributes inherited from CCObject
unsigned int m_uReference
unsigned int m_uAutoReleaseCount

Additional Inherited Members

- Public Attributes inherited from CCObject
unsigned int m_uID
int m_nLuaID

Constructor & Destructor Documentation

Default constructor.

var UIScrollView ( )

Default constructor.

local UIScrollView ( )

Default constructor.

virtual ~UIScrollView ( )
virtual

Default destructor.

var ~UIScrollView ( )
virtual

Default destructor.

local ~UIScrollView ( )
virtual

Default destructor.

Member Function Documentation

virtual bool addChild ( UIWidget child)
virtual

Adds a child to the container.

Parameters
childA child widget

Reimplemented from UIWidget.

var addChild ( var  child)
virtual

Adds a child to the container.

Parameters
childA child widget

Reimplemented from UIWidget.

local addChild ( local  child)
virtual

Adds a child to the container.

Parameters
childA child widget

Reimplemented from UIWidget.

void addEventListener ( CCObject target,
SEL_ScrollViewEvent  selector 
)

Add call back function called scrollview event triggered.

var addEventListener ( var  target,
var  selector 
)

Add call back function called scrollview event triggered.

local addEventListener ( local  target,
local  selector 
)

Add call back function called scrollview event triggered.

void addScrollToBottomEvent ( CCObject target,
SEL_ScrollToBottomEvent  selector 
)

Add call back function called when scrollview scrolled to bottom.

var addScrollToBottomEvent ( var  target,
var  selector 
)

Add call back function called when scrollview scrolled to bottom.

local addScrollToBottomEvent ( local  target,
local  selector 
)

Add call back function called when scrollview scrolled to bottom.

void addScrollToLeftEvent ( CCObject target,
SEL_ScrollToLeftEvent  selector 
)

Add call back function called when scrollview scrolled to left.

var addScrollToLeftEvent ( var  target,
var  selector 
)

Add call back function called when scrollview scrolled to left.

local addScrollToLeftEvent ( local  target,
local  selector 
)

Add call back function called when scrollview scrolled to left.

void addScrollToRightEvent ( CCObject target,
SEL_ScrollToRightEvent  selector 
)

Add call back function called when scrollview scrolled to right.

var addScrollToRightEvent ( var  target,
var  selector 
)

Add call back function called when scrollview scrolled to right.

local addScrollToRightEvent ( local  target,
local  selector 
)

Add call back function called when scrollview scrolled to right.

void addScrollToTopEvent ( CCObject target,
SEL_ScrollToTopEvent  selector 
)

Add call back function called when scrollview scrolled to top.

var addScrollToTopEvent ( var  target,
var  selector 
)

Add call back function called when scrollview scrolled to top.

local addScrollToTopEvent ( local  target,
local  selector 
)

Add call back function called when scrollview scrolled to top.

void autoScrollChildren ( float  dt)
protected
var autoScrollChildren ( var  dt)
protected
local autoScrollChildren ( local  dt)
protected
virtual void checkChildInfo ( int  handleState,
UIWidget sender,
const CCPoint touchPoint 
)
protectedvirtual

Reimplemented from UIWidget.

var checkChildInfo ( var  handleState,
var  sender,
var  touchPoint 
)
protectedvirtual

Reimplemented from UIWidget.

local checkChildInfo ( local  handleState,
local  sender,
local  touchPoint 
)
protectedvirtual

Reimplemented from UIWidget.

static UIScrollView* create ( )
static

Allocates and initializes.

var create ( )
static

Allocates and initializes.

local create ( )
static

Allocates and initializes.

virtual void doLayout ( )
virtual

Reimplemented from Layout.

var doLayout ( )
virtual

Reimplemented from Layout.

local doLayout ( )
virtual

Reimplemented from Layout.

virtual void endRecordSlidAction ( )
protectedvirtual
var endRecordSlidAction ( )
protectedvirtual
local endRecordSlidAction ( )
protectedvirtual
virtual CCArray* getChildren ( )
virtual

Return an array of children.

Composing a "tree" structure is a very important feature of UIWidget

Returns
An array of children

Reimplemented from UIWidget.

var getChildren ( )
virtual

Return an array of children.

Composing a "tree" structure is a very important feature of UIWidget

Returns
An array of children

Reimplemented from UIWidget.

local getChildren ( )
virtual

Return an array of children.

Composing a "tree" structure is a very important feature of UIWidget

Returns
An array of children

Reimplemented from UIWidget.

float getCurAutoScrollDistance ( float  time)
protected
var getCurAutoScrollDistance ( var  time)
protected
local getCurAutoScrollDistance ( local  time)
protected
virtual const char* getDescription ( ) const
virtual

Returns the "class name" of widget.

Reimplemented from Layout.

var getDescription ( )
virtual

Returns the "class name" of widget.

Reimplemented from Layout.

local getDescription ( )
virtual

Returns the "class name" of widget.

Reimplemented from Layout.

SCROLLVIEW_DIR getDirection ( )

Gets scroll direction of scrollview.

See Also
SCROLLVIEW_DIR SCROLLVIEW_DIR_VERTICAL means vertical scroll, SCROLLVIEW_DIR_HORIZONTAL means horizontal scroll
Returns
SCROLLVIEW_DIR
var getDirection ( )

Gets scroll direction of scrollview.

See Also
SCROLLVIEW_DIR SCROLLVIEW_DIR_VERTICAL means vertical scroll, SCROLLVIEW_DIR_HORIZONTAL means horizontal scroll
Returns
SCROLLVIEW_DIR
local getDirection ( )

Gets scroll direction of scrollview.

See Also
SCROLLVIEW_DIR SCROLLVIEW_DIR_VERTICAL means vertical scroll, SCROLLVIEW_DIR_HORIZONTAL means horizontal scroll
Returns
SCROLLVIEW_DIR
Layout* getInnerContainer ( )

Gets inner container of scrollview.

Inner container is the container of scrollview's children.

Returns
inner container.
var getInnerContainer ( )

Gets inner container of scrollview.

Inner container is the container of scrollview's children.

Returns
inner container.
local getInnerContainer ( )

Gets inner container of scrollview.

Inner container is the container of scrollview's children.

Returns
inner container.
const CCSize& getInnerContainerSize ( ) const

Gets inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Returns
inner container size.
var getInnerContainerSize ( )

Gets inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Returns
inner container size.
local getInnerContainerSize ( )

Gets inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Returns
inner container size.
virtual LayoutType getLayoutType ( ) const
virtual

Gets LayoutType.

See Also
LayoutType
Returns
LayoutType

Reimplemented from Layout.

var getLayoutType ( )
virtual

Gets LayoutType.

See Also
LayoutType
Returns
LayoutType

Reimplemented from Layout.

local getLayoutType ( )
virtual

Gets LayoutType.

See Also
LayoutType
Returns
LayoutType

Reimplemented from Layout.

SCROLLVIEW_MOVE_DIR
getMoveDirection
( )
protected
var getMoveDirection ( )
protected
local getMoveDirection ( )
protected
virtual void handleMoveLogic ( const CCPoint touchPoint)
protectedvirtual

Implements UIScrollInterface.

var handleMoveLogic ( var  touchPoint)
protectedvirtual

Implements UIScrollInterface.

local handleMoveLogic ( local  touchPoint)
protectedvirtual

Implements UIScrollInterface.

virtual void handlePressLogic ( const CCPoint touchPoint)
protectedvirtual

Implements UIScrollInterface.

var handlePressLogic ( var  touchPoint)
protectedvirtual

Implements UIScrollInterface.

local handlePressLogic ( local  touchPoint)
protectedvirtual

Implements UIScrollInterface.

virtual void handleReleaseLogic ( const CCPoint touchPoint)
protectedvirtual

Implements UIScrollInterface.

var handleReleaseLogic ( var  touchPoint)
protectedvirtual

Implements UIScrollInterface.

local handleReleaseLogic ( local  touchPoint)
protectedvirtual

Implements UIScrollInterface.

virtual bool init ( )
protectedvirtual

Reimplemented from Layout.

var init ( )
protectedvirtual

Reimplemented from Layout.

local init ( )
protectedvirtual

Reimplemented from Layout.

virtual void initRenderer ( )
protectedvirtual

Reimplemented from Layout.

var initRenderer ( )
protectedvirtual

Reimplemented from Layout.

local initRenderer ( )
protectedvirtual

Reimplemented from Layout.

virtual void interceptTouchEvent ( int  handleState,
UIWidget sender,
const CCPoint touchPoint 
)
protectedvirtual

Implements UIScrollInterface.

var interceptTouchEvent ( var  handleState,
var  sender,
var  touchPoint 
)
protectedvirtual

Implements UIScrollInterface.

local interceptTouchEvent ( local  handleState,
local  sender,
local  touchPoint 
)
protectedvirtual

Implements UIScrollInterface.

void moveChildren ( float  offset)
protected
var moveChildren ( var  offset)
protected
local moveChildren ( local  offset)
protected
virtual void onSizeChanged ( )
protectedvirtual

Reimplemented from Layout.

var onSizeChanged ( )
protectedvirtual

Reimplemented from Layout.

local onSizeChanged ( )
protectedvirtual

Reimplemented from Layout.

virtual bool onTouchBegan ( const CCPoint touchPoint)
virtual

A call back function called when widget is selected, and on touch began.

Parameters
touchpoint
Returns
true if the event should be pass to parent, flase otherwise.

Reimplemented from UIWidget.

var onTouchBegan ( var  touchPoint)
virtual

A call back function called when widget is selected, and on touch began.

Parameters
touchpoint
Returns
true if the event should be pass to parent, flase otherwise.

Reimplemented from UIWidget.

local onTouchBegan ( local  touchPoint)
virtual

A call back function called when widget is selected, and on touch began.

Parameters
touchpoint
Returns
true if the event should be pass to parent, flase otherwise.

Reimplemented from UIWidget.

virtual void onTouchCancelled ( const CCPoint touchPoint)
virtual

A call back function called when widget is selected, and on touch canceled.

Parameters
touchpoint

Reimplemented from UIWidget.

var onTouchCancelled ( var  touchPoint)
virtual

A call back function called when widget is selected, and on touch canceled.

Parameters
touchpoint

Reimplemented from UIWidget.

local onTouchCancelled ( local  touchPoint)
virtual

A call back function called when widget is selected, and on touch canceled.

Parameters
touchpoint

Reimplemented from UIWidget.

virtual void onTouchEnded ( const CCPoint touchPoint)
virtual

A call back function called when widget is selected, and on touch ended.

Parameters
touchpoint

Reimplemented from UIWidget.

var onTouchEnded ( var  touchPoint)
virtual

A call back function called when widget is selected, and on touch ended.

Parameters
touchpoint

Reimplemented from UIWidget.

local onTouchEnded ( local  touchPoint)
virtual

A call back function called when widget is selected, and on touch ended.

Parameters
touchpoint

Reimplemented from UIWidget.

virtual void onTouchLongClicked ( const CCPoint touchPoint)
virtual

A call back function called when widget is selected, and on touch long clicked.

Parameters
touchpoint

Reimplemented from UIWidget.

var onTouchLongClicked ( var  touchPoint)
virtual

A call back function called when widget is selected, and on touch long clicked.

Parameters
touchpoint

Reimplemented from UIWidget.

local onTouchLongClicked ( local  touchPoint)
virtual

A call back function called when widget is selected, and on touch long clicked.

Parameters
touchpoint

Reimplemented from UIWidget.

virtual void onTouchMoved ( const CCPoint touchPoint)
virtual

A call back function called when widget is selected, and on touch moved.

Parameters
touchpoint

Reimplemented from UIWidget.

var onTouchMoved ( var  touchPoint)
virtual

A call back function called when widget is selected, and on touch moved.

Parameters
touchpoint

Reimplemented from UIWidget.

local onTouchMoved ( local  touchPoint)
virtual

A call back function called when widget is selected, and on touch moved.

Parameters
touchpoint

Reimplemented from UIWidget.

void recordSlidTime ( float  dt)
protected
var recordSlidTime ( var  dt)
protected
local recordSlidTime ( local  dt)
protected
virtual void releaseResoures ( )
protectedvirtual

Release texture resoures of widget.

Release renderer. If you override releaseResoures, you shall call its parent's one, e.g. UIWidget::releaseResoures().

Reimplemented from UIWidget.

var releaseResoures ( )
protectedvirtual

Release texture resoures of widget.

Release renderer. If you override releaseResoures, you shall call its parent's one, e.g. UIWidget::releaseResoures().

Reimplemented from UIWidget.

local releaseResoures ( )
protectedvirtual

Release texture resoures of widget.

Release renderer. If you override releaseResoures, you shall call its parent's one, e.g. UIWidget::releaseResoures().

Reimplemented from UIWidget.

virtual void removeAllChildren ( )
virtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Reimplemented from UIWidget.

var removeAllChildren ( )
virtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Reimplemented from UIWidget.

local removeAllChildren ( )
virtual

Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.

Reimplemented from UIWidget.

virtual bool removeChild ( UIWidget child)
virtual

Removes a child from the container with a cleanup.

Parameters
childThe child widget which will be removed.
Returns
the result of removing, succeeded or failed.

Reimplemented from UIWidget.

var removeChild ( var  child)
virtual

Removes a child from the container with a cleanup.

Parameters
childThe child widget which will be removed.
Returns
the result of removing, succeeded or failed.

Reimplemented from UIWidget.

local removeChild ( local  child)
virtual

Removes a child from the container with a cleanup.

Parameters
childThe child widget which will be removed.
Returns
the result of removing, succeeded or failed.

Reimplemented from UIWidget.

virtual bool scrollChildren ( float  touchOffset)
protectedvirtual
var scrollChildren ( var  touchOffset)
protectedvirtual
local scrollChildren ( local  touchOffset)
protectedvirtual
void scrollToBottom ( )

Scroll inner container to bottom boundary of scrollview.

var scrollToBottom ( )

Scroll inner container to bottom boundary of scrollview.

local scrollToBottom ( )

Scroll inner container to bottom boundary of scrollview.

void scrollToBottomEvent ( )
protected
var scrollToBottomEvent ( )
protected
local scrollToBottomEvent ( )
protected
void scrollToLeftEvent ( )
protected
var scrollToLeftEvent ( )
protected
local scrollToLeftEvent ( )
protected
void scrollToRightEvent ( )
protected
var scrollToRightEvent ( )
protected
local scrollToRightEvent ( )
protected
void scrollToTop ( )

Scroll inner container to top boundary of scrollview.

var scrollToTop ( )

Scroll inner container to top boundary of scrollview.

local scrollToTop ( )

Scroll inner container to top boundary of scrollview.

void scrollToTopEvent ( )
protected
var scrollToTopEvent ( )
protected
local scrollToTopEvent ( )
protected
virtual void setClippingEnable ( bool  is)
inlineprotectedvirtual

These methods will be removed.

Reimplemented from Layout.

var setClippingEnable ( var  is)
inlineprotectedvirtual

These methods will be removed.

Reimplemented from Layout.

local setClippingEnable ( local  is)
inlineprotectedvirtual

These methods will be removed.

Reimplemented from Layout.

virtual void setClippingEnabled ( bool  able)
inlineprotectedvirtual

Changes if layout can clip it's content and child.

If you really need this, please enable it. But it would reduce the rendering efficiency.

Parameters
clippingenabled.

Reimplemented from Layout.

var setClippingEnabled ( var  able)
inlineprotectedvirtual

Changes if layout can clip it's content and child.

If you really need this, please enable it. But it would reduce the rendering efficiency.

Parameters
clippingenabled.

Reimplemented from Layout.

local setClippingEnabled ( local  able)
inlineprotectedvirtual

Changes if layout can clip it's content and child.

If you really need this, please enable it. But it would reduce the rendering efficiency.

Parameters
clippingenabled.

Reimplemented from Layout.

void setDirection ( SCROLLVIEW_DIR  dir)

Changes scroll direction of scrollview.

See Also
SCROLLVIEW_DIR SCROLLVIEW_DIR_VERTICAL means vertical scroll, SCROLLVIEW_DIR_HORIZONTAL means horizontal scroll
Parameters
SCROLLVIEW_DIR
var setDirection ( var  dir)

Changes scroll direction of scrollview.

See Also
SCROLLVIEW_DIR SCROLLVIEW_DIR_VERTICAL means vertical scroll, SCROLLVIEW_DIR_HORIZONTAL means horizontal scroll
Parameters
SCROLLVIEW_DIR
local setDirection ( local  dir)

Changes scroll direction of scrollview.

See Also
SCROLLVIEW_DIR SCROLLVIEW_DIR_VERTICAL means vertical scroll, SCROLLVIEW_DIR_HORIZONTAL means horizontal scroll
Parameters
SCROLLVIEW_DIR
void setInnerContainerSize ( const CCSize size)

Changes inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Parameters
innercontainer size.
var setInnerContainerSize ( var  size)

Changes inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Parameters
innercontainer size.
local setInnerContainerSize ( local  size)

Changes inner container size of scrollview.

Inner container size must be larger than or equal scrollview's size.

Parameters
innercontainer size.
virtual void setLayoutType ( LayoutType  type)
virtual

Sets LayoutType.

See Also
LayoutType
Parameters
LayoutType

Reimplemented from Layout.

var setLayoutType ( var  type)
virtual

Sets LayoutType.

See Also
LayoutType
Parameters
LayoutType

Reimplemented from Layout.

local setLayoutType ( local  type)
virtual

Sets LayoutType.

See Also
LayoutType
Parameters
LayoutType

Reimplemented from Layout.

void setMoveDirection ( SCROLLVIEW_MOVE_DIR  dir)
protected
var setMoveDirection ( var  dir)
protected
local setMoveDirection ( local  dir)
protected
void startAutoScrollChildren ( float  v)
protected
var startAutoScrollChildren ( var  v)
protected
local startAutoScrollChildren ( local  v)
protected
void startRecordSlidAction ( )
protected
var startRecordSlidAction ( )
protected
local startRecordSlidAction ( )
protected
void stopAutoScrollChildren ( )
protected
var stopAutoScrollChildren ( )
protected
local stopAutoScrollChildren ( )
protected
virtual void update ( float  dt)
virtual

Reimplemented from CCObject.

var update ( var  dt)
virtual

Reimplemented from CCObject.

local update ( local  dt)
virtual

Reimplemented from CCObject.

Member Data Documentation

bool m_bAutoScroll
protected
var m_bAutoScroll
protected
local m_bAutoScroll
protected
bool m_bBePressed
protected
var m_bBePressed
protected
local m_bBePressed
protected
bool m_bBottomEnd
protected
var m_bBottomEnd
protected
local m_bBottomEnd
protected
bool m_bLeftEnd
protected
var m_bLeftEnd
protected
local m_bLeftEnd
protected
bool m_bRightEnd
protected
var m_bRightEnd
protected
local m_bRightEnd
protected
bool m_bTopEnd
protected
var m_bTopEnd
protected
local m_bTopEnd
protected
SCROLLVIEW_DIR m_eDirection
protected
var m_eDirection
protected
local m_eDirection
protected
SCROLLVIEW_MOVE_DIR
m_eMoveDirection
protected
var m_eMoveDirection
protected
local m_eMoveDirection
protected
float m_fAutoScrollAcceleration
protected
var m_fAutoScrollAcceleration
protected
local m_fAutoScrollAcceleration
protected
float m_fAutoScrollOriginalSpeed
protected
var m_fAutoScrollOriginalSpeed
protected
local m_fAutoScrollOriginalSpeed
protected
float m_fBottomBoundary
protected
var m_fBottomBoundary
protected
local m_fBottomBoundary
protected
float m_fChildFocusCancelOffset
protected
var m_fChildFocusCancelOffset
protected
local m_fChildFocusCancelOffset
protected
float m_fLeftBoundary
protected
var m_fLeftBoundary
protected
local m_fLeftBoundary
protected
float m_fRightBoundary
protected
var m_fRightBoundary
protected
local m_fRightBoundary
protected
float m_fSlidTime
protected
var m_fSlidTime
protected
local m_fSlidTime
protected
float m_fTopBoundary
protected
var m_fTopBoundary
protected
local m_fTopBoundary
protected
float m_fTouchEndLocation
protected
var m_fTouchEndLocation
protected
local m_fTouchEndLocation
protected
float m_fTouchMoveStartLocation
protected
var m_fTouchMoveStartLocation
protected
local m_fTouchMoveStartLocation
protected
float m_fTouchStartLocation
protected
var m_fTouchStartLocation
protected
local m_fTouchStartLocation
protected
CCObject* m_pEventListener
protected
var m_pEventListener
protected
local m_pEventListener
protected
SEL_ScrollViewEvent
m_pfnEventSelector
protected
var m_pfnEventSelector
protected
local m_pfnEventSelector
protected
SEL_ScrollToBottomEvent
m_pfnScrollToBottomSelector
protected
var m_pfnScrollToBottomSelector
protected
local m_pfnScrollToBottomSelector
protected
SEL_ScrollToLeftEvent
m_pfnScrollToLeftSelector
protected
var m_pfnScrollToLeftSelector
protected
local m_pfnScrollToLeftSelector
protected
SEL_ScrollToRightEvent
m_pfnScrollToRightSelector
protected
var m_pfnScrollToRightSelector
protected
local m_pfnScrollToRightSelector
protected
SEL_ScrollToTopEvent
m_pfnScrollToTopSelector
protected
var m_pfnScrollToTopSelector
protected
local m_pfnScrollToTopSelector
protected
Layout* m_pInnerContainer
protected
var m_pInnerContainer
protected
local m_pInnerContainer
protected
CCObject* m_pScrollToBottomListener
protected
var m_pScrollToBottomListener
protected
local m_pScrollToBottomListener
protected
CCObject* m_pScrollToLeftListener
protected
var m_pScrollToLeftListener
protected
local m_pScrollToLeftListener
protected
CCObject* m_pScrollToRightListener
protected
var m_pScrollToRightListener
protected
local m_pScrollToRightListener
protected
CCObject* m_pScrollToTopListener
protected
var m_pScrollToTopListener
protected
local m_pScrollToTopListener
protected
CCPoint moveChildPoint
protected
var moveChildPoint
protected
local moveChildPoint
protected

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