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

#include <UIPageView.h>

Inheritance diagram for UIPageView:
UILayout UIScrollInterface UIWidget Object

Public Member Functions

 UIPageView ()
 Default constructor. More...
 
 ctor ()
 Default constructor. More...
 
 UIPageView ()
 Default constructor. More...
 
virtual ~UIPageView ()
 Default destructor. More...
 
void addWidgetToPage (UIWidget *widget, int pageIdx, bool forceCreate)
 Add a widget to a page of pageview. More...
 
void addPage (UILayout *page)
 Push back a page to pageview. More...
 
void insertPage (UILayout *page, int idx)
 Inert a page to pageview. More...
 
var insertPage ( var page, var idx)
 Inert a page to pageview. More...
 
local insertPage ( local page, local idx)
 Inert a page to pageview. More...
 
void removePage (UILayout *page)
 Remove a page of pageview. More...
 
void removePageAtIndex (int index)
 Remove a page at index of pageview. More...
 
var removePageAtIndex ( var index)
 Remove a page at index of pageview. More...
 
local removePageAtIndex ( local index)
 Remove a page at index of pageview. More...
 
void removeAllPages ()
void scrollToPage (int idx)
 scroll pageview to index. More...
 
var scrollToPage ( var idx)
 scroll pageview to index. More...
 
local scrollToPage ( local idx)
 scroll pageview to index. More...
 
int getCurPageIndex () const
 Gets current page index. More...
 
cocos2d::ArraygetPages ()
var getPages ()
local getPages ()
UILayoutgetPage (int index)
var getPage ( var index)
local getPage ( local index)
void addEventListenerPageView (cocos2d::Object *target, SEL_PageViewEvent selector)
var addEventListenerPageView ( var target, var selector)
local addEventListenerPageView ( local target, local selector)
virtual bool onTouchBegan (const cocos2d::Point &touchPoint) override
 override "onTouchBegan" method of widget. More...
 
virtual void onTouchMoved (const cocos2d::Point &touchPoint) override
 override "onTouchMoved" method of widget. More...
 
virtual void onTouchEnded (const cocos2d::Point &touchPoint) override
 override "onTouchEnded" method of widget. More...
 
virtual void onTouchCancelled (const cocos2d::Point &touchPoint) override
 override "onTouchCancelled" method of widget. More...
 
virtual void update (float dt) override
virtual void doLayout () override
var doLayout ()
local doLayout ()
virtual void setLayoutType (LayoutType type) override
 Sets LayoutType. More...
 
var setLayoutType ( var type)
 Sets LayoutType. More...
 
local setLayoutType ( local type)
 Sets LayoutType. More...
 
virtual LayoutType getLayoutType () const override
 Gets LayoutType. More...
 
virtual const char * getDescription () const override
 Returns the "class name" of widget. More...
 
local getDescription ()
 Returns the "class name" of widget. More...
 
- Public Member Functions inherited from UILayout
 UILayout ()
virtual ~UILayout ()
 Default destructor. More...
 
virtual bool hitTest (const cocos2d::Point &pt) override
 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 cocos2d::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...
 
local setBackGroundColorType ( local type)
 Sets Color Type for layout. More...
 
void setBackGroundImageScale9Enabled (bool enabled)
 Sets background iamge use scale9 renderer. More...
 
var setBackGroundImageScale9Enabled ( var enabled)
 Sets background iamge use scale9 renderer. More...
 
local setBackGroundImageScale9Enabled ( local enabled)
 Sets background iamge use scale9 renderer. More...
 
void setBackGroundColor (const cocos2d::Color3B &color)
 Sets background color for layout, if color type is LAYOUT_COLOR_SOLID. More...
 
void setBackGroundColor (const cocos2d::Color3B &startColor, const cocos2d::Color3B &endColor)
 Sets background color for layout, if color type is LAYOUT_COLOR_GRADIENT. More...
 
var setBackGroundColor ( var startColor, var endColor)
 Sets background color for layout, if color type is LAYOUT_COLOR_GRADIENT. More...
 
local setBackGroundColor ( local startColor, local 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 cocos2d::Point &vector)
 Sets background color vector for layout, if color type is LAYOUT_COLOR_GRADIENT. More...
 
virtual void setColor (const cocos2d::Color3B &color) override
 Sets color to widget. More...
 
virtual void setOpacity (int opacity) override
 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 cocos2d::SizegetBackGroundImageTextureSize () const
 Gets background image texture size. More...
 
var getBackGroundImageTextureSize ()
 Gets background image texture size. More...
 
local getBackGroundImageTextureSize ()
 Gets background image texture size. More...
 
virtual bool isClippingEnabled ()
 Gets if layout is clipping enabled. More...
 
virtual const cocos2d::SizegetContentSize () const override
 Gets the content size of widget. More...
 
local getContentSize ()
 Gets the content size of widget. More...
 
- Public Member Functions inherited from UIWidget
 UIWidget (void)
 ctor ()
virtual ~UIWidget ()
 Default destructor. More...
 
virtual void setEnabled (bool enabled)
 Sets whether the widget is enabled. More...
 
local setEnabled ( local 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...
 
var setVisible ( var visible)
 Sets whether the widget is visible. More...
 
local setVisible ( local 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...
 
var setBrightStyle ( var style)
 To set the bright style of widget. More...
 
local setBrightStyle ( local 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...
 
var getLeftInParent ()
 Gets the left boundary position of this widget. More...
 
local 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...
 
var getRightInParent ()
 Gets the right boundary position of this widget. More...
 
local getRightInParent ()
 Gets the right boundary position of this widget. More...
 
float getTopInParent ()
 Gets the top boundary position of this widget. More...
 
var getTopInParent ()
 Gets the top boundary position of this widget. More...
 
local getTopInParent ()
 Gets the top boundary position of this widget. More...
 
virtual void removeFromParent ()
 Removes this widget itself from its parent widget. More...
 
local 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...
 
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...
 
cocos2d::NodegetRenderer ()
 Gets the renderer of widget. More...
 
void addRenderer (cocos2d::Node *renderer, int zOrder)
 Add a Node for rendering. More...
 
var addRenderer ( var renderer, var zOrder)
 Add a Node for rendering. More...
 
local addRenderer ( local renderer, local zOrder)
 Add a Node for rendering. More...
 
void removeRenderer (cocos2d::Node *renderer, bool cleanup)
 Remove a Node from widget. More...
 
local removeRenderer ( local renderer, local cleanup)
 Remove a Node from widget. More...
 
void setParent (UIWidget *parent)
 Sets the parent widget. More...
 
local setParent ( local parent)
 Sets the parent widget. More...
 
UIWidgetgetParent ()
 Returns a pointer to the parent widget. More...
 
void addTouchEventListener (cocos2d::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 cocos2d::Point &pos)
 Changes the position (x,y) of the widget in OpenGL coordinates. More...
 
void setPositionPercent (const cocos2d::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 cocos2d::PointgetPosition ()
 Gets the position (x,y) of the widget in OpenGL coordinates. More...
 
const cocos2d::PointgetPositionPercent ()
 Gets the percent (x,y) of the widget in OpenGL coordinates. More...
 
var getPositionPercent ()
 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...
 
var getPositionType ()
 Gets the position type of the widget. More...
 
local getPositionType ()
 Gets the position type of the widget. More...
 
virtual void setAnchorPoint (const cocos2d::Point &pt)
 Sets the anchor point in percent. More...
 
local setAnchorPoint ( local pt)
 Sets the anchor point in percent. More...
 
const cocos2d::PointgetAnchorPoint ()
 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...
 
var setScaleX ( var 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...
 
var getScaleY ()
 Returns the scale factor on Y axis of this widget. More...
 
local 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...
 
var getRotationY ()
 Gets the Y rotation (angle) of the widget in degrees which performs a vertical rotational skew. More...
 
local 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...
 
local setFlipX ( local 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...
 
local setFlipY ( local 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 cocos2d::Color3BgetColor ()
 Gets color of widget. More...
 
local getColor ()
 Gets color of widget. More...
 
virtual int getOpacity ()
 Gets opacity of widget. More...
 
virtual bool isCascadeOpacityEnabled ()
var isCascadeOpacityEnabled ()
local isCascadeOpacityEnabled ()
virtual void setCascadeOpacityEnabled (bool cascadeOpacityEnabled)
virtual bool isCascadeColorEnabled ()
var isCascadeColorEnabled ()
local isCascadeColorEnabled ()
virtual void setCascadeColorEnabled (bool cascadeColorEnabled)
void setBlendFunc (cocos2d::BlendFunc blendFunc)
virtual void setActionManager (cocos2d::ActionManager *actionManager)
local setActionManager ( local actionManager)
virtual cocos2d::ActionManagergetActionManager ()
local getActionManager ()
cocos2d::ActionrunAction (cocos2d::Action *action)
var runAction ( var action)
local runAction ( local action)
void stopAllActions (void)
var stopAllActions ()
local stopAllActions ()
void stopAction (cocos2d::Action *action)
var stopAction ( var action)
local stopAction ( local action)
void stopActionByTag (int tag)
var stopActionByTag ( var tag)
local stopActionByTag ( local tag)
cocos2d::ActiongetActionByTag (int tag)
var getActionByTag ( var tag)
local getActionByTag ( local 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 cocos2d::Point &pt)
var clippingParentAreaContainPoint ( var pt)
local clippingParentAreaContainPoint ( local pt)
const cocos2d::PointgetTouchStartPos ()
var getTouchStartPos ()
local getTouchStartPos ()
const cocos2d::PointgetTouchMovePos ()
local getTouchMovePos ()
const cocos2d::PointgetTouchEndPos ()
void setTag (int tag)
 Changes the tag that is used to identify the widget easily. More...
 
local setTag ( local 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...
 
var getTag ()
 Returns a tag that is used to identify the widget easily. More...
 
local getTag ()
 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...
 
var setName ( var name)
 Changes the name that is used to identify the widget easily. More...
 
local setName ( local 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 cocos2d::Size &size)
 Changes the size that is widget's size. More...
 
virtual void setSizePercent (const cocos2d::Point &percent)
 Changes the percent that is widget's percent size. More...
 
local setSizePercent ( local percent)
 Changes the percent that is widget's percent size. More...
 
void setSizeType (SizeType type)
 Changes the size type of widget. More...
 
var setSizeType ( var type)
 Changes the size type of widget. More...
 
local setSizeType ( local type)
 Changes the size type of widget. More...
 
SizeType getSizeType () const
 Gets the size type of widget. More...
 
var getSizeType ()
 Gets the size type of widget. More...
 
local getSizeType ()
 Gets the size type of widget. More...
 
const cocos2d::SizegetSize () const
 Returns size of widget. More...
 
const cocos2d::PointgetSizePercent () const
 Returns size percent of widget. More...
 
local getSizePercent ()
 Returns size percent of widget. More...
 
virtual void onTouchLongClicked (const cocos2d::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...
 
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...
 
var ignoreContentAdaptWithSize ( var ignore)
 Ignore the widget size. More...
 
local ignoreContentAdaptWithSize ( local ignore)
 Ignore the widget size. More...
 
bool isIgnoreContentAdaptWithSize () const
 Gets the widget if is ignore it's size. More...
 
var isIgnoreContentAdaptWithSize ()
 Gets the widget if is ignore it's size. More...
 
local isIgnoreContentAdaptWithSize ()
 Gets the widget if is ignore it's size. More...
 
cocos2d::Point getWorldPosition ()
 Gets world position of widget. More...
 
local getWorldPosition ()
 Gets world position of widget. More...
 
cocos2d::Point convertToWorldSpace (const cocos2d::Point &pt)
 Converts a Point to world space coordinates. More...
 
local convertToWorldSpace ( local pt)
 Converts a Point to world space coordinates. More...
 
virtual cocos2d::NodegetVirtualRenderer ()
 Gets the Virtual Renderer of widget. More...
 
local getVirtualRenderer ()
 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 ()
var clone ()
local clone ()
virtual void onEnter ()
virtual void onExit ()
void updateSizeAndPosition ()
var updateSizeAndPosition ()
local updateSizeAndPosition ()
virtual ObjectgetUserObject ()
virtual const ObjectgetUserObject () const
virtual void setUserObject (Object *userObject)
 Returns a user assigned Object. More...
 
void setActionTag (int tag)
var setActionTag ( var tag)
local setActionTag ( local tag)
int getActionTag ()
var getActionTag ()
local 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)
- Public Member Functions inherited from UIScrollInterface
virtual ~UIScrollInterface ()

Static Public Member Functions

static UIPageViewcreate ()
 Allocates and initializes. More...
 
- Static Public Member Functions inherited from UILayout
static UILayoutcreate ()
 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 addChild (UIWidget *widget) override
 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 bool removeChild (UIWidget *widget) override
 Removes a child from the container with a cleanup. More...
 
local removeChild ( local widget)
 Removes a child from the container with a cleanup. More...
 
virtual void removeAllChildren () override
 Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More...
 
virtual cocos2d::ArraygetChildren () override
 Return an array of children. More...
 
local getChildren ()
 Return an array of children. More...
 
virtual bool init () override
UILayoutcreatePage ()
local createPage ()
float getPositionXByIndex (int idx)
var getPositionXByIndex ( var idx)
local getPositionXByIndex ( local idx)
void updateBoundaryPages ()
var updateBoundaryPages ()
local updateBoundaryPages ()
virtual void handlePressLogic (const cocos2d::Point &touchPoint) override
virtual void handleMoveLogic (const cocos2d::Point &touchPoint) override
virtual void handleReleaseLogic (const cocos2d::Point &touchPoint) override
virtual void interceptTouchEvent (int handleState, UIWidget *sender, const cocos2d::Point &touchPoint) override
var interceptTouchEvent ( var handleState, var sender, var touchPoint)
local interceptTouchEvent ( local handleState, local sender, local touchPoint)
virtual void checkChildInfo (int handleState, UIWidget *sender, const cocos2d::Point &touchPoint) override
virtual bool scrollPages (float touchOffset)
void movePages (float offset)
var movePages ( var offset)
local movePages ( local offset)
void pageTurningEvent ()
var pageTurningEvent ()
local pageTurningEvent ()
void updateChildrenSize ()
var updateChildrenSize ()
local updateChildrenSize ()
void updateChildrenPosition ()
var updateChildrenPosition ()
local updateChildrenPosition ()
virtual void onSizeChanged () override
virtual UIWidgetcreateCloneInstance () override
local createCloneInstance ()
virtual void copySpecialProperties (UIWidget *model) override
virtual void copyClonedWidgetChildren (UIWidget *model) override
virtual void setClippingEnabled (bool enabled) override
 Changes if layout can clip it's content and child. More...
 
- Protected Member Functions inherited from UILayout
virtual void initRenderer () override
local initRenderer ()
void addBackGroundImage ()
var addBackGroundImage ()
local addBackGroundImage ()
void supplyTheLayoutParameterLackToChild (UIWidget *child)
var supplyTheLayoutParameterLackToChild ( var child)
local supplyTheLayoutParameterLackToChild ( local child)
- Protected Member Functions inherited from UIWidget
virtual void onPressStateChangedToNormal ()
var onPressStateChangedToNormal ()
local onPressStateChangedToNormal ()
virtual void onPressStateChangedToPressed ()
var onPressStateChangedToPressed ()
local onPressStateChangedToPressed ()
virtual void onPressStateChangedToDisabled ()
local onPressStateChangedToDisabled ()
void pushDownEvent ()
var pushDownEvent ()
local pushDownEvent ()
void moveEvent ()
var moveEvent ()
local moveEvent ()
void releaseUpEvent ()
var releaseUpEvent ()
local releaseUpEvent ()
void cancelUpEvent ()
var cancelUpEvent ()
local cancelUpEvent ()
void longClickEvent ()
var longClickEvent ()
local longClickEvent ()
void updateAnchorPoint ()
var updateAnchorPoint ()
local updateAnchorPoint ()
void copyProperties (UIWidget *model)
var copyProperties ( var model)
local copyProperties ( local model)

Protected Attributes

int _curPageIdx
cocos2d::Array_pages
var _pages
local _pages
PVTouchDir _touchMoveDir
var _touchMoveDir
local _touchMoveDir
float _touchStartLocation
var _touchStartLocation
local _touchStartLocation
float _touchMoveStartLocation
var _touchMoveStartLocation
local _touchMoveStartLocation
cocos2d::Point _movePagePoint
var _movePagePoint
local _movePagePoint
UIWidget_leftChild
var _leftChild
local _leftChild
UIWidget_rightChild
var _rightChild
local _rightChild
float _leftBoundary
var _leftBoundary
local _leftBoundary
float _rightBoundary
var _rightBoundary
local _rightBoundary
bool _isAutoScrolling
var _isAutoScrolling
local _isAutoScrolling
float _autoScrollDistance
var _autoScrollDistance
local _autoScrollDistance
float _autoScrollSpeed
var _autoScrollSpeed
local _autoScrollSpeed
int _autoScrollDir
var _autoScrollDir
local _autoScrollDir
float _childFocusCancelOffset
var _childFocusCancelOffset
local _childFocusCancelOffset
cocos2d::Object_pageViewEventListener
SEL_PageViewEvent _pageViewEventSelector
var _pageViewEventSelector
local _pageViewEventSelector
- Protected Attributes inherited from UILayout
bool _clippingEnabled
bool _backGroundScale9Enabled
var _backGroundScale9Enabled
local _backGroundScale9Enabled
cocos2d::Node_backGroundImage
var _backGroundImage
local _backGroundImage
std::string _backGroundImageFileName
var _backGroundImageFileName
local _backGroundImageFileName
cocos2d::Rect _backGroundImageCapInsets
var _backGroundImageCapInsets
local _backGroundImageCapInsets
LayoutBackGroundColorType _colorType
var _colorType
local _colorType
TextureResType _bgImageTexType
var _bgImageTexType
local _bgImageTexType
cocos2d::LayerColor_colorRender
cocos2d::LayerGradient_gradientRender
var _gradientRender
local _gradientRender
cocos2d::Color3B _cColor
var _cColor
local _cColor
cocos2d::Color3B _gStartColor
var _gStartColor
local _gStartColor
cocos2d::Color3B _gEndColor
var _gEndColor
local _gEndColor
cocos2d::Point _alongVector
var _alongVector
local _alongVector
int _cOpacity
var _cOpacity
local _cOpacity
cocos2d::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...
 
var _bright
 is this widget bright More...
 
local _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...
 
var _touchPassedEnabled
 is the touch event should be passed More...
 
local _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...
 
var _widgetZOrder
 z-order value that affects the draw order and touch order More...
 
local _widgetZOrder
 z-order value that affects the draw order and touch order More...
 
cocos2d::Point _anchorPoint
 anchor point normalized More...
 
var _anchorPoint
 anchor point normalized More...
 
local _anchorPoint
 anchor point normalized More...
 
UIWidget_widgetParent
 parent of widget More...
 
local _widgetParent
 parent of widget More...
 
BrightStyle _brightStyle
 bright style More...
 
var _brightStyle
 bright style More...
 
local _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...
 
cocos2d::Node_renderer
 base renderer More...
 
var _renderer
 base renderer More...
 
local _renderer
 base renderer More...
 
cocos2d::Point _touchStartPos
 touch began point More...
 
var _touchStartPos
 touch began point More...
 
local _touchStartPos
 touch began point More...
 
cocos2d::Point _touchMovePos
 touch moved point More...
 
var _touchMovePos
 touch moved point More...
 
local _touchMovePos
 touch moved point More...
 
cocos2d::Point _touchEndPos
 touch ended point More...
 
var _touchEndPos
 touch ended point More...
 
local _touchEndPos
 touch ended point More...
 
Object_touchEventListener
local _touchEventListener
SEL_TouchEvent _touchEventSelector
var _touchEventSelector
local _touchEventSelector
int _widgetTag
var _widgetTag
local _widgetTag
std::string _name
var _name
local _name
WidgetType _widgetType
var _widgetType
local _widgetType
int _actionTag
var _actionTag
local _actionTag
cocos2d::Size _size
var _size
local _size
cocos2d::Size _customSize
var _customSize
local _customSize
cocos2d::Dictionary_layoutParameterDictionary
var _layoutParameterDictionary
local _layoutParameterDictionary
bool _ignoreSize
var _ignoreSize
local _ignoreSize
cocos2d::Array_children
var _children
local _children
bool _affectByClipping
var _affectByClipping
local _affectByClipping
cocos2d::Scheduler_scheduler
var _scheduler
local _scheduler
SizeType _sizeType
var _sizeType
local _sizeType
cocos2d::Point _sizePercent
var _sizePercent
local _sizePercent
PositionType _positionType
var _positionType
local _positionType
cocos2d::Point _positionPercent
var _positionPercent
local _positionPercent
bool _isRunning
var _isRunning
local _isRunning
cocos2d::Object_userObject
var _userObject
local _userObject
- Protected Attributes inherited from Object
unsigned int _reference
 count of references More...
 
unsigned int _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 ctor ( )

Default constructor.

local UIPageView ( )

Default constructor.

virtual ~UIPageView ( )
virtual

Default destructor.

Member Function Documentation

virtual bool addChild ( UIWidget child)
overrideprotectedvirtual

Adds a child to the container.

Parameters
childA child widget

Reimplemented from UILayout.

var addChild ( var  child)
overrideprotectedvirtual

Adds a child to the container.

Parameters
childA child widget

Reimplemented from UILayout.

local addChild ( local  child)
overrideprotectedvirtual

Adds a child to the container.

Parameters
childA child widget

Reimplemented from UILayout.

void addEventListenerPageView ( cocos2d::Object target,
SEL_PageViewEvent  selector 
)
var addEventListenerPageView ( var  target,
var  selector 
)
local addEventListenerPageView ( local  target,
local  selector 
)
void addPage ( UILayout 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 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 cocos2d::Point touchPoint 
)
overrideprotectedvirtual

Reimplemented from UIWidget.

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

Reimplemented from UIWidget.

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

Reimplemented from UIWidget.

virtual void
copyClonedWidgetChildren
( UIWidget model)
overrideprotectedvirtual

Reimplemented from UILayout.

var copyClonedWidgetChildren ( var  model)
overrideprotectedvirtual

Reimplemented from UILayout.

local copyClonedWidgetChildren ( local  model)
overrideprotectedvirtual

Reimplemented from UILayout.

virtual void copySpecialProperties ( UIWidget model)
overrideprotectedvirtual

Reimplemented from UILayout.

var copySpecialProperties ( var  model)
overrideprotectedvirtual

Reimplemented from UILayout.

local copySpecialProperties ( local  model)
overrideprotectedvirtual

Reimplemented from UILayout.

static UIPageView* create ( )
static

Allocates and initializes.

var create ( )
static

Allocates and initializes.

local create ( )
static

Allocates and initializes.

virtual UIWidget*
createCloneInstance
( )
overrideprotectedvirtual

Reimplemented from UILayout.

var createCloneInstance ( )
overrideprotectedvirtual

Reimplemented from UILayout.

local createCloneInstance ( )
overrideprotectedvirtual

Reimplemented from UILayout.

UILayout* createPage ( )
protected
var createPage ( )
protected
local createPage ( )
protected
virtual void doLayout ( )
inlineoverridevirtual

Reimplemented from UILayout.

var doLayout ( )
inlineoverridevirtual

Reimplemented from UILayout.

local doLayout ( )
inlineoverridevirtual

Reimplemented from UILayout.

virtual cocos2d::Array* getChildren ( )
inlineoverrideprotectedvirtual

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 ( )
inlineoverrideprotectedvirtual

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 ( )
inlineoverrideprotectedvirtual

Return an array of children.

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

Returns
An array of children

Reimplemented from UIWidget.

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
overridevirtual

Returns the "class name" of widget.

Reimplemented from UILayout.

var getDescription ( )
overridevirtual

Returns the "class name" of widget.

Reimplemented from UILayout.

local getDescription ( )
overridevirtual

Returns the "class name" of widget.

Reimplemented from UILayout.

virtual LayoutType getLayoutType ( ) const
inlineoverridevirtual

Gets LayoutType.

See Also
LayoutType
Returns
LayoutType

Reimplemented from UILayout.

var getLayoutType ( )
inlineoverridevirtual

Gets LayoutType.

See Also
LayoutType
Returns
LayoutType

Reimplemented from UILayout.

local getLayoutType ( )
inlineoverridevirtual

Gets LayoutType.

See Also
LayoutType
Returns
LayoutType

Reimplemented from UILayout.

UILayout* getPage ( int  index)
var getPage ( var  index)
local getPage ( local  index)
cocos2d::Array* getPages ( )
var getPages ( )
local getPages ( )
float getPositionXByIndex ( int  idx)
protected
var getPositionXByIndex ( var  idx)
protected
local getPositionXByIndex ( local  idx)
protected
virtual void handleMoveLogic ( const cocos2d::Point touchPoint)
overrideprotectedvirtual

Implements UIScrollInterface.

var handleMoveLogic ( var  touchPoint)
overrideprotectedvirtual

Implements UIScrollInterface.

local handleMoveLogic ( local  touchPoint)
overrideprotectedvirtual

Implements UIScrollInterface.

virtual void handlePressLogic ( const cocos2d::Point touchPoint)
overrideprotectedvirtual

Implements UIScrollInterface.

var handlePressLogic ( var  touchPoint)
overrideprotectedvirtual

Implements UIScrollInterface.

local handlePressLogic ( local  touchPoint)
overrideprotectedvirtual

Implements UIScrollInterface.

virtual void handleReleaseLogic ( const cocos2d::Point touchPoint)
overrideprotectedvirtual

Implements UIScrollInterface.

var handleReleaseLogic ( var  touchPoint)
overrideprotectedvirtual

Implements UIScrollInterface.

local handleReleaseLogic ( local  touchPoint)
overrideprotectedvirtual

Implements UIScrollInterface.

virtual bool init ( )
overrideprotectedvirtual

Reimplemented from UILayout.

var init ( )
overrideprotectedvirtual

Reimplemented from UILayout.

local init ( )
overrideprotectedvirtual

Reimplemented from UILayout.

void insertPage ( UILayout 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 cocos2d::Point touchPoint 
)
overrideprotectedvirtual

Implements UIScrollInterface.

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

Implements UIScrollInterface.

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

Implements UIScrollInterface.

void movePages ( float  offset)
protected
var movePages ( var  offset)
protected
local movePages ( local  offset)
protected
virtual void onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from UILayout.

var onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from UILayout.

local onSizeChanged ( )
overrideprotectedvirtual

Reimplemented from UILayout.

virtual bool onTouchBegan ( const cocos2d::Point touchPoint)
overridevirtual

override "onTouchBegan" method of widget.

Reimplemented from UIWidget.

virtual void onTouchCancelled ( const cocos2d::Point touchPoint)
overridevirtual

override "onTouchCancelled" method of widget.

Reimplemented from UIWidget.

virtual void onTouchEnded ( const cocos2d::Point touchPoint)
overridevirtual

override "onTouchEnded" method of widget.

Reimplemented from UIWidget.

virtual void onTouchMoved ( const cocos2d::Point touchPoint)
overridevirtual

override "onTouchMoved" method of widget.

Reimplemented from UIWidget.

void pageTurningEvent ( )
protected
var pageTurningEvent ( )
protected
local pageTurningEvent ( )
protected
virtual void removeAllChildren ( )
overrideprotectedvirtual

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

Reimplemented from UIWidget.

var removeAllChildren ( )
overrideprotectedvirtual

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

Reimplemented from UIWidget.

local removeAllChildren ( )
overrideprotectedvirtual

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

Reimplemented from UIWidget.

void removeAllPages ( )
var removeAllPages ( )
local removeAllPages ( )
virtual bool removeChild ( UIWidget child)
overrideprotectedvirtual

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)
overrideprotectedvirtual

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)
overrideprotectedvirtual

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 ( UILayout 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 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.
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 setClippingEnabled ( bool  enabled)
inlineoverrideprotectedvirtual

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.

var setClippingEnabled ( var  enabled)
inlineoverrideprotectedvirtual

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.

local setClippingEnabled ( local  enabled)
inlineoverrideprotectedvirtual

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 setLayoutType ( LayoutType  type)
inlineoverridevirtual

Sets LayoutType.

See Also
LayoutType
Parameters
LayoutType

Reimplemented from UILayout.

var setLayoutType ( var  type)
inlineoverridevirtual

Sets LayoutType.

See Also
LayoutType
Parameters
LayoutType

Reimplemented from UILayout.

local setLayoutType ( local  type)
inlineoverridevirtual

Sets LayoutType.

See Also
LayoutType
Parameters
LayoutType

Reimplemented from UILayout.

virtual void update ( float  dt)
overridevirtual

Reimplemented from Object.

var update ( var  dt)
overridevirtual

Reimplemented from Object.

local update ( local  dt)
overridevirtual

Reimplemented from Object.

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

int _autoScrollDir
protected
var _autoScrollDir
protected
local _autoScrollDir
protected
float _autoScrollDistance
protected
var _autoScrollDistance
protected
local _autoScrollDistance
protected
float _autoScrollSpeed
protected
var _autoScrollSpeed
protected
local _autoScrollSpeed
protected
float _childFocusCancelOffset
protected
var _childFocusCancelOffset
protected
local _childFocusCancelOffset
protected
int _curPageIdx
protected
var _curPageIdx
protected
local _curPageIdx
protected
bool _isAutoScrolling
protected
var _isAutoScrolling
protected
local _isAutoScrolling
protected
float _leftBoundary
protected
var _leftBoundary
protected
local _leftBoundary
protected
UIWidget* _leftChild
protected
var _leftChild
protected
local _leftChild
protected
cocos2d::Point _movePagePoint
protected
var _movePagePoint
protected
local _movePagePoint
protected
cocos2d::Array* _pages
protected
var _pages
protected
local _pages
protected
cocos2d::Object*
_pageViewEventListener
protected
var _pageViewEventListener
protected
local _pageViewEventListener
protected
SEL_PageViewEvent
_pageViewEventSelector
protected
var _pageViewEventSelector
protected
local _pageViewEventSelector
protected
float _rightBoundary
protected
var _rightBoundary
protected
local _rightBoundary
protected
UIWidget* _rightChild
protected
var _rightChild
protected
local _rightChild
protected
PVTouchDir _touchMoveDir
protected
var _touchMoveDir
protected
local _touchMoveDir
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: