Inheritance diagram for Sandbox.Graphics.GUI.MyGuiControlTextbox:

Classes
struct	MySkipCombination

class	StyleDefinition

Public Member Functions
bool	TextEquals (StringBuilder text)

void	GetText (StringBuilder result)

void	SetText (StringBuilder source)
	Copies string from source to internal string builder More...

	MyGuiControlTextbox ()

	MyGuiControlTextbox (Vector2?position=null, string defaultText=null, int maxLength=512, Vector4?textColor=null, float textScale=MyGuiConstants.DEFAULT_TEXT_SCALE, MyGuiControlTextboxType type=MyGuiControlTextboxType.Normal, MyGuiControlTextboxStyleEnum visualStyle=MyGuiControlTextboxStyleEnum.Default)

override void	Init (MyObjectBuilder_GuiControlBase objectBuilder)

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

bool	IsSkipCharacter (MyKeys character)

void	MoveCarriageToEnd ()

void	SelectAll ()
	GR: Use this to select all text outside for current textbox. More...

void	ApplyStyle (StyleDefinition style)

Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlBase
virtual MyObjectBuilder_GuiControlBase	GetObjectBuilder ()

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)

virtual void	Clear ()

override string	ToString ()

Static Public Member Functions
static StyleDefinition	GetVisualStyle (MyGuiControlTextboxStyleEnum style)

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
MyGuiControlTextboxType	Type

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 Member Functions
override void	OnHasHighlightChanged ()

override void	OnSizeChanged ()

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	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
int	MaxLength `[get, set]`

float	TextScale `[get, set]`

float	TextScaleWithLanguage `[get]`

string	Text `[get, set]`
	When setting text to textbox, make sure you won't set it to unsuported charact More...

MyGuiControlTextboxStyleEnum	VisualStyle `[get, set]`

int	CarriagePositionIndex `[get]`

MySkipCombination[]	SkipCombinations `[get, set]`

string	TextFont `[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]`

Events
Action< MyGuiControlTextbox >	TextChanged

Action< MyGuiControlTextbox >	EnterPressed

Events inherited from Sandbox.Graphics.GUI.MyGuiControlBase
Action< MyGuiControlBase, NameChangedArgs >	NameChanged

Action< MyGuiControlBase >	SizeChanged

VisibleChangedDelegate	VisibleChanged

Action< MyGuiControlBase, bool >	FocusChanged
	Called when the control enters or leaves focus. More...

Additional Inherited Members
Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiControlBase
bool	m_mouseButtonPressed = false

bool	m_showToolTip = false

Vector2	m_toolTipPosition

Detailed Description

Definition at line 37 of file MyGuiControlTextbox.cs.

Constructor & Destructor Documentation

Sandbox.Graphics.GUI.MyGuiControlTextbox.MyGuiControlTextbox ( )

inline

Definition at line 248 of file MyGuiControlTextbox.cs.

Sandbox.Graphics.GUI.MyGuiControlTextbox.MyGuiControlTextbox	(	Vector2?	position = `null`,
		string	defaultText = `null`,
		int	maxLength = `512`,
		Vector4?	textColor = `null`,
		float	textScale = `MyGuiConstants.DEFAULT_TEXT_SCALE`,
		MyGuiControlTextboxType	type = `MyGuiControlTextboxType.Normal`,
		MyGuiControlTextboxStyleEnum	visualStyle = `MyGuiControlTextboxStyleEnum.Default`
	)

inline

Definition at line 250 of file MyGuiControlTextbox.cs.

Member Function Documentation

void Sandbox.Graphics.GUI.MyGuiControlTextbox.ApplyStyle ( StyleDefinition style )

inline

Definition at line 911 of file MyGuiControlTextbox.cs.

override void Sandbox.Graphics.GUI.MyGuiControlTextbox.Draw	(	float	transitionAlpha,
		float	backgroundTransitionAlpha
	)

inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 285 of file MyGuiControlTextbox.cs.

void Sandbox.Graphics.GUI.MyGuiControlTextbox.GetText ( StringBuilder result )

inline

Definition at line 151 of file MyGuiControlTextbox.cs.

static StyleDefinition Sandbox.Graphics.GUI.MyGuiControlTextbox.GetVisualStyle ( MyGuiControlTextboxStyleEnum style )

inlinestatic

Definition at line 72 of file MyGuiControlTextbox.cs.

override MyGuiControlBase Sandbox.Graphics.GUI.MyGuiControlTextbox.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 392 of file MyGuiControlTextbox.cs.

override void Sandbox.Graphics.GUI.MyGuiControlTextbox.Init ( MyObjectBuilder_GuiControlBase objectBuilder )

inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 275 of file MyGuiControlTextbox.cs.

bool Sandbox.Graphics.GUI.MyGuiControlTextbox.IsSkipCharacter ( MyKeys character )

inline

Definition at line 543 of file MyGuiControlTextbox.cs.

void Sandbox.Graphics.GUI.MyGuiControlTextbox.MoveCarriageToEnd ( )

inline

Definition at line 666 of file MyGuiControlTextbox.cs.

override void Sandbox.Graphics.GUI.MyGuiControlTextbox.OnHasHighlightChanged ( )

inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 633 of file MyGuiControlTextbox.cs.

override void Sandbox.Graphics.GUI.MyGuiControlTextbox.OnSizeChanged ( )

inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 639 of file MyGuiControlTextbox.cs.

void Sandbox.Graphics.GUI.MyGuiControlTextbox.SelectAll ( )

inline

GR: Use this to select all text outside for current textbox.

Definition at line 903 of file MyGuiControlTextbox.cs.

void Sandbox.Graphics.GUI.MyGuiControlTextbox.SetText ( StringBuilder source )

inline

Copies string from source to internal string builder

Definition at line 159 of file MyGuiControlTextbox.cs.

bool Sandbox.Graphics.GUI.MyGuiControlTextbox.TextEquals ( StringBuilder text )

inline

Definition at line 146 of file MyGuiControlTextbox.cs.

Member Data Documentation

MyGuiControlTextboxType Sandbox.Graphics.GUI.MyGuiControlTextbox.Type

Definition at line 169 of file MyGuiControlTextbox.cs.

Property Documentation

int Sandbox.Graphics.GUI.MyGuiControlTextbox.CarriagePositionIndex

getprotected

Definition at line 187 of file MyGuiControlTextbox.cs.

int Sandbox.Graphics.GUI.MyGuiControlTextbox.MaxLength

getset

Definition at line 100 of file MyGuiControlTextbox.cs.

MySkipCombination [] Sandbox.Graphics.GUI.MyGuiControlTextbox.SkipCombinations

getset

Definition at line 237 of file MyGuiControlTextbox.cs.

string Sandbox.Graphics.GUI.MyGuiControlTextbox.Text

getset

When setting text to textbox, make sure you won't set it to unsuported charact

Definition at line 131 of file MyGuiControlTextbox.cs.

string Sandbox.Graphics.GUI.MyGuiControlTextbox.TextFont

get

Definition at line 895 of file MyGuiControlTextbox.cs.

float Sandbox.Graphics.GUI.MyGuiControlTextbox.TextScale

getset

Definition at line 111 of file MyGuiControlTextbox.cs.

float Sandbox.Graphics.GUI.MyGuiControlTextbox.TextScaleWithLanguage

get

Definition at line 121 of file MyGuiControlTextbox.cs.

MyGuiControlTextboxStyleEnum Sandbox.Graphics.GUI.MyGuiControlTextbox.VisualStyle

getset

Definition at line 172 of file MyGuiControlTextbox.cs.

Event Documentation

Action<MyGuiControlTextbox> Sandbox.Graphics.GUI.MyGuiControlTextbox.EnterPressed

Definition at line 244 of file MyGuiControlTextbox.cs.

Action<MyGuiControlTextbox> Sandbox.Graphics.GUI.MyGuiControlTextbox.TextChanged

Definition at line 243 of file MyGuiControlTextbox.cs.

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

Sources/Sandbox.Graphics/Gui/MyGuiControlTextbox.cs

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Properties

Events

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation

Event Documentation