Space Engineers
Classes | Public Member Functions | Protected Member Functions | List of all members
Sandbox.Graphics.GUI.MyGuiScreenProgressBaseAsync< T > Class Template Reference
Inheritance diagram for Sandbox.Graphics.GUI.MyGuiScreenProgressBaseAsync< T >:
Sandbox.Graphics.GUI.MyGuiScreenProgressBase Sandbox.Graphics.GUI.MyGuiScreenBase Sandbox.Graphics.GUI.IMyGuiControlsParent Sandbox.Graphics.GUI.IMyGuiControlsOwner

Public Member Functions

override bool Update (bool hasFocus)
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenProgressBase
 MyGuiScreenProgressBase (MyStringId progressText, MyStringId?cancelText=null)
 
override void RecreateControls (bool constructor)
 
void Cancel ()
 
override bool Draw ()
 
override void LoadContent ()
 
override void UnloadContent ()
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
delegate void ScreenHandler (MyGuiScreenBase source)
 
MyObjectBuilder_GuiScreen GetObjectBuilder ()
 
void Init (MyObjectBuilder_GuiScreen objectBuilder)
 
virtual void LoadData ()
 
virtual void UnloadData ()
 
virtual void RunLoadingAction ()
 
bool IsMouseOverAnyControl ()
 
MyGuiControlBase GetMouseOverControl ()
 
virtual void GetControlsUnderMouseCursor (Vector2 position, List< MyGuiControlBase > controls, bool visibleOnly)
 
MyGuiControlBase GetNextFocusControl (MyGuiControlBase currentFocusControl, bool forwardMovement)
 
virtual void HandleInput (bool receivedFocusInThisUpdate)
 
virtual void InputLost ()
 
virtual void HandleUnhandledInput (bool receivedFocusInThisUpdate)
 
virtual bool HandleInputAfterSimulation ()
 
virtual bool CloseScreen ()
 
virtual bool HideScreen ()
 
virtual bool UnhideScreen ()
 
virtual void CloseScreenNow ()
 
void HideTooltips ()
 
Vector2 GetPositionAbsolute ()
 
Vector2 GetPositionAbsoluteCenter ()
 
Vector2 GetPositionAbsoluteTopLeft ()
 
bool GetDrawMouseCursor ()
 
bool IsTopMostScreen ()
 
bool IsAlwaysFirst ()
 
bool IsTopScreen ()
 
bool IsFirstForUnload ()
 
bool GetDrawScreenEvenWithoutFocus ()
 
Vector2 GetPosition ()
 
Vector2 GetSize ()
 
bool CanShareInput ()
 
bool CanCloseInCloseAllScreenCalls ()
 
abstract string GetFriendlyName ()
 For displaying in the list in the debug screen. More...
 
virtual int GetTransitionOpeningTime ()
 
virtual int GetTransitionClosingTime ()
 
virtual void OnRemoved ()
 Called when [show]. More...
 

Protected Member Functions

 MyGuiScreenProgressBaseAsync (MyStringId progressText, MyStringId?cancelText=null)
 
void AddAction (IAsyncResult asyncResult, ErrorHandler< T > errorHandler=null)
 
void AddAction (IAsyncResult asyncResult, ActionDoneHandler< T > doneHandler, ErrorHandler< T > errorHandler=null)
 
void CancelAll ()
 
override void OnCancelClick (MyGuiControlButton sender)
 
virtual void OnActionCompleted (IAsyncResult asyncResult, T asyncState)
 
virtual void OnError (Exception exception, T asyncState)
 
void Retry ()
 
- Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenProgressBase
override void Canceling ()
 Called when user presses ESC or clicks on CANCEL - hook to this method so you can do gui-screen-specific event More...
 
abstract void ProgressStart ()
 
- Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
 MyGuiScreenBase (Vector2?position=null, Vector4?backgroundColor=null, Vector2?size=null, bool isTopMostScreen=false, string backgroundTexture=null, float backgroundTransition=0.0f, float guiTransition=0.0f)
 
bool HandleKeyboardActiveIndex (bool forwardMovement)
 
bool IsMouseOver ()
 
MyGuiControlLabel AddCaption (MyStringId textEnum, Vector4?captionTextColor=null, Vector2?captionOffset=null, float captionScale=MyGuiConstants.DEFAULT_TEXT_SCALE)
 
MyGuiControlLabel AddCaption (String text, Vector4?captionTextColor=null, Vector2?captionOffset=null, float captionScale=MyGuiConstants.DEFAULT_TEXT_SCALE)
 
Color ApplyTransitionAlpha (Vector4 color, float transition)
 
virtual void OnShow ()
 Called when [show]. More...
 
virtual void OnHide ()
 Called when [show]. More...
 
virtual void OnClosed ()
 Called when [show]. More...
 
void MakeXAndYEqual (ref Vector2 val)
 Computes ratio of width and height in GUI coordinates to make X and Y of equal value represent same distance on screen as well. Then multiplies Y using this ratio. More...
 
Vector2 MakeXAndYEqual (Vector2 val)
 
void SetDefaultCloseButtonOffset ()
 

Additional Inherited Members

- Public Attributes inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
Action OnLoadingAction
 
readonly MyGuiControls Elements
 
- Static Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
static string MakeScreenFilepath (string name)
 
- Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiScreenProgressBase
MyGuiControlLabel m_progressTextLabel
 
MyGuiControlRotatingWheel m_rotatingWheel
 
bool ReturnToMainMenuOnError = false
 
- Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
Action OnEnterCallback
 
float m_transitionAlpha
 
float m_backgroundTransition
 
float m_guiTransition
 
Vector2 m_position
 
Color m_backgroundFadeColor
 
bool m_isTopMostScreen = false
 
bool m_isAlwaysFirst = false
 
bool m_isTopScreen = false
 
bool m_isFirstForUnload = false
 
Vector4 m_backgroundColor
 
string m_backgroundTexture
 
bool m_canCloseInCloseAllScreenCalls = true
 
Vector2 m_size
 
bool m_closeOnEsc = true
 
bool m_joystickAsMouse = true
 
bool m_defaultJoystickDpadUse = true
 
bool m_defaultJoystickCancelUse = true
 
bool m_drawEvenWithoutFocus = false
 
bool m_canShareInput = false
 
bool m_allowUnhidePreviousScreen
 
GuiSounds m_openingCueEnum
 
GuiSounds m_closingCueEnum
 
MyGuiControlGridDragAndDrop m_gridDragAndDropHandlingNow
 
MyGuiControlBase m_comboboxHandlingNow
 
MyGuiControlBase m_lastHandlingControl
 
- Properties inherited from Sandbox.Graphics.GUI.MyGuiScreenProgressBase
MyGuiControlRotatingWheel RotatingWheel [get]
 
MyStringId ProgressText [get, set]
 
String ProgressTextString [get, set]
 
- Properties inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
Color BackgroundFadeColor [get]
 
bool SkipTransition [get, set]
 
bool Cancelled [get]
 
bool DrawMouseCursor [get, set]
 
bool JoystickAsMouse [get, set]
 
MyGuiScreenState State [get, set]
 
bool IsLoaded [get, set]
 
bool EnabledBackgroundFade [get, protected set]
 Draw fade rectangle under top-most screen? More...
 
bool CanBeHidden [get, protected set]
 Indicates whether screen can be hidden when another screen is on top of it (assuming that screen hides screens below it). More...
 
bool CanHideOthers [get, protected set]
 Indicates whether screen can hide screens below it. This will not hide screens that cannot be hidden. More...
 
bool CanHaveFocus [get, protected set]
 Without focus, this screen will not steal input. More...
 
virtual MyGuiControls Controls [get]
 
Vector4 BackgroundColor [get, set]
 
Vector2 Size [get, set]
 
bool Visible [get]
 
Vector2 CloseButtonOffset [get, set]
 
bool CloseButtonEnabled [get, set]
 
MyGuiControlBase FocusedControl [get, set]
 
string DebugNamePath [get]
 
string Name [get]
 
IMyGuiControlsOwner Owner [get]
 
- Properties inherited from Sandbox.Graphics.GUI.IMyGuiControlsParent
MyGuiControls Controls [get]
 
- Properties inherited from Sandbox.Graphics.GUI.IMyGuiControlsOwner
string DebugNamePath [get]
 
string Name [get]
 
IMyGuiControlsOwner Owner [get]
 
- Events inherited from Sandbox.Graphics.GUI.MyGuiScreenProgressBase
Action ProgressCancelled
 
- Events inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
ScreenHandler Closed
 
VisibleChangedDelegate VisibleChanged
 
Action< MyGuiScreenBaseDataLoading
 
Action< MyGuiScreenBaseDataUnloading
 

Detailed Description

Definition at line 14 of file MyGuiScreenProgressBaseAsync.cs.

Constructor & Destructor Documentation

Sandbox.Graphics.GUI.MyGuiScreenProgressBaseAsync< T >.MyGuiScreenProgressBaseAsync ( MyStringId  progressText,
MyStringId cancelText = null 
)
inlineprotected

Definition at line 26 of file MyGuiScreenProgressBaseAsync.cs.

Member Function Documentation

void Sandbox.Graphics.GUI.MyGuiScreenProgressBaseAsync< T >.AddAction ( IAsyncResult  asyncResult,
ErrorHandler< T >  errorHandler = null 
)
inlineprotected

Definition at line 38 of file MyGuiScreenProgressBaseAsync.cs.

void Sandbox.Graphics.GUI.MyGuiScreenProgressBaseAsync< T >.AddAction ( IAsyncResult  asyncResult,
ActionDoneHandler< T >  doneHandler,
ErrorHandler< T >  errorHandler = null 
)
inlineprotected

Definition at line 43 of file MyGuiScreenProgressBaseAsync.cs.

void Sandbox.Graphics.GUI.MyGuiScreenProgressBaseAsync< T >.CancelAll ( )
inlineprotected

Definition at line 49 of file MyGuiScreenProgressBaseAsync.cs.

virtual void Sandbox.Graphics.GUI.MyGuiScreenProgressBaseAsync< T >.OnActionCompleted ( IAsyncResult  asyncResult,
asyncState 
)
inlineprotectedvirtual

Definition at line 92 of file MyGuiScreenProgressBaseAsync.cs.

override void Sandbox.Graphics.GUI.MyGuiScreenProgressBaseAsync< T >.OnCancelClick ( MyGuiControlButton  sender)
inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenProgressBase.

Definition at line 54 of file MyGuiScreenProgressBaseAsync.cs.

virtual void Sandbox.Graphics.GUI.MyGuiScreenProgressBaseAsync< T >.OnError ( Exception  exception,
asyncState 
)
inlineprotectedvirtual

Definition at line 97 of file MyGuiScreenProgressBaseAsync.cs.

void Sandbox.Graphics.GUI.MyGuiScreenProgressBaseAsync< T >.Retry ( )
inlineprotected

Definition at line 104 of file MyGuiScreenProgressBaseAsync.cs.

override bool Sandbox.Graphics.GUI.MyGuiScreenProgressBaseAsync< T >.Update ( bool  hasFocus)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 60 of file MyGuiScreenProgressBaseAsync.cs.


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