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

Public Member Functions

 MyGuiControlLabeledGrid ()
 
override void Draw (float transitionAlpha, float backgroundTransitionAlpha)
 
override void Clear ()
 Removes all items. This affects the size of the collection. More...
 
void AddLabeledItem (Item gridItem, String label)
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlGrid
 MyGuiControlGrid ()
 
override void Init (MyObjectBuilder_GuiControlBase objectBuilder)
 
override MyObjectBuilder_GuiControlBase GetObjectBuilder ()
 
void Add (Item item, int startingRow=0)
 Adds item to the first empty (null) position. More...
 
Item GetItemAt (int index)
 
bool IsValidIndex (int row, int col)
 
bool IsValidIndex (int index)
 
Item GetItemAt (int rowIdx, int colIdx)
 
void SetItemAt (int index, Item item)
 
void SetItemAt (int rowIdx, int colIdx, Item item)
 
void blinkSlot (int?slot)
 
void SetItemsToDefault ()
 Sets all items to default value (null). Note that this does not affect the number of items. More...
 
void TrimEmptyItems ()
 Removes items which are null (empty) from the end. Stops as soon as first non-empty item is found. More...
 
Item TryGetItemAt (int rowIdx, int colIdx)
 
Item TryGetItemAt (int itemIdx)
 
void SelectLastItem ()
 
void AddRows (int numberOfRows)
 
void RecalculateRowsCount ()
 
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 void Update ()
 
override void ShowToolTip ()
 
int ComputeIndex (int row, int col)
 
void SetEmptyItemToolTip (String toolTip)
 
int GetItemsCount ()
 
- 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 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 ()
 

Public Attributes

List< String > Labels = new List<String>()
 
float TextScale = 1.0f
 
- Public Attributes inherited from Sandbox.Graphics.GUI.MyGuiControlGrid
const int INVALID_INDEX = -1
 
Dictionary< int, ColorModalItems
 
string EmptyItemIcon
 
bool SelectionEnabled = true
 
bool ShowEmptySlots = true
 
- 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
 

Additional Inherited Members

- Static Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlGrid
static StyleDefinition GetVisualStyle (MyGuiControlGridStyleEnum 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 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 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 ()
 
- Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiControlGrid
RectangleF m_itemsRectangle
 
Vector2 m_itemStep
 
StyleDefinition m_styleDef
 
- 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.MyGuiControlGrid
bool EnableSelectEmptyCell [get, set]
 
Vector2 ItemStep [get]
 
int ColumnsCount [get, set]
 
int RowsCount [get, set]
 
int MaxItemCount [get, set]
 
Vector2 ItemSize [get]
 
int MouseOverIndex [get]
 
Item MouseOverItem [get]
 
int SelectedIndex [get, set]
 
Item SelectedItem [get]
 
MyGuiControlGridStyleEnum VisualStyle [get, set]
 
float ItemTextScale [get]
 
float ItemTextScaleWithLanguage [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 inherited from Sandbox.Graphics.GUI.MyGuiControlGrid
Action< MyGuiControlGrid, EventArgsItemChanged
 
Action< MyGuiControlGrid, EventArgsItemClicked
 
Action< MyGuiControlGrid, EventArgsItemReleased
 
Action< MyGuiControlGrid, EventArgsItemClickedWithoutDoubleClick
 
Action< MyGuiControlGrid, EventArgsItemDoubleClicked
 
Action< MyGuiControlGrid, EventArgsItemDragged
 
Action< MyGuiControlGrid, EventArgsItemSelected
 
Action< MyGuiControlGrid, EventArgsMouseOverIndexChanged
 
- 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 MyGuiControlLabeledGrid.cs.

Constructor & Destructor Documentation

Sandbox.Graphics.GUI.MyGuiControlLabeledGrid.MyGuiControlLabeledGrid ( )
inline

Definition at line 20 of file MyGuiControlLabeledGrid.cs.

Member Function Documentation

void Sandbox.Graphics.GUI.MyGuiControlLabeledGrid.AddLabeledItem ( Item  gridItem,
String  label 
)
inline

Definition at line 78 of file MyGuiControlLabeledGrid.cs.

override void Sandbox.Graphics.GUI.MyGuiControlLabeledGrid.Clear ( )
inlinevirtual

Removes all items. This affects the size of the collection.

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlGrid.

Definition at line 71 of file MyGuiControlLabeledGrid.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlGrid.

Definition at line 25 of file MyGuiControlLabeledGrid.cs.

Member Data Documentation

List<String> Sandbox.Graphics.GUI.MyGuiControlLabeledGrid.Labels = new List<String>()

Definition at line 14 of file MyGuiControlLabeledGrid.cs.

float Sandbox.Graphics.GUI.MyGuiControlLabeledGrid.TextScale = 1.0f

Definition at line 18 of file MyGuiControlLabeledGrid.cs.


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