rag
graphic 2d engine
Classes | Public Member Functions | List of all members
rag::TextInput Class Reference

Helper object to add input to a TextField. More...

#include <TextInput.h>

Inheritance diagram for rag::TextInput:
rag::DisplayObject events::EventListener events::EventDispatcher

Public Member Functions

 TextInput (std::string defaultText="", int maxLines=0, int maxCharacters=0, bool useCaptureLayer=true, Keyboard::KeyboardType keyboardType=Keyboard::KeyboardTypeDefault)
 
std::string getText ()
 
void setText (const std::string &text)
 
void openKeyboard ()
 
void closeKeyboard ()
 
void clearText ()
 
- Public Member Functions inherited from rag::DisplayObject
void addChild (DisplayObject *child)
 Adds a DisplayObject child.
 
void addChildAt (DisplayObject *child, int index)
 Adds a DisplayObject child in a specific order.
 
void removeChild (DisplayObject *child)
 Removes a child DisplayObject. More...
 
void deleteChild (DisplayObject *child)
 Deletes a specific child from the DisplayList. More...
 
DisplayObjectgetChildByName (const std::string &name)
 Returns a child by name.
 
DisplayObjectgetChildAt (int index)
 Returns a child by index.
 
int getChildIndex (DisplayObject *child) const
 Returns a child's index.
 
bool contains (const DisplayObject *child) const
 Returns true if the child DisplayObject exists as a child.
 
int getNumChilds ()
 Returns the number of childs.
 
void swapChildren (DisplayObject *child1, DisplayObject *child2)
 Swaps two childs indexes.
 
virtual void logicTraversal ()
 Recursively calls logicUpdate in all child objects. More...
 
virtual void render ()
 Renders the DisplayObject in the screen.
 
virtual void renderTraversal (const Color &color)
 Recursively calls render in all childs objects.
 
virtual void prerender ()
 Temporal transition to new automatic batch render.
 
void setX (float x)
 Sets x position.
 
float getX ()
 Returns x position.
 
void setY (float y)
 Sets y position.
 
float getY ()
 Returns y position.
 
void setPosition (float x, float y)
 Sets x and y position.
 
void setPosition (glm::vec2 p)
 Sets object position.
 
glm::vec2 getPosition () const
 Returns object position.
 
void setScale (float scale)
 Sets object scale.
 
void setScaleX (float scaleX)
 Sets object x scale.
 
float getScaleX () const
 Returns object x scale.
 
void setScaleY (float scaleY)
 Sets object y scale.
 
float getScaleY () const
 Returns object y scale.
 
void setAngle (float angle)
 Sets object orientation angle.
 
float getAngle () const
 Returns object orientation angle.
 
void setSkewX (float skewX)
 Sets object x skew.
 
float getSkewX () const
 Returns object x skew.
 
void setSkewY (float skewY)
 Sets object y skew.
 
float getSkewY () const
 Returns object y skew.
 
void setWidth (float width)
 Sets object width.
 
float getWidth ()
 Returns object width.
 
void setHeight (float height)
 Sets object width.
 
float getHeight ()
 Returns object width.
 
virtual bool hitTestPoint (int x, int y)
 Returns true if the point lies inside the object boundary box.
 
glm::vec2 localToGlobal (const glm::vec2 &point)
 Converts local coordinates to global coordinates.
 
glm::vec2 globalToLocal (const glm::vec2 &point)
 Convert global coordinates to local coordinates.
 
void setClipRectangle (const Rectangle &rect)
 This allow to render just a part of the bitmap.
 
Rectangle getBounds (DisplayObject *targetCoordinateSpace=NULL)
 Returns the boundary box of the object.
 
void onNativeEvent (events::TouchEvent &event)
 Notifies the object about an input event. More...
 
void setText (rag::DisplayObject *displayObject, const std::string &text)
 Helper function to set a text.
 
void setText (rag::DisplayObject *displayObject, int value)
 Helper function to set a text number.
 
void destroy ()
 self-destroy the object and all its childs. More...
 
void updateMatrix ()
 
- Public Member Functions inherited from events::EventDispatcher
void addEventListener (std::string type, EventListener *listener)
 
void dispatchEvent (Event &event)
 
bool hasEventListener (std::string type)
 
void removeEventListener (std::string type, EventListener *listener)
 

Additional Inherited Members

- Static Public Member Functions inherited from rag::DisplayObject
static void deletePendentObjects ()
 Deletes from memory all the nodes currently on the toDelete list. More...
 
static void showLivingObjects ()
 Logs information about the current number of living DisplayObject.
 
- Public Attributes inherited from rag::DisplayObject
std::string name
 
DisplayObjectparent
 
std::vector< DisplayObject * > childs
 List of childs.
 
Color color
 Color of the object.
 
Material material
 Material of the object.
 
MaterialrenderMaterial
 The render material modified by the display list hierarchy.
 
glm::mat4 matrix
 The object matrix.
 
bool visible
 Determines object visibility.
 
bool autoScaleOnTouch
 When true, the bounds scale when is touched. More...
 
bool captureInput
 When true, input events are captured and propagation stops.
 
bool checkHitPoint
 When captureInput, checkHitPoint makes capture input only when hitTest is true. Defaults to false.
 
std::string soundName
 
std::string script
 
- Protected Member Functions inherited from rag::DisplayObject
virtual void updateBounds (rag::DisplayObject *targetCoordinateSpace)
 Updates the bounding box of the object according to childs bounds. More...
 
- Protected Attributes inherited from rag::DisplayObject
float scaleX
 
float scaleY
 
float x
 
float y
 
float width
 
float height
 
float angle
 
float skewX
 
float skewY
 
Rectangle bounds
 
int numChilds
 
bool dirty
 
Color colorTransform
 
Rectangle clipRect
 

Detailed Description

Helper object to add input to a TextField.

System keyboard is shown when the user clicks the TextInput object.

You need to add a TextInput in a TextField to let user write on it, and TextField parent should have ButtonBehaviour.

The hierarchy for a button with text and textinput is like this:

button -> textfield -> textinput

where button is the grandfather of textinput.

CaptureLayer may be added, so when user clicks somewhere in the screen the keyboard is closed.


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