IHYVisualPlugin

Overview

IHYVisualPlugin is the interface of visual Hydra plugins. It is implemented by the THYVisualPlugin form class.

Use visual plugins for GUI modules. IHYVisualPlugin has methods that will let the host application show the module and access its actions.

Location

Implemented in

 

GetObject    (declared in IHYPlugin)

Returns a reference to the associated object.

function GetObject: TObject

Hide

Hides plugin control.

procedure Hide

Host    (declared in IHYHostAware)

Gets or sets reference to an instance of the host.

property Host: IHYHost read write

HostParameters    (declared in IHYHostAware)

Gets or sets reference to a list of host parameters.

property HostParameters: TStrings read write

InstanceID    (declared in IHYPlugin)

Gets the InstanceID to determine the run-time identifier of the plugin instance. Deprecated.

property InstanceID: integer read write

PluginActions    (declared in IHYPlugin)

Gets reference to the action list associated with the plugin.

property PluginActions: TActionList read write

Show

Shows plugin control.

procedure Show

ShowParented

Shows plugin control within specified parent control.

procedure ShowParented(aParent: TWinControl)

Parameters:

  • aParent: Reference to a parent control.

ShowWindowed

Shows plugin control without parent control.

procedure ShowWindowed

Visible

Gets or sets value that defines whether plugin control is visible.

property Visible: boolean read write

 

Host    (declared in IHYHostAware)

Gets or sets reference to an instance of the host.

property Host: IHYHost read write

HostParameters    (declared in IHYHostAware)

Gets or sets reference to a list of host parameters.

property HostParameters: TStrings read write

InstanceID    (declared in IHYPlugin)

Gets the InstanceID to determine the run-time identifier of the plugin instance. Deprecated.

property InstanceID: integer read write

PluginActions    (declared in IHYPlugin)

Gets reference to the action list associated with the plugin.

property PluginActions: TActionList read write

Visible

Gets or sets value that defines whether plugin control is visible.

property Visible: boolean read write

 

GetObject    (declared in IHYPlugin)

Returns a reference to the associated object.

function GetObject: TObject

Hide

Hides plugin control.

procedure Hide

Show

Shows plugin control.

procedure Show

ShowParented

Shows plugin control within specified parent control.

procedure ShowParented(aParent: TWinControl)

Parameters:

  • aParent: Reference to a parent control.

ShowWindowed

Shows plugin control without parent control.

procedure ShowWindowed