Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |
00001 00002 00003 00004 00005 00006 00007 00008 00009 00010 00011 00012 00013 00014 00015 00016 00017 00018 00019 00020 00021 00022 00023 00024 00025 00026 00027 00028 00029 00030 00031 00032 00033 00034 00035 00036 00037 00038 00039 00040 00041 00042 00043 00044 00045 00046 00047 00048 00049 00050 00051 00052 00053 00054 00055 00056 00057 00058 00059 00060 00061 00062 00063 00064 00065 00066 00067 00068 00069 00070 00071 00072 00073 00074 00075 00076 00077 00078 00079 00080 00081 00082 00083 00084 00085 00086 00087 00088 00089 00090 00091 00092 00093 00094 00095 00096 00097 00098 00099 00100 00101 00102 00103 00104 00105 00106 00107 00108 00109 00110 00111 00112 00113 00114 00115 00116 00117 00118 00119 00120 00121 00122 00123 00124 00125 00126 00127 00128 00129 00130 00131 00132 00133 00134 00135 00136 00137 00138 00139 00140 00141 00142 00143 00144 00145 00146 00147 00148 00149 00150 00151 00152 00153 00154 00155 00156 00157 00158 00159 00160 00161 00162 00163 00164 00165 00166 00167 00168 00169 00170 00171 00172 00173 00174 00175 00176 00177 00178 00179 00180 00181 00182 00183 00184 00185 00186 00187 00188 00189 00190 00191 00192 00193 00194 00195 00196 00197 00198 00199 00200 00201 00202 00203 00204 00205 00206 00207 00208 00209 00210 00211 00212 00213 00214 00215 00216 00217 00218 00219 00220 00221 00222 00223 00224 00225 00226 00227 00228 00229 00230 00231 00232 00233 00234 00235 00236 00237 00238 00239 00240 00241 00242 00243 00244 00245 00246 00247 00248 00249 00250 00251 00252 00253 00254 00255 00256 00257 00258 00259 00260 00261 00262 00263 00264 00265 00266 00267 00268 00269 00270 00271 00272 00273 00274 00275 00276 00277 00278 00279 00280 00281 00282 00283 00284 00285 00286 00287 00288 00289 00290 00291 00292 00293 00294 00295 00296 00297 00298 00299 00300 00301 00302 00303 00304 00305 00306 00307 00308 00309 00310 00311 00312 00313 00314 00315 00316 00317 00318 00319 00320 00321 00322 00323 00324 00325 00326 00327 00328 00329 00330 00331 00332 00333 00334 00335 00336 00337 00338 00339 00340 00341 00342 00343 00344 00345 00346 00347 00348 00349 00350 00351 00352 00353 00354 |
/** * 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 */ class UIComp_DrawStringEditbox extends UIComp_DrawString within UIEditBox native(inherit) config(UI); /** * Defines a range of selected text in a UIString. */ struct native transient UIStringSelectionRegion { var int SelectionStartCharIndex; var int SelectionEndCharIndex; // not yet implemented - will only be used if we later decide to go with using styles for the selection region. // // var float SelectionStartLocation; // var float SelectionEndLocation; // // var bool bRecalculateStartLocation, bRecalculateEndLocation; // // var UICombinedStyleData SelectionStyleData; structcpptext { /** * Determines whether this selection region contains characters. * * @param StringLength if specified, the range of selected characters will also be validated against this * value. Otherwise, the region is considered valid as long as the starting index is * greater than zero and the ending index is greater than the starting index. * * @return TRUE if a valid range of characters is selected. */ UBOOL IsValid( INT StringLength=INDEX_NONE ) const; /** * Resets this selection region. * * @return TRUE for success. */ UBOOL ClearSelection(); } structdefaultproperties { SelectionStartCharIndex=INDEX_NONE SelectionEndCharIndex=INDEX_NONE } }; /** Contains the text that the user has typed into the editbox */ var private{protected} transient string UserText; /** Controls whether and how a caret is displayed */ var(Presentation) UIStringCaretParameters StringCaret; /** the editbox's selected text */ var transient UIStringSelectionRegion SelectionRegion; /** the color to use for selected text */ var config LinearColor SelectionTextColor; /** the color to use for the background of a selected text block */ var config LinearColor SelectionBackgroundColor; /** the image node that is used for rendering the caret */ var const native private transient pointer CaretNode{struct FUIStringNode_Image}; /** the position of the first visible character in the editbox */ var const private transient int FirstCharacterPosition; /** indicates that the FirstCharacterPosition needs to be re-evaluated the next time the string is reformatted */ var const transient bool bRecalculateFirstCharacter; /** the offset (in pixels) from the left edge of the editbox's bounding region for rendering the caret */ var const transient float CaretOffset; // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) /* == Delegates == */ /* == Natives == */ /** * 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. */ native final function bool SetUserText( string NewValue ); /** * Returns the length of UserText */ native final function int GetUserTextLength() const; /** * 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. */ native final function bool SetSelectionRange( int StartIndex, int EndIndex ); /** * 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. */ native final function bool SetSelectionStart( int StartIndex ); /** * 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. */ native final function bool SetSelectionEnd( int EndIndex ); /** * Clears the current selection region. * * @return TRUE if the selection was cleared successfully. */ native final function bool ClearSelection(); /** * 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. */ native final function bool GetSelectionRange( out int out_StartIndex, out int out_EndIndex ) const; /** * @return the string that is currently selected. */ native final function string GetSelectedText() const; /* == Events == */ /* == UnrealScript == */ /* == SequenceAction handlers == */ 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' } |
Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |