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 00355 00356 00357 00358 00359 00360 00361 00362 00363 00364 00365 00366 00367 00368 00369 00370 00371 00372 00373 00374 00375 00376 00377 00378 00379 00380 00381 00382 00383 00384 00385 00386 00387 00388 00389 00390 00391 00392 00393 00394 00395 00396 00397 00398 00399 00400 00401 00402 00403 00404 00405 00406 00407 00408 00409 00410 00411 00412 00413 00414 00415 00416 00417 00418 00419 00420 00421 00422 00423 00424 00425 00426 00427 00428 00429 00430 00431 00432 00433 00434 00435 00436 00437 00438 00439 00440 00441 00442 00443 00444 00445 00446 00447 00448 00449 00450 00451 00452 00453 00454 00455 00456 00457 00458 00459 00460 00461 00462 00463 00464 00465 00466 00467 00468 00469 00470 00471 00472 00473 00474 00475 00476 00477 00478 00479 00480 00481 00482 00483 00484 |
/** * Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. * * Option widget that works similar to a read only combobox. */ class UTUIOptionButton extends UTUI_Widget native(UI) placeable implements(UIDataStorePublisher); /** UI Key Action Events */ const UIKEY_MoveCursorLeft = 'UIKEY_MoveCursorLeft'; const UIKEY_MoveCursorRight = 'UIKEY_MoveCursorRight'; /** Arrow enums. */ enum EOptionButtonArrow { OPTBUT_ArrowLeft, OPTBUT_ArrowRight }; // (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) /** Left and right arrow buttons for this widget. */ var instanced UIButton ArrowLeftButton; var instanced UIButton ArrowRightButton; /** * The styles used for the increment, decrement and marker buttons */ var private UIStyleReference IncrementStyle; var private UIStyleReference DecrementStyle; /** Spacing between buttons and text. */ var(Presentation) UIScreenValue ButtonSpacing; /** Component for rendering the button background image */ var(Image) editinline const noclear UIComp_DrawImage BackgroundImageComponent; /** Renders the text displayed by this label */ var(Data) editinline const noclear UIComp_DrawString StringRenderComponent; /** Profile settings current index. */ var transient int CurrentIndex; /** this sound is played when the index is incremented */ var(Sound) name IncrementCue; /** this sound is played when the index is decremented */ var(Sound) name DecrementCue; /** Whether we should wrap the options or not, meaning if the user hits the beginning or the end of the list, they will wrap to the other end of the list. */ var() bool bWrapOptions; /** The data store that this list is bound to */ var(Data) UIDataStoreBinding DataSource; /** the list element provider referenced by DataSource */ var const transient UIListElementProvider DataProvider; /** If true, this widget won't attempt to align it's children */ var() bool bCustomPlacement; /** * @return TRUE if the CurrentIndex is at the start of the ValueMappings array, FALSE otherwise. */ native function bool HasPrevValue(); /** * @return TRUE if the CurrentIndex is at the start of the ValueMappings array, FALSE otherwise. */ native function bool HasNextValue(); /** * Moves the current index back by 1 in the valuemappings array if it isn't already at the front of the array. */ native function SetPrevValue(); /** * Moves the current index forward by 1 in the valuemappings array if it isn't already at the end of the array. */ native function SetNextValue(); event Initialized() { Super.Initialized(); VerifyArrowButtons(); } // since we now manage the styles for our internal buttons, make sure we're actually the owner of the button. (no flags were set on the buttons so you could reparent them in the editor) function VerifyArrowButtons() { if ( ArrowLeftButton != None && ArrowLeftButton.Outer != Self ) { WarnInternal(Name $ ".ArrowLeftButton (" $ ArrowLeftButton.Name $ ") has been reparented to " $ ArrowLeftButton.Outer $ "! This will trigger an assertion in the style system because UTUIOptionButton is responsible for resolving its style. This must be fixed by a programmer - set the PrivateFlags for UTUIOptionButton.LeftArrowButtonTemplate object to 0, then reparent the button to this widget."); } if ( ArrowRightButton != None && ArrowRightButton.Outer != Self ) { WarnInternal(Name $ ".ArrowRightButton (" $ ArrowRightButton.Name $ ") has been reparented to " $ ArrowRightButton.Outer $ "! This will trigger an assertion in the style system because UTUIOptionButton is responsible for resolving its style. This must be fixed by a programmer - set the PrivateFlags for UTUIOptionButton.ArrowRightButtonTempate object to 0, then reparent the button to this widget."); } } /** Called after the widget is done initializing. */ event PostInitialize() { Super.PostInitialize(); ArrowLeftButton.OnClicked = OnArrowLeft_Clicked; ArrowRightButton.OnClicked = OnArrowRight_Clicked; } /** Moves the current selection to the left. */ event OnMoveSelectionLeft(int PlayerIndex) { if(HasPrevValue()) { // Move to the prev value SetPrevValue(); // Play the decrement sound PlayUISound(DecrementCue,PlayerIndex); } } /** Moves the current selection to the right. */ event OnMoveSelectionRight(int PlayerIndex) { if(HasNextValue()) { // Move to the next value SetNextValue(); // Play the increment sound PlayUISound(IncrementCue,PlayerIndex); } } /** Arrow left clicked callback. */ function bool OnArrowLeft_Clicked(UIScreenObject InButton, int PlayerIndex) { if(IsFocused()==false) { SetFocus(none); } OnMoveSelectionLeft(PlayerIndex); return true; } /** Arrow right clicked callback. */ function bool OnArrowRight_Clicked(UIScreenObject InButton, int PlayerIndex) { if(IsFocused()==false) { SetFocus(none); } OnMoveSelectionRight(PlayerIndex); return true; } /** @return Returns the current index of the optionbutton. */ native function int GetCurrentIndex(); /** * Sets a new index for the option button. * * @param NewIndex New index for the option button. */ native function SetCurrentIndex(INT NewIndex); /** UIDataSourceSubscriber interface */ /** * Sets the data store binding for this object to the text specified. * * @param MarkupText a markup string which resolves to data exposed by a data store. The expected format is: * <DataStoreTag:DataFieldTag> * @param BindingIndex optional parameter for indicating which data store binding is being requested for those * objects which have multiple data store bindings. How this parameter is used is up to the * class which implements this interface, but typically the "primary" data store will be index 0. */ native final virtual function SetDataStoreBinding( string MarkupText, optional int BindingIndex=INDEX_NONE ); /** * Retrieves the markup string corresponding to the data store that this object is bound to. * * @param BindingIndex optional parameter for indicating which data store binding is being requested for those * objects which have multiple data store bindings. How this parameter is used is up to the * class which implements this interface, but typically the "primary" data store will be index 0. * * @return a datastore markup string which resolves to the datastore field that this object is bound to, in the format: * <DataStoreTag:DataFieldTag> */ native final virtual function string GetDataStoreBinding( optional int BindingIndex=INDEX_NONE ) const; /** * Resolves this subscriber's data store binding and updates the subscriber with the current value from the data store. * * @return TRUE if this subscriber successfully resolved and applied the updated value. */ native final virtual function bool RefreshSubscriberValue( optional int BindingIndex=INDEX_NONE ); /** * Handler for the UIDataStore.OnDataStoreValueUpdated delegate. Used by data stores to indicate that some data provided by the data * has changed. Subscribers should use this function to refresh any data store values being displayed with the updated value. * notify subscribers when they should refresh their values from this data store. * * @param SourceDataStore the data store that generated the refresh notification; useful for subscribers with multiple data store * bindings, to tell which data store sent the notification. * @param PropertyTag the tag associated with the data field that was updated; Subscribers can use this tag to determine whether * there is any need to refresh their data values. * @param SourceProvider for data stores which contain nested providers, the provider that contains the data which changed. * @param ArrayIndex for collection fields, indicates which element was changed. value of INDEX_NONE indicates not an array * or that the entire array was updated. */ native function NotifyDataStoreValueUpdated( UIDataStore SourceDataStore, bool bValuesInvalidated, name PropertyTag, UIDataProvider SourceProvider, int ArrayIndex ); /** * Retrieves the list of data stores bound by this subscriber. * * @param out_BoundDataStores receives the array of data stores that subscriber is bound to. */ native final virtual function GetBoundDataStores( out array<UIDataStore> out_BoundDataStores ); /** * Notifies this subscriber to unbind itself from all bound data stores */ native final virtual function ClearBoundDataStores(); /** UIDataSourcePublisher interface */ /** * Resolves this subscriber's data store binding and publishes this subscriber's value to the appropriate data store. * * @param out_BoundDataStores contains the array of data stores that widgets have saved values to. Each widget that * implements this method should add its resolved data store to this array after data values have been * published. Once SaveSubscriberValue has been called on all widgets in a scene, OnCommit will be called * on all data stores in this array. * @param BindingIndex optional parameter for indicating which data store binding is being requested for those * objects which have multiple data store bindings. How this parameter is used is up to the * class which implements this interface, but typically the "primary" data store will be index 0. * * @return TRUE if the value was successfully published to the data store. */ native virtual function bool SaveSubscriberValue( out array<UIDataStore> out_BoundDataStores, optional int BindingIndex=INDEX_NONE ); defaultproperties { Begin Object Class=UIButton Name=LeftArrowButtonTemplate ObjName=LeftArrowButtonTemplate Archetype=UIButton'Engine.Default__UIButton' Begin Object Class=UIComp_DrawImage Name=BackgroundImageTemplate ObjName=BackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIButton:BackgroundImageTemplate' ObjectArchetype=UIComp_DrawImage'Engine.Default__UIButton:BackgroundImageTemplate' End Object Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIButton:WidgetEventComponent' ObjectArchetype=UIComp_Event'Engine.Default__UIButton:WidgetEventComponent' End Object WidgetTag="butArrowLeft" TabIndex=0 PrivateFlags=2087 Position=(Value[0]=0.603122,Value[1]=0.125000,Value[2]=0.209372,Value[3]=0.750006) Name="LeftArrowButtonTemplate" ObjectArchetype=UIButton'Engine.Default__UIButton' End Object ArrowLeftButton=UIButton'UTGame.Default__UTUIOptionButton:LeftArrowButtonTemplate' Begin Object Class=UIButton Name=RightArrowButtonTemplate ObjName=RightArrowButtonTemplate Archetype=UIButton'Engine.Default__UIButton' Begin Object Class=UIComp_DrawImage Name=BackgroundImageTemplate ObjName=BackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIButton:BackgroundImageTemplate' ObjectArchetype=UIComp_DrawImage'Engine.Default__UIButton:BackgroundImageTemplate' End Object Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'Engine.Default__UIButton:WidgetEventComponent' ObjectArchetype=UIComp_Event'Engine.Default__UIButton:WidgetEventComponent' End Object WidgetTag="butArrowRight" TabIndex=1 PrivateFlags=2087 Position=(Value[0]=0.790628,Value[1]=0.125000,Value[2]=0.209372,Value[3]=0.750000) Name="RightArrowButtonTemplate" ObjectArchetype=UIButton'Engine.Default__UIButton' End Object ArrowRightButton=UIButton'UTGame.Default__UTUIOptionButton:RightArrowButtonTemplate' IncrementStyle=(DefaultStyleTag="DefaultOptionButtonRightArrowStyle",RequiredStyleClass=Class'Engine.UIStyle_Image') DecrementStyle=(DefaultStyleTag="DefaultOptionButtonLeftArrowStyle",RequiredStyleClass=Class'Engine.UIStyle_Image') ButtonSpacing=(ScaleType=EVALPOS_PixelOwner) Begin Object Class=UIComp_DrawImage Name=BackgroundImageTemplate ObjName=BackgroundImageTemplate Archetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage' StyleResolverTag="Background Image Style" ImageStyle=(DefaultStyleTag="OptionButtonBackground") Name="BackgroundImageTemplate" ObjectArchetype=UIComp_DrawImage'Engine.Default__UIComp_DrawImage' End Object BackgroundImageComponent=BackgroundImageTemplate Begin Object Class=UIComp_DrawString Name=LabelStringRenderer ObjName=LabelStringRenderer Archetype=UIComp_DrawString'Engine.Default__UIComp_DrawString' StyleResolverTag="Caption Style" StringStyle=(DefaultStyleTag="DefaultOptionButtonStyle") Name="LabelStringRenderer" ObjectArchetype=UIComp_DrawString'Engine.Default__UIComp_DrawString' End Object StringRenderComponent=LabelStringRenderer IncrementCue="SliderIncrement" DecrementCue="SliderDecrement" bWrapOptions=True DataSource=(RequiredFieldType=DATATYPE_Collection) Position=(Value[2]=256.000000,Value[3]=32.000000,ScaleType[2]=EVALPOS_PixelOwner,ScaleType[3]=EVALPOS_PixelOwner) DefaultStates(2)=Class'Engine.UIState_Focused' DefaultStates(3)=Class'Engine.UIState_Active' DefaultStates(4)=Class'Engine.UIState_Pressed' Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTUI_Widget:WidgetEventComponent' ObjectArchetype=UIComp_Event'UTGame.Default__UTUI_Widget:WidgetEventComponent' End Object EventProvider=WidgetEventComponent Name="Default__UTUIOptionButton" ObjectArchetype=UTUI_Widget'UTGame.Default__UTUI_Widget' } |
Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |