Inheritance diagram for CEGUI::Editbox:
Public Member Functions | |
bool | hasInputFocus (void) const |
return true if the Editbox has input focus. | |
bool | isReadOnly (void) const |
return true if the Editbox is read-only. | |
bool | isTextMasked (void) const |
return true if the text for the Editbox will be rendered masked. | |
bool | isTextValid (void) const |
return true if the Editbox text is valid given the currently set validation string. | |
const String & | getValidationString (void) const |
return the currently set validation string | |
size_t | getCaratIndex (void) const |
return the current position of the carat. | |
size_t | getSelectionStartIndex (void) const |
return the current selection start point. | |
size_t | getSelectionEndIndex (void) const |
return the current selection end point. | |
size_t | getSelectionLength (void) const |
return the length of the current selection (in code points / characters). | |
utf32 | getMaskCodePoint (void) const |
return the utf32 code point used when rendering masked text. | |
size_t | getMaxTextLength (void) const |
return the maximum text length set for this Editbox. | |
colour | getNormalTextColour (void) const |
return the currently set colour to be used for rendering Editbox text in the normal, unselected state. | |
colour | getSelectedTextColour (void) const |
return the currently set colour to be used for rendering the Editbox text when within the selected region. | |
colour | getNormalSelectBrushColour (void) const |
return the currently set colour to be used for rendering the Editbox selection highlight when the Editbox is active. | |
colour | getInactiveSelectBrushColour (void) const |
return the currently set colour to be used for rendering the Editbox selection highlight when the Editbox is inactive. | |
void | setReadOnly (bool setting) |
Specify whether the Editbox is read-only. | |
void | setTextMasked (bool setting) |
Specify whether the text for the Editbox will be rendered masked. | |
void | setValidationString (const String &validation_string) |
Set the text validation string. | |
void | setCaratIndex (size_t carat_pos) |
Set the current position of the carat. | |
void | setSelection (size_t start_pos, size_t end_pos) |
Define the current selection for the Editbox. | |
void | setMaskCodePoint (utf32 code_point) |
set the utf32 code point used when rendering masked text. | |
void | setMaxTextLength (size_t max_len) |
set the maximum text length for this Editbox. | |
void | setNormalTextColour (const colour &col) |
Set the colour to be used for rendering Editbox text in the normal, unselected state. | |
void | setSelectedTextColour (const colour &col) |
Set the colour to be used for rendering the Editbox text when within the selected region. | |
void | setNormalSelectBrushColour (const colour &col) |
Set the colour to be used for rendering the Editbox selection highlight when the Editbox is active. | |
void | setInactiveSelectBrushColour (const colour &col) |
Set the colour to be used for rendering the Editbox selection highlight when the Editbox is inactive. | |
Editbox (const String &type, const String &name) | |
Constructor for Editbox class. | |
virtual | ~Editbox (void) |
Destructor for Editbox class. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const argb_t | DefaultNormalTextColour = 0xFFFFFFFF |
Colour applied to normal unselected text. | |
static const argb_t | DefaultSelectedTextColour = 0xFF000000 |
Colour applied to selected text. | |
static const argb_t | DefaultNormalSelectionColour = 0xFF6060FF |
Colour applied to normal selection brush. | |
static const argb_t | DefaultInactiveSelectionColour = 0xFF808080 |
Colour applied to selection brush when widget is inactive. | |
static const String | EventReadOnlyModeChanged |
The read-only mode for the edit box has been changed. | |
static const String | EventMaskedRenderingModeChanged |
The masked rendering mode (password mode) has been changed. | |
static const String | EventMaskCodePointChanged |
The code point (character) to use for masked text has been changed. | |
static const String | EventValidationStringChanged |
The validation string has been changed. | |
static const String | EventMaximumTextLengthChanged |
The maximum allowable string length has been changed. | |
static const String | EventTextInvalidated |
Some operation has made the current text invalid with regards to the validation string. | |
static const String | EventInvalidEntryAttempted |
The user attempted to modify the text in a way that would have made it invalid. | |
static const String | EventCaratMoved |
The text carat (insert point) has changed. | |
static const String | EventTextSelectionChanged |
The current text selection has changed. | |
static const String | EventEditboxFull |
The number of characters in the edit box has reached the current maximum. | |
static const String | EventTextAccepted |
The user has accepted the current text by pressing Return, Enter, or Tab. | |
Protected Member Functions | |
void | addEditboxEvents (void) |
Add edit box specific events. | |
virtual size_t | getTextIndexFromPosition (const Point &pt) const =0 |
Return the text code point index that is rendered closest to screen position pt. | |
void | clearSelection (void) |
Clear the current selection setting. | |
void | eraseSelectedText (bool modify_text=true) |
Erase the currently selected text. | |
bool | isStringValid (const String &str) const |
return true if the given string matches the validation regular expression. | |
void | handleBackspace (void) |
Processing for backspace key. | |
void | handleDelete (void) |
Processing for Delete key. | |
void | handleCharLeft (uint sysKeys) |
Processing to move carat one character left. | |
void | handleWordLeft (uint sysKeys) |
Processing to move carat one word left. | |
void | handleCharRight (uint sysKeys) |
Processing to move carat one character right. | |
void | handleWordRight (uint sysKeys) |
Processing to move carat one word right. | |
void | handleHome (uint sysKeys) |
Processing to move carat to the start of the text. | |
void | handleEnd (uint sysKeys) |
Processing to move carat to the end of the text. | |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. | |
virtual void | onReadOnlyChanged (WindowEventArgs &e) |
Event fired internally when the read only state of the Editbox has been changed. | |
virtual void | onMaskedRenderingModeChanged (WindowEventArgs &e) |
Event fired internally when the masked rendering mode (password mode) has been changed. | |
virtual void | onMaskCodePointChanged (WindowEventArgs &e) |
Event fired internally when the code point to use for masked rendering has been changed. | |
virtual void | onValidationStringChanged (WindowEventArgs &e) |
Event fired internally when the validation string is changed. | |
virtual void | onMaximumTextLengthChanged (WindowEventArgs &e) |
Event fired internally when the maximum text length for the edit box is changed. | |
virtual void | onTextInvalidatedEvent (WindowEventArgs &e) |
Event fired internally when something has caused the current text to now fail validation. | |
virtual void | onInvalidEntryAttempted (WindowEventArgs &e) |
Event fired internally when the user attempted to make a change to the edit box that would have caused it to fail validation. | |
virtual void | onCaratMoved (WindowEventArgs &e) |
Event fired internally when the carat (insert point) position changes. | |
virtual void | onTextSelectionChanged (WindowEventArgs &e) |
Event fired internally when the current text selection changes. | |
virtual void | onEditboxFullEvent (WindowEventArgs &e) |
Event fired internally when the edit box text has reached the set maximum length. | |
virtual void | onTextAcceptedEvent (WindowEventArgs &e) |
Event fired internally when the user accepts the edit box text by pressing Return, Enter, or Tab. | |
virtual void | onMouseButtonDown (MouseEventArgs &e) |
Handler called when a mouse button has been depressed within this window's area. | |
virtual void | onMouseButtonUp (MouseEventArgs &e) |
Handler called when a mouse button has been released within this window's area. | |
virtual void | onMouseDoubleClicked (MouseEventArgs &e) |
Handler called when a mouse button has been double-clicked within this window's area. | |
virtual void | onMouseTripleClicked (MouseEventArgs &e) |
Handler called when a mouse button has been triple-clicked within this window's area. | |
virtual void | onMouseMove (MouseEventArgs &e) |
Handler called when the mouse cursor has been moved within this window's area. | |
virtual void | onCaptureLost (WindowEventArgs &e) |
Handler called when this window loses capture of mouse inputs. | |
virtual void | onCharacter (KeyEventArgs &e) |
Handler called when a character-key has been pressed while this window has input focus. | |
virtual void | onKeyDown (KeyEventArgs &e) |
Handler called when a key as been depressed while this window has input focus. | |
virtual void | onTextChanged (WindowEventArgs &e) |
Handler called when the window's text is changed. | |
Protected Attributes | |
bool | d_readOnly |
True if the editbox is in read-only mode. | |
bool | d_maskText |
True if the editbox text should be rendered masked. | |
utf32 | d_maskCodePoint |
Code point to use when rendering masked text. | |
size_t | d_maxTextLen |
Maximum number of characters for this Editbox. | |
size_t | d_caratPos |
Position of the carat / insert-point. | |
size_t | d_selectionStart |
Start of selection area. | |
size_t | d_selectionEnd |
End of selection area. | |
String | d_validationString |
Copy of validation reg-ex string. | |
RegexValidator * | d_validator |
RegEx String used for validation of text. | |
bool | d_dragging |
true when a selection is being dragged. | |
size_t | d_dragAnchorIdx |
Selection index for drag selection anchor point. | |
colour | d_normalTextColour |
Text colour used normally. | |
colour | d_selectTextColour |
Text colour used when text is highlighted. | |
colour | d_selectBrushColour |
Colour to apply to the selection brush. | |
colour | d_inactiveSelectBrushColour |
Colour to apply to the selection brush when widget is inactive / read-only. |
|
Erase the currently selected text.
|
|
return the current position of the carat.
|
|
return the currently set colour to be used for rendering the Editbox selection highlight when the Editbox is inactive.
|
|
return the utf32 code point used when rendering masked text.
|
|
return the maximum text length set for this Editbox.
|
|
return the currently set colour to be used for rendering the Editbox selection highlight when the Editbox is active.
|
|
return the currently set colour to be used for rendering Editbox text in the normal, unselected state.
|
|
return the currently set colour to be used for rendering the Editbox text when within the selected region.
|
|
return the current selection end point.
|
|
return the length of the current selection (in code points / characters).
|
|
return the current selection start point.
|
|
Return the text code point index that is rendered closest to screen position pt.
|
|
return the currently set validation string
|
|
return true if the Editbox has input focus.
|
|
return true if the Editbox is read-only.
|
|
return true if the text for the Editbox will be rendered masked.
|
|
return true if the Editbox text is valid given the currently set validation string.
|
|
Handler called when this window loses capture of mouse inputs.
Reimplemented from CEGUI::Window. |
|
Handler called when a character-key has been pressed while this window has input focus.
Reimplemented from CEGUI::Window. |
|
Handler called when a key as been depressed while this window has input focus.
Reimplemented from CEGUI::Window. |
|
Handler called when a mouse button has been depressed within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when a mouse button has been released within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when a mouse button has been double-clicked within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when the mouse cursor has been moved within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when a mouse button has been triple-clicked within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when the window's text is changed.
Reimplemented from CEGUI::Window. |
|
Event fired internally when something has caused the current text to now fail validation. This can be caused by changing the validation string or setting a maximum length that causes the current text to be truncated. |
|
Set the current position of the carat.
|
|
Set the colour to be used for rendering the Editbox selection highlight when the Editbox is inactive.
|
|
set the utf32 code point used when rendering masked text.
|
|
set the maximum text length for this Editbox.
|
|
Set the colour to be used for rendering the Editbox selection highlight when the Editbox is active.
|
|
Set the colour to be used for rendering Editbox text in the normal, unselected state.
|
|
Specify whether the Editbox is read-only.
|
|
Set the colour to be used for rendering the Editbox text when within the selected region.
|
|
Define the current selection for the Editbox.
|
|
Specify whether the text for the Editbox will be rendered masked.
|
|
Set the text validation string.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented from CEGUI::Window. |