Class CodeEditor

An advanced widget used for displaying and editing source code.

Inheritance
object
Widget
CodeEditor
Implements
Inherited Members
Namespace: Ritchie.Toolbox.Widgets.CodeEditing
Assembly: Ritchie.Toolbox.dll
Syntax
public sealed class CodeEditor : Widget, IFontFamilyProvider, IInspectable, IUpdateThemeProperties, IGainFocusHandler, ILoseFocusHandler, IMouseClickHandler, IMouseHandler, IKeyCharHandler, IKeyDownHandler, IVisual<CodeEditor.VisualState>

Constructors

CodeEditor()

Declaration
public CodeEditor()

Properties

HasSelection

Declaration
public bool HasSelection { get; }
Property Value
Type Description
bool

VisualProperties

Gets a read-only reference to the visual properties associated with the widget.

Declaration
public ref readonly CodeEditor.VisualState VisualProperties { get; }
Property Value
Type Description
CodeEditor.VisualState

Methods

ArrangeChildren(IGuiContext, LayoutRect)

Declaration
protected override void ArrangeChildren(IGuiContext context, LayoutRect availableSpace)
Parameters
Type Name Description
IGuiContext context
LayoutRect availableSpace
Overrides

BeforeRender()

Declaration
protected override void BeforeRender()
Overrides

DeselectAll()

Declaration
public void DeselectAll()

GetContentSize(Point)

Declaration
protected override Point GetContentSize(Point availableSize)
Parameters
Type Name Description
Point availableSize
Returns
Type Description
Point
Overrides

GetDocumentTExt()

Declaration
public string GetDocumentTExt()
Returns
Type Description
string

GetSelectionText()

Declaration
public string GetSelectionText()
Returns
Type Description
string

LoadDocumentAsync(Stream, Encoding)

Declaration
public Task LoadDocumentAsync(Stream stream, Encoding encoding)
Parameters
Type Name Description
Stream stream
Encoding encoding
Returns
Type Description
Task

OnFocusGained(FocusEvent)

Declaration
public void OnFocusGained(FocusEvent e)
Parameters
Type Name Description
FocusEvent e

OnFocusLost(FocusEvent)

Declaration
public void OnFocusLost(FocusEvent e)
Parameters
Type Name Description
FocusEvent e

OnKeyChar(KeyCharEvent)

Declaration
public void OnKeyChar(KeyCharEvent e)
Parameters
Type Name Description
KeyCharEvent e

OnKeyDown(KeyEvent)

Declaration
public void OnKeyDown(KeyEvent e)
Parameters
Type Name Description
KeyEvent e

OnMouseClick(MouseButtonEvent)

Declaration
public void OnMouseClick(MouseButtonEvent e)
Parameters
Type Name Description
MouseButtonEvent e

RebuildClippingZone(GeometryHelper)

Declaration
protected override void RebuildClippingZone(GeometryHelper geometry)
Parameters
Type Name Description
GeometryHelper geometry
Overrides

RebuildGeometry(GeometryHelper)

Declaration
protected override void RebuildGeometry(GeometryHelper geometry)
Parameters
Type Name Description
GeometryHelper geometry
Overrides

SaveTo(Stream, Encoding)

Declaration
public void SaveTo(Stream stream, Encoding encoding)
Parameters
Type Name Description
Stream stream
Encoding encoding

SaveTo(StringBuilder)

Declaration
public void SaveTo(StringBuilder stringBuilder)
Parameters
Type Name Description
StringBuilder stringBuilder

SaveToAsync(Stream, Encoding)

Declaration
public Task SaveToAsync(Stream stream, Encoding encoding)
Parameters
Type Name Description
Stream stream
Encoding encoding
Returns
Type Description
Task

SelectAll()

Declaration
public void SelectAll()

SetDocumentTExt(string)

Declaration
public void SetDocumentTExt(string text)
Parameters
Type Name Description
string text

StartNewDocument()

Clears all text within this CodeEditor.

Declaration
public void StartNewDocument()

UpdateThemeProperties()

Retrieves layout properties from the visual style. Called by the UI system on every frame before layout updates occur. If layout properties change during this method call, the widget will automatically invalidate its own layout.

Declaration
public void UpdateThemeProperties()

Implements

Extension Methods