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

Public Member Functions

 MyGuiControlScrollablePanel (MyGuiControlBase scrolledControl)
 
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 Draw (float transitionAlpha, float backgroundTransitionAlpha)
 
void FitSizeToScrolledControl ()
 
void SetPageVertical (float pageNumber)
 
override void ShowToolTip ()
 
void RefreshInternals ()
 
- 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 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

Vector2 ScrollBarOffset = Vector2.Zero
 
float ScrollBarHScale = 1
 
float ScrollBarVScale = 1
 
- 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 DrawElements (float transitionAlpha, float backgroundTransitionAlpha)
 
override void OnPositionChanged ()
 
override void OnSizeChanged ()
 
override void OnHasHighlightChanged ()
 
override void OnEnabledChanged ()
 
- 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 OnColorMaskChanged ()
 
MyGuiScreenBase GetTopMostOwnerScreen ()
 
bool IsMouseOverOrKeyboardActive ()
 
MyGuiControlBase HandleInputElements ()
 
virtual void ClearEvents ()
 

Properties

float ScrollbarHSizeX [get]
 
float ScrollbarHSizeY [get]
 
float ScrollbarVSizeX [get]
 
float ScrollbarVSizeY [get]
 
bool ScrollbarHWheel [get, set]
 
bool ScrollbarHEnabled [get, set]
 
bool ScrollbarVEnabled [get, set]
 
MyGuiControlBase ScrolledControl [get, set]
 
Vector2 ScrolledAreaSize [get]
 
MyGuiBorderThickness ScrolledAreaPadding [get, set]
 
float ScrollbarVPosition [get, set]
 
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]
 

Events

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

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
 

Detailed Description

Definition at line 10 of file MyGuiControlScrollablePanel.cs.

Constructor & Destructor Documentation

Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.MyGuiControlScrollablePanel ( MyGuiControlBase  scrolledControl)
inline

Definition at line 161 of file MyGuiControlScrollablePanel.cs.

Member Function Documentation

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 194 of file MyGuiControlScrollablePanel.cs.

override void Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.DrawElements ( float  transitionAlpha,
float  backgroundTransitionAlpha 
)
inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 214 of file MyGuiControlScrollablePanel.cs.

void Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.FitSizeToScrolledControl ( )
inline

Definition at line 230 of file MyGuiControlScrollablePanel.cs.

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

override void Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.OnEnabledChanged ( )
inlineprotectedvirtual

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 268 of file MyGuiControlScrollablePanel.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 261 of file MyGuiControlScrollablePanel.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 248 of file MyGuiControlScrollablePanel.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 254 of file MyGuiControlScrollablePanel.cs.

void Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.RefreshInternals ( )
inline

Definition at line 343 of file MyGuiControlScrollablePanel.cs.

void Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.SetPageVertical ( float  pageNumber)
inline

Definition at line 243 of file MyGuiControlScrollablePanel.cs.

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

Reimplemented from Sandbox.Graphics.GUI.MyGuiControlBase.

Definition at line 273 of file MyGuiControlScrollablePanel.cs.

Member Data Documentation

float Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrollBarHScale = 1

Definition at line 22 of file MyGuiControlScrollablePanel.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrollBarOffset = Vector2.Zero

Definition at line 21 of file MyGuiControlScrollablePanel.cs.

float Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrollBarVScale = 1

Definition at line 23 of file MyGuiControlScrollablePanel.cs.

Property Documentation

MyGuiControls Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.Controls
get

Definition at line 361 of file MyGuiControlScrollablePanel.cs.

bool Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrollbarHEnabled
getset

Definition at line 74 of file MyGuiControlScrollablePanel.cs.

float Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrollbarHSizeX
get

Definition at line 26 of file MyGuiControlScrollablePanel.cs.

float Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrollbarHSizeY
get

Definition at line 35 of file MyGuiControlScrollablePanel.cs.

bool Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrollbarHWheel
getset

Definition at line 62 of file MyGuiControlScrollablePanel.cs.

bool Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrollbarVEnabled
getset

Definition at line 89 of file MyGuiControlScrollablePanel.cs.

float Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrollbarVPosition
getset

Definition at line 147 of file MyGuiControlScrollablePanel.cs.

float Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrollbarVSizeX
get

Definition at line 44 of file MyGuiControlScrollablePanel.cs.

float Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrollbarVSizeY
get

Definition at line 53 of file MyGuiControlScrollablePanel.cs.

MyGuiBorderThickness Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrolledAreaPadding
getset

Definition at line 137 of file MyGuiControlScrollablePanel.cs.

Vector2 Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrolledAreaSize
get

Definition at line 132 of file MyGuiControlScrollablePanel.cs.

MyGuiControlBase Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.ScrolledControl
getset

Definition at line 104 of file MyGuiControlScrollablePanel.cs.

Event Documentation

Action<MyGuiControlScrollablePanel> Sandbox.Graphics.GUI.MyGuiControlScrollablePanel.PanelScrolled

Definition at line 19 of file MyGuiControlScrollablePanel.cs.


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