Class PluginPanelDescriptor

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

How a plugin's window should be presented: its identity, its title bar, its shelf button, and whether it starts open.

public sealed record PluginPanelDescriptor : IEquatable<PluginPanelDescriptor>

Inheritance

object

PluginPanelDescriptor

Implements

IEquatable<PluginPanelDescriptor>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PluginPanelDescriptor(string, string)

How a plugin's window should be presented: its identity, its title bar, its shelf button, and whether it starts open.

public PluginPanelDescriptor(string WindowId, string Title)

Parameters

WindowId string

The plugin's own short name for this window. It is part of the key the host stores the window's position under, so changing it loses the saved position.

Title string

The caption shown in the window's title bar.

Properties

IconSurfaceId

The icon drawn on the shelf button, either a full image id or a bare index. 0 means no icon, in which case IconText is used.

public uint IconSurfaceId { get; init; }

Property Value

uint

IconText

A word or two of initials drawn on the shelf button when no icon id is given. Null falls back to the host's own default.

public string? IconText { get; init; }

Property Value

string

ShowInSidePanel

Whether this window receives a button in the shared sidepanel.

public bool ShowInSidePanel { get; init; }

Property Value

bool

StartVisible

Whether the window is open as soon as it is registered.

public bool StartVisible { get; init; }

Property Value

bool

Title

The caption shown in the window's title bar.

public string Title { get; init; }

Property Value

string

WindowId

The plugin's own short name for this window. It is part of the key the host stores the window's position under, so changing it loses the saved position.

public string WindowId { get; init; }

Property Value

string