Space Engineers
Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock > Class Template Reference
Inheritance diagram for Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >:
Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, StringBuilder > Sandbox.Game.Gui.ITerminalControlSync Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlTextbox Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalValueControl< StringBuilder > Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlTitleTooltip

Public Member Functions

delegate StringBuilder GetterDelegate (TBlock block)
 
delegate void SetterDelegate (TBlock block, StringBuilder value)
 
delegate void SerializerDelegate (BitStream stream, StringBuilder value)
 
 MyTerminalControlTextbox (string id, MyStringId title, MyStringId tooltip)
 
void Serialize (BitStream stream, MyTerminalBlock block)
 (De)serializes block data. More...
 
override StringBuilder GetValue (TBlock block)
 
override void SetValue (TBlock block, StringBuilder value)
 
override StringBuilder GetDefaultValue (TBlock block)
 
override StringBuilder GetMinimum (TBlock block)
 
override StringBuilder GetMaximum (TBlock block)
 
- Public Member Functions inherited from Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, StringBuilder >
delegate TValue GetterDelegate (TBlock block)
 
delegate void SetterDelegate (TBlock block, TValue value)
 
delegate void SerializerDelegate (BitStream stream, ref TValue value)
 
delegate void ExternalSetterDelegate (IMyTerminalBlock block, TValue value)
 
 MyTerminalValueControl (string id)
 
TValue GetValue (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
virtual void SetValue (TBlock block, TValue value)
 
void SetValue (VRage.Game.ModAPI.Ingame.IMyCubeBlock block, TValue value)
 
virtual void Serialize (BitStream stream, TBlock block)
 
void Serialize (BitStream stream, MyTerminalBlock block)
 (De)serializes block data. More...
 
TValue GetDefaultValue (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
TValue GetMininum (TBlock block)
 
TValue GetMininum (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
TValue GetMinimum (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
TValue GetMaximum (VRage.Game.ModAPI.Ingame.IMyCubeBlock block)
 
- Public Member Functions inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl
void RedrawControl ()
 Recreates the control GUI. This allows you to update the Title of some controls. More...
 
void UpdateVisual ()
 This updates a control that is currently displayed, allowing you to refresh it's state More...
 

Public Attributes

SerializerDelegate Serializer
 
MyStringId Title
 
MyStringId Tooltip
 
- Public Attributes inherited from Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, StringBuilder >
SerializerDelegate Serializer
 Serializer which (de)serializes the value. More...
 

Protected Member Functions

override MyGuiControlBase CreateGui ()
 
override void OnUpdateVisual ()
 

Properties

GetterDelegate Getter [set]
 Returns borrowed string builder instance which won't be stored or overwritten More...
 
SetterDelegate Setter [set]
 
Expression< Func< TBlock, StringBuilder > > MemberExpression [set]
 
- Properties inherited from Sandbox.Game.Screens.Terminal.Controls.MyTerminalValueControl< TBlock, StringBuilder >
GetterDelegate Getter [get, set]
 Getter which gets value from block. Can be set by anyone, but used only by MyTerminalValueControl. If you need to get the value, use GetValue method. More...
 
SetterDelegate Setter [get, set]
 Setter which sets value to block. Can be set by anyone, but used only by MyTerminalValueControl. If you need to set the value, use SetValue method, which does handles notification. More...
 
Expression< Func< TBlock, TValue > > MemberExpression [set]
 
- Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControl
string Id [get]
 Identifier of control More...
 
Func< IMyTerminalBlock, bool > Enabled [set]
 Allows you to set if the control is enabled More...
 
Func< IMyTerminalBlock, bool > Visible [set]
 Allows you to set if the control is visible More...
 
bool SupportsMultipleBlocks [get, set]
 Allows you to set if the control is visible when the block is selected as a group More...
 
- Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalValueControl< StringBuilder >
Func< IMyTerminalBlock, TValue > Getter [get, set]
 This is triggered when the value of the control is required. More...
 
Action< IMyTerminalBlock, TValue > Setter [get, set]
 This is triggered when the value of the control is set by the user. Depending on the control, this may be called a lot. More...
 
- Properties inherited from Sandbox.ModAPI.Interfaces.Terminal.IMyTerminalControlTitleTooltip
MyStringId Title [get, set]
 Allows you to get or set the Label that appears on the control More...
 
MyStringId Tooltip [get, set]
 Allows you to get or set the tooltip that appears when you hover over the control More...
 

Detailed Description

Type Constraints
TBlock :MyTerminalBlock 

Definition at line 22 of file MyTerminalControlTextbox.cs.

Constructor & Destructor Documentation

Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >.MyTerminalControlTextbox ( string  id,
MyStringId  title,
MyStringId  tooltip 
)
inline

Definition at line 55 of file MyTerminalControlTextbox.cs.

Member Function Documentation

override MyGuiControlBase Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >.CreateGui ( )
inlineprotected

Definition at line 77 of file MyTerminalControlTextbox.cs.

override StringBuilder Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >.GetDefaultValue ( TBlock  block)
inlinevirtual
override StringBuilder Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >.GetMaximum ( TBlock  block)
inlinevirtual
override StringBuilder Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >.GetMinimum ( TBlock  block)
inlinevirtual
delegate StringBuilder Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >.GetterDelegate ( TBlock  block)
override StringBuilder Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >.GetValue ( TBlock  block)
inlinevirtual
override void Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >.OnUpdateVisual ( )
inlineprotected

Definition at line 101 of file MyTerminalControlTextbox.cs.

void Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >.Serialize ( BitStream  stream,
MyTerminalBlock  block 
)
inline

(De)serializes block data.

Implements Sandbox.Game.Gui.ITerminalControlSync.

Definition at line 63 of file MyTerminalControlTextbox.cs.

delegate void Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >.SerializerDelegate ( BitStream  stream,
StringBuilder  value 
)
delegate void Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >.SetterDelegate ( TBlock  block,
StringBuilder  value 
)
override void Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >.SetValue ( TBlock  block,
StringBuilder  value 
)
inline

Definition at line 122 of file MyTerminalControlTextbox.cs.

Member Data Documentation

Definition at line 37 of file MyTerminalControlTextbox.cs.

Definition at line 39 of file MyTerminalControlTextbox.cs.

Definition at line 40 of file MyTerminalControlTextbox.cs.

Property Documentation

Returns borrowed string builder instance which won't be stored or overwritten

Definition at line 35 of file MyTerminalControlTextbox.cs.

Expression<Func<TBlock, StringBuilder> > Sandbox.Game.Gui.MyTerminalControlTextbox< TBlock >.MemberExpression
set

Definition at line 44 of file MyTerminalControlTextbox.cs.

Definition at line 36 of file MyTerminalControlTextbox.cs.


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