IHYVCLNonVisualPlugin

Overview

IHYVCLNonVisualPlugin is the interface of non-visual Hydra plugins. It is implemented by the THYVCLNonVisualPlugin data module class.

Use non-visual plugins for the encapsulation of processes. IHYVCLNonVisualPlugin has methods that will let the host application Start, Pause, Resume and Stop the process encapsulated by the plugin.

Location


 

GetInstanceID    (declared in IHYVCLPlugin)

function GetInstanceID: NativeInt

GetObject    (declared in IHYVCLPlugin)

Returns a reference to the associated object.

function GetObject: TObject

GetPluginActions    (declared in IHYVCLPlugin)

function GetPluginActions: TActionList

Host    (declared in IHYVCLHostAware)

Gets or sets reference to an instance of the host.

property Host: IHYVCLHost read write

HostParameters    (declared in IHYVCLHostAware)

Gets or sets reference to a list of host parameters.

property HostParameters: TStrings read write

InstanceID    (declared in IHYVCLPlugin)

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

property InstanceID: NativeInt read

Pause

Pauses executing the non-visual plugin.

procedure Pause

PluginActions    (declared in IHYVCLPlugin)

Gets reference to the action list associated with the plugin.

property PluginActions: TActionList read

Resume

Resumes executing the non-visual plugin.

procedure Resume

Start

Starts executing the non-visual plugin.

procedure Start

Stop

Stops executing the non-visual plugin.

procedure Stop

 

Host    (declared in IHYVCLHostAware)

Gets or sets reference to an instance of the host.

property Host: IHYVCLHost read write

HostParameters    (declared in IHYVCLHostAware)

Gets or sets reference to a list of host parameters.

property HostParameters: TStrings read write

InstanceID    (declared in IHYVCLPlugin)

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

property InstanceID: NativeInt read

PluginActions    (declared in IHYVCLPlugin)

Gets reference to the action list associated with the plugin.

property PluginActions: TActionList read

 

GetInstanceID    (declared in IHYVCLPlugin)

function GetInstanceID: NativeInt

GetObject    (declared in IHYVCLPlugin)

Returns a reference to the associated object.

function GetObject: TObject

GetPluginActions    (declared in IHYVCLPlugin)

function GetPluginActions: TActionList

Pause

Pauses executing the non-visual plugin.

procedure Pause

Resume

Resumes executing the non-visual plugin.

procedure Resume

Start

Starts executing the non-visual plugin.

procedure Start

Stop

Stops executing the non-visual plugin.

procedure Stop