omegalib  13.1
omegaToolkit::ui::TextBox Class Reference

#include <TextBox.h>

Public Types

enum  HorizontalAlign { AlignRight, AlignLeft, AlignCenter }
 
enum  VerticalAlign { AlignTop, AlignMiddle, AlignBottom }
 
- Public Types inherited from omegaToolkit::ui::Label
enum  HorizontalAlign { AlignRight, AlignLeft, AlignCenter }
 
enum  VerticalAlign { AlignTop, AlignMiddle, AlignBottom }
 
- Public Types inherited from omegaToolkit::ui::Widget
enum  Layer { Back, Middle, Front, NumLayers }
 
enum  BlendMode { BlendInherit, BlendNormal, BlendAdditive, BlendDisabled }
 

Public Member Functions

 TextBox (Engine *server)
 
virtual ~TextBox ()
 
virtual void updateSize ()
 
virtual void handleEvent (const Event &evt)
 
virtual void update (const omega::UpdateContext &context)
 
- Public Member Functions inherited from omegaToolkit::ui::Label
 Label (Engine *server)
 
virtual ~Label ()
 
virtual RenderablecreateRenderable ()
 
String getText ()
 
void setText (const String &value)
 
String getFont ()
 
void setFont (const String &value)
 
Color getColor ()
 
void setColor (const Color &value)
 
HorizontalAlign getHorizontalAlign ()
 
void setHorizontalAlign (HorizontalAlign value)
 
VerticalAlign getVerticalAlign ()
 
void setVerticalAlign (VerticalAlign value)
 
void setAutosizeVerticalPadding (int value)
 
void setAutosizeHorizontalPadding (int value)
 
int getAutosizeVerticalPadding ()
 
int getAutosizeHorizontalPadding ()
 
void setAutosizePadding (int value)
 
virtual void autosize ()
 
- Public Member Functions inherited from omegaToolkit::ui::Widget
 Widget (Engine *server)
 
virtual ~Widget ()
 
ContainergetContainer ()
 
const String & getName ()
 Returns the widget name. More...
 
void setName (const String &name)
 Sets the widget name. More...
 
int getId ()
 Returns the unique Widget id. More...
 
virtual void layout ()
 
void setStereo (bool value)
 
bool isStereo ()
 
void requestLayoutRefresh ()
 
Layer getLayer ()
 
void setLayer (Layer layer)
 
bool hitTest (const Vector2f &point)
 Returns true if the point is within this widget's bounding box. More...
 
Vector2f transformPoint (const omega::Vector2f &point)
 Transforms a 2D point from screen space to this widget's reference frame. More...
 
void setUserData (void *data)
 
void * getUserData ()
 
bool isDraggable ()
 
void setDraggable (bool value)
 
bool isDragging ()
 
bool isPinned ()
 When a widget is pinned, its position will remain fixed with respect to its container. More...
 
void setPinned (bool value)
 
void setSizeAnchorEnabled (bool enabled)
 
bool isSizeAnchorEnabled ()
 
void setSizeAnchor (const Vector2f &value)
 
const Vector2f getSizeAnchor ()
 
WidgetFactorygetFactory ()
 
void setUIEventHandler (IEventListener *value)
 Input and Events. More...
 
IEventListener * getUIEventHandler ()
 
void setUIEventCommand (const String &command)
 
bool isButtonDown (const Event &evt, Event::Flags button)
 Returns true if the event is a button down event happening on this widget. More...
 
bool isButtonUp (const Event &evt, Event::Flags button)
 Returns true if the event is a button up event happening on this widget. More...
 
void setUpdateCommand (const String &cmd)
 Sets or gets a script command to be invoked on every update for this widget. More...
 
String getUpdateCommand ()
 
void setDragBeginCommand (const String &cmd)
 Sets or gets a script command to be invoked when this widget starts dragging. More...
 
String getDragBeginCommand ()
 
void setDragEndCommand (const String &cmd)
 Sets or gets a script command to be invoked when this widget ends dragging. More...
 
String getDragEndCommand ()
 
void setActivateCommand (const String &cmd)
 Sets or gets a script command to be invoked when this widget gets active status. More...
 
String getActivateCommand ()
 
void setDeactivateCommand (const String &cmd)
 Sets or gets a script command to be invoked when this widget loses active status. More...
 
String getDeactivateCommand ()
 
const Vector2f & getPosition ()
 Position and rotation. More...
 
Vector2f getDerivedPosition ()
 Gets the widget position in screen space. More...
 
void setPosition (const omega::Vector2f &value)
 Sets the widget position. More...
 
void setPosition (int value, int dimension)
 
void setCenter (const omega::Vector2f &value)
 
Vector2f getCenter ()
 
void setRotation (float value)
 Sets the widget rotation. More...
 
float getRotation ()
 Gets the widget position. More...
 
const Vector2f & getSize ()
 Size constraints. More...
 
float getWidth ()
 
float getHeight ()
 
void setSize (const Vector2f &value)
 Sets the widget size. More...
 
void setWidth (float value)
 
void setHeight (float value)
 
const Vector2f & getMinimumSize ()
 
const Vector2f & getMaximumSize ()
 
void setMinimumSize (const Vector2f &value)
 
int getMinimumWidth ()
 
int getMinimumHeight ()
 
void setMaximumSize (const Vector2f &value)
 
int getMaximumWidth ()
 
int getMaximumHeight ()
 
void setMinimumWidth (float value)
 
void setMinimumHeight (float value)
 
void setMaximumWidth (float value)
 
void setMaximumHeight (float value)
 
void clearSizeConstaints ()
 
void setAutosize (bool value)
 
bool getAutosize ()
 
bool isVisible ()
 Flags. More...
 
void setVisible (bool value)
 
bool isEnabled ()
 When true, the widget is enabled, i.e. it can receive input events and takes part in navigation (can become active) More...
 
void setEnabled (bool value)
 
bool isActive ()
 
void setActive (bool value)
 
virtual bool isIn3DContainer ()
 Returns true if this widget is part of a container that will be drawn in 3D mode. More...
 
bool isPointerInside ()
 
void setHorizontalNextWidget (Widget *value)
 Navigation. More...
 
WidgetgetHorizontalNextWidget ()
 
void setHorizontalPrevWidget (Widget *value)
 
WidgetgetHorizontalPrevWidget ()
 
void setVerticalNextWidget (Widget *value)
 
WidgetgetVerticalNextWidget ()
 
void setVerticalPrevWidget (Widget *value)
 
WidgetgetVerticalPrevWidget ()
 
bool isNavigationEnabled ()
 
void setNavigationEnabled (bool value)
 
bool isGamepadInteractionEnabled ()
 
bool isPointerInteractionEnabled ()
 
void setStyle (const String &style)
 Appearance. More...
 
String getStyleValue (const String &key, const String &defaultValue="")
 
void setStyleValue (const String &key, const String &value)
 
void setScale (float value)
 
void setActiveStyle (const String &value)
 
void setInactiveStyle (const String &value)
 
String getActiveStyle ()
 
String getInactiveStyle ()
 
float getScale ()
 Sets the widget scale. More...
 
float getDerivedScale ()
 Gets the scale of this widget, taking into account the scale of any parent container. More...
 
void setAlpha (float value)
 
float getAlpha ()
 
void setBlendMode (BlendMode value)
 
BlendMode getBlendMode ()
 
void setFillColor (const Color &c)
 
void setFillEnabled (bool value)
 
BorderStylegetBorderStyle (int side)
 Gets the style for one of the borders. More...
 
void setShaderEnabled (bool value)
 Enables or disables shaders for this widget. More...
 
bool isShaderEnabled ()
 
void setShaderName (const String &name)
 Sets the name of the shader used by this widget. More...
 
const String & getShaderName ()
 
Color getDebugColor ()
 Debug mode. More...
 
void setDebugColor (omega::Color value)
 Sets the color used when widget debug mode is enabled. More...
 
bool isDebugModeEnabled ()
 Returns true if debug mode is enabled for this widget. More...
 
void setDebugModeEnabled (bool value)
 Enabled or disabled debug mode for this widget. More...
 
void setPreDrawCallback (PyObject *predcb)
 Scriptable draw callbacks. More...
 
void setPostDrawCallback (PyObject *postdcb)
 Sets a python function to be called right before rendering of this widget terminates. More...
 
- Public Member Functions inherited from omega::RenderableFactory
 RenderableFactory ()
 
virtual ~RenderableFactory ()
 
virtual void initialize (Engine *srv)
 
void dispose ()
 
void refresh ()
 
virtual bool isInitialized ()
 
RenderablegetRenderable (Renderer *client)
 
EnginegetEngine ()
 
- Public Member Functions inherited from omicron::ReferenceType
 ReferenceType ()
 
virtual ~ReferenceType ()
 
void ref ()
 
void unref ()
 
long refCount ()
 

Static Public Member Functions

static TextBoxcreate (Container *container)
 
- Static Public Member Functions inherited from omegaToolkit::ui::Label
static Labelcreate (Container *container)
 
- Static Public Member Functions inherited from omegaToolkit::ui::Widget
static Widgetcreate (Container *parent)
 
template<typename W >
static W * getSource (const Event &evt)
 
- Static Public Member Functions inherited from omicron::ReferenceType
static void printObjCounts ()
 

Protected Member Functions

virtual void activate ()
 Called when this widget becomes the active widget. More...
 
virtual void deactivate ()
 Called when this widget is not the active widget anymore. More...
 
- Protected Member Functions inherited from omegaToolkit::ui::Label
unsigned int getFontAlignFlags ()
 
virtual void updateStyle ()
 
- Protected Member Functions inherited from omegaToolkit::ui::Widget
bool simpleHitTest (const omega::Vector2f &point)
 
void setContainer (Container *value)
 
void dispatchUIEvent (const Event &evt)
 
void playMenuScrollSound ()
 
bool needLayoutRefresh ()
 internal layout management More...
 
void setActualSize (int value, Orientation orientation, bool force=false)
 
- Protected Member Functions inherited from omega::RenderableFactory
RenderableaddRenderable (Renderer *cli)
 

Additional Inherited Members

- Static Public Attributes inherited from omegaToolkit::ui::Widget
static const int MaxWidgets = 16384
 
- Static Protected Member Functions inherited from omegaToolkit::ui::Widget
static bool simpleHitTest (const omega::Vector2f &point, const omega::Vector2f &pos, const omega::Vector2f &size)
 
- Protected Attributes inherited from omegaToolkit::ui::Label
String myText
 
String myFont
 
Color myColor
 
HorizontalAlign myHorizontalAlign
 
VerticalAlign myVerticalAlign
 
int myAutosizeHorizontalPadding
 
int myAutosizeVerticalPadding
 
- Protected Attributes inherited from omegaToolkit::ui::Widget
omega::Vector2f myPosition
 
omega::Vector2f mySize
 
float myRotation
 
- Static Protected Attributes inherited from omicron::ReferenceType
static List< ReferenceType * > mysObjList
 
+ Inheritance diagram for omegaToolkit::ui::TextBox:

Member Enumeration Documentation

Enumerator
AlignRight 
AlignLeft 
AlignCenter 
Enumerator
AlignTop 
AlignMiddle 
AlignBottom 

Constructor & Destructor Documentation

omegaToolkit::ui::TextBox::TextBox ( Engine server)
virtual omegaToolkit::ui::TextBox::~TextBox ( )
virtual

Member Function Documentation

virtual void omegaToolkit::ui::TextBox::activate ( )
protectedvirtual

Called when this widget becomes the active widget.

Derivec classes can implement this method to specify a custom activation behavior

Reimplemented from omegaToolkit::ui::Widget.

static TextBox* omegaToolkit::ui::TextBox::create ( Container container)
static
virtual void omegaToolkit::ui::TextBox::deactivate ( )
protectedvirtual

Called when this widget is not the active widget anymore.

Derivec classes can implement this method to specify a custom deactivation behavior

Reimplemented from omegaToolkit::ui::Widget.

virtual void omegaToolkit::ui::TextBox::handleEvent ( const Event &  evt)
virtual

Reimplemented from omegaToolkit::ui::Widget.

virtual void omegaToolkit::ui::TextBox::update ( const omega::UpdateContext context)
virtual

Reimplemented from omegaToolkit::ui::Widget.

virtual void omegaToolkit::ui::TextBox::updateSize ( )
virtual

Reimplemented from omegaToolkit::ui::Widget.


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