Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members | Tutorials
Public Member Functions | List of all members
irr::gui::IGUIEditBox Class Reference

Single line edit box for editing simple text. More...

#include <IGUIEditBox.h>

Inheritance diagram for irr::gui::IGUIEditBox:
irr::gui::IGUIElement irr::io::IAttributeExchangingObject irr::IEventReceiver irr::IReferenceCounted

Public Member Functions

virtual void enableOverrideColor (bool enable)=0
 Sets if the text should use the override color or the color in the gui skin.
virtual u32 getMax () const =0
 Returns maximum amount of characters, previously set by setMax();.
virtual core::dimension2du getTextDimension ()=0
 Gets the size area of the text in the edit box.
 IGUIEditBox (IGUIEnvironment *environment, IGUIElement *parent, s32 id, core::rect< s32 > rectangle)
 constructor
virtual bool isAutoScrollEnabled () const =0
 Checks to see if automatic scrolling is enabled.
virtual bool isMultiLineEnabled () const =0
 Checks if multi line editing is enabled.
virtual bool isPasswordBox () const =0
 Returns true if the edit box is currently a password box.
virtual bool isWordWrapEnabled () const =0
 Checks if word wrap is enabled.
virtual void setAutoScroll (bool enable)=0
 Enables or disables automatic scrolling with cursor position.
virtual void setDrawBorder (bool border)=0
 Turns the border on or off.
virtual void setMax (u32 max)=0
 Sets the maximum amount of characters which may be entered in the box.
virtual void setMultiLine (bool enable)=0
 Enables or disables newlines.
virtual void setOverrideColor (video::SColor color)=0
 Sets another color for the text.
virtual void setOverrideFont (IGUIFont *font=0)=0
 Sets another skin independent font.
virtual void setPasswordBox (bool passwordBox, wchar_t passwordChar=L'*')=0
 Sets whether the edit box is a password box. Setting this to true will.
virtual void setTextAlignment (EGUI_ALIGNMENT horizontal, EGUI_ALIGNMENT vertical)=0
 Sets text justification mode.
virtual void setWordWrap (bool enable)=0
 Enables or disables word wrap.
- Public Member Functions inherited from irr::gui::IGUIElement
virtual void addChild (IGUIElement *child)
 Adds a GUI element as new child of this element.
virtual bool bringToFront (IGUIElement *element)
 Brings a child to front.
virtual void deserializeAttributes (io::IAttributes *in, io::SAttributeReadWriteOptions *options=0)
 Reads attributes of the scene node.
virtual void draw ()
 Draws the element and its children.
core::rect< s32getAbsoluteClippingRect () const
 Returns the visible area of the element.
core::rect< s32getAbsolutePosition () const
 Gets the absolute rectangle of this element.
virtual const core::list
< IGUIElement * > & 
getChildren () const
 Returns list with children of this element.
virtual IGUIElementgetElementFromId (s32 id, bool searchchildren=false) const
 Finds the first element with the given id.
IGUIElementgetElementFromPoint (const core::position2d< s32 > &point)
 Returns the topmost GUI element at the specific position.
virtual s32 getID () const
 Returns id. Can be used to identify the element.
bool getNextElement (s32 startOrder, bool reverse, bool group, IGUIElement *&first, IGUIElement *&closest, bool includeInvisible=false) const
 searches elements to find the closest next element to tab to
IGUIElementgetParent () const
 Returns parent of this element.
core::rect< s32getRelativePosition () const
 Returns the relative rectangle of this element.
IGUIElementgetTabGroup ()
 Returns the container element which holds all elements in this element's tab group.
s32 getTabOrder () const
 Returns the number in the tab order sequence.
virtual const wchar_t * getText () const
 Returns caption of this element.
virtual const core::stringwgetToolTipText () const
 Returns caption of this element.
EGUI_ELEMENT_TYPE getType () const
 Returns the type of the gui element.
virtual const c8getTypeName () const
 Returns the type name of the gui element.
virtual bool hasType (EGUI_ELEMENT_TYPE type) const
 Returns true if the gui element supports the given type.
 IGUIElement (EGUI_ELEMENT_TYPE type, IGUIEnvironment *environment, IGUIElement *parent, s32 id, const core::rect< s32 > &rectangle)
 Constructor.
virtual bool isEnabled () const
 Returns true if element is enabled.
bool isMyChild (IGUIElement *child) const
bool isNotClipped () const
 Gets whether the element will ignore its parent's clipping rectangle.
virtual bool isPointInside (const core::position2d< s32 > &point) const
 Returns true if a point is within this element.
virtual bool isSubElement () const
 Returns true if this element was created as part of its parent control.
bool isTabGroup () const
 Returns true if this element is a tab group.
bool isTabStop () const
 Returns true if this element can be focused by navigating with the tab key.
virtual bool isVisible () const
 Returns true if element is visible.
virtual void move (core::position2d< s32 > absoluteMovement)
 Moves this element.
virtual bool OnEvent (const SEvent &event)
 Called if an event happened.
virtual void OnPostRender (u32 timeMs)
 animate the element and its children.
virtual void remove ()
 Removes this element from its parent.
virtual void removeChild (IGUIElement *child)
 Removes a child.
virtual void serializeAttributes (io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const
 Writes attributes of the scene node.
void setAlignment (EGUI_ALIGNMENT left, EGUI_ALIGNMENT right, EGUI_ALIGNMENT top, EGUI_ALIGNMENT bottom)
 The alignment defines how the borders of this element will be positioned when the parent element is resized.
virtual void setEnabled (bool enabled)
 Sets the enabled state of this element.
virtual void setID (s32 id)
 Sets the id of this element.
void setMaxSize (core::dimension2du size)
 Sets the maximum size allowed for this element.
void setMinSize (core::dimension2du size)
 Sets the minimum size allowed for this element.
void setNotClipped (bool noClip)
 Sets whether the element will ignore its parent's clipping rectangle.
void setRelativePosition (const core::rect< s32 > &r)
 Sets the relative rectangle of this element.
void setRelativePosition (const core::position2di &position)
 Sets the relative rectangle of this element, maintaining its current width and height.
void setRelativePositionProportional (const core::rect< f32 > &r)
 Sets the relative rectangle of this element as a proportion of its parent's area.
virtual void setSubElement (bool subElement)
 Sets whether this control was created as part of its parent.
void setTabGroup (bool isGroup)
 Sets whether this element is a container for a group of elements which can be navigated using the tab key.
void setTabOrder (s32 index)
 Sets the priority of focus when using the tab key to navigate between a group of elements.
void setTabStop (bool enable)
 If set to true, the focus will visit this element when using the tab key to cycle through elements.
virtual void setText (const wchar_t *text)
 Sets the new caption of this element.
virtual void setToolTipText (const wchar_t *text)
 Sets the new caption of this element.
virtual void setVisible (bool visible)
 Sets the visible state of this element.
virtual void updateAbsolutePosition ()
 Updates the absolute position.
virtual ~IGUIElement ()
 Destructor.
- Public Member Functions inherited from irr::IEventReceiver
virtual ~IEventReceiver ()
 Destructor.

Additional Inherited Members

- Protected Member Functions inherited from irr::gui::IGUIElement
void addChildToEnd (IGUIElement *child)
void recalculateAbsolutePosition (bool recursive)
- Protected Attributes inherited from irr::gui::IGUIElement
core::rect< s32AbsoluteClippingRect
 absolute clipping rect of element
core::rect< s32AbsoluteRect
 absolute rect of element
EGUI_ALIGNMENT AlignBottom
EGUI_ALIGNMENT AlignLeft
 tells the element how to act when its parent is resized
EGUI_ALIGNMENT AlignRight
EGUI_ALIGNMENT AlignTop
core::list< IGUIElement * > Children
 List of all children of this element.
core::rect< s32DesiredRect
IGUIEnvironmentEnvironment
 GUI Environment.
s32 ID
 id
bool IsEnabled
 is enabled?
bool IsSubElement
 is a part of a larger whole and should not be serialized?
bool IsTabGroup
 tab groups are containers like windows, use ctrl+tab to navigate
bool IsTabStop
 tab stop like in windows
bool IsVisible
 is visible?
core::rect< s32LastParentRect
 for calculating the difference when resizing parent
core::dimension2du MaxSize
 maximum and minimum size of the element
core::dimension2du MinSize
bool NoClip
 does this element ignore its parent's clipping rectangle?
IGUIElementParent
 Pointer to the parent.
core::rect< s32RelativeRect
 relative rect of element
core::rect< f32ScaleRect
 relative scale of the element inside its parent
s32 TabOrder
 tab order
core::stringw Text
 caption
core::stringw ToolTipText
 tooltip
EGUI_ELEMENT_TYPE Type
 type of element

Detailed Description

Single line edit box for editing simple text.

Definition at line 18 of file IGUIEditBox.h.

Constructor & Destructor Documentation

irr::gui::IGUIEditBox::IGUIEditBox ( IGUIEnvironment environment,
IGUIElement parent,
s32  id,
core::rect< s32 rectangle 
)
inline

constructor

Definition at line 23 of file IGUIEditBox.h.

Member Function Documentation

virtual void irr::gui::IGUIEditBox::enableOverrideColor ( bool  enable)
pure virtual

Sets if the text should use the override color or the color in the gui skin.

\param enable: If set to true, the override color, which can be set

with IGUIEditBox::setOverrideColor is used, otherwise the EGDC_BUTTON_TEXT color of the skin.

virtual u32 irr::gui::IGUIEditBox::getMax ( ) const
pure virtual

Returns maximum amount of characters, previously set by setMax();.

virtual core::dimension2du irr::gui::IGUIEditBox::getTextDimension ( )
pure virtual

Gets the size area of the text in the edit box.

Returns
The size in pixels of the text
virtual bool irr::gui::IGUIEditBox::isAutoScrollEnabled ( ) const
pure virtual

Checks to see if automatic scrolling is enabled.

Returns
true if automatic scrolling is enabled, false if not
virtual bool irr::gui::IGUIEditBox::isMultiLineEnabled ( ) const
pure virtual

Checks if multi line editing is enabled.

Returns
true if multi-line is enabled, false otherwise
virtual bool irr::gui::IGUIEditBox::isPasswordBox ( ) const
pure virtual

Returns true if the edit box is currently a password box.

virtual bool irr::gui::IGUIEditBox::isWordWrapEnabled ( ) const
pure virtual

Checks if word wrap is enabled.

Returns
true if word wrap is enabled, false otherwise
virtual void irr::gui::IGUIEditBox::setAutoScroll ( bool  enable)
pure virtual

Enables or disables automatic scrolling with cursor position.

Parameters
enable,:If set to true, the text will move around with the cursor position
virtual void irr::gui::IGUIEditBox::setDrawBorder ( bool  border)
pure virtual

Turns the border on or off.

Parameters
border,:true if you want the border to be drawn, false if not
virtual void irr::gui::IGUIEditBox::setMax ( u32  max)
pure virtual

Sets the maximum amount of characters which may be entered in the box.

\param max: Maximum amount of characters. If 0, the character amount is

infinity.

virtual void irr::gui::IGUIEditBox::setMultiLine ( bool  enable)
pure virtual

Enables or disables newlines.

\param enable: If set to true, the EGET_EDITBOX_ENTER event will not be fired,

instead a newline character will be inserted.

virtual void irr::gui::IGUIEditBox::setOverrideColor ( video::SColor  color)
pure virtual

Sets another color for the text.

If set, the edit box does not use the EGDC_BUTTON_TEXT color defined

in the skin, but the set color instead. You don't need to call IGUIEditBox::enableOverrrideColor(true) after this, this is done by this function. If you set a color, and you want the text displayed with the color of the skin again, call IGUIEditBox::enableOverrideColor(false);

Parameters
color,:New color of the text.
virtual void irr::gui::IGUIEditBox::setOverrideFont ( IGUIFont font = 0)
pure virtual

Sets another skin independent font.

If this is set to zero, the button uses the font of the skin.
Parameters
font,:New font to set.
virtual void irr::gui::IGUIEditBox::setPasswordBox ( bool  passwordBox,
wchar_t  passwordChar = L'*' 
)
pure virtual

Sets whether the edit box is a password box. Setting this to true will.

disable MultiLine, WordWrap and the ability to copy with ctrl+c or ctrl+x
Parameters
passwordBox,:true to enable password, false to disable
passwordChar,:the character that is displayed instead of letters
virtual void irr::gui::IGUIEditBox::setTextAlignment ( EGUI_ALIGNMENT  horizontal,
EGUI_ALIGNMENT  vertical 
)
pure virtual

Sets text justification mode.

\param horizontal: EGUIA_UPPERLEFT for left justified (default),

EGUIA_LOWERRIGHT for right justified, or EGUIA_CENTER for centered text.

Parameters
vertical,:EGUIA_UPPERLEFT to align with top edge, EGUIA_LOWERRIGHT for bottom edge, or EGUIA_CENTER for centered text (default).
virtual void irr::gui::IGUIEditBox::setWordWrap ( bool  enable)
pure virtual

Enables or disables word wrap.

\param enable: If set to true, words going over one line are

broken to the next line.


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

The Irrlicht Engine
The Irrlicht Engine Documentation © 2003-2010 by Nikolaus Gebhardt. Generated on Fri Mar 21 2014 04:40:23 by Doxygen (1.8.1.2)