Space Engineers
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties | List of all members
Sandbox.Graphics.GUI.MyGuiControlList Class Reference
Inheritance diagram for Sandbox.Graphics.GUI.MyGuiControlList:
Sandbox.Graphics.GUI.MyGuiControlParent Sandbox.Graphics.GUI.MyGuiControlBase Sandbox.Graphics.GUI.IMyGuiControlsParent Sandbox.Graphics.GUI.IMyGuiControlsOwner Sandbox.Graphics.GUI.IMyGuiControlsOwner

Classes

class  StyleDefinition
 

Public Member Functions

 MyGuiControlList ()
 
 MyGuiControlList (Vector2?position=null, Vector2?size=null, Vector4?backgroundColor=null, String toolTip=null, MyGuiControlListStyleEnum visualStyle=MyGuiControlListStyleEnum.Default)
 
override void Init (MyObjectBuilder_GuiControlBase builder)
 
void InitControls (IEnumerable< MyGuiControlBase > controls)
 
override MyObjectBuilder_GuiControlBase GetObjectBuilder ()
 
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...
 
void Recalculate ()
 
override void ShowToolTip ()
 
void SetScrollBarPage (float page=0)
 Set scroll to desired page. Default 0 mean start of the list. More...
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlParent
 MyGuiControlParent ()
 
 MyGuiControlParent (Vector2?position=null, Vector2?size=null, Vector4?backgroundColor=null, String toolTip=null)
 
override void Init (MyObjectBuilder_GuiControlBase builder)
 
override MyObjectBuilder_GuiControlBase GetObjectBuilder ()
 
override 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...
 
override MyGuiControlBase GetExclusiveInputHandler ()
 
override bool IsMouseOverAnyControl ()
 
override MyGuiControlBase GetMouseOverControl ()
 Returns first control, which has mouse over. More...
 
override MyGuiControlGridDragAndDrop GetDragAndDropHandlingNow ()
 
override void HideToolTip ()
 
override void ShowToolTip ()
 
override void Update ()
 
override void OnRemoving ()
 Removes various references and clears event handlers. More...
 
override MyGuiControlBase GetNextFocusControl (MyGuiControlBase currentFocusControl, bool forwardMovement)
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlBase
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)
 
void GetElementsUnderCursor (Vector2 position, bool visibleOnly, List< MyGuiControlBase > controls)
 
override string ToString ()
 

Static Public Member Functions

static StyleDefinition GetVisualStyle (MyGuiControlListStyleEnum 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)
 

Protected Member Functions

override void OnPositionChanged ()
 
override void OnSizeChanged ()
 
override void OnHasHighlightChanged ()
 
- 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 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

MyGuiControlListStyleEnum VisualStyle [get, set]
 
- Properties inherited from Sandbox.Graphics.GUI.MyGuiControlParent
MyGuiControls Controls [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]
 
- Properties inherited from Sandbox.Graphics.GUI.IMyGuiControlsParent
MyGuiControls Controls [get]
 

Additional Inherited Members

- 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.MyGuiControlBase
bool m_mouseButtonPressed = false
 
bool m_showToolTip = false
 
Vector2 m_toolTipPosition
 
- 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 13 of file MyGuiControlList.cs.

Constructor & Destructor Documentation

Sandbox.Graphics.GUI.MyGuiControlList.MyGuiControlList ( )
inline

Definition at line 74 of file MyGuiControlList.cs.

Sandbox.Graphics.GUI.MyGuiControlList.MyGuiControlList ( Vector2 position = null,
Vector2 size = null,
Vector4 backgroundColor = null,
String  toolTip = null,
MyGuiControlListStyleEnum  visualStyle = MyGuiControlListStyleEnum.Default 
)
inline

Definition at line 76 of file MyGuiControlList.cs.

Member Function Documentation

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 136 of file MyGuiControlList.cs.

override MyObjectBuilder_GuiControlBase Sandbox.Graphics.GUI.MyGuiControlList.GetObjectBuilder ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 126 of file MyGuiControlList.cs.

static StyleDefinition Sandbox.Graphics.GUI.MyGuiControlList.GetVisualStyle ( MyGuiControlListStyleEnum  style)
inlinestatic

Definition at line 49 of file MyGuiControlList.cs.

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

override void Sandbox.Graphics.GUI.MyGuiControlList.Init ( MyObjectBuilder_GuiControlBase  builder)
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 100 of file MyGuiControlList.cs.

void Sandbox.Graphics.GUI.MyGuiControlList.InitControls ( IEnumerable< MyGuiControlBase controls)
inline

Definition at line 109 of file MyGuiControlList.cs.

override void Sandbox.Graphics.GUI.MyGuiControlList.OnHasHighlightChanged ( )
inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 273 of file MyGuiControlList.cs.

override void Sandbox.Graphics.GUI.MyGuiControlList.OnPositionChanged ( )
inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 177 of file MyGuiControlList.cs.

override void Sandbox.Graphics.GUI.MyGuiControlList.OnSizeChanged ( )
inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 184 of file MyGuiControlList.cs.

void Sandbox.Graphics.GUI.MyGuiControlList.Recalculate ( )
inline

Definition at line 190 of file MyGuiControlList.cs.

void Sandbox.Graphics.GUI.MyGuiControlList.SetScrollBarPage ( float  page = 0)
inline

Set scroll to desired page. Default 0 mean start of the list.

Parameters
page

Definition at line 289 of file MyGuiControlList.cs.

override void Sandbox.Graphics.GUI.MyGuiControlList.ShowToolTip ( )
inlinevirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 279 of file MyGuiControlList.cs.

Property Documentation

MyGuiControlListStyleEnum Sandbox.Graphics.GUI.MyGuiControlList.VisualStyle
getset

Definition at line 62 of file MyGuiControlList.cs.


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