Space Engineers
Classes | Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
Sandbox.Graphics.GUI.MyGuiScreenMessageBox Class Reference
Inheritance diagram for Sandbox.Graphics.GUI.MyGuiScreenMessageBox:
Sandbox.Graphics.GUI.MyGuiScreenBase Sandbox.Graphics.GUI.IMyGuiControlsParent Sandbox.Graphics.GUI.IMyGuiControlsOwner

Classes

class  Style
 

Public Types

enum  ResultEnum { ResultEnum.YES, ResultEnum.NO, ResultEnum.CANCEL }
 

Public Member Functions

 MyGuiScreenMessageBox (MyMessageBoxStyleEnum styleEnum, MyMessageBoxButtonsType buttonType, StringBuilder messageText, StringBuilder messageCaption, MyStringId okButtonText, MyStringId cancelButtonText, MyStringId yesButtonText, MyStringId noButtonText, Action< ResultEnum > callback, int timeoutInMiliseconds, ResultEnum focusedResult, bool canHideOthers, Vector2?size)
 
override void RecreateControls (bool constructor)
 
override string GetFriendlyName ()
 For displaying in the list in the debug screen. More...
 
void OnYesClick (MyGuiControlButton sender)
 
void OnNoClick (MyGuiControlButton sender)
 
void OnCancelClick (MyGuiControlButton sender)
 
override bool Update (bool hasFocus)
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
delegate void ScreenHandler (MyGuiScreenBase source)
 
MyObjectBuilder_GuiScreen GetObjectBuilder ()
 
void Init (MyObjectBuilder_GuiScreen objectBuilder)
 
virtual void LoadContent ()
 
virtual void LoadData ()
 
virtual void UnloadContent ()
 
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 ()
 
virtual bool Draw ()
 
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 ()
 
virtual int GetTransitionOpeningTime ()
 
virtual int GetTransitionClosingTime ()
 
virtual void OnRemoved ()
 Called when [show]. More...
 

Public Attributes

Action< ResultEnumResultCallback
 
- Public Attributes inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
Action OnLoadingAction
 
readonly MyGuiControls Elements
 

Protected Member Functions

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...
 
- 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 ()
 

Properties

bool CloseBeforeCallback [get, set]
 
bool InstantClose [get, set]
 
new bool CanHideOthers [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]
 

Additional Inherited Members

- Static Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
static string MakeScreenFilepath (string name)
 
- 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
 
- Events inherited from Sandbox.Graphics.GUI.MyGuiScreenBase
ScreenHandler Closed
 
VisibleChangedDelegate VisibleChanged
 
Action< MyGuiScreenBaseDataLoading
 
Action< MyGuiScreenBaseDataUnloading
 

Detailed Description

Definition at line 28 of file MyGuiScreenMessageBox.cs.

Member Enumeration Documentation

Enumerator
YES 
NO 
CANCEL 

Definition at line 62 of file MyGuiScreenMessageBox.cs.

Constructor & Destructor Documentation

Sandbox.Graphics.GUI.MyGuiScreenMessageBox.MyGuiScreenMessageBox ( MyMessageBoxStyleEnum  styleEnum,
MyMessageBoxButtonsType  buttonType,
StringBuilder  messageText,
StringBuilder  messageCaption,
MyStringId  okButtonText,
MyStringId  cancelButtonText,
MyStringId  yesButtonText,
MyStringId  noButtonText,
Action< ResultEnum callback,
int  timeoutInMiliseconds,
ResultEnum  focusedResult,
bool  canHideOthers,
Vector2 size 
)
inline

Definition at line 96 of file MyGuiScreenMessageBox.cs.

Member Function Documentation

override void Sandbox.Graphics.GUI.MyGuiScreenMessageBox.Canceling ( )
inlineprotectedvirtual

Called when user presses ESC or clicks on CANCEL - hook to this method so you can do gui-screen-specific event

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 314 of file MyGuiScreenMessageBox.cs.

override string Sandbox.Graphics.GUI.MyGuiScreenMessageBox.GetFriendlyName ( )
inlinevirtual

For displaying in the list in the debug screen.

Returns

Implements Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 246 of file MyGuiScreenMessageBox.cs.

void Sandbox.Graphics.GUI.MyGuiScreenMessageBox.OnCancelClick ( MyGuiControlButton  sender)
inline

Definition at line 261 of file MyGuiScreenMessageBox.cs.

void Sandbox.Graphics.GUI.MyGuiScreenMessageBox.OnNoClick ( MyGuiControlButton  sender)
inline

Definition at line 256 of file MyGuiScreenMessageBox.cs.

void Sandbox.Graphics.GUI.MyGuiScreenMessageBox.OnYesClick ( MyGuiControlButton  sender)
inline

Definition at line 251 of file MyGuiScreenMessageBox.cs.

override void Sandbox.Graphics.GUI.MyGuiScreenMessageBox.RecreateControls ( bool  constructor)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 161 of file MyGuiScreenMessageBox.cs.

override bool Sandbox.Graphics.GUI.MyGuiScreenMessageBox.Update ( bool  hasFocus)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiScreenBase.

Definition at line 293 of file MyGuiScreenMessageBox.cs.

Member Data Documentation

Action<ResultEnum> Sandbox.Graphics.GUI.MyGuiScreenMessageBox.ResultCallback

Definition at line 71 of file MyGuiScreenMessageBox.cs.

Property Documentation

new bool Sandbox.Graphics.GUI.MyGuiScreenMessageBox.CanHideOthers
getset

Definition at line 91 of file MyGuiScreenMessageBox.cs.

bool Sandbox.Graphics.GUI.MyGuiScreenMessageBox.CloseBeforeCallback
getset

Definition at line 69 of file MyGuiScreenMessageBox.cs.

bool Sandbox.Graphics.GUI.MyGuiScreenMessageBox.InstantClose
getset

Definition at line 70 of file MyGuiScreenMessageBox.cs.


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