cocos2d-x  3.0-alpha0
 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 Object

Public Member Functions

 UIScrollView ()
 Default constructor. More...
 
 UIScrollView ()
 Default constructor. More...
 
 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...
 
var getDirection ()
 Gets scroll direction of scrollview. More...
 
local getDirection ()
 Gets scroll direction of scrollview. More...
 
LayoutgetInnerContainer ()
 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 Size &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 SizegetInnerContainerSize () 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 (Object *target, SEL_ScrollViewEvent selector)
 Add call back function called scrollview event triggered. More...
 
virtual bool addChild (UIWidget *widget)
 Adds a child to the container. More...
 
var addChild ( var widget)
 Adds a child to the container. More...
 
local addChild ( local 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 ArraygetChildren ()
 Return an array of children. More...
 
var getChildren ()
 Return an array of children. More...
 
local getChildren ()
 Return an array of children. More...
 
virtual bool onTouchBegan (const Point &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 Point &touchPoint)
 A call back function called when widget is selected, and on touch moved. More...
 
virtual void onTouchEnded (const Point &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 Point &touchPoint)
 A call back function called when widget is selected, and on touch canceled. More...
 
var onTouchCancelled ( var touchPoint)
 A call back function called when widget is selected, and on touch canceled. More...
 
local onTouchCancelled ( local touchPoint)
 A call back function called when widget is selected, and on touch canceled. More...
 
virtual void onTouchLongClicked (const Point &touchPoint)
 A call back function called when widget is selected, and on touch long clicked. More...
 
var onTouchLongClicked ( var touchPoint)
 A call back function called when widget is selected, and on touch long clicked. More...
 
local onTouchLongClicked ( local 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...
 
local setLayoutType ( local type)
 Sets LayoutType. More...
 
virtual LayoutType getLayoutType () const
 Gets LayoutType. More...
 
var getLayoutType ()
 Gets LayoutType. More...
 
local getLayoutType ()
 Gets LayoutType. More...
 
virtual void doLayout ()
virtual const char * getDescription () const
 Returns the "class name" of widget. More...
 
local getDescription ()
 Returns the "class name" of widget. More...
 
- Public Member Functions inherited from Layout
 Layout ()
 Default constructor. More...
 
virtual ~Layout ()
 Default destructor. More...
 
virtual bool hitTest (const Point &pt)
 Checks a point if is in widget's space. More...
 
local hitTest ( local 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...
 
var setBackGroundImage ( var fileName, var UI_TEX_TYPE_LOCAL)
 Sets a background image for layout. More...
 
local setBackGroundImage ( local fileName, local UI_TEX_TYPE_LOCAL)
 Sets a background image for layout. More...
 
void setBackGroundImageCapInsets (const Rect &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 Color3B &color)
 Sets background color for layout, if color type is LAYOUT_COLOR_SOLID. More...
 
void setBackGroundColor (const Color3B &startColor, const Color3B &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 Point &vector)
 Sets background color vector for layout, if color type is LAYOUT_COLOR_GRADIENT. More...
 
virtual void setColor (const Color3B &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...
 
var removeBackGroundImage ()
 Remove the background image of layout. More...
 
local removeBackGroundImage ()
 Remove the background image of layout. More...
 
const SizegetBackGroundImageTextureSize () const
 Gets background image texture size. More...
 
virtual bool isClippingEnabled ()
 Gets if layout is clipping enabled. More...
 
virtual const SizegetContentSize () const
 Gets the content size of widget. More...
 
local getContentSize ()
 Gets the content size of widget. More...
 
- Public Member Functions inherited from UIWidget
 UIWidget (void)
 Default constructor. More...
 
 UIWidget ()
 Default constructor. More...
 
virtual ~UIWidget ()
 Default destructor. More...
 
local ~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...
 
local setTouchEnabled ( local 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...
 
var getBottomInParent ()
 Gets the bottom boundary position of this widget. More...
 
local 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...
 
local reorderChild ( local 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...
 
NodegetRenderer ()
 Gets the renderer of widget. More...
 
void addRenderer (Node *renderer, int zOrder)
 Add a CCNode for rendering. More...
 
void removeRenderer (Node *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 (Object *target, SEL_TouchEvent selector)
 Sets the touch event target/selector of the menu item. More...
 
var addTouchEventListener ( var target, var selector)
 Sets the touch event target/selector of the menu item. More...
 
local addTouchEventListener ( local target, local selector)
 Sets the touch event target/selector of the menu item. More...
 
void setPosition (const Point &pos)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionPercent (const Point &percent)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
var setPositionPercent ( var percent)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
local setPositionPercent ( local percent)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
const PointgetPosition ()
 Gets the position (x,y) of the widget in OpenGL coordinates. More...
 
const PointgetPositionPercent ()
 Gets the percent (x,y) of the widget in OpenGL coordinates. More...
 
local getPositionPercent ()
 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 Point &pt)
 Sets the anchor point in percent. More...
 
local setAnchorPoint ( local pt)
 Sets the anchor point in percent. More...
 
const PointgetAnchorPoint ()
 Returns the anchor point in percent. More...
 
var getAnchorPoint ()
 Returns the anchor point in percent. More...
 
local getAnchorPoint ()
 Returns the anchor point in percent. More...
 
virtual void setScale (float fScale)
 Changes both X and Y scale factor of the widget. More...
 
local setScale ( local 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...
 
local setScaleX ( local 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...
 
local setScaleY ( local 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...
 
local 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...
 
local setRotationX ( local 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...
 
local setRotationY ( local 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 Color3BgetColor ()
 Gets color of widget. More...
 
var getColor ()
 Gets color of widget. More...
 
local getColor ()
 Gets color of widget. More...
 
virtual int getOpacity ()
 Gets opacity of widget. More...
 
local getOpacity ()
 Gets opacity of widget. More...
 
virtual bool isCascadeOpacityEnabled ()
local isCascadeOpacityEnabled ()
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
local setCascadeOpacityEnabled ( local cascadeOpacityEnabled)
virtual bool isCascadeColorEnabled ()
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
local setCascadeColorEnabled ( local cascadeColorEnabled)
void setBlendFunc (BlendFunc blendFunc)
virtual void setActionManager (ActionManager *actionManager)
local setActionManager ( local actionManager)
virtual ActionManagergetActionManager ()
local getActionManager ()
ActionrunAction (Action *action)
void stopAllActions (void)
void stopAction (Action *action)
void stopActionByTag (int tag)
ActiongetActionByTag (int tag)
void didNotSelectSelf ()
 A call back function when widget lost of focus. More...
 
var didNotSelectSelf ()
 A call back function when widget lost of focus. More...
 
local didNotSelectSelf ()
 A call back function when widget lost of focus. More...
 
bool clippingParentAreaContainPoint (const Point &pt)
const PointgetTouchStartPos ()
const PointgetTouchMovePos ()
const PointgetTouchEndPos ()
local getTouchEndPos ()
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...
 
var getName ()
 Returns a name that is used to identify the widget easily. More...
 
local getName ()
 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 Size &size)
 Changes the size that is widget's size. More...
 
local setSize ( local size)
 Changes the size that is widget's size. More...
 
virtual void setSizePercent (const Point &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...
 
local getSizeType ()
 Gets the size type of widget. More...
 
const SizegetSize () const
 Returns size of widget. More...
 
const PointgetSizePercent () const
 Returns size percent of widget. More...
 
local getSizePercent ()
 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...
 
Point getWorldPosition ()
 Gets world position of widget. More...
 
Point convertToWorldSpace (const Point &pt)
 Converts a Point to world space coordinates. More...
 
virtual NodegetVirtualRenderer ()
 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 ()
local onExit ()
void setActionTag (int tag)
int getActionTag ()
- Public Member Functions inherited from Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
void release ()
 Release the ownership immediately. More...
 
void retain ()
 Retains the ownership. More...
 
Objectautorelease ()
 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 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...
 
local create ()
 Allocates and initializes a layout. More...
 
- Static Public Member Functions inherited from UIWidget
static UIWidgetcreate ()
 Allocates and initializes a widget. More...
 
local create ()
 Allocates and initializes a widget. More...
 

Protected Member Functions

virtual bool init ()
var init ()
local init ()
virtual void initRenderer ()
var initRenderer ()
local initRenderer ()
void moveChildren (float offset)
var moveChildren ( var offset)
local moveChildren ( local offset)
void autoScrollChildren (float dt)
void startAutoScrollChildren (float v)
var startAutoScrollChildren ( var v)
local startAutoScrollChildren ( local v)
void stopAutoScrollChildren ()
var stopAutoScrollChildren ()
local stopAutoScrollChildren ()
float getCurAutoScrollDistance (float 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 Point &touchPoint)
var handlePressLogic ( var touchPoint)
local handlePressLogic ( local touchPoint)
virtual void handleMoveLogic (const Point &touchPoint)
var handleMoveLogic ( var touchPoint)
local handleMoveLogic ( local touchPoint)
virtual void handleReleaseLogic (const Point &touchPoint)
var handleReleaseLogic ( var touchPoint)
local handleReleaseLogic ( local touchPoint)
virtual void interceptTouchEvent (int handleState, UIWidget *sender, const Point &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 Point &touchPoint)
var checkChildInfo ( var handleState, var sender, var touchPoint)
local checkChildInfo ( local handleState, local sender, local touchPoint)
void recordSlidTime (float dt)
var recordSlidTime ( var dt)
local recordSlidTime ( local dt)
virtual void releaseResoures ()
 Release texture resoures of widget. More...
 
var releaseResoures ()
 Release texture resoures of widget. More...
 
local releaseResoures ()
 Release texture resoures of widget. More...
 
void scrollToTopEvent ()
void scrollToBottomEvent ()
var scrollToBottomEvent ()
local scrollToBottomEvent ()
void scrollToLeftEvent ()
var scrollToLeftEvent ()
local scrollToLeftEvent ()
void scrollToRightEvent ()
var scrollToRightEvent ()
local scrollToRightEvent ()
void setMoveDirection (SCROLLVIEW_MOVE_DIR dir)
var setMoveDirection ( var dir)
local setMoveDirection ( local dir)
SCROLLVIEW_MOVE_DIR getMoveDirection ()
local getMoveDirection ()
virtual void onSizeChanged ()
var onSizeChanged ()
local onSizeChanged ()
virtual void setClippingEnabled (bool able)
 Changes if layout can clip it's content and child. More...
 
local setClippingEnabled ( local 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 ()
local onPressStateChangedToNormal ()
virtual void onPressStateChangedToPressed ()
virtual void onPressStateChangedToDisabled ()
void pushDownEvent ()
void moveEvent ()
void releaseUpEvent ()
void cancelUpEvent ()
void longClickEvent ()
void updateAnchorPoint ()
var updateAnchorPoint ()
local updateAnchorPoint ()
void updateSizeAndPosition ()

Protected Attributes

Layout_innerContainer
var _innerContainer
local _innerContainer
SCROLLVIEW_DIR _direction
var _direction
local _direction
SCROLLVIEW_MOVE_DIR _moveDirection
var _moveDirection
local _moveDirection
float _touchStartLocation
float _touchEndLocation
var _touchEndLocation
float _touchMoveStartLocation
float _topBoundary
float _bottomBoundary
float _leftBoundary
float _rightBoundary
bool _topEnd
bool _bottomEnd
bool _leftEnd
bool _rightEnd
bool _autoScroll
var _autoScroll
local _autoScroll
float _autoScrollOriginalSpeed
var _autoScrollOriginalSpeed
local _autoScrollOriginalSpeed
float _autoScrollAcceleration
var _autoScrollAcceleration
local _autoScrollAcceleration
bool _bePressed
float _slidTime
Point _moveChildPoint
var _moveChildPoint
local _moveChildPoint
float _childFocusCancelOffset
var _childFocusCancelOffset
local _childFocusCancelOffset
Object_eventListener
SEL_ScrollViewEvent _eventSelector
var _eventSelector
local _eventSelector
- Protected Attributes inherited from Layout
bool _clippingEnabled
var _clippingEnabled
local _clippingEnabled
bool _backGroundScale9Enabled
Node_backGroundImage
var _backGroundImage
local _backGroundImage
std::string _backGroundImageFileName
var _backGroundImageFileName
local _backGroundImageFileName
Rect _backGroundImageCapInsets
LayoutBackGroundColorType _colorType
var _colorType
local _colorType
TextureResType _bgImageTexType
LayerColor_colorRender
var _colorRender
local _colorRender
LayerGradient_gradientRender
var _gradientRender
local _gradientRender
Color3B _cColor
Color3B _gStartColor
var _gStartColor
local _gStartColor
Color3B _gEndColor
var _gEndColor
local _gEndColor
Point _alongVector
var _alongVector
local _alongVector
int _cOpacity
Size _backGroundImageTextureSize
var _backGroundImageTextureSize
local _backGroundImageTextureSize
LayoutType _layoutType
var _layoutType
local _layoutType
- Protected Attributes inherited from UIWidget
bool _enabled
 Highest control of widget. More...
 
bool _visible
 is this widget visible More...
 
var _visible
 is this widget visible More...
 
local _visible
 is this widget visible More...
 
bool _bright
 is this widget bright More...
 
bool _touchEnabled
 is this widget touch endabled More...
 
var _touchEnabled
 is this widget touch endabled More...
 
local _touchEnabled
 is this widget touch endabled More...
 
bool _touchPassedEnabled
 is the touch event should be passed More...
 
bool _focus
 is the widget on focus More...
 
int _widgetZOrder
 z-order value that affects the draw order and touch order More...
 
Point _anchorPoint
 anchor point normalized More...
 
var _anchorPoint
 anchor point normalized More...
 
local _anchorPoint
 anchor point normalized More...
 
UIWidget_widgetParent
 parent of widget More...
 
BrightStyle _brightStyle
 bright style More...
 
bool _updateEnabled
 is "update" method scheduled More...
 
var _updateEnabled
 is "update" method scheduled More...
 
local _updateEnabled
 is "update" method scheduled More...
 
Node_renderer
 base renderer More...
 
Point _touchStartPos
 touch began point More...
 
var _touchStartPos
 touch began point More...
 
local _touchStartPos
 touch began point More...
 
Point _touchMovePos
 touch moved point More...
 
var _touchMovePos
 touch moved point More...
 
local _touchMovePos
 touch moved point More...
 
Point _touchEndPos
 touch ended point More...
 
var _touchEndPos
 touch ended point More...
 
local _touchEndPos
 touch ended point More...
 
Object_touchEventListener
SEL_TouchEvent _touchEventSelector
var _touchEventSelector
local _touchEventSelector
int _widgetTag
std::string _name
var _name
local _name
WidgetType _widgetType
var _widgetType
local _widgetType
int _actionTag
var _actionTag
local _actionTag
Size _size
Size _customSize
var _customSize
local _customSize
LayoutParameter_layoutParameter
var _layoutParameter
local _layoutParameter
bool _ignoreSize
Array_children
var _children
local _children
bool _affectByClipping
var _affectByClipping
local _affectByClipping
Scheduler_scheduler
SizeType _sizeType
var _sizeType
local _sizeType
Point _sizePercent
var _sizePercent
local _sizePercent
PositionType _positionType
var _positionType
local _positionType
Point _positionPercent
var _positionPercent
local _positionPercent
bool _isRunning
- 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 Attributes inherited from Object
unsigned int _ID
 object id, ScriptSupport need public _ID More...
 
int _luaID
 Lua reference id. More...
 

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 ( Object 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 autoScrollChildren ( float  dt)
protected
var autoScrollChildren ( var  dt)
protected
local autoScrollChildren ( local  dt)
protected
virtual void checkChildInfo ( int  handleState,
UIWidget sender,
const Point 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 Array* 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 Size& 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 Point touchPoint)
protectedvirtual

Implements UIScrollInterface.

var handleMoveLogic ( var  touchPoint)
protectedvirtual

Implements UIScrollInterface.

local handleMoveLogic ( local  touchPoint)
protectedvirtual

Implements UIScrollInterface.

virtual void handlePressLogic ( const Point touchPoint)
protectedvirtual

Implements UIScrollInterface.

var handlePressLogic ( var  touchPoint)
protectedvirtual

Implements UIScrollInterface.

local handlePressLogic ( local  touchPoint)
protectedvirtual

Implements UIScrollInterface.

virtual void handleReleaseLogic ( const Point 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 Point 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 Point 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 Point 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 Point 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 Point 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 Point 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 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 Size 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 Object.

var update ( var  dt)
virtual

Reimplemented from Object.

local update ( local  dt)
virtual

Reimplemented from Object.

Member Data Documentation

bool _autoScroll
protected
var _autoScroll
protected
local _autoScroll
protected
float _autoScrollAcceleration
protected
var _autoScrollAcceleration
protected
local _autoScrollAcceleration
protected
float _autoScrollOriginalSpeed
protected
var _autoScrollOriginalSpeed
protected
local _autoScrollOriginalSpeed
protected
bool _bePressed
protected
var _bePressed
protected
local _bePressed
protected
float _bottomBoundary
protected
var _bottomBoundary
protected
local _bottomBoundary
protected
bool _bottomEnd
protected
var _bottomEnd
protected
local _bottomEnd
protected
float _childFocusCancelOffset
protected
var _childFocusCancelOffset
protected
local _childFocusCancelOffset
protected
SCROLLVIEW_DIR _direction
protected
var _direction
protected
local _direction
protected
Object* _eventListener
protected
var _eventListener
protected
local _eventListener
protected
SEL_ScrollViewEvent _eventSelector
protected
var _eventSelector
protected
local _eventSelector
protected
Layout* _innerContainer
protected
var _innerContainer
protected
local _innerContainer
protected
float _leftBoundary
protected
var _leftBoundary
protected
local _leftBoundary
protected
bool _leftEnd
protected
var _leftEnd
protected
local _leftEnd
protected
Point _moveChildPoint
protected
var _moveChildPoint
protected
local _moveChildPoint
protected
SCROLLVIEW_MOVE_DIR _moveDirection
protected
var _moveDirection
protected
local _moveDirection
protected
float _rightBoundary
protected
var _rightBoundary
protected
local _rightBoundary
protected
bool _rightEnd
protected
var _rightEnd
protected
local _rightEnd
protected
float _slidTime
protected
var _slidTime
protected
local _slidTime
protected
float _topBoundary
protected
var _topBoundary
protected
local _topBoundary
protected
bool _topEnd
protected
var _topEnd
protected
local _topEnd
protected
float _touchEndLocation
protected
var _touchEndLocation
protected
local _touchEndLocation
protected
float _touchMoveStartLocation
protected
var _touchMoveStartLocation
protected
local _touchMoveStartLocation
protected
float _touchStartLocation
protected
var _touchStartLocation
protected
local _touchStartLocation
protected

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