Interface IScopedUiRegistry

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

The host-side registry, which takes the owning plugin on every call. Each plugin is handed a wrapper over this that fills its own owner in, so plugins use IUiRegistry and never this interface.

public interface IScopedUiRegistry : IUiRegistry

Inherited Members

IUiRegistry.AddMarkupPanel(string, object)

IUiRegistry.AddPanel(PluginPanelDescriptor, string, object)

IUiRegistry.RegisterPanel(PluginPanelDescriptor, string, object)

IUiRegistry.RegisterPanelContent(PluginPanelDescriptor, string, object)

IUiRegistry.ViewExists(string)

IUiRegistry.IsViewVisible(string)

IUiRegistry.ShowPanel(string)

IUiRegistry.HidePanel(string)

IUiRegistry.ControlExists(string, string)

IUiRegistry.SetControlLabel(string, string, string)

IUiRegistry.SetControlVisible(string, string, bool)

IUiRegistry.InvalidateView(string, string)

IUiRegistry.FocusControl(string, string)

IUiRegistry.ToggleClientWindow(PluginClientWindow)

IUiRegistry.ShowClientWindow(PluginClientWindow)

IUiRegistry.HideClientWindow(PluginClientWindow)

IUiRegistry.IsClientWindowVisible(PluginClientWindow)

IUiRegistry.Images

IUiRegistry.RegisterCanvas(PluginCanvasDescriptor, Action<IPluginPainter>)

Methods

ControlExists(PluginUiOwner, string, string)

Whether one plugin's named window contains a named control.

bool ControlExists(PluginUiOwner owner, string viewName, string controlName)

Parameters

owner PluginUiOwner

viewName string

controlName string

Returns

bool

FocusControl(PluginUiOwner, string, string)

Moves keyboard focus to one plugin input control.

bool FocusControl(PluginUiOwner owner, string viewName, string controlName)

Parameters

owner PluginUiOwner

viewName string

controlName string

Returns

bool

HidePanel(PluginUiOwner, string)

Hides one plugin's named window; see HidePanel(string). False on a host that draws nothing.

bool HidePanel(PluginUiOwner owner, string viewName)

Parameters

owner PluginUiOwner

viewName string

Returns

bool

ImagesFor(PluginUiOwner)

One plugin's image surface, the same object on every call for the same owner until it is disposed. A host that draws nothing hands out the inert surface; a host that draws hands out a surface that also implements IDisposable, and disposing it lets go of every image the plugin held.

IPluginImages ImagesFor(PluginUiOwner owner)

Parameters

owner PluginUiOwner

Returns

IPluginImages

InvalidateView(PluginUiOwner, string, string?)

Requests binding reevaluation for one plugin view.

bool InvalidateView(PluginUiOwner owner, string viewName, string? propertyName = null)

Parameters

owner PluginUiOwner

viewName string

propertyName string

Returns

bool

IsViewVisible(PluginUiOwner, string)

Whether one plugin's named window is currently shown.

bool IsViewVisible(PluginUiOwner owner, string viewName)

Parameters

owner PluginUiOwner

viewName string

Returns

bool

RegisterCanvas(PluginUiOwner, PluginCanvasDescriptor, Action<IPluginPainter>)

Registers a canvas on behalf of one plugin; see RegisterCanvas(PluginCanvasDescriptor, Action<IPluginPainter>).

IPluginCanvas RegisterCanvas(PluginUiOwner owner, PluginCanvasDescriptor descriptor, Action<IPluginPainter> paint)

Parameters

owner PluginUiOwner

The plugin the canvas belongs to.

descriptor PluginCanvasDescriptor

The canvas's id, size and placement.

paint Action<IPluginPainter>

What to draw when the canvas is repainted.

Returns

IPluginCanvas

The canvas, which the plugin shows, moves, invalidates and disposes.

RegisterMarkupPanel(string, object)

Registers a window from a markup file and returns a token that removes it again.

IDisposable RegisterMarkupPanel(string markupPath, object binding)

Parameters

markupPath string

binding object

Returns

IDisposable

RegisterPanel(PluginUiOwner, PluginPanelDescriptor, string, object)

Registers a window from a markup file on behalf of one plugin.

IDisposable RegisterPanel(PluginUiOwner owner, PluginPanelDescriptor descriptor, string markupPath, object binding)

Parameters

owner PluginUiOwner

descriptor PluginPanelDescriptor

markupPath string

binding object

Returns

IDisposable

RegisterPanelContent(PluginUiOwner, PluginPanelDescriptor, string, object)

Host-owned registration for in-memory plugin markup.

IDisposable RegisterPanelContent(PluginUiOwner owner, PluginPanelDescriptor descriptor, string markupContent, object binding)

Parameters

owner PluginUiOwner

descriptor PluginPanelDescriptor

markupContent string

binding object

Returns

IDisposable

SetControlLabel(PluginUiOwner, string, string, string)

Replaces the text of a named control in one plugin's window. Returns false when the control is not found or carries no text.

bool SetControlLabel(PluginUiOwner owner, string viewName, string controlName, string label)

Parameters

owner PluginUiOwner

viewName string

controlName string

label string

Returns

bool

SetControlVisible(PluginUiOwner, string, string, bool)

Shows or hides a named control in one plugin's window. Returns false when the control is not found.

bool SetControlVisible(PluginUiOwner owner, string viewName, string controlName, bool visible)

Parameters

owner PluginUiOwner

viewName string

controlName string

visible bool

Returns

bool

ShowPanel(PluginUiOwner, string)

Shows one plugin's named window; see ShowPanel(string). False on a host that draws nothing.

bool ShowPanel(PluginUiOwner owner, string viewName)

Parameters

owner PluginUiOwner

viewName string

Returns

bool

ViewExists(PluginUiOwner, string)

Whether one plugin registered a window with this title or id. False on a host that draws nothing.

bool ViewExists(PluginUiOwner owner, string viewName)

Parameters

owner PluginUiOwner

viewName string

Returns

bool