Space Engineers
Public Member Functions | Protected Member Functions | Protected Attributes | Properties | Events | List of all members
Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser Class Reference
Inheritance diagram for Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser:
Sandbox.Graphics.GUI.MyGuiControlTable Sandbox.Graphics.GUI.MyGuiControlBase Sandbox.Graphics.GUI.IMyGuiControlsOwner Sandbox.Game.Screens.Helpers.MyGuiControlSaveBrowser

Public Member Functions

 MyGuiControlDirectoryBrowser (string topMostDirectory=null, string initialDirectory=null, Predicate< DirectoryInfo > dirPredicate=null, Predicate< FileInfo > filePredicate=null)
 
virtual void Refresh ()
 
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 SetTopMostAndCurrentDir (string directory)
 
- Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlTable
 MyGuiControlTable ()
 
void Add (Row row)
 
void Insert (int index, Row row)
 
void Clear ()
 
Row GetRow (int index)
 
Row Find (Predicate< Row > match)
 
int FindIndex (Predicate< Row > match)
 
void Remove (Predicate< Row > match)
 
void RemoveSelectedRow ()
 
void MoveSelectedRowUp ()
 
void MoveSelectedRowDown ()
 
void MoveSelectedRowTop ()
 
void MoveSelectedRowBottom ()
 
void MoveToNextRow ()
 
void MoveToPreviousRow ()
 
void SetColumnName (int colIdx, StringBuilder name)
 
void SetColumnComparison (int colIdx, Comparison< Cell > ascendingComparison)
 
void SetCustomColumnWidths (float[] p)
 Modifies width of each column. Note that widths are relative to the width of table (excluding slider), so they should sum up to 1. Setting widths to 0.75 and 0.25 for 2 column table will give 3/4 of size to one column and 1/4 to the second one. More...
 
void SetColumnAlign (int colIdx, MyGuiDrawAlignEnum align=MyGuiDrawAlignEnum.HORISONTAL_LEFT_AND_VERTICAL_CENTER)
 
void SetHeaderColumnAlign (int colIdx, MyGuiDrawAlignEnum align=MyGuiDrawAlignEnum.HORISONTAL_LEFT_AND_VERTICAL_CENTER)
 
void ScrollToSelection ()
 
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 void Update ()
 
override void ShowToolTip ()
 
void Sort (bool switchSort=true)
 
void SortByColumn (int columnIdx, SortStateEnum?sortState=null, bool switchSort=true)
 
int FindRow (Row row)
 
- 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 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 ()
 

Protected Member Functions

virtual void AddFileRow (FileInfo file)
 
virtual void AddFolderRow (DirectoryInfo dir)
 
virtual void AddBackRow ()
 
virtual void OnDirectoryDoubleclicked (DirectoryInfo info)
 
virtual void OnFileDoubleclicked (FileInfo info)
 
virtual void OnBackDoubleclicked ()
 
bool NotifyDirectoryChanging (string from, string to)
 
- Protected Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlTable
override void OnOriginAlignChanged ()
 
override void OnPositionChanged ()
 
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 OnVisibleChanged ()
 
virtual void OnEnabledChanged ()
 
virtual void OnColorMaskChanged ()
 
MyGuiScreenBase GetTopMostOwnerScreen ()
 
bool IsMouseOverOrKeyboardActive ()
 
virtual void DrawElements (float transitionAlpha, float backgroundTransitionAlpha)
 
MyGuiControlBase HandleInputElements ()
 
virtual void ClearEvents ()
 

Protected Attributes

readonly MyDirectoryChangeCancelEventArgs m_cancelEvent
 
DirectoryInfo m_topMostDir
 
DirectoryInfo m_currentDir
 
Row m_backRow
 
- Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiControlTable
int m_visibleRowIndexOffset
 Index computed from scrollbar. More...
 
- Protected Attributes inherited from Sandbox.Graphics.GUI.MyGuiControlBase
bool m_mouseButtonPressed = false
 
bool m_showToolTip = false
 
Vector2 m_toolTipPosition
 

Properties

Color FolderCellColor [get, set]
 
MyGuiHighlightTexture FolderCellIconTexture [get, set]
 
MyGuiDrawAlignEnum FolderCellIconAlign [get, set]
 
Color FileCellColor [get, set]
 
MyGuiHighlightTexture FileCellIconTexture [get, set]
 
MyGuiDrawAlignEnum FileCellIconAlign [get, set]
 
Predicate< DirectoryInfo > DirPredicate [get]
 
Predicate< FileInfo > FilePredicate [get]
 
string CurrentDirectory [get, set]
 
- Properties inherited from Sandbox.Graphics.GUI.MyGuiControlTable
MyGuiControls Controls [get]
 
MyVScrollbar ScrollBar [get]
 
bool HeaderVisible [get, set]
 
int ColumnsCount [get, set]
 
int SelectedRowIndex [get, set]
 
Row SelectedRow [get, set]
 
int VisibleRowsCount [get, set]
 
float RowHeight [get]
 
MyGuiControlTableStyleEnum VisualStyle [get, set]
 
float TextScale [get]
 
float TextScaleWithLanguage [get]
 
int RowsCount [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< MyDirectoryChangeCancelEventArgsDirectoryChanging
 
Action< MyGuiControlDirectoryBrowser, string > DirectoryChanged
 
Action< MyGuiControlDirectoryBrowser, string > FileDoubleClick
 
Action< MyGuiControlDirectoryBrowser, string > DirectoryDoubleclick
 
Action< MyDirectoryChangeCancelEventArgsDirectoryDoubleclicking
 
- Events inherited from Sandbox.Graphics.GUI.MyGuiControlTable
Action< MyGuiControlTable, EventArgsItemDoubleClicked
 
Action< MyGuiControlTable, EventArgsItemRightClicked
 
Action< MyGuiControlTable, EventArgsItemSelected
 
Action< MyGuiControlTable, EventArgsItemConfirmed
 
Action< MyGuiControlTable, int > ColumnClicked
 
- 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

- Public Types inherited from Sandbox.Graphics.GUI.MyGuiControlTable
enum  SortStateEnum { SortStateEnum.Unsorted, SortStateEnum.Ascending, SortStateEnum.Descending }
 
- Static Public Member Functions inherited from Sandbox.Graphics.GUI.MyGuiControlTable
static StyleDefinition GetVisualStyle (MyGuiControlTableStyleEnum 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 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
 

Detailed Description

Definition at line 30 of file MyGuiControlDirectoryBrowser.cs.

Constructor & Destructor Documentation

Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.MyGuiControlDirectoryBrowser ( string  topMostDirectory = null,
string  initialDirectory = null,
Predicate< DirectoryInfo >  dirPredicate = null,
Predicate< FileInfo >  filePredicate = null 
)
inline

Definition at line 69 of file MyGuiControlDirectoryBrowser.cs.

Member Function Documentation

virtual void Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.AddBackRow ( )
inlineprotectedvirtual

Definition at line 181 of file MyGuiControlDirectoryBrowser.cs.

virtual void Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.AddFileRow ( FileInfo  file)
inlineprotectedvirtual

Definition at line 141 of file MyGuiControlDirectoryBrowser.cs.

virtual void Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.AddFolderRow ( DirectoryInfo  dir)
inlineprotectedvirtual
override MyGuiControlBase Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.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 303 of file MyGuiControlDirectoryBrowser.cs.

bool Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.NotifyDirectoryChanging ( string  from,
string  to 
)
inlineprotected

Definition at line 287 of file MyGuiControlDirectoryBrowser.cs.

virtual void Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.OnBackDoubleclicked ( )
inlineprotectedvirtual
virtual void Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.OnDirectoryDoubleclicked ( DirectoryInfo  info)
inlineprotectedvirtual

Definition at line 250 of file MyGuiControlDirectoryBrowser.cs.

virtual void Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.OnFileDoubleclicked ( FileInfo  info)
inlineprotectedvirtual

Definition at line 262 of file MyGuiControlDirectoryBrowser.cs.

virtual void Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.Refresh ( )
inlinevirtual
bool Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.SetTopMostAndCurrentDir ( string  directory)
inline

Definition at line 312 of file MyGuiControlDirectoryBrowser.cs.

Member Data Documentation

Row Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.m_backRow
protected

Definition at line 35 of file MyGuiControlDirectoryBrowser.cs.

readonly MyDirectoryChangeCancelEventArgs Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.m_cancelEvent
protected

Definition at line 32 of file MyGuiControlDirectoryBrowser.cs.

DirectoryInfo Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.m_currentDir
protected

Definition at line 34 of file MyGuiControlDirectoryBrowser.cs.

DirectoryInfo Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.m_topMostDir
protected

Definition at line 33 of file MyGuiControlDirectoryBrowser.cs.

Property Documentation

string Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.CurrentDirectory
getset

Definition at line 64 of file MyGuiControlDirectoryBrowser.cs.

Predicate<DirectoryInfo> Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.DirPredicate
get

Definition at line 49 of file MyGuiControlDirectoryBrowser.cs.

Color Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.FileCellColor
getset

Definition at line 43 of file MyGuiControlDirectoryBrowser.cs.

MyGuiDrawAlignEnum Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.FileCellIconAlign
getset

Definition at line 45 of file MyGuiControlDirectoryBrowser.cs.

MyGuiHighlightTexture Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.FileCellIconTexture
getset

Definition at line 44 of file MyGuiControlDirectoryBrowser.cs.

Predicate<FileInfo> Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.FilePredicate
get

Definition at line 50 of file MyGuiControlDirectoryBrowser.cs.

Color Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.FolderCellColor
getset

Definition at line 39 of file MyGuiControlDirectoryBrowser.cs.

MyGuiDrawAlignEnum Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.FolderCellIconAlign
getset

Definition at line 41 of file MyGuiControlDirectoryBrowser.cs.

MyGuiHighlightTexture Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.FolderCellIconTexture
getset

Definition at line 40 of file MyGuiControlDirectoryBrowser.cs.

Event Documentation

Action<MyGuiControlDirectoryBrowser, string> Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.DirectoryChanged

Definition at line 55 of file MyGuiControlDirectoryBrowser.cs.

Action<MyDirectoryChangeCancelEventArgs> Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.DirectoryChanging

Definition at line 54 of file MyGuiControlDirectoryBrowser.cs.

Action<MyGuiControlDirectoryBrowser, string> Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.DirectoryDoubleclick

Definition at line 57 of file MyGuiControlDirectoryBrowser.cs.

Action<MyDirectoryChangeCancelEventArgs> Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.DirectoryDoubleclicking

Definition at line 58 of file MyGuiControlDirectoryBrowser.cs.

Action<MyGuiControlDirectoryBrowser, string> Sandbox.Gui.DirectoryBrowser.MyGuiControlDirectoryBrowser.FileDoubleClick

Definition at line 56 of file MyGuiControlDirectoryBrowser.cs.


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