Space Engineers
Public Member Functions | Protected Member Functions | Properties | List of all members
Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText Class Reference
Inheritance diagram for Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText:
Sandbox.Graphics.GUI.MyGuiControlMultilineText Sandbox.Graphics.GUI.MyGuiControlBase Sandbox.Graphics.GUI.IMyGuiControlsOwner

Public Member Functions

 MyGuiControlMultilineEditableText (Vector2?position=null, Vector2?size=null, Vector4?backgroundColor=null, string font=MyFontEnum.Blue, float textScale=MyGuiConstants.DEFAULT_TEXT_SCALE, MyGuiDrawAlignEnum textAlign=MyGuiDrawAlignEnum.HORISONTAL_LEFT_AND_VERTICAL_TOP, StringBuilder contents=null, bool drawScrollbar=true, MyGuiDrawAlignEnum textBoxAlign=MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER, int?visibleLinesCount=null, MyGuiCompositeTexture backgroundTexture=null, MyGuiBorderThickness?textPadding=null)
 
override MyGuiControlBase HandleInput ()
 Method returns true if input was captured by control, so no other controls, nor screen can use input in this update. More...
 
int GetCurrentCarriageLine ()
 
int MeasureNumLines (string text)
 
bool CarriageMoved ()
 
int GetTotalNumLines ()
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlMultilineText
 MyGuiControlMultilineText ()
 
 MyGuiControlMultilineText (Vector2?position=null, Vector2?size=null, Vector4?backgroundColor=null, string font=MyFontEnum.Blue, float textScale=MyGuiConstants.DEFAULT_TEXT_SCALE, MyGuiDrawAlignEnum textAlign=MyGuiDrawAlignEnum.HORISONTAL_LEFT_AND_VERTICAL_TOP, StringBuilder contents=null, bool drawScrollbar=true, MyGuiDrawAlignEnum textBoxAlign=MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER, int?visibleLinesCount=null, bool selectable=false, bool showTextShadow=false, MyGuiCompositeTexture backgroundTexture=null, MyGuiBorderThickness?textPadding=null)
 
override void Init (MyObjectBuilder_GuiControlBase objectBuilder)
 
override MyObjectBuilder_GuiControlBase GetObjectBuilder ()
 
void RefreshText (bool useEnum)
 Sets the text to the given StringBuilder value. Layouts the controls. More...
 
void AppendText (StringBuilder text)
 
void AppendText (StringBuilder text, string font, float scale, Vector4 color)
 
void AppendText (string text)
 
void AppendText (string text, string font, float scale, Vector4 color)
 
void AppendImage (string texture, Vector2 size, Vector4 color)
 
void AppendLink (string url, string text)
 
void AppendLine ()
 
void Clear ()
 
override void Draw (float transitionAlpha, float backgroundTransitionAlpha)
 
override MyGuiControlBase HandleInput ()
 Method returns true if input was captured by control, so no other controls, nor screen can use input in this update. More...
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlBase
virtual MyGuiControlGridDragAndDrop GetDragAndDropHandlingNow ()
 
virtual MyGuiControlBase GetExclusiveInputHandler ()
 
virtual MyGuiControlBase GetMouseOverControl ()
 Returns first control, which has mouse over. More...
 
virtual void HideToolTip ()
 
virtual bool IsMouseOverAnyControl ()
 
virtual void ShowToolTip ()
 
virtual void Update ()
 
virtual bool CheckMouseOver ()
 Checks if mouse cursor is over control. GR: Update: Also check if mouse over parent controls. Slower but more solid implementation (and we get rid of a few bugs). Also there is no need for HandleMouse variable (removed) More...
 
virtual string GetMouseCursorTexture ()
 
Vector2 GetPositionAbsolute ()
 
Vector2 GetPositionAbsoluteBottomLeft ()
 
Vector2 GetPositionAbsoluteBottomRight ()
 
Vector2 GetPositionAbsoluteCenterLeft ()
 
Vector2 GetPositionAbsoluteCenter ()
 
Vector2 GetPositionAbsoluteTopLeft ()
 
Vector2 GetPositionAbsoluteTopRight ()
 
Vector2 GetSize ()
 
void SetToolTip (MyToolTips toolTip)
 
void SetToolTip (String text)
 
void SetToolTip (MyStringId text)
 
virtual void OnRemoving ()
 Removes various references and clears event handlers. More...
 
void GetElementsUnderCursor (Vector2 position, bool visibleOnly, List< MyGuiControlBase > controls)
 
virtual MyGuiControlBase GetNextFocusControl (MyGuiControlBase currentFocusControl, bool forwardMovement)
 
override string ToString ()
 

Protected Member Functions

override float ComputeRichLabelWidth ()
 
void HandleTextInputBuffered (ref MyGuiControlBase ret)
 
override Vector2 GetCarriageOffset (int idx)
 
override int GetLineStartIndex (int idx)
 
override int GetCarriagePositionFromMouseCursor ()
 
override int GetIndexUnderCarriage (int idx)
 
override int GetIndexOverCarriage (int idx)
 
- Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlMultilineText
override void OnSizeChanged ()
 
int GetLineEndIndex (int idx)
 
- Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlBase
 MyGuiControlBase (Vector2?position=null, Vector2?size=null, Vector4?colorMask=null, String toolTip=null, MyGuiCompositeTexture backgroundTexture=null, bool isActiveControl=true, bool canHaveFocus=false, bool allowFocusingElements=false, MyGuiControlHighlightType highlightType=MyGuiControlHighlightType.WHEN_ACTIVE, MyGuiDrawAlignEnum originAlign=MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER)
 
void DrawBackground (float transitionAlpha)
 
void DrawBorder (float transitionAlpha)
 
virtual bool ShouldHaveHighlight ()
 
virtual void OnHasHighlightChanged ()
 
virtual void OnPositionChanged ()
 
virtual void OnVisibleChanged ()
 
virtual void OnOriginAlignChanged ()
 
virtual void OnEnabledChanged ()
 
virtual void OnColorMaskChanged ()
 
MyGuiScreenBase GetTopMostOwnerScreen ()
 
bool IsMouseOverOrKeyboardActive ()
 
virtual void DrawElements (float transitionAlpha, float backgroundTransitionAlpha)
 
MyGuiControlBase HandleInputElements ()
 
virtual void ClearEvents ()
 

Properties

override StringBuilder Text [get, set]
 
- Properties inherited from Sandbox.Graphics.GUI.MyGuiControlMultilineText
int CarriagePositionIndex [get, set]
 
bool Selectable [get]
 
virtual StringBuilder Text [get, set]
 
MyStringId TextEnum [get, set]
 
string Font [get, set]
 
Color TextColor [get, set]
 Gets or sets the color of the text. More...
 
Vector2 TextSize [get]
 
int NumberOfRows [get]
 
float ScrollbarOffset [get, set]
 
float TextScale [get, set]
 
float TextScaleWithLanguage [get]
 
bool ShowTextShadow [get]
 
MyGuiDrawAlignEnum TextAlign [get, set]
 Alignment of text as if you were specifying it in MS Word. This controls the appearance of text itself. More...
 
MyGuiDrawAlignEnum TextBoxAlign [get, set]
 Alignment of box containing text within the control. Eg. if text does not fill whole control horizontally, this will specify how should sides of the box be aligned. More...
 
float ScrollbarValue [get]
 
- Properties inherited from Sandbox.Graphics.GUI.MyGuiControlBase
float Alpha [get, set]
 
string Name [get, set]
 
IMyGuiControlsOwner Owner [get]
 
MyToolTips Tooltips [get]
 
Vector2 Position [get, set]
 Position of control's center (normalized and relative to parent screen center (not left/top corner!!!)) More...
 
float PositionY [get, set]
 
float PositionX [get, set]
 
Vector2 Size [get, set]
 Size of control (normalized). More...
 
Vector2 MinSize [get, protected set]
 
Vector2 MaxSize [get, protected set]
 
Vector4 ColorMask [get, set]
 
int BorderSize [get, set]
 
bool Enabled [get, set]
 False to disable control, disabled controls are skipped when switching with Tab key etc., look implemented atm. only in MyGuiControlButton. More...
 
MyGuiDrawAlignEnum OriginAlign [get, set]
 
bool Visible [get, set]
 Says whether control is visible. Note that this is not a constant time operation (checks parents, fires events on set). More...
 
bool HasHighlight [get]
 Says whether control is currently highlighted. When control is highlit depends on HighlightType. More...
 
bool HasFocus [get]
 
bool IsMouseOver [get, set]
 
bool CanHaveFocus [get, set]
 
bool AllowFocusingElements [get, set]
 Indicates whether elements can have focus or not. More...
 
object UserData [get, set]
 Specific user data for this control. More...
 
string DebugNamePath [get]
 
- Properties inherited from Sandbox.Graphics.GUI.IMyGuiControlsOwner
string DebugNamePath [get]
 
string Name [get]
 
IMyGuiControlsOwner Owner [get]
 

Additional Inherited Members

- Static Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlBase
static void ReadIfHasValue< T > (ref T target, T?source)
 
static void ReadIfHasValue (ref Color target, Vector4?source)
 
static MyGuiControlBase GetExclusiveInputHandler (MyGuiControls controls)
 
static Color ApplyColorMaskModifiers (Vector4 sourceColorMask, bool enabled, float transitionAlpha)
 Modifies source color mask using transition alpha and color multiplier in case a control is disabled. More...
 
static bool CheckMouseOver (Vector2 size, Vector2 position, MyGuiDrawAlignEnum originAlign)
 
static bool IsPointInside (Vector2 queryPoint, Vector2 size, Vector2 position, MyGuiDrawAlignEnum originAlign)
 
- Public Attributes inherited from Sandbox.Graphics.GUI.MyGuiControlBase
readonly MyGuiControls Elements
 
MyGuiCompositeTexture BackgroundTexture
 
Vector4 BorderColor
 
bool BorderEnabled
 
bool DrawWhilePaused
 
bool ShowTooltipWhenDisabled
 
bool IsActiveControl
 There are some controls, that cannot receive any handle input(control panel for example), thus disable them with this. More...
 
MyGuiControlHighlightType HighlightType
 
- Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiControlMultilineText
readonly StringBuilder m_tmpOffsetMeasure = new StringBuilder()
 
MyRichLabel m_label
 
MyKeyThrottler m_keyThrottler
 
int m_carriagePositionIndex
 
MyGuiControlMultilineSelection m_selection
 
StringBuilder m_text
 
- Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiControlBase
bool m_mouseButtonPressed = false
 
bool m_showToolTip = false
 
Vector2 m_toolTipPosition
 
- Events inherited from Sandbox.Graphics.GUI.MyGuiControlMultilineText
LinkClicked OnLinkClicked
 
- Events inherited from Sandbox.Graphics.GUI.MyGuiControlBase
Action< MyGuiControlBase, NameChangedArgsNameChanged
 
Action< MyGuiControlBaseSizeChanged
 
VisibleChangedDelegate VisibleChanged
 
Action< MyGuiControlBase, bool > FocusChanged
 Called when the control enters or leaves focus. More...
 

Detailed Description

Definition at line 12 of file MyGuiControlMultilineEditableText.cs.

Constructor & Destructor Documentation

Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.MyGuiControlMultilineEditableText ( Vector2 position = null,
Vector2 size = null,
Vector4 backgroundColor = null,
string  font = MyFontEnum.Blue,
float  textScale = MyGuiConstants.DEFAULT_TEXT_SCALE,
MyGuiDrawAlignEnum  textAlign = MyGuiDrawAlignEnum.HORISONTAL_LEFT_AND_VERTICAL_TOP,
StringBuilder  contents = null,
bool  drawScrollbar = true,
MyGuiDrawAlignEnum  textBoxAlign = MyGuiDrawAlignEnum.HORISONTAL_CENTER_AND_VERTICAL_CENTER,
int?  visibleLinesCount = null,
MyGuiCompositeTexture  backgroundTexture = null,
MyGuiBorderThickness textPadding = null 
)
inline

Definition at line 33 of file MyGuiControlMultilineEditableText.cs.

Member Function Documentation

bool Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.CarriageMoved ( )
inline

Definition at line 355 of file MyGuiControlMultilineEditableText.cs.

override float Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.ComputeRichLabelWidth ( )
inlineprotectedvirtual
override Vector2 Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.GetCarriageOffset ( int  idx)
inlineprotectedvirtual
override int Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.GetCarriagePositionFromMouseCursor ( )
inlineprotectedvirtual
int Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.GetCurrentCarriageLine ( )
inline

Definition at line 324 of file MyGuiControlMultilineEditableText.cs.

override int Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.GetIndexOverCarriage ( int  idx)
inlineprotectedvirtual
override int Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.GetIndexUnderCarriage ( int  idx)
inlineprotectedvirtual
override int Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.GetLineStartIndex ( int  idx)
inlineprotectedvirtual
int Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.GetTotalNumLines ( )
inline

Definition at line 365 of file MyGuiControlMultilineEditableText.cs.

override MyGuiControlBase Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.HandleInput ( )
inlinevirtual

Method returns true if input was captured by control, so no other controls, nor screen can use input in this update.

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 72 of file MyGuiControlMultilineEditableText.cs.

void Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.HandleTextInputBuffered ( ref MyGuiControlBase  ret)
inlineprotected

Definition at line 165 of file MyGuiControlMultilineEditableText.cs.

int Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.MeasureNumLines ( string  text)
inline

Definition at line 342 of file MyGuiControlMultilineEditableText.cs.

Property Documentation

override StringBuilder Sandbox.Graphics.GUI.MyGuiControlMultilineEditableText.Text
getset

Definition at line 54 of file MyGuiControlMultilineEditableText.cs.


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