s&box docs

public class Editor.Option : Editor.QObject

Broader workflow and conceptual references connected to this API.

Constructors

Showing 3 constructors

Methods

Showing 3 methods

protected virtual void OnToggled(bool b)

Called when this option was toggled.

protected virtual void OnTriggered()

Called when this option was clicked..

public void SetIcon(Editor.Pixmap pixmap)

Sets an icon for the option via a raw image.

Properties

Showing 13 properties

public bool Editor.Option.Checkable { get; set; }

Whether this option is a toggle option. `Editor.Option.Checked`.

public bool Editor.Option.Checked { get; set; }

Whether this option is toggled/checked. `Editor.Option.Checkable`.

public bool Editor.Option.Enabled { get; set; }

Whether this option can be clicked. Will also be visually different.

public string Editor.Option.Icon { get; set; }

The icon for this option.

public Editor.Pixmap Editor.Option.IconImage { get; set; }

The icon for this option.

public string Editor.Option.IconText { get; set; }

Text to display if `Editor.Option.Text` is empty.

public string Editor.Option.Shortcut { get; set; }Obsolete

Obsolete: Please use ShortcutName, which takes a shortcut ident (such as editor.save) instead of keys (such as CTRL+S).

public string Editor.Option.ShortcutName { get; set; }

public string Editor.Option.StatusText { get; set; }Obsolete

Obsolete: Use StatusTip

public string Editor.Option.StatusTip { get; set; }

public string Editor.Option.Text { get; set; }

Text for this option.

public string Editor.Option.Tooltip { get; set; }Obsolete

Obsolete: Use ToolTip

public string Editor.Option.ToolTip { get; set; }

Metadata

FieldValue
NamespaceEditor
Typeclass
AssemblySandbox.Tools
Doc IDT:Editor.Option

On this page