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

#include <UIScrollView.h>

Inheritance diagram for UIScrollView:
UILayout UIScrollInterface UIWidget CCObject CCCopying UIDragPanel UIListViewEx

Public Member Functions

 UIScrollView ()
virtual ~UIScrollView ()
 Default destructor. More...
 
virtual void setDirection (SCROLLVIEW_DIR dir)
 Changes scroll direction of scrollview. More...
 
SCROLLVIEW_DIR getDirection ()
 Gets scroll direction of scrollview. More...
 
UILayoutgetInnerContainer ()
 Gets inner container of scrollview. More...
 
void scrollToBottom (float time, bool attenuated)
 Scroll inner container to bottom boundary of scrollview. More...
 
void scrollToTop (float time, bool attenuated)
 Scroll inner container to top boundary of scrollview. More...
 
void scrollToLeft (float time, bool attenuated)
 Scroll inner container to left boundary of scrollview. More...
 
void scrollToRight (float time, bool attenuated)
 Scroll inner container to right boundary of scrollview. More...
 
void scrollToTopLeft (float time, bool attenuated)
 Scroll inner container to top and left boundary of scrollview. More...
 
void scrollToTopRight (float time, bool attenuated)
 Scroll inner container to top and right boundary of scrollview. More...
 
void scrollToBottomLeft (float time, bool attenuated)
 Scroll inner container to bottom and left boundary of scrollview. More...
 
void scrollToBottomRight (float time, bool attenuated)
 Scroll inner container to bottom and right boundary of scrollview. More...
 
void scrollToPercentVertical (float percent, float time, bool attenuated)
 Scroll inner container to vertical percent position of scrollview. More...
 
void scrollToPercentHorizontal (float percent, float time, bool attenuated)
 Scroll inner container to horizontal percent position of scrollview. More...
 
void scrollToPercentBothDirection (const CCPoint &percent, float time, bool attenuated)
 Scroll inner container to both direction percent position of scrollview. More...
 
void jumpToBottom ()
 Move inner container to bottom boundary of scrollview. More...
 
void jumpToTop ()
 Move inner container to top boundary of scrollview. More...
 
void jumpToLeft ()
 Move inner container to left boundary of scrollview. More...
 
void jumpToRight ()
 Move inner container to right boundary of scrollview. More...
 
void jumpToTopLeft ()
 Move inner container to top and left boundary of scrollview. More...
 
void jumpToTopRight ()
 Move inner container to top and right boundary of scrollview. More...
 
void jumpToBottomLeft ()
 Move inner container to bottom and left boundary of scrollview. More...
 
void jumpToBottomRight ()
 Move inner container to bottom and right boundary of scrollview. More...
 
void jumpToPercentVertical (float percent)
 Move inner container to vertical percent position of scrollview. More...
 
void jumpToPercentHorizontal (float percent)
 Move inner container to horizontal percent position of scrollview. More...
 
void jumpToPercentBothDirection (const CCPoint &percent)
 Move inner container to both direction percent position of scrollview. More...
 
void setInnerContainerSize (const CCSize &size)
 Changes inner container size of scrollview. More...
 
const CCSizegetInnerContainerSize () const
 Gets inner container size of scrollview. More...
 
void addEventListenerScrollView (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...
 
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...
 
void addScrollToRightEvent (CCObject *target, SEL_ScrollToRightEvent 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...
 
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...
 
virtual void onTouchMoved (const CCPoint &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...
 
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)
void setBounceEnabled (bool enabled)
bool isBounceEnabled () const
void setInertiaScrollEnabled (bool enabled)
bool isInertiaScrollEnabled () const
virtual void setLayoutType (LayoutType type)
 Sets LayoutType. More...
 
virtual LayoutType getLayoutType () const
 Gets LayoutType. More...
 
virtual void doLayout ()
virtual const char * getDescription () const
 Returns the "class name" of widget. More...
 
- Public Member Functions inherited from UILayout
 UILayout ()
virtual ~UILayout ()
 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...
 
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 (UILayoutParameter *parameter)
 Sets a LayoutParameter to widget. More...
 
UILayoutParametergetLayoutParameter (LayoutParameterType type)
 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...
 
UIWidgetclone ()
virtual void onEnter ()
virtual void onExit ()
virtual CCObjectgetUserObject ()
 Returns a user assigned CCObject. More...
 
virtual void setUserObject (CCObject *pUserObject)
 Returns a user assigned CCObject. More...
 
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 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 ()
void updateSizeAndPosition ()
- 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...
 
- Static Public Member Functions inherited from UILayout
static UILayoutcreate ()
 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 ()
virtual void initRenderer ()
void moveChildren (float offsetX, float offsetY)
void autoScrollChildren (float dt)
void bounceChildren (float dt)
void checkBounceBoundary ()
bool checkNeedBounce ()
void startAutoScrollChildrenWithOriginalSpeed (const CCPoint &dir, float v, bool attenuated, float acceleration)
void startAutoScrollChildrenWithDestination (const CCPoint &des, float time, bool attenuated)
void jumpToDestination (const CCPoint &des)
void stopAutoScrollChildren ()
void startBounceChildren (float v)
void stopBounceChildren ()
bool checkCustomScrollDestination (float *touchOffsetX, float *touchOffsetY)
virtual bool scrollChildren (float touchOffsetX, float touchOffsetY)
bool bounceScrollChildren (float touchOffsetX, float touchOffsetY)
void startRecordSlidAction ()
virtual void endRecordSlidAction ()
virtual void handlePressLogic (const CCPoint &touchPoint)
virtual void handleMoveLogic (const CCPoint &touchPoint)
virtual void handleReleaseLogic (const CCPoint &touchPoint)
virtual void interceptTouchEvent (int handleState, UIWidget *sender, const CCPoint &touchPoint)
virtual void checkChildInfo (int handleState, UIWidget *sender, const CCPoint &touchPoint)
void recordSlidTime (float dt)
void scrollToTopEvent ()
void scrollToBottomEvent ()
void scrollToLeftEvent ()
void scrollToRightEvent ()
void scrollingEvent ()
void bounceTopEvent ()
void bounceBottomEvent ()
void bounceLeftEvent ()
void bounceRightEvent ()
virtual void onSizeChanged ()
virtual UIWidgetcreateCloneInstance ()
virtual void copySpecialProperties (UIWidget *model)
virtual void copyClonedWidgetChildren (UIWidget *model)
virtual void setClippingEnable (bool 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 UILayout
void addBackGroundImage ()
void supplyTheLayoutParameterLackToChild (UIWidget *child)
- 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 copyProperties (UIWidget *model)

Protected Attributes

UILayoutm_pInnerContainer
SCROLLVIEW_DIR m_eDirection
CCPoint m_touchBeganPoint
CCPoint m_touchMovedPoint
CCPoint m_touchEndedPoint
CCPoint m_touchMovingPoint
CCPoint m_autoScrollDir
float m_fTopBoundary
float m_fBottomBoundary
float m_fLeftBoundary
float m_fRightBoundary
float m_fBounceTopBoundary
float m_fBounceBottomBoundary
float m_fBounceLeftBoundary
float m_fBounceRightBoundary
bool m_bAutoScroll
float m_fAutoScrollAddUpTime
float m_fAutoScrollOriginalSpeed
float m_fAutoScrollAcceleration
bool m_bIsAutoScrollSpeedAttenuated
bool m_bNeedCheckAutoScrollDestination
CCPoint m_autoScrollDestination
bool m_bBePressed
float m_fSlidTime
CCPoint moveChildPoint
float m_fChildFocusCancelOffset
bool m_bLeftBounceNeeded
bool m_bTopBounceNeeded
bool m_bRightBounceNeeded
bool m_bBottomBounceNeeded
bool m_bBounceEnabled
bool m_bBouncing
CCPoint m_bounceDir
float m_fBounceOriginalSpeed
bool m_bInertiaScrollEnabled
CCObjectm_pScrollViewEventListener
SEL_ScrollViewEvent m_pfnScrollViewEventSelector
CCObjectm_pScrollToTopListener
SEL_ScrollToTopEvent m_pfnScrollToTopSelector
CCObjectm_pScrollToBottomListener
SEL_ScrollToBottomEvent m_pfnScrollToBottomSelector
CCObjectm_pScrollToLeftListener
SEL_ScrollToLeftEvent m_pfnScrollToLeftSelector
CCObjectm_pScrollToRightListener
SEL_ScrollToRightEvent m_pfnScrollToRightSelector
- Protected Attributes inherited from UILayout
bool m_bClippingEnabled
bool m_bBackGroundScale9Enabled
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
CCDictionarym_pLayoutParameterDictionary
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_pUserObject
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

virtual ~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 UILayout.

Reimplemented in UIListViewEx.

void addEventListenerScrollView ( CCObject target,
SEL_ScrollViewEvent  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.

void addScrollToLeftEvent ( CCObject target,
SEL_ScrollToLeftEvent  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.

void addScrollToTopEvent ( CCObject target,
SEL_ScrollToTopEvent  selector 
)

Add call back function called when scrollview scrolled to top.

void autoScrollChildren ( float  dt)
protected
void bounceBottomEvent ( )
protected
void bounceChildren ( float  dt)
protected
void bounceLeftEvent ( )
protected
void bounceRightEvent ( )
protected
bool bounceScrollChildren ( float  touchOffsetX,
float  touchOffsetY 
)
protected
void bounceTopEvent ( )
protected
void checkBounceBoundary ( )
protected
virtual void checkChildInfo ( int  handleState,
UIWidget sender,
const CCPoint touchPoint 
)
protectedvirtual

Reimplemented from UIWidget.

bool checkCustomScrollDestination ( float *  touchOffsetX,
float *  touchOffsetY 
)
protected
bool checkNeedBounce ( )
protected
virtual void
copyClonedWidgetChildren
( UIWidget model)
protectedvirtual

Reimplemented from UILayout.

Reimplemented in UIListViewEx.

virtual void copySpecialProperties ( UIWidget model)
protectedvirtual

Reimplemented from UILayout.

Reimplemented in UIListViewEx.

static UIScrollView* create ( )
static

Allocates and initializes.

virtual UIWidget*
createCloneInstance
( )
protectedvirtual

Reimplemented from UILayout.

Reimplemented in UIListViewEx.

virtual void doLayout ( )
virtual

Reimplemented from UILayout.

virtual void 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.

Reimplemented in UIListViewEx.

virtual const char* getDescription ( ) const
virtual

Returns the "class name" of widget.

Reimplemented from UILayout.

Reimplemented in UIListViewEx.

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
UILayout* 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.
virtual LayoutType getLayoutType ( ) const
virtual

Gets LayoutType.

See Also
LayoutType
Returns
LayoutType

Reimplemented from UILayout.

virtual void handleMoveLogic ( const CCPoint touchPoint)
protectedvirtual

Implements UIScrollInterface.

virtual void handlePressLogic ( const CCPoint touchPoint)
protectedvirtual

Implements UIScrollInterface.

virtual void handleReleaseLogic ( const CCPoint touchPoint)
protectedvirtual

Implements UIScrollInterface.

virtual bool init ( )
protectedvirtual

Reimplemented from UILayout.

Reimplemented in UIListViewEx, and UIDragPanel.

virtual void initRenderer ( )
protectedvirtual

Reimplemented from UILayout.

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

Implements UIScrollInterface.

Reimplemented in UIListViewEx.

bool isBounceEnabled ( ) const
bool isInertiaScrollEnabled ( ) const
void jumpToBottom ( )

Move inner container to bottom boundary of scrollview.

void jumpToBottomLeft ( )

Move inner container to bottom and left boundary of scrollview.

void jumpToBottomRight ( )

Move inner container to bottom and right boundary of scrollview.

void jumpToDestination ( const CCPoint des)
protected
void jumpToLeft ( )

Move inner container to left boundary of scrollview.

void jumpToPercentBothDirection ( const CCPoint percent)

Move inner container to both direction percent position of scrollview.

void jumpToPercentHorizontal ( float  percent)

Move inner container to horizontal percent position of scrollview.

void jumpToPercentVertical ( float  percent)

Move inner container to vertical percent position of scrollview.

void jumpToRight ( )

Move inner container to right boundary of scrollview.

void jumpToTop ( )

Move inner container to top boundary of scrollview.

void jumpToTopLeft ( )

Move inner container to top and left boundary of scrollview.

void jumpToTopRight ( )

Move inner container to top and right boundary of scrollview.

void moveChildren ( float  offsetX,
float  offsetY 
)
protected
virtual void onSizeChanged ( )
protectedvirtual

Reimplemented from UILayout.

Reimplemented in UIListViewEx.

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.

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.

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.

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.

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.

void recordSlidTime ( float  dt)
protected
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.

Reimplemented in UIListViewEx.

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.

Reimplemented in UIListViewEx.

virtual bool scrollChildren ( float  touchOffsetX,
float  touchOffsetY 
)
protectedvirtual
void scrollingEvent ( )
protected
void scrollToBottom ( float  time,
bool  attenuated 
)

Scroll inner container to bottom boundary of scrollview.

void scrollToBottomEvent ( )
protected
void scrollToBottomLeft ( float  time,
bool  attenuated 
)

Scroll inner container to bottom and left boundary of scrollview.

void scrollToBottomRight ( float  time,
bool  attenuated 
)

Scroll inner container to bottom and right boundary of scrollview.

void scrollToLeft ( float  time,
bool  attenuated 
)

Scroll inner container to left boundary of scrollview.

void scrollToLeftEvent ( )
protected
void scrollToPercentBothDirection ( const CCPoint percent,
float  time,
bool  attenuated 
)

Scroll inner container to both direction percent position of scrollview.

void scrollToPercentHorizontal ( float  percent,
float  time,
bool  attenuated 
)

Scroll inner container to horizontal percent position of scrollview.

void scrollToPercentVertical ( float  percent,
float  time,
bool  attenuated 
)

Scroll inner container to vertical percent position of scrollview.

void scrollToRight ( float  time,
bool  attenuated 
)

Scroll inner container to right boundary of scrollview.

void scrollToRightEvent ( )
protected
void scrollToTop ( float  time,
bool  attenuated 
)

Scroll inner container to top boundary of scrollview.

void scrollToTopEvent ( )
protected
void scrollToTopLeft ( float  time,
bool  attenuated 
)

Scroll inner container to top and left boundary of scrollview.

void scrollToTopRight ( float  time,
bool  attenuated 
)

Scroll inner container to top and right boundary of scrollview.

void setBounceEnabled ( bool  enabled)
virtual void setClippingEnable ( bool  is)
inlineprotectedvirtual

These methods will be removed.

Reimplemented from UILayout.

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 UILayout.

virtual void setDirection ( SCROLLVIEW_DIR  dir)
virtual

Changes scroll direction of scrollview.

See Also
SCROLLVIEW_DIR SCROLLVIEW_DIR_VERTICAL means vertical scroll, SCROLLVIEW_DIR_HORIZONTAL means horizontal scroll
Parameters
SCROLLVIEW_DIR

Reimplemented in UIListViewEx.

void setInertiaScrollEnabled ( bool  enabled)
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.
virtual void setLayoutType ( LayoutType  type)
virtual

Sets LayoutType.

See Also
LayoutType
Parameters
LayoutType

Reimplemented from UILayout.

void
startAutoScrollChildrenWithDestination
( const CCPoint des,
float  time,
bool  attenuated 
)
protected
void
startAutoScrollChildrenWithOriginalSpeed
( const CCPoint dir,
float  v,
bool  attenuated,
float  acceleration 
)
protected
void startBounceChildren ( float  v)
protected
void startRecordSlidAction ( )
protected
void stopAutoScrollChildren ( )
protected
void stopBounceChildren ( )
protected
virtual void update ( float  dt)
virtual

Reimplemented from CCObject.

Member Data Documentation

CCPoint m_autoScrollDestination
protected
CCPoint m_autoScrollDir
protected
bool m_bAutoScroll
protected
bool m_bBePressed
protected
bool m_bBottomBounceNeeded
protected
bool m_bBounceEnabled
protected
bool m_bBouncing
protected
bool m_bInertiaScrollEnabled
protected
bool m_bIsAutoScrollSpeedAttenuated
protected
bool m_bLeftBounceNeeded
protected
bool
m_bNeedCheckAutoScrollDestination
protected
CCPoint m_bounceDir
protected
bool m_bRightBounceNeeded
protected
bool m_bTopBounceNeeded
protected
SCROLLVIEW_DIR m_eDirection
protected
float m_fAutoScrollAcceleration
protected
float m_fAutoScrollAddUpTime
protected
float m_fAutoScrollOriginalSpeed
protected
float m_fBottomBoundary
protected
float m_fBounceBottomBoundary
protected
float m_fBounceLeftBoundary
protected
float m_fBounceOriginalSpeed
protected
float m_fBounceRightBoundary
protected
float m_fBounceTopBoundary
protected
float m_fChildFocusCancelOffset
protected
float m_fLeftBoundary
protected
float m_fRightBoundary
protected
float m_fSlidTime
protected
float m_fTopBoundary
protected
SEL_ScrollToBottomEvent
m_pfnScrollToBottomSelector
protected
SEL_ScrollToLeftEvent
m_pfnScrollToLeftSelector
protected
SEL_ScrollToRightEvent
m_pfnScrollToRightSelector
protected
SEL_ScrollToTopEvent
m_pfnScrollToTopSelector
protected
SEL_ScrollViewEvent
m_pfnScrollViewEventSelector
protected
UILayout* m_pInnerContainer
protected
CCObject* m_pScrollToBottomListener
protected
CCObject* m_pScrollToLeftListener
protected
CCObject* m_pScrollToRightListener
protected
CCObject* m_pScrollToTopListener
protected
CCObject*
m_pScrollViewEventListener
protected
CCPoint m_touchBeganPoint
protected
CCPoint m_touchEndedPoint
protected
CCPoint m_touchMovedPoint
protected
CCPoint m_touchMovingPoint
protected
CCPoint moveChildPoint
protected

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