Space Engineers
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
Sandbox.Graphics.GUI.MyGuiControlTreeView Class Reference
Inheritance diagram for Sandbox.Graphics.GUI.MyGuiControlTreeView:
Sandbox.Graphics.GUI.MyGuiControlBase Sandbox.Graphics.GUI.ITreeView Sandbox.Graphics.GUI.IMyGuiControlsOwner

Public Member Functions

 MyGuiControlTreeView (Vector2 position, Vector2 size, Vector4 backgroundColor, bool canHandleKeyboardActiveControl)
 
MyTreeViewItem AddItem (StringBuilder text, string icon, Vector2 iconSize, string expandIcon, string collapseIcon, Vector2 expandIconSize)
 
void DeleteItem (MyTreeViewItem item)
 
MyTreeViewItem GetFocusedItem ()
 
void ClearItems ()
 
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 ShowToolTip (MyToolTips tooltip)
 
MyTreeViewItem GetItem (int index)
 
MyTreeViewItem GetItem (StringBuilder name)
 
int GetItemCount ()
 
void SetSize (Vector2 size)
 
void FilterTree (Predicate< MyTreeViewItem > itemFilter)
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlBase
virtual void Init (MyObjectBuilder_GuiControlBase builder)
 
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 ()
 

Public Attributes

bool WholeRowHighlight
 
- 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 OnPositionChanged ()
 
- 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 OnSizeChanged ()
 
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 ()
 

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)
 
- Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiControlBase
bool m_mouseButtonPressed = false
 
bool m_showToolTip = false
 
Vector2 m_toolTipPosition
 
- 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 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 8 of file MyGuiControlTreeView.cs.

Constructor & Destructor Documentation

Sandbox.Graphics.GUI.MyGuiControlTreeView.MyGuiControlTreeView ( Vector2  position,
Vector2  size,
Vector4  backgroundColor,
bool  canHandleKeyboardActiveControl 
)
inline

Definition at line 16 of file MyGuiControlTreeView.cs.

Member Function Documentation

MyTreeViewItem Sandbox.Graphics.GUI.MyGuiControlTreeView.AddItem ( StringBuilder  text,
string  icon,
Vector2  iconSize,
string  expandIcon,
string  collapseIcon,
Vector2  expandIconSize 
)
inline

Definition at line 35 of file MyGuiControlTreeView.cs.

void Sandbox.Graphics.GUI.MyGuiControlTreeView.ClearItems ( )
inline

Definition at line 50 of file MyGuiControlTreeView.cs.

void Sandbox.Graphics.GUI.MyGuiControlTreeView.DeleteItem ( MyTreeViewItem  item)
inline

Definition at line 40 of file MyGuiControlTreeView.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 55 of file MyGuiControlTreeView.cs.

void Sandbox.Graphics.GUI.MyGuiControlTreeView.FilterTree ( Predicate< MyTreeViewItem itemFilter)
inline

Definition at line 122 of file MyGuiControlTreeView.cs.

MyTreeViewItem Sandbox.Graphics.GUI.MyGuiControlTreeView.GetFocusedItem ( )
inline

Definition at line 45 of file MyGuiControlTreeView.cs.

MyTreeViewItem Sandbox.Graphics.GUI.MyGuiControlTreeView.GetItem ( int  index)
inline

Implements Sandbox.Graphics.GUI.ITreeView.

Definition at line 94 of file MyGuiControlTreeView.cs.

MyTreeViewItem Sandbox.Graphics.GUI.MyGuiControlTreeView.GetItem ( StringBuilder  name)
inline

Definition at line 99 of file MyGuiControlTreeView.cs.

int Sandbox.Graphics.GUI.MyGuiControlTreeView.GetItemCount ( )
inline

Implements Sandbox.Graphics.GUI.ITreeView.

Definition at line 104 of file MyGuiControlTreeView.cs.

override MyGuiControlBase Sandbox.Graphics.GUI.MyGuiControlTreeView.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 MyGuiControlTreeView.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 109 of file MyGuiControlTreeView.cs.

void Sandbox.Graphics.GUI.MyGuiControlTreeView.SetSize ( Vector2  size)
inline

Definition at line 115 of file MyGuiControlTreeView.cs.

void Sandbox.Graphics.GUI.MyGuiControlTreeView.ShowToolTip ( MyToolTips  tooltip)
inline

Definition at line 87 of file MyGuiControlTreeView.cs.

Member Data Documentation

bool Sandbox.Graphics.GUI.MyGuiControlTreeView.WholeRowHighlight

Definition at line 11 of file MyGuiControlTreeView.cs.


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