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

#include <UIPageView.h>

Inheritance diagram for UIPageView:
Layout UIScrollInterface UIWidget CCObject CCCopying

Public Member Functions

 UIPageView ()
 Default constructor. More...
 
virtual ~UIPageView ()
 Default destructor. More...
 
local ~UIPageView ()
 Default destructor. More...
 
void addWidgetToPage (UIWidget *widget, int pageIdx, bool forceCreate)
 Add a widget to a page of pageview. More...
 
void addPage (Layout *page)
 Push back a page to pageview. More...
 
void insertPage (Layout *page, int idx)
 Inert a page to pageview. More...
 
void removePage (Layout *page)
 Remove a page of pageview. More...
 
void removePageAtIndex (int index)
 Remove a page at index of pageview. More...
 
void scrollToPage (int idx)
 scroll pageview to index. More...
 
int getCurPageIndex () const
 Gets current page index. More...
 
void addEventListener (CCObject *target, SEL_PageViewEvent selector)
var addEventListener ( var target, var selector)
local addEventListener ( local target, local selector)
void addPageTurningEvent (CCObject *target, SEL_PageViewPageTurningEvent selector)
virtual bool removeChild (UIWidget *widget)
 Removes a child from the container with a cleanup. More...
 
virtual void removeAllChildren ()
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
local removeAllChildren ()
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. 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...
 
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...
 
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...
 
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 update (float dt)
virtual void doLayout ()
local doLayout ()
virtual const char * getDescription () const
 Returns the "class name" of widget. More...
 
int getPage () const
 These methods will be removed. More...
 
void removePage (Layout *page, bool cleanup)
void removePageAtIndex (int index, bool cleanup)
- 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...
 
virtual void setLayoutType (LayoutType type)
 Sets LayoutType. More...
 
virtual LayoutType getLayoutType () const
 Gets LayoutType. 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...
 
virtual CCArraygetChildren ()
 Return an array of children. 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...
 
virtual void onTouchLongClicked (const CCPoint &touchPoint)
 A call back function called when widget is selected, and on touch long clicked. 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 UIPageViewcreate ()
 Allocates and initializes. More...
 
var create ()
 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 addChild (UIWidget *widget)
 Adds a child to the container. More...
 
virtual bool init ()
LayoutcreatePage ()
local createPage ()
float getPositionXByIndex (int idx)
var getPositionXByIndex ( var idx)
local getPositionXByIndex ( local idx)
void updateBoundaryPages ()
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)
var handleReleaseLogic ( var touchPoint)
local handleReleaseLogic ( local 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)
virtual bool scrollPages (float touchOffset)
void movePages (float offset)
void pageTurningEvent ()
void updateChildrenSize ()
void updateChildrenPosition ()
virtual void onSizeChanged ()
virtual void setClippingEnable (bool is)
 These methods will be removed. More...
 
var setClippingEnable ( var 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
virtual void initRenderer ()
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 ()
virtual void releaseResoures ()
 Release texture resoures of widget. More...
 
void updateSizeAndPosition ()

Protected Attributes

int m_nCurPageIdx
CCArraym_pages
var m_pages
local m_pages
PVTouchDir m_touchMoveDir
var m_touchMoveDir
local m_touchMoveDir
float m_fTouchStartLocation
var m_fTouchStartLocation
local m_fTouchStartLocation
float m_fTouchEndLocation
var m_fTouchEndLocation
local m_fTouchEndLocation
float m_fTouchMoveStartLocation
var m_fTouchMoveStartLocation
local m_fTouchMoveStartLocation
CCPoint movePagePoint
UIWidgetm_pLeftChild
var m_pLeftChild
local m_pLeftChild
UIWidgetm_pRightChild
var m_pRightChild
local m_pRightChild
float m_fLeftBoundary
var m_fLeftBoundary
local m_fLeftBoundary
float m_fRightBoundary
var m_fRightBoundary
local m_fRightBoundary
bool m_bIsAutoScrolling
var m_bIsAutoScrolling
local m_bIsAutoScrolling
float m_fAutoScrollDistance
var m_fAutoScrollDistance
local m_fAutoScrollDistance
float m_fAutoScrollSpeed
var m_fAutoScrollSpeed
local m_fAutoScrollSpeed
int m_nAutoScrollDir
var m_nAutoScrollDir
local m_nAutoScrollDir
float m_fChildFocusCancelOffset
var m_fChildFocusCancelOffset
local m_fChildFocusCancelOffset
CCObjectm_pEventListener
var m_pEventListener
local m_pEventListener
SEL_PageViewEvent m_pfnEventSelector
var m_pfnEventSelector
local m_pfnEventSelector
CCObjectm_pPageTurningListener
var m_pPageTurningListener
local m_pPageTurningListener
SEL_PageViewPageTurningEvent m_pfnPageTurningSelector
- 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 UIPageView ( )

Default constructor.

local UIPageView ( )

Default constructor.

virtual ~UIPageView ( )
virtual

Default destructor.

var ~UIPageView ( )
virtual

Default destructor.

local ~UIPageView ( )
virtual

Default destructor.

Member Function Documentation

virtual bool addChild ( UIWidget child)
protectedvirtual

Adds a child to the container.

Parameters
childA child widget

Reimplemented from UIWidget.

var addChild ( var  child)
protectedvirtual

Adds a child to the container.

Parameters
childA child widget

Reimplemented from UIWidget.

local addChild ( local  child)
protectedvirtual

Adds a child to the container.

Parameters
childA child widget

Reimplemented from UIWidget.

void addEventListener ( CCObject target,
SEL_PageViewEvent  selector 
)
var addEventListener ( var  target,
var  selector 
)
local addEventListener ( local  target,
local  selector 
)
void addPage ( Layout page)

Push back a page to pageview.

Parameters
pagepage to be added to pageview.
var addPage ( var  page)

Push back a page to pageview.

Parameters
pagepage to be added to pageview.
local addPage ( local  page)

Push back a page to pageview.

Parameters
pagepage to be added to pageview.
void addPageTurningEvent ( CCObject target,
SEL_PageViewPageTurningEvent  selector 
)
var addPageTurningEvent ( var  target,
var  selector 
)
local addPageTurningEvent ( local  target,
local  selector 
)
void addWidgetToPage ( UIWidget widget,
int  pageIdx,
bool  forceCreate 
)

Add a widget to a page of pageview.

Parameters
widgetwidget to be added to pageview.
pageIdxindex of page.
forceCreateif force create and there is no page exsit, pageview would create a default page for adding widget.
var addWidgetToPage ( var  widget,
var  pageIdx,
var  forceCreate 
)

Add a widget to a page of pageview.

Parameters
widgetwidget to be added to pageview.
pageIdxindex of page.
forceCreateif force create and there is no page exsit, pageview would create a default page for adding widget.
local addWidgetToPage ( local  widget,
local  pageIdx,
local  forceCreate 
)

Add a widget to a page of pageview.

Parameters
widgetwidget to be added to pageview.
pageIdxindex of page.
forceCreateif force create and there is no page exsit, pageview would create a default page for adding widget.
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 UIPageView* create ( )
static

Allocates and initializes.

var create ( )
static

Allocates and initializes.

local create ( )
static

Allocates and initializes.

Layout* createPage ( )
protected
var createPage ( )
protected
local createPage ( )
protected
virtual void doLayout ( )
inlinevirtual

Reimplemented from Layout.

var doLayout ( )
inlinevirtual

Reimplemented from Layout.

local doLayout ( )
inlinevirtual

Reimplemented from Layout.

int getCurPageIndex ( ) const

Gets current page index.

Returns
current page index.
var getCurPageIndex ( )

Gets current page index.

Returns
current page index.
local getCurPageIndex ( )

Gets current page index.

Returns
current page index.
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.

int getPage ( ) const
inline

These methods will be removed.

var getPage ( )
inline

These methods will be removed.

local getPage ( )
inline

These methods will be removed.

float getPositionXByIndex ( int  idx)
protected
var getPositionXByIndex ( var  idx)
protected
local getPositionXByIndex ( local  idx)
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.

void insertPage ( Layout page,
int  idx 
)

Inert a page to pageview.

Parameters
pagepage to be added to pageview.
var insertPage ( var  page,
var  idx 
)

Inert a page to pageview.

Parameters
pagepage to be added to pageview.
local insertPage ( local  page,
local  idx 
)

Inert a page to pageview.

Parameters
pagepage to be added to pageview.
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 movePages ( float  offset)
protected
var movePages ( var  offset)
protected
local movePages ( 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 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 pageTurningEvent ( )
protected
var pageTurningEvent ( )
protected
local pageTurningEvent ( )
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.

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.

void removePage ( Layout page)

Remove a page of pageview.

Parameters
pagepage which will be removed.
var removePage ( var  page)

Remove a page of pageview.

Parameters
pagepage which will be removed.
local removePage ( local  page)

Remove a page of pageview.

Parameters
pagepage which will be removed.
void removePage ( Layout page,
bool  cleanup 
)
inline
var removePage ( var  page,
var  cleanup 
)
inline
local removePage ( local  page,
local  cleanup 
)
inline
void removePageAtIndex ( int  index)

Remove a page at index of pageview.

Parameters
indexindex of page.
var removePageAtIndex ( var  index)

Remove a page at index of pageview.

Parameters
indexindex of page.
local removePageAtIndex ( local  index)

Remove a page at index of pageview.

Parameters
indexindex of page.
void removePageAtIndex ( int  index,
bool  cleanup 
)
inline
var removePageAtIndex ( var  index,
var  cleanup 
)
inline
local removePageAtIndex ( local  index,
local  cleanup 
)
inline
virtual bool scrollPages ( float  touchOffset)
protectedvirtual
var scrollPages ( var  touchOffset)
protectedvirtual
local scrollPages ( local  touchOffset)
protectedvirtual
void scrollToPage ( int  idx)

scroll pageview to index.

Parameters
idxindex of page.
var scrollToPage ( var  idx)

scroll pageview to index.

Parameters
idxindex of page.
local scrollToPage ( local  idx)

scroll pageview to index.

Parameters
idxindex of page.
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.

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.

void updateBoundaryPages ( )
protected
var updateBoundaryPages ( )
protected
local updateBoundaryPages ( )
protected
void updateChildrenPosition ( )
protected
var updateChildrenPosition ( )
protected
local updateChildrenPosition ( )
protected
void updateChildrenSize ( )
protected
var updateChildrenSize ( )
protected
local updateChildrenSize ( )
protected

Member Data Documentation

bool m_bIsAutoScrolling
protected
var m_bIsAutoScrolling
protected
local m_bIsAutoScrolling
protected
float m_fAutoScrollDistance
protected
var m_fAutoScrollDistance
protected
local m_fAutoScrollDistance
protected
float m_fAutoScrollSpeed
protected
var m_fAutoScrollSpeed
protected
local m_fAutoScrollSpeed
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_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
int m_nAutoScrollDir
protected
var m_nAutoScrollDir
protected
local m_nAutoScrollDir
protected
int m_nCurPageIdx
protected
CCArray* m_pages
protected
var m_pages
protected
local m_pages
protected
CCObject* m_pEventListener
protected
var m_pEventListener
protected
local m_pEventListener
protected
SEL_PageViewEvent
m_pfnEventSelector
protected
var m_pfnEventSelector
protected
local m_pfnEventSelector
protected
SEL_PageViewPageTurningEvent
m_pfnPageTurningSelector
protected
var m_pfnPageTurningSelector
protected
local m_pfnPageTurningSelector
protected
UIWidget* m_pLeftChild
protected
var m_pLeftChild
protected
local m_pLeftChild
protected
CCObject* m_pPageTurningListener
protected
var m_pPageTurningListener
protected
local m_pPageTurningListener
protected
UIWidget* m_pRightChild
protected
var m_pRightChild
protected
local m_pRightChild
protected
PVTouchDir m_touchMoveDir
protected
var m_touchMoveDir
protected
local m_touchMoveDir
protected
CCPoint movePagePoint
protected
var movePagePoint
protected
local movePagePoint
protected

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