Widgetclass

public void AdjustSize()PUBLIC

Adjusts the size of the widget to fit its contents.

public virtual void AlignToParent(Sandbox.TextFlag alignment, Vector2 offset = null)PUBLICVIRTUAL

Align this widget to its parents edge, with an offset.

public void Blur()PUBLIC

Clear keyboard focus from this widget.

public virtual void ChildValuesChanged(Editor.Widget source)PUBLICVIRTUAL

public void ClearContext(string key)PUBLIC

Remove a context on this widget. This will NOT remove contexts set from parent objects.

public virtual void Close()PUBLICVIRTUAL

If a window - will close

public void ConstrainTo(Sandbox.Rect parentRect)PUBLIC

Reposition this widget to ensure it is within the given rectangle.

public void ConstrainToScreen()PUBLIC

Constrain this widget to the screen it's currently on.

public void DestroyChildren()PUBLIC

Destroys all child widgets of this widget.

public void DisableWindowActivation()PUBLIC

Calling this will set the WS_EX_NOACTIVATE flag on the window internally, which will stop it taking focus away from other windows.

protected virtual void DoLayout()PROTECTEDVIRTUAL

Called to make sure all child panels are in correct positions and have correct sizes. This is typically called when the size of this widget changes, but there are other cases as well.

public void Focus(bool activateWindow = True)PUBLIC

protected virtual bool FocusNext()PROTECTEDVIRTUAL

Called when Tab is pressed to find the next widget to focus. Return true to prevent focusing.

protected virtual bool FocusPrevious()PROTECTEDVIRTUAL

Called when Shift + Tab is pressed to find the next widget to focus. Return true to prevent focusing.

public Vector2 FromScreen(Vector2 p)PUBLIC

Transform coordinates relative to the monitors's top left corner, to coordinates relative to panel's top left corner.

public T GetAncestor()PUBLIC

Find the closest ancestor widget of type

public T GetContext(string key, T defaultIfMissing = null)PUBLIC

Find a context on this widget. If not found, look at the parent. If not found, look at the parent. This is useful for passing information down to child widgets without any effort.

public System.Collections.Generic.IEnumerable`1<T> GetDescendants()PUBLIC

Get all descendants of type T

public Editor.Widget GetWindow()PUBLIC

Get the top level window widget

public virtual void Hide()PUBLICVIRTUAL

Make this widget not visible.

public bool IsAncestorOf(Editor.Widget child)PUBLIC

Returns whether or not the specified Widget is an ancestor of this Widget.

public bool IsDescendantOf(Editor.Widget parent)PUBLIC

Returns whether or not the specified Widget is a descendent of this Widget.

public bool IsModal()PUBLIC

Returns true if this is a modal window. This means it will appear on top of everything and block input to everything else.

public void Lower()PUBLIC

Lowers the widget to the bottom of the parent widget's stack. After this call the widget will be visually behind (and therefore obscured by) any overlapping sibling widgets.

public void MakeMaximized()PUBLIC

public void MakeMinimized()PUBLIC

public void MakeSignal(string name)PUBLIC

public void MakeWindowed()PUBLIC

protected virtual Vector2 MinimumSizeHint()PROTECTEDVIRTUAL

Return the minimum size this widget wants to be

protected virtual void OnBlur(Editor.FocusChangeReason reason)PROTECTEDVIRTUAL

Called when the widget loses keyboard focus.

protected virtual bool OnClose()PROTECTEDVIRTUAL

Called when a window is about to be closed.

protected virtual void OnClosed()PROTECTEDVIRTUAL

Called when a window is closed.

protected virtual void OnContextMenu(Editor.ContextMenuEvent e)PROTECTEDVIRTUAL

Called after `Editor.Widget.OnMouseRightClick(Editor.MouseEvent)`, for the purposes of opening a context menu.

protected virtual void OnDoubleClick(Editor.MouseEvent e)PROTECTEDVIRTUAL

Called when the widget was double clicked with any mouse button.

public virtual void OnDragDrop(Editor.Widget.DragEvent ev)PUBLICVIRTUAL

Something was dragged and dropped on this widget. Apply the data here, if its valid. Requires `Editor.Widget.AcceptDrops` to function.

public virtual void OnDragHover(Editor.Widget.DragEvent ev)PUBLICVIRTUAL

Cursor with drag and drop data moved on this widget. Requires `Editor.Widget.AcceptDrops` to function.

public virtual void OnDragLeave()PUBLICVIRTUAL

Cursor with drag and drop data left the bounds of this widget. Requires `Editor.Widget.AcceptDrops` to function.

protected virtual void OnDragStart()PROTECTEDVIRTUALLIFECYCLE

Called when dragging. `Editor.Widget.IsDraggable` should be true.

protected virtual void OnFocus(Editor.FocusChangeReason reason)PROTECTEDVIRTUAL

Called when the widget gains keyboard focus.

protected virtual void OnKeyPress(Editor.KeyEvent e)PROTECTEDVIRTUAL

A key has been pressed. Your widget needs keyboard focus for this to be called - see FocusMode.

protected virtual void OnKeyRelease(Editor.KeyEvent e)PROTECTEDVIRTUAL

A key has been released.

protected virtual void OnMouseClick(Editor.MouseEvent e)PROTECTEDVIRTUAL

Called when this widget is left clicked (on mouse release).

protected virtual void OnMouseEnter()PROTECTEDVIRTUAL

Mouse cursor entered the bounds of this widget.

protected virtual void OnMouseLeave()PROTECTEDVIRTUAL

Mouse cursor exited the bounds of this widget.

protected virtual void OnMouseMove(Editor.MouseEvent e)PROTECTEDVIRTUAL

Called when the mouse cursor is moved while being over this widget.

protected virtual void OnMousePress(Editor.MouseEvent e)PROTECTEDVIRTUAL

Called when mouse is pressed over this widget.

protected virtual void OnMouseReleased(Editor.MouseEvent e)PROTECTEDVIRTUAL

Called when mouse is released over this widget.

protected virtual void OnMouseRightClick(Editor.MouseEvent e)PROTECTEDVIRTUAL

Called when this widget is right clicked (on mouse release).

protected virtual void OnMouseWheel(Editor.WheelEvent e)PROTECTEDVIRTUAL

Mouse wheel was scrolled while the mouse cursor was over this widget.

protected virtual void OnMoved()PROTECTEDVIRTUAL

Called when the widget was moved to a new position relative to it's parent.

protected virtual void OnPaint()PROTECTEDVIRTUAL

Override to custom paint your widget, for example using `Editor.Paint`. Can be overwritten by `Editor.Widget.OnPaintOverride`.

protected virtual void OnResize()PROTECTEDVIRTUAL

Called when the widgets' size was changed.

protected virtual void OnShortcutPressed(Editor.KeyEvent e)PROTECTEDVIRTUAL

A shortcut has been activated. This is called on the focused control so they can override it.

protected virtual void OnVisibilityChanged(bool visible)PROTECTEDVIRTUAL

Called when the visibility of this widget changes.

protected virtual void OnWheel(Editor.WheelEvent e)PROTECTEDVIRTUALOBSOLETE

Mouse wheel was scrolled while the mouse cursor was over this widget.

Obsolete: Use OnMouseWheel

public void PostKeyEvent(Editor.KeyCode key)PUBLIC

public void Raise()PUBLIC

Raises this widget to the top of the parent widget's stack. After this call the widget will be visually in front of any overlapping sibling widgets.

public void RestoreGeometry(string state)PUBLIC

Restore position and size previously stored via `Editor.Widget.SaveGeometry`.

public string SaveGeometry()PUBLIC

Serialize position and size of this widget to a string, which can then be passed to `Editor.Widget.RestoreGeometry(System.String)`.

public void SetContext(string key, object value)PUBLIC

Set a context value on this widget. This context will be available to its children via FindContext.

public void SetEffectOpacity(float f)PUBLIC

public void SetModal(bool on, bool application = False)PUBLIC

Set this window to be modal. This means it will appear on top of everything and block input to everything else.

public void SetSizeMode(Editor.SizeMode horizontal, Editor.SizeMode vertical)PUBLIC

public void SetStyles(string sheet)PUBLIC

Directly set CSS style sheet(s) for this widget. Same format as a .css file.

public void SetStylesheetFile(string filename)PUBLIC

Set a file to load CSS for this widget from.

public virtual void Show()PUBLICVIRTUAL

Make this widget visible.

protected virtual void Signal(Editor.WidgetSignal signal)PROTECTEDVIRTUAL

protected void SignalValuesChanged()PROTECTED

When a value on this widget changed due to user input (ie, checking a box, editing a form) this is called, which sends a signal up the parent widgets.

protected virtual Vector2 SizeHint()PROTECTEDVIRTUAL

Should return the size this widget really wants to be if it can its way. The default is that you don't care - and just to return whatever the base value is.

public Vector2 ToScreen(Vector2 p)PUBLIC

Transform coordinates relative to the panel's top left corner, to coordinates relative to monitors's top left corner.

public virtual void Update()PUBLICVIRTUALPER-FRAME

Tell this widget that shit changed and it needs to redraw

public void UpdateGeometry()PUBLICPER-FRAME

Tell everything that the geometry of this has changed

public bool Editor.Widget.AcceptDrops { get; set; }PUBLICGETSET

Accept drag and dropping shit on us

public System.Collections.Generic.IEnumerable`1<Editor.Widget> Editor.Widget.Children { get; set; }PUBLICGETSET

Child widgets of this widget.

public Sandbox.UI.Margin Editor.Widget.ContentMargins { get; set; }PUBLICGETSET

public Sandbox.Rect Editor.Widget.ContentRect { get; set; }PUBLICGETSET

public bool Editor.Widget.ContextMenuEnabled { get; set; }PUBLICGETSET

Enables or disables the context menu on this widget.

public virtual Editor.CursorShape Editor.Widget.Cursor { get; set; }PUBLICVIRTUALGETSET

Cursor override for this widget.

public bool Editor.Widget.DebugModeEnabled { get; set; }PUBLICGETSET

Enable debug mode on this widget.

public bool Editor.Widget.DeleteOnClose { get; set; }PUBLICGETSET

Delete this widget when close is pressed

public float Editor.Widget.DpiScale { get; set; }PUBLICGETSET

The scale this widget is using (multiplying Size by this value gives the actual native size)

public bool Editor.Widget.Enabled { get; set; }PUBLICGETSET

Makes the widget not interactable. This is also usually be reflected visually by the widget. The widget will not process any keyboard or mouse inputs. Applies retroactively to all children.

public float Editor.Widget.FixedHeight { get; set; }PUBLICGETSET

Sets the fixed height for this widget

public Vector2 Editor.Widget.FixedSize { get; set; }PUBLICGETSET

public float Editor.Widget.FixedWidth { get; set; }PUBLICGETSET

Sets the fixed width for this widget

public Editor.FocusMode Editor.Widget.FocusMode { get; set; }PUBLICGETSET

Sets the focus mode for this widget. This determines both how it will get focus and whether it will receive keyboard input.

public Editor.Widget Editor.Widget.FocusProxy { get; set; }PUBLICGETSET

public bool Editor.Widget.HasMaximizeButton { get; set; }PUBLICGETSET

public float Editor.Widget.Height { get; set; }PUBLICGETSET

Utility to interact with a widget's width - use Size where possible

public bool Editor.Widget.Hidden { get; set; }PUBLICGETSET

Whether this widget is hidden. This differs from Visible because this will return the state for this particular widget, where as Visible returns false if a parent is hidden etc.

public Editor.SizeMode Editor.Widget.HorizontalSizeMode { get; set; }PUBLICGETSET

public bool Editor.Widget.IsActiveWindow { get; set; }PUBLICGETSET

public bool Editor.Widget.IsBeingDroppedOn { get; set; }PUBLICGETSET

Whether something is being dragged over this widget.

public bool Editor.Widget.IsDraggable { get; set; }PUBLICGETSET

Whether this widget can be drag and dropped onto other widgets.

public bool Editor.Widget.IsFocused { get; set; }PUBLICGETSET

Whether this widget has keyboard focus.

public bool Editor.Widget.IsFramelessWindow { get; set; }PUBLICGETSET

public bool Editor.Widget.IsMaximized { get; set; }PUBLICGETSET

public bool Editor.Widget.IsMinimized { get; set; }PUBLICGETSET

public bool Editor.Widget.IsPopup { get; set; }PUBLICGETSET

public bool Editor.Widget.IsPressed { get; set; }PUBLICGETSET

Whether this widget is currently being pressed down or not.

public bool Editor.Widget.IsTooltip { get; set; }PUBLICGETSET

public bool Editor.Widget.IsUnderMouse { get; set; }PUBLICGETSET

public bool Editor.Widget.IsWindow { get; set; }PUBLICGETSET

public Editor.Layout Editor.Widget.Layout { get; set; }PUBLICGETSET

The widget's internal layout, if any

public Sandbox.Rect Editor.Widget.LocalRect { get; set; }PUBLICGETSET

This panel's rect at 0,0

public float Editor.Widget.MaximumHeight { get; set; }PUBLICGETSET

This widgets height should never be larger than the given value.

public Vector2 Editor.Widget.MaximumSize { get; set; }PUBLICGETSET

Sets `Editor.Widget.MaximumWidth` and `Editor.Widget.MaximumHeight` simultaneously.

public float Editor.Widget.MaximumWidth { get; set; }PUBLICGETSET

This widgets width should never be larger than the given value.

public float Editor.Widget.MinimumHeight { get; set; }PUBLICGETSET

This widgets height should never be smaller than the given value.

public Vector2 Editor.Widget.MinimumSize { get; set; }PUBLICGETSET

Sets `Editor.Widget.MinimumWidth` and `Editor.Widget.MinimumHeight` simultaneously.

public float Editor.Widget.MinimumWidth { get; set; }PUBLICGETSET

This widgets width should never be smaller than the given value.

public bool Editor.Widget.MouseTracking { get; set; }PUBLICGETSET

public string Editor.Widget.Name { get; set; }PUBLICGETSET

Name of the widget, usually for debugging purposes.

public bool Editor.Widget.NoSystemBackground { get; set; }PUBLICGETSET

public Editor.Widget Editor.Widget.Parent { get; set; }PUBLICGETSET

Parent widget. If non null, position of this widget will be relative to the parent widget. Certain events will also propagate to the parent widget if unhandled.

public virtual Editor.Pixmap Editor.Widget.PixmapCursor { get; set; }PUBLICVIRTUALGETSET

Custom cursor override for this widget. Will override `Editor.Widget.Cursor` with `Editor.CursorShape.CustomCursor`.

public Vector2 Editor.Widget.Position { get; set; }PUBLICGETSET

Position of this widget, relative to its parent if it has one.

public virtual bool Editor.Widget.ProvidesDebugMode { get; set; }PUBLICVIRTUALGETSET

If true then this widget has a debug mode that can be activated

public virtual bool Editor.Widget.ReadOnly { get; set; }PUBLICVIRTUALGETSET

Makes the widget read only. I.e. You can copy text of a text entry, but can't edit it. Applies retroactively to all children.

public Sandbox.Rect Editor.Widget.ScreenGeometry { get; set; }PUBLICGETSET

Returns the geometry of the screen this widget is currently on.

public Vector2 Editor.Widget.ScreenPosition { get; set; }PUBLICGETSET

Position of the widget relative to the monitor's top left corner.

public Sandbox.Rect Editor.Widget.ScreenRect { get; set; }PUBLICGETSET

This panel's rect in screen coordinates

public bool Editor.Widget.ShowWithoutActivating { get; set; }PUBLICGETSET

public Vector2 Editor.Widget.Size { get; set; }PUBLICGETSET

Size of this widget.

public string Editor.Widget.StatusTip { get; set; }PUBLICGETSET

If set, hovering over this widget will set the text of a `Editor.StatusBar` of the window the widget belongs to.

public virtual string Editor.Widget.ToolTip { get; set; }PUBLICVIRTUALGETSET

If set, this text will be displayed after a certain delay of hovering this widget with the mouse cursor.

public bool Editor.Widget.TranslucentBackground { get; set; }PUBLICGETSET

public bool Editor.Widget.TransparentForMouseEvents { get; set; }PUBLICGETSET

public bool Editor.Widget.UpdatesEnabled { get; set; }PUBLICGETSETPER-FRAME

If true, Update will call

public Editor.SizeMode Editor.Widget.VerticalSizeMode { get; set; }PUBLICGETSET

public bool Editor.Widget.Visible { get; set; }PUBLICGETSET

Whether this widget is visible or not, in the tree. This will return false if a parent is hidden. You might want to set Hidden if you're looking to check local visible status on a widget.

public float Editor.Widget.Width { get; set; }PUBLICGETSET

Utility to interact with a widget's width - use Size where possible

public Editor.WindowFlags Editor.Widget.WindowFlags { get; set; }PUBLICGETSET

public float Editor.Widget.WindowOpacity { get; set; }PUBLICGETSET

public virtual string Editor.Widget.WindowTitle { get; set; }PUBLICVIRTUALGETSET