Engine.UIComp_DrawStringEditbox

Extends

UIComp_DrawString

Modifiers

within UIEditBox native ( inherit ) config ( UI )

This specialized version of UIComp_DrawString handles rendering UIStrings for editboxes. The responsibilities specific to rendering text in editboxes are: 1. A caret must be rendered at the appropriate location in the string 2. Ensuring that the text surrounding the caret is always visible 3. Tracking the text that was typed by the user independently from the data source that the owning widget is bound to. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. @todo - register this component with the data store for the caret image node so that it receives the refreshdatastore callback

Core.Object
|   
+-- Core.Component
   |   
   +-- Engine.UIComponent
      |   
      +-- Engine.UIComp_DrawComponents
         |   
         +-- Engine.UIComp_DrawString
            |   
            +-- Engine.UIComp_DrawStringEditbox

Functions Summary
	bool	ClearSelection ()
	string	GetSelectedText () con)
	bool	GetSelectionRange (out int out_StartIndex, out int out_EndIndex ) con)
	int	GetUserTextLength () con)
	bool	SetSelectionEnd (int EndIndex)
	bool	SetSelectionRange (int StartIndex, int EndIndex)
	bool	SetSelectionStart (int StartIndex)
	bool	SetUserText (string NewValue)

bRecalculateFirstCharacter Source code

indicates that the FirstCharacterPosition needs to be re-evaluated the next time the string is reformatted

CaretNode Source code

the image node that is used for rendering the caret

CaretOffset Source code

the offset (in pixels) from the left edge of the editbox's bounding region for rendering the caret

FirstCharacterPosition Source code

the position of the first visible character in the editbox

SelectionBackgroundColor Source code

the color to use for the background of a selected text block

SelectionRegion Source code

the editbox's selected text

SelectionTextColor Source code

the color to use for selected text

UserText Source code

Contains the text that the user has typed into the editbox

Presentation

StringCaret Source code

Controls whether and how a caret is displayed

UIStringSelectionRegion Source code

Defines a range of selected text in a UIString.

ClearSelection Source code

Clears the current selection region.
@return TRUE if the selection was cleared successfully.

GetSelectedText Source code

@return the string that is currently selected.

GetSelectionRange Source code

Retrieves the indexes of start and end characters of the selection region.
@param out_startIndex receives the index for the beginning of the selection region (guaranteed to be less than out_EndIndex)
@param out_EndIndex recieves the index for the end of the selection region.
@return TRUE if the selection region is valid.

GetUserTextLength Source code

Returns the length of UserText

SetSelectionEnd Source code

Sets the ending character for the selection region.
@param EndIndex the index of the character that should become the end of the selection region.
@return TRUE if the selection's ending index was changed successfully.

SetSelectionRange Source code

Change the range of selected characters in this editbox.
@param StartIndex the index of the first character that should be selected.
@param EndIndex the index of the last character that should be selected.
@return TRUE if the selection was changed successfully.

SetSelectionStart Source code

Sets the starting character for the selection region.
@param StartIndex the index of the character that should become the start of the selection region.
@return TRUE if the selection's starting index was changed successfully.

SetUserText Source code

Changes the value of UserText to the specified text without affecting the SetUserText should be used for modifying the "input text"; that is, the text that would potentially be published to the data store this editbox is bound to. SetValue should be used to change the raw string that will be parsed by the underlying UIString. UserText will be set to the resolved value of the parsed string.
@param NewText the new text that should be displayed
@return TRUE if the value changed.

defaultproperties
{
   StringCaret=(CaretWidth=1.000000,CaretStyle="DefaultCaretStyle")
   SelectionTextColor=(R=1.000000,G=1.000000,B=1.000000,A=1.000000)
   SelectionBackgroundColor=(R=0.654901,G=0.125490,B=0.019608,A=0.600000)
   TextStyleCustomization=(ClipMode=CLIP_Normal,ClipAlignment=UIALIGN_Right,bOverrideClipMode=True,bOverrideClipAlignment=True)
   StringStyle=(DefaultStyleTag="DefaultEditboxStyle")
   Name="Default__UIComp_DrawStringEditbox"
   ObjectArchetype=UIComp_DrawString'Engine.Default__UIComp_DrawString'
}