Class for edit box. More...
Inherits Widget, and IMEDelegate.
Public Types | |
enum | KeyboardReturnType |
The popup keyboard return type. | |
enum | InputMode { ANY, EMAIL_ADDRESS, NUMERIC, PHONE_NUMBER, URL, DECIMAL, SINGLE_LINE } |
The EditBox::InputMode defines the type of text that the user is allowed to enter. More... | |
enum | InputFlag { PASSWORD, SENSITIVE, INITIAL_CAPS_WORD, INITIAL_CAPS_SENTENCE, INTIAL_CAPS_ALL_CHARACTERS } |
The EditBox::InputFlag defines how the input text is displayed/formatted. More... | |
![]() | |
enum | FocusDirection |
Widget focus direction. | |
enum | PositionType |
Widget position type for layout. | |
enum | SizeType |
Widget size type for layout. | |
enum | TouchEventType |
Touch event type. | |
enum | TextureResType |
Texture resource type. More... | |
enum | BrightStyle |
Widget bright style. | |
typedef std::function< void(Ref *, Widget::TouchEventType)> | ccWidgetTouchCallback |
Widget touch event callback. | |
typedef std::function< void(Ref *)> | ccWidgetClickCallback |
Widget click event callback. | |
typedef std::function< void(Ref *, int)> | ccWidgetEventCallback |
Widget custom event callback. More... | |
Public Member Functions | |
EditBox (void) | |
Constructor. | |
virtual | ~EditBox (void) |
Destructor. | |
bool | initWithSizeAndBackgroundSprite (const Size &size, const std::string &normal9SpriteBg, TextureResType texType=TextureResType::LOCAL) |
Init edit box with specified size. More... | |
bool | initWithSizeAndBackgroundSprite (const Size &size, Scale9Sprite *normal9SpriteBg) |
Init edit box with specified size. More... | |
void | setDelegate (EditBoxDelegate *delegate) |
Gets/Sets the delegate for edit box. | |
void | registerScriptEditBoxHandler (int handler) |
Registers a script function that will be called for EditBox events. More... | |
void | unregisterScriptEditBoxHandler (void) |
Unregisters a script function that will be called for EditBox events. | |
int | getScriptEditBoxHandler (void) |
get a script Handler More... | |
void | setText (const char *pText) |
Set the text entered in the edit box. More... | |
const char * | getText (void) |
Get the text entered in the edit box. More... | |
void | setFont (const char *pFontName, int fontSize) |
Set the font. More... | |
void | setFontName (const char *pFontName) |
Set the font name. More... | |
void | setFontSize (int fontSize) |
Set the font size. More... | |
void | setFontColor (const Color3B &color) |
Set the font color of the widget's text. | |
void | setPlaceholderFont (const char *pFontName, int fontSize) |
Set the placeholder's font. More... | |
void | setPlaceholderFontName (const char *pFontName) |
Set the placeholder's font name. More... | |
void | setPlaceholderFontSize (int fontSize) |
Set the placeholder's font size. More... | |
void | setPlaceholderFontColor (const Color3B &color) |
Set the font color of the placeholder text when the edit box is empty. | |
void | setPlaceholderFontColor (const Color4B &color) |
Set the font color of the placeholder text when the edit box is empty. | |
void | setPlaceHolder (const char *pText) |
Set a text in the edit box that acts as a placeholder when an edit box is empty. More... | |
const char * | getPlaceHolder (void) |
Get a text in the edit box that acts as a placeholder when an edit box is empty. | |
void | setInputMode (InputMode inputMode) |
Set the input mode of the edit box. More... | |
void | setMaxLength (int maxLength) |
Sets the maximum input length of the edit box. More... | |
int | getMaxLength () |
Gets the maximum input length of the edit box. More... | |
void | setInputFlag (InputFlag inputFlag) |
Set the input flags that are to be applied to the edit box. More... | |
void | setReturnType (EditBox::KeyboardReturnType returnType) |
Set the return type that are to be applied to the edit box. More... | |
virtual void | setPosition (const Vec2 &pos) override |
Changes the position (x,y) of the widget in OpenGL coordinates. More... | |
virtual void | setVisible (bool visible) override |
Sets whether the node is visible. More... | |
virtual void | setContentSize (const Size &size) override |
Changes the size that is widget's size. More... | |
virtual void | setAnchorPoint (const Vec2 &anchorPoint) override |
Sets the anchor point in percent. More... | |
virtual std::string | getDescription () const override |
Returns the "class name" of widget. | |
virtual void | draw (Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override |
Override this method to draw your own node. More... | |
virtual void | onEnter (void) override |
Event callback that is invoked every time when Node enters the 'stage'. More... | |
virtual void | onExit (void) override |
Event callback that is invoked every time the Node leaves the 'stage'. More... | |
![]() | |
Widget (void) | |
Default constructor. More... | |
virtual | ~Widget () |
Default destructor. More... | |
virtual void | setEnabled (bool enabled) |
Sets whether the widget is enabled. More... | |
bool | isEnabled () const |
Determines if the widget is enabled or not. 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 | isHighlighted () const |
Determines if the widget is highlighted. More... | |
void | setHighlighted (bool hilight) |
Sets whether the widget is hilighted. More... | |
float | getLeftInParent () |
Gets the left boundary position of this widget in parent's coordination system. More... | |
float | getLeftBoundary () const |
Gets the left boundary position of this widget in parent's coordination system. More... | |
float | getBottomInParent () |
Gets the bottom boundary position of this widget in parent's coordination system. More... | |
float | getBottomBoundary () const |
Gets the bottom boundary position of this widget in parent's coordination system. More... | |
float | getRightInParent () |
Gets the right boundary position of this widget in parent's coordination system. More... | |
float | getRightBoundary () const |
Gets the right boundary position of this widget in parent's coordination system. More... | |
float | getTopInParent () |
Gets the top boundary position of this widget in parent's coordination system. More... | |
float | getTopBoundary () const |
Gets the top boundary position of this widget in parent's coordination system. More... | |
virtual void | visit (cocos2d::Renderer *renderer, const Mat4 &parentTransform, uint32_t parentFlags) override |
Visits this node's children and draw them recursively. More... | |
void | addTouchEventListener (Ref *target, SEL_TouchEvent selector) |
Sets the touch event target/selector to the widget. | |
void | addTouchEventListener (const ccWidgetTouchCallback &callback) |
Set a callback to touch vent listener. More... | |
void | addClickEventListener (const ccWidgetClickCallback &callback) |
Set a click event handler to the widget. More... | |
virtual void | addCCSEventListener (const ccWidgetEventCallback &callback) |
Set a event handler to the widget in order to use cocostudio editor and framework. More... | |
void | setPositionPercent (const Vec2 &percent) |
Set the percent(x,y) of the widget in OpenGL coordinates. More... | |
const Vec2 & | 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 | setFlippedX (bool flippedX) |
Sets whether the widget should be flipped horizontally or not. More... | |
virtual bool | isFlippedX () const |
Returns the flag which indicates whether the widget is flipped horizontally or not. More... | |
virtual void | setFlippedY (bool flippedY) |
Sets whether the widget should be flipped vertically or not. More... | |
virtual bool | isFlippedY () const |
Return the flag which indicates whether the widget is flipped vertically or not. More... | |
bool | isFlipX () |
void | setFlipX (bool flipX) |
bool | isFlipY () |
void | setFlipY (bool flipY) |
virtual void | setScaleX (float scaleX) override |
Sets the scale (x) of the node. More... | |
virtual void | setScaleY (float scaleY) override |
Sets the scale (y) of the node. More... | |
virtual void | setScale (float scale) override |
Sets the scale (x,y,z) of the node. More... | |
virtual void | setScale (float scalex, float scaley) override |
Sets the scale (x,y) of the node. More... | |
virtual float | getScaleX () const override |
Returns the scale factor on X axis of this node. More... | |
virtual float | getScaleY () const override |
Returns the scale factor on Y axis of this node. More... | |
virtual float | getScale () const override |
Gets the scale factor of the node, when X and Y have the same scale factor. More... | |
bool | clippingParentAreaContainPoint (const Vec2 &pt) |
Checks a point if in parent's area. More... | |
bool | isClippingParentContainsPoint (const Vec2 &pt) |
Checks a point if in parent's area. More... | |
const Vec2 & | getTouchStartPos () const |
Gets the touch began point of widget when widget is selected. More... | |
const Vec2 & | getTouchBeganPosition () const |
Gets the touch began point of widget when widget is selected. More... | |
virtual void | setSize (const Size &size) |
Changes the size that is widget's size. More... | |
virtual void | setSizePercent (const Vec2 &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 Size & | getSize () const |
Get the size of widget. More... | |
const Size & | getCustomSize () const |
Get the user defined widget size. More... | |
virtual const Size & | getLayoutSize () |
Get the content size of widget. More... | |
const Vec2 & | getSizePercent () |
Get size percent of widget. More... | |
virtual bool | hitTest (const Vec2 &pt, const Camera *camera, Vec3 *p) const |
Checks a point is in widget's content space. More... | |
virtual bool | onTouchBegan (Touch *touch, Event *unusedEvent) |
A callback which will be called when touch began event is issued. More... | |
virtual void | onTouchMoved (Touch *touch, Event *unusedEvent) |
A callback which will be called when touch moved event is issued. More... | |
virtual void | onTouchEnded (Touch *touch, Event *unusedEvent) |
A callback which will be called when touch ended event is issued. More... | |
virtual void | onTouchCancelled (Touch *touch, Event *unusedEvent) |
A callback which will be called when touch cancelled event is issued. More... | |
void | setLayoutParameter (LayoutParameter *parameter) |
Sets a LayoutParameter to widget. More... | |
LayoutParameter * | getLayoutParameter () const override |
Gets LayoutParameter of widget. More... | |
LayoutParameter * | getLayoutParameter (LayoutParameter::Type type) |
Gets LayoutParameter of widget. More... | |
virtual void | ignoreContentAdaptWithSize (bool ignore) |
Toggle whether ignore user defined content size for widget. More... | |
bool | isIgnoreContentAdaptWithSize () const |
Query whether the widget ignores user deinfed content size or not. More... | |
Vec2 | getWorldPosition () const |
Gets position of widget in world space. More... | |
virtual Node * | getVirtualRenderer () |
Gets the inner Renderer node of widget. More... | |
virtual Size | getVirtualRendererSize () const |
Get the virtual renderer's size. More... | |
Widget * | clone () |
Create a new widget copy of the original one. More... | |
void | updateSizeAndPosition () |
Update all children's contents size and position recursively. More... | |
void | updateSizeAndPosition (const Size &parentSize) |
Update all children's contents size and position recursively. | |
void | setActionTag (int tag) |
Set the tag of action. More... | |
int | getActionTag () const |
Get the action tag. More... | |
void | setPropagateTouchEvents (bool isPropagate) |
Allow widget touch events to propagate to its parents. More... | |
bool | isPropagateTouchEvents () const |
Return whether the widget is propagate touch events to its parents or not. More... | |
void | setSwallowTouches (bool swallow) |
Toggle widget swallow touch option. More... | |
bool | isSwallowTouches () const |
Return whether the widget is swallowing touch or not. More... | |
bool | isFocused () const |
Query whether widget is focused or not. More... | |
void | setFocused (bool focus) |
Toggle widget focus status. More... | |
bool | isFocusEnabled () const |
Query widget's focus enable state. More... | |
void | setFocusEnabled (bool enable) |
Allow widget to accept focus. More... | |
virtual Widget * | findNextFocusedWidget (FocusDirection direction, Widget *current) |
When a widget is in a layout, you could call this method to get the next focused widget within a specified direction. More... | |
void | requestFocus () |
when a widget calls this method, it will get focus immediately. | |
Widget * | getCurrentFocusedWidget (bool isWidget) |
Return a current focused widget in your UI scene. More... | |
Widget * | getCurrentFocusedWidget () const |
Return a current focused widget in your UI scene. More... | |
void | setUnifySizeEnabled (bool enable) |
Toggle use unify size. More... | |
bool | isUnifySizeEnabled () const |
Query whether unify size enable state. More... | |
void | setCallbackName (const std::string &callbackName) |
Set callback name. More... | |
const std::string & | getCallbackName () const |
Query callback name. More... | |
void | setCallbackType (const std::string &callbackType) |
Set callback type. More... | |
const std::string & | getCallbackType () const |
Query callback type. More... | |
void | setLayoutComponentEnabled (bool enable) |
Toggle layout component enable. More... | |
bool | isLayoutComponentEnabled () const |
Query whether layout component is enabled or not. More... | |
![]() | |
virtual void | cleanup () override |
Stops all running actions and schedulers. | |
virtual void | onEnterTransitionDidFinish () override |
Event callback that is invoked when the Node enters in the 'stage'. More... | |
virtual void | onExitTransitionDidStart () override |
Event callback that is called every time the Node leaves the 'stage'. More... | |
virtual void | addProtectedChild (Node *child) |
Adds a child to the container with z-order as 0. More... | |
virtual void | addProtectedChild (Node *child, int localZOrder) |
Adds a child to the container with a local z-order. More... | |
virtual void | addProtectedChild (Node *child, int localZOrder, int tag) |
Adds a child to the container with z order and tag. More... | |
virtual Node * | getProtectedChildByTag (int tag) |
Gets a child from the container with its tag. More... | |
virtual void | removeProtectedChild (Node *child, bool cleanup=true) |
Removes a child from the container. More... | |
virtual void | removeProtectedChildByTag (int tag, bool cleanup=true) |
Removes a child from the container by tag value. More... | |
virtual void | removeAllProtectedChildren () |
Removes all children from the container with a cleanup. More... | |
virtual void | removeAllProtectedChildrenWithCleanup (bool cleanup) |
Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More... | |
virtual void | reorderProtectedChild (Node *child, int localZOrder) |
Reorders a child according to a new z value. More... | |
virtual void | sortAllProtectedChildren () |
Sorts the children array once before drawing, instead of every time when a child is added or reordered. More... | |
![]() | |
virtual bool | isRunning () const |
Returns whether or not the node is "running". More... | |
void | scheduleUpdateWithPriorityLua (int handler, int priority) |
Schedules for lua script. More... | |
virtual Scene * | getScene () const |
Returns the Scene that contains the Node. More... | |
virtual Rect | getBoundingBox () const |
Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system. More... | |
virtual Rect | boundingBox () const |
virtual void | setEventDispatcher (EventDispatcher *dispatcher) |
Set event dispatcher for scene. More... | |
virtual EventDispatcher * | getEventDispatcher () const |
Get the event dispatcher of scene. More... | |
void | setPhysicsBody (PhysicsBody *body) |
Set the PhysicsBody that let the sprite effect with physics. More... | |
PhysicsBody * | getPhysicsBody () const |
Get the PhysicsBody the sprite have. More... | |
void | removeFromPhysicsWorld () |
Remove this node from physics world. More... | |
void | updateTransformFromPhysics (const Mat4 &parentTransform, uint32_t parentFlags) |
Update the transform matrix from physics. | |
virtual void | updatePhysicsBodyTransform (const Mat4 &parentTransform, uint32_t parentFlags, float parentScaleX, float parentScaleY) |
Update physics body transform matrix. | |
unsigned short | getCameraMask () const |
get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true | |
virtual void | setLocalZOrder (int localZOrder) |
LocalZOrder is the 'key' used to sort the node relative to its siblings. More... | |
virtual void | setZOrder (int localZOrder) |
virtual void | _setLocalZOrder (int z) |
virtual int | getLocalZOrder () const |
Gets the local Z order of this node. More... | |
virtual int | getZOrder () const |
virtual void | setGlobalZOrder (float globalZOrder) |
Defines the oder in which the nodes are renderer. More... | |
virtual float | getGlobalZOrder () const |
Returns the Node's Global Z Order. More... | |
virtual void | setScaleZ (float scaleZ) |
Changes the scale factor on Z axis of this node. More... | |
virtual float | getScaleZ () const |
Returns the scale factor on Z axis of this node. More... | |
virtual void | setNormalizedPosition (const Vec2 &position) |
Sets the position (x,y) using values between 0 and 1. More... | |
virtual const Vec2 & | getPosition () const |
Gets the position (x,y) of the node in its parent's coordinate system. More... | |
virtual const Vec2 & | getNormalizedPosition () const |
Returns the normalized position. More... | |
virtual void | setPosition (float x, float y) |
Sets the position (x,y) of the node in its parent's coordinate system. More... | |
virtual void | getPosition (float *x, float *y) const |
Gets position in a more efficient way, returns two number instead of a Vec2 object. More... | |
virtual void | setPositionX (float x) |
Gets/Sets x or y coordinate individually for position. More... | |
virtual float | getPositionX (void) const |
Gets the x coordinate of the node in its parent's coordinate system. More... | |
virtual void | setPositionY (float y) |
Sets the y coordinate of the node in its parent's coordinate system. More... | |
virtual float | getPositionY (void) const |
Gets the y coordinate of the node in its parent's coordinate system. More... | |
virtual void | setPosition3D (const Vec3 &position) |
Sets the position (X, Y, and Z) in its parent's coordinate system. More... | |
virtual Vec3 | getPosition3D () const |
Returns the position (X,Y,Z) in its parent's coordinate system. More... | |
virtual void | setPositionZ (float positionZ) |
Sets the 'z' coordinate in the position. More... | |
virtual void | setVertexZ (float vertexZ) |
virtual float | getPositionZ () const |
Gets position Z coordinate of this node. More... | |
virtual float | getVertexZ () const |
virtual void | setSkewX (float skewX) |
Changes the X skew angle of the node in degrees. More... | |
virtual float | getSkewX () const |
Returns the X skew angle of the node in degrees. More... | |
virtual void | setSkewY (float skewY) |
Changes the Y skew angle of the node in degrees. More... | |
virtual float | getSkewY () const |
Returns the Y skew angle of the node in degrees. More... | |
virtual const Vec2 & | getAnchorPoint () const |
Returns the anchor point in percent. More... | |
virtual const Vec2 & | getAnchorPointInPoints () const |
Returns the anchorPoint in absolute pixels. More... | |
virtual const Size & | getContentSize () const |
Returns the untransformed size of the node. More... | |
virtual bool | isVisible () const |
Determines if the node is visible. More... | |
virtual void | setRotation (float rotation) |
Sets the rotation (angle) of the node in degrees. More... | |
virtual float | getRotation () const |
Returns the rotation of the node in degrees. More... | |
virtual void | setRotation3D (const Vec3 &rotation) |
Sets the rotation (X,Y,Z) in degrees. More... | |
virtual Vec3 | getRotation3D () const |
Returns the rotation (X,Y,Z) in degrees. More... | |
virtual void | setRotationQuat (const Quaternion &quat) |
Set rotation by quaternion. More... | |
virtual Quaternion | getRotationQuat () const |
Return the rotation by quaternion, Note that when _rotationZ_X == _rotationZ_Y, the returned quaternion equals to RotationZ_X * RotationY * RotationX, it equals to RotationY * RotationX otherwise. More... | |
virtual void | setRotationSkewX (float rotationX) |
Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew. More... | |
virtual void | setRotationX (float rotationX) |
virtual float | getRotationSkewX () const |
Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew. More... | |
virtual float | getRotationX () const |
virtual void | setRotationSkewY (float rotationY) |
Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More... | |
virtual void | setRotationY (float rotationY) |
virtual float | getRotationSkewY () const |
Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew. More... | |
virtual float | getRotationY () const |
void | setOrderOfArrival (int orderOfArrival) |
Sets the arrival order when this node has a same ZOrder with other children. More... | |
int | getOrderOfArrival () const |
Returns the arrival order, indicates which children is added previously. More... | |
void | setGLServerState (int serverState) |
int | getGLServerState () const |
virtual void | ignoreAnchorPointForPosition (bool ignore) |
Sets whether the anchor point will be (0,0) when you position this node. More... | |
virtual bool | isIgnoreAnchorPointForPosition () const |
Gets whether the anchor point will be (0,0) when you position this node. More... | |
virtual void | addChild (Node *child) |
Adds a child to the container with z-order as 0. More... | |
virtual void | addChild (Node *child, int localZOrder) |
Adds a child to the container with a local z-order. More... | |
virtual void | addChild (Node *child, int localZOrder, int tag) |
Adds a child to the container with z order and tag. More... | |
virtual void | addChild (Node *child, int localZOrder, const std::string &name) |
Adds a child to the container with z order and tag. More... | |
virtual Node * | getChildByTag (int tag) const |
Gets a child from the container with its tag. More... | |
virtual Node * | getChildByName (const std::string &name) const |
Gets a child from the container with its name. More... | |
template<typename T > | |
T | getChildByName (const std::string &name) const |
Gets a child from the container with its name that can be cast to Type T. More... | |
virtual void | enumerateChildren (const std::string &name, std::function< bool(Node *node)> callback) const |
Search the children of the receiving node to perform processing for nodes which share a name. More... | |
virtual Vector< Node * > & | getChildren () |
Returns the array of the node's children. More... | |
virtual const Vector< Node * > & | getChildren () const |
virtual ssize_t | getChildrenCount () const |
Returns the amount of children. More... | |
virtual void | setParent (Node *parent) |
Sets the parent node. More... | |
virtual Node * | getParent () |
Returns a pointer to the parent node. More... | |
virtual const Node * | getParent () const |
virtual void | removeFromParent () |
Removes this node itself from its parent node with a cleanup. More... | |
virtual void | removeFromParentAndCleanup (bool cleanup) |
Removes this node itself from its parent node. More... | |
virtual void | removeChild (Node *child, bool cleanup=true) |
Removes a child from the container. More... | |
virtual void | removeChildByTag (int tag, bool cleanup=true) |
Removes a child from the container by tag value. More... | |
virtual void | removeChildByName (const std::string &name, bool cleanup=true) |
Removes a child from the container by tag value. More... | |
virtual void | removeAllChildren () |
Removes all children from the container with a cleanup. More... | |
virtual void | removeAllChildrenWithCleanup (bool cleanup) |
Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter. More... | |
virtual void | reorderChild (Node *child, int localZOrder) |
Reorders a child according to a new z value. More... | |
virtual void | sortAllChildren () |
Sorts the children array once before drawing, instead of every time when a child is added or reordered. More... | |
virtual int | getTag () const |
Returns a tag that is used to identify the node easily. More... | |
virtual void | setTag (int tag) |
Changes the tag that is used to identify the node easily. More... | |
virtual std::string | getName () const |
Returns a string that is used to identify the node. More... | |
virtual void | setName (const std::string &name) |
Changes the name that is used to identify the node easily. More... | |
virtual void * | getUserData () |
Returns a custom user data pointer. More... | |
virtual const void * | getUserData () const |
virtual void | setUserData (void *userData) |
Sets a custom user data pointer. More... | |
virtual Ref * | getUserObject () |
Returns a user assigned Object. More... | |
virtual const Ref * | getUserObject () const |
virtual void | setUserObject (Ref *userObject) |
Returns a user assigned Object. More... | |
GLProgram * | getGLProgram () const |
Return the GLProgram (shader) currently used for this node. More... | |
GLProgram * | getShaderProgram () const |
virtual void | setGLProgram (GLProgram *glprogram) |
Sets the shader program for this node. More... | |
void | setShaderProgram (GLProgram *glprogram) |
GLProgramState * | getGLProgramState () const |
Return the GLProgramState currently used for this node. More... | |
virtual void | setGLProgramState (GLProgramState *glProgramState) |
Set the GLProgramState for this node. More... | |
virtual void | setActionManager (ActionManager *actionManager) |
Sets the ActionManager object that is used by all actions. More... | |
virtual ActionManager * | getActionManager () |
Gets the ActionManager object that is used by all actions. More... | |
virtual const ActionManager * | getActionManager () const |
virtual Action * | runAction (Action *action) |
Executes an action, and returns the action that is executed. More... | |
void | stopAllActions () |
Stops and removes all actions from the running action list . | |
void | stopAction (Action *action) |
Stops and removes an action from the running action list. More... | |
void | stopActionByTag (int tag) |
Removes an action from the running action list by its tag. More... | |
void | stopAllActionsByTag (int tag) |
Removes all actions from the running action list by its tag. More... | |
void | stopActionsByFlags (unsigned int flags) |
Removes all actions from the running action list by its flags. More... | |
Action * | getActionByTag (int tag) |
Gets an action from the running action list by its tag. More... | |
ssize_t | getNumberOfRunningActions () const |
Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays). More... | |
ssize_t | numberOfRunningActions () const |
virtual void | setScheduler (Scheduler *scheduler) |
Sets a Scheduler object that is used to schedule all "updates" and timers. More... | |
virtual Scheduler * | getScheduler () |
Gets a Sheduler object. More... | |
virtual const Scheduler * | getScheduler () const |
bool | isScheduled (SEL_SCHEDULE selector) |
Checks whether a selector is scheduled. More... | |
bool | isScheduled (const std::string &key) |
Checks whether a lambda function is scheduled. More... | |
void | scheduleUpdate (void) |
Schedules the "update" method. More... | |
void | scheduleUpdateWithPriority (int priority) |
Schedules the "update" method with a custom priority. More... | |
void | unscheduleUpdate (void) |
void | schedule (SEL_SCHEDULE selector, float interval, unsigned int repeat, float delay) |
Schedules a custom selector. More... | |
void | schedule (SEL_SCHEDULE selector, float interval) |
Schedules a custom selector with an interval time in seconds. More... | |
void | scheduleOnce (SEL_SCHEDULE selector, float delay) |
Schedules a selector that runs only once, with a delay of 0 or larger. More... | |
void | scheduleOnce (const std::function< void(float)> &callback, float delay, const std::string &key) |
Schedules a lambda function that runs only once, with a delay of 0 or larger. More... | |
void | schedule (SEL_SCHEDULE selector) |
Schedules a custom selector, the scheduled selector will be ticked every frame. More... | |
void | schedule (const std::function< void(float)> &callback, const std::string &key) |
Schedules a lambda function. More... | |
void | schedule (const std::function< void(float)> &callback, float interval, const std::string &key) |
Schedules a lambda function. More... | |
void | schedule (const std::function< void(float)> &callback, float interval, unsigned int repeat, float delay, const std::string &key) |
Schedules a lambda function. More... | |
void | unschedule (SEL_SCHEDULE selector) |
Unschedules a custom selector. More... | |
void | unschedule (const std::string &key) |
Unschedules a lambda function. More... | |
void | unscheduleAllCallbacks () |
Unschedule all scheduled selectors and lambda functions: custom selectors, and the 'update' selector and lambda functions. More... | |
void | unscheduleAllSelectors () |
virtual void | resume (void) |
Resumes all scheduled selectors, actions and event listeners. More... | |
virtual void | pause (void) |
Pauses all scheduled selectors, actions and event listeners. More... | |
void | resumeSchedulerAndActions () |
Resumes all scheduled selectors, actions and event listeners. More... | |
void | pauseSchedulerAndActions () |
Pauses all scheduled selectors, actions and event listeners. More... | |
virtual void | update (float delta) |
Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live". More... | |
virtual void | updateTransform () |
Calls children's updateTransform() method recursively. More... | |
virtual const Mat4 & | getNodeToParentTransform () const |
Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More... | |
virtual AffineTransform | getNodeToParentAffineTransform () const |
virtual Mat4 | getNodeToParentTransform (Node *ancestor) const |
Returns the matrix that transform the node's (local) space coordinates into the parent's space coordinates. More... | |
virtual AffineTransform | getNodeToParentAffineTransform (Node *ancestor) const |
Returns the affline transform matrix that transform the node's (local) space coordinates into the parent's space coordinates. More... | |
virtual void | setNodeToParentTransform (const Mat4 &transform) |
Sets the transformation matrix manually. More... | |
virtual AffineTransform | nodeToParentTransform () const |
virtual const Mat4 & | getParentToNodeTransform () const |
Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates. More... | |
virtual AffineTransform | getParentToNodeAffineTransform () const |
virtual AffineTransform | parentToNodeTransform () const |
virtual Mat4 | getNodeToWorldTransform () const |
Returns the world affine transform matrix. More... | |
virtual AffineTransform | getNodeToWorldAffineTransform () const |
virtual AffineTransform | nodeToWorldTransform () const |
virtual Mat4 | getWorldToNodeTransform () const |
Returns the inverse world affine transform matrix. More... | |
virtual AffineTransform | getWorldToNodeAffineTransform () const |
virtual AffineTransform | worldToNodeTransform () const |
Vec2 | convertToNodeSpace (const Vec2 &worldPoint) const |
Converts a Vec2 to node (local) space coordinates. More... | |
Vec2 | convertToWorldSpace (const Vec2 &nodePoint) const |
Converts a Vec2 to world space coordinates. More... | |
Vec2 | convertToNodeSpaceAR (const Vec2 &worldPoint) const |
Converts a Vec2 to node (local) space coordinates. More... | |
Vec2 | convertToWorldSpaceAR (const Vec2 &nodePoint) const |
Converts a local Vec2 to world space coordinates.The result is in Points. More... | |
Vec2 | convertTouchToNodeSpace (Touch *touch) const |
convenience methods which take a Touch instead of Vec2. More... | |
Vec2 | convertTouchToNodeSpaceAR (Touch *touch) const |
converts a Touch (world coordinates) into a local coordinate. More... | |
void | setAdditionalTransform (Mat4 *additionalTransform) |
Sets an additional transform matrix to the node. More... | |
void | setAdditionalTransform (const AffineTransform &additionalTransform) |
Component * | getComponent (const std::string &name) |
Gets a component by its name. More... | |
virtual bool | addComponent (Component *component) |
Adds a component. More... | |
virtual bool | removeComponent (const std::string &name) |
Removes a component by its name. More... | |
virtual bool | removeComponent (Component *component) |
Removes a component by its pointer. More... | |
virtual void | removeAllComponents () |
Removes all components. | |
![]() | |
void | retain () |
Retains the ownership. More... | |
void | release () |
Releases the ownership immediately. More... | |
Ref * | autorelease () |
Releases the ownership sometime soon automatically. More... | |
unsigned int | getReferenceCount () const |
Returns the Ref's current reference count. More... | |
virtual | ~Ref () |
Destructor. More... | |
![]() | |
virtual | ~LayoutParameterProtocol () |
Default destructor. | |
![]() | |
virtual | ~IMEDelegate () |
Default constructor. | |
virtual bool | attachWithIME () |
Default destructor. | |
virtual bool | detachWithIME () |
Determine whether the IME is detached or not. | |
Static Public Member Functions | |
static EditBox * | create (const Size &size, Scale9Sprite *normalSprite, Scale9Sprite *pressedSprite=nullptr, Scale9Sprite *disabledSprite=nullptr) |
create a edit box with size. More... | |
static EditBox * | create (const Size &size, const std::string &normal9SpriteBg, TextureResType texType=TextureResType::LOCAL) |
create a edit box with size. More... | |
![]() | |
static Widget * | create () |
Create and return a empty Widget instance pointer. | |
![]() | |
static ProtectedNode * | create (void) |
Creates a ProtectedNode with no argument. More... | |
![]() | |
static Node * | create () |
Allocates and initializes a node. More... | |
Additional Inherited Members | |
![]() | |
std::function< void(Widget *, Widget *)> | onFocusChanged |
When a widget lose/get focus, this method will be called. More... | |
std::function< Widget *(FocusDirection)> | onNextFocusedWidget |
use this function to manually specify the next focused widget regards to each direction | |
![]() | |
unsigned int | _ID |
object id, ScriptSupport need public _ID | |
int | _luaID |
Lua reference id. | |
void * | _scriptObject |
scriptObject, support for swift | |
![]() | |
static const int | INVALID_TAG = -1 |
Default tag used for all the nodes. | |
![]() | |
void | propagateTouchEvent (TouchEventType event, Widget *sender, Touch *touch) |
Propagate touch events to its parents. | |
void | onFocusChange (Widget *widgetLostFocus, Widget *widgetGetFocus) |
This method is called when a focus change event happens. More... | |
void | dispatchFocusEvent (Widget *widgetLoseFocus, Widget *widgetGetFocus) |
Dispatch a EventFocus through a EventDispatcher. More... | |
Class for edit box.
You can use this widget to gather small amounts of text from the user.
|
static |
create a edit box with size.
|
static |
create a edit box with size.
bool initWithSizeAndBackgroundSprite |
( | const Size & | size, |
const std::string & | normal9SpriteBg, | ||
TextureResType | texType = TextureResType::LOCAL |
||
) |
Init edit box with specified size.
This method should be invoked right after constructor.
size | The size of edit box. |
normal9SpriteBg | background image of edit box. |
texType | the resource type, the default value is TextureResType::LOCAL |
bool initWithSizeAndBackgroundSprite |
( | const Size & | size, |
Scale9Sprite * | normal9SpriteBg | ||
) |
Init edit box with specified size.
This method should be invoked right after constructor.
size | The size of edit box. |
normal9SpriteBg | background image of edit box. |
void registerScriptEditBoxHandler | ( | int | handler | ) |
Registers a script function that will be called for EditBox events.
This handler will be removed automatically after onExit() called.
handler | A number that indicates a lua function. |
|
inline |
get a script Handler
void setText | ( | const char * | pText | ) |
Set the text entered in the edit box.
pText | The given text. |
const char* getText | ( | void | ) |
Get the text entered in the edit box.
void setFont | ( | const char * | pFontName, |
int | fontSize | ||
) |
Set the font.
Only system font is allowed.
pFontName | The font name. |
fontSize | The font size. |
void setFontName | ( | const char * | pFontName | ) |
Set the font name.
Only system font is allowed.
pFontName | The font name. |
void setFontSize | ( | int | fontSize | ) |
Set the font size.
fontSize | The font size. |
void setPlaceholderFont | ( | const char * | pFontName, |
int | fontSize | ||
) |
Set the placeholder's font.
Only system font is allowed.
pFontName | The font name. |
fontSize | The font size. |
void setPlaceholderFontName | ( | const char * | pFontName | ) |
Set the placeholder's font name.
only system font is allowed.
pFontName | The font name. |
void setPlaceholderFontSize | ( | int | fontSize | ) |
Set the placeholder's font size.
fontSize | The font size. |
void setPlaceHolder | ( | const char * | pText | ) |
Set a text in the edit box that acts as a placeholder when an edit box is empty.
pText | The given text. |
void setInputMode | ( | InputMode | inputMode | ) |
Set the input mode of the edit box.
inputMode | One of the EditBox::InputMode constants. |
void setMaxLength | ( | int | maxLength | ) |
Sets the maximum input length of the edit box.
Setting this value enables multiline input mode by default. Available on Android, iOS and Windows Phone.
maxLength | The maximum length. |
int getMaxLength | ( | ) |
Gets the maximum input length of the edit box.
void setInputFlag | ( | InputFlag | inputFlag | ) |
Set the input flags that are to be applied to the edit box.
inputFlag | One of the EditBox::InputFlag constants. |
void setReturnType | ( | EditBox::KeyboardReturnType | returnType | ) |
Set the return type that are to be applied to the edit box.
returnType | One of the EditBox::KeyboardReturnType constants. |
|
overridevirtual |
|
overridevirtual |
Sets whether the node is visible.
The default value is true, a node is default to visible.
visible | true if the node is visible, false if the node is hidden. |
Reimplemented from Node.
|
overridevirtual |
Changes the size that is widget's size.
contentSize | A content size in Size . |
Reimplemented from Widget.
|
overridevirtual |
Sets the anchor point in percent.
anchorPoint is the point around which all transformations and positioning manipulations take place. It's like a pin in the node where it is "attached" to its parent. The anchorPoint is normalized, like a percentage. (0,0) means the bottom-left corner and (1,1) means the top-right corner. But you can use values higher than (1,1) and lower than (0,0) too. The default anchorPoint is (0.5,0.5), so it starts in the center of the node.
anchorPoint | The anchor point of node. |
Reimplemented from Node.
|
overridevirtual |
Override this method to draw your own node.
The following GL states will be enabled by default:
glEnableClientState(GL_VERTEX_ARRAY);
glEnableClientState(GL_COLOR_ARRAY);
glEnableClientState(GL_TEXTURE_COORD_ARRAY);
glEnable(GL_TEXTURE_2D);
AND YOU SHOULD NOT DISABLE THEM AFTER DRAWING YOUR NODE But if you enable any other GL state, you should disable it after drawing your node.renderer | A given renderer. |
transform | A transform matrix. |
flags | Renderer flag. |
Reimplemented from Node.
|
overridevirtual |
Event callback that is invoked every time when Node enters the 'stage'.
If the Node enters the 'stage' with a transition, this event is called when the transition starts. During onEnter you can't access a "sister/brother" node. If you override onEnter, you shall call its parent's one, e.g., Node::onEnter().
Reimplemented from Widget.
|
overridevirtual |
Event callback that is invoked every time the Node leaves the 'stage'.
If the Node leaves the 'stage' with a transition, this event is called when the transition finishes. During onExit you can't access a sibling node. If you override onExit, you shall call its parent's one, e.g., Node::onExit().
Reimplemented from Widget.