THYVCLNonVisualPlugin

Overview

THYNonVisualPlugin is the base class for Hydra VCL non-visual plugins. You will use this class as a base for your own non-visual plugins, please refer to this article for more information about non-visual plugins.

Location

Unit: Hydra.VCL.NonVisualPlugin.pas
Ancestry: TDataModule | THYPlugin | THYNonVisualPlugin | THYVCLNonVisualPlugin

constructor Create override

Creates a new instance of the class.

constructor Create(aOwner: TComponent)

Parameters:

aOwner: Reference to the owner object.

ControlsRepository

Gets or sets reference to a controls repository.

property ControlsRepository: THYPluginControlsRepository read write

CrossPlatformHost protected (declared in THYPlugin)

Reference to an instance of a cross platform host.

property CrossPlatformHost: IHYCrossPlatformHost read

Host protected

The reference to the plugin host interface.

property Host: IHYVCLHost read write

InstanceID

property InstanceID: NativeInt read

NewInstance override

Allocates memory for an instance of an object type and returns a pointer to that new instance.

class function NewInstance: TObject

OnHostParametersChange protected virtual

Event handler. Reacts on host parameters changed.

procedure OnHostParametersChange(Sender: TObject)

Parameters:

Sender: Object that initiates this event handler.

OnPause (declared in THYNonVisualPlugin)

Gets or sets event handler that reacts on Pause calls.

property OnPause: TNotifyEvent read write

OnReferenceCountChange

Fired whenever number of references is changed.

property OnReferenceCountChange: THYReferenceCountChangeEvent read write
delegate:  procedure OnReferenceCountChange(Sender: TObject; NewReferenceCount: Integer; Operation: THYReferenceCountOperation)

OnResume (declared in THYNonVisualPlugin)

Gets or sets event handler that reacts on Resume calls.

property OnResume: TNotifyEvent read write

OnSetHost

Fired whenever reference to a host changed.

property OnSetHost: THYHostSetEvent read write
delegate:  procedure OnSetHost(const Sender: IHYVCLHostAware; const aHost: IHYVCLHost)

OnSetHostParameters

Fired whenever parameters of the host changed.

property OnSetHostParameters: THYHostParametersChangeEvent read write
delegate:  procedure OnSetHostParameters(const aHost: IHYVCLHost; aParameters: TStrings)

OnStart (declared in THYNonVisualPlugin)

Gets or sets event handler that reacts on Start calls.

property OnStart: TNotifyEvent read write

OnStop (declared in THYNonVisualPlugin)

Gets or sets event handler that reacts on Stop calls.

property OnStop: TNotifyEvent read write

Pause protected safecall (declared in THYNonVisualPlugin)

Pauses executing the non-visual plugin. Call to this method triggers OnPause event.

procedure Pause

PluginActions

Gets of sets reference to the action list associated with the plugin.

property PluginActions: TActionList read write

Resume protected safecall (declared in THYNonVisualPlugin)

Resumes executing the non-visual plugin. Call to this method triggers OnResume event.

procedure Resume

Start protected safecall (declared in THYNonVisualPlugin)

Starts executing the non-visual plugin. Call to this method triggers OnStart event.

procedure Start

Stop protected safecall (declared in THYNonVisualPlugin)

Stops executing the non-visual plugin. Call to this method triggers OnStop event.

procedure Stop

ControlsRepository

Gets or sets reference to a controls repository.

property ControlsRepository: THYPluginControlsRepository read write

CrossPlatformHost protected (declared in THYPlugin)

Reference to an instance of a cross platform host.

property CrossPlatformHost: IHYCrossPlatformHost read

Host protected

The reference to the plugin host interface.

property Host: IHYVCLHost read write

InstanceID

property InstanceID: NativeInt read

PluginActions

Gets of sets reference to the action list associated with the plugin.

property PluginActions: TActionList read write

NewInstance override

Allocates memory for an instance of an object type and returns a pointer to that new instance.

class function NewInstance: TObject

constructor Create override

Creates a new instance of the class.

constructor Create(aOwner: TComponent)

Parameters:

aOwner: Reference to the owner object.

OnHostParametersChange protected virtual

Event handler. Reacts on host parameters changed.

procedure OnHostParametersChange(Sender: TObject)

Parameters:

Sender: Object that initiates this event handler.

Pause protected safecall (declared in THYNonVisualPlugin)

Pauses executing the non-visual plugin. Call to this method triggers OnPause event.

procedure Pause

Resume protected safecall (declared in THYNonVisualPlugin)

Resumes executing the non-visual plugin. Call to this method triggers OnResume event.

procedure Resume

Start protected safecall (declared in THYNonVisualPlugin)

Starts executing the non-visual plugin. Call to this method triggers OnStart event.

procedure Start

Stop protected safecall (declared in THYNonVisualPlugin)

Stops executing the non-visual plugin. Call to this method triggers OnStop event.

procedure Stop

OnPause (declared in THYNonVisualPlugin)

Gets or sets event handler that reacts on Pause calls.

property OnPause: TNotifyEvent read write

OnReferenceCountChange

Fired whenever number of references is changed.

property OnReferenceCountChange: THYReferenceCountChangeEvent read write
delegate:  procedure OnReferenceCountChange(Sender: TObject; NewReferenceCount: Integer; Operation: THYReferenceCountOperation)

OnResume (declared in THYNonVisualPlugin)

Gets or sets event handler that reacts on Resume calls.

property OnResume: TNotifyEvent read write

OnSetHost

Fired whenever reference to a host changed.

property OnSetHost: THYHostSetEvent read write
delegate:  procedure OnSetHost(const Sender: IHYVCLHostAware; const aHost: IHYVCLHost)

OnSetHostParameters

Fired whenever parameters of the host changed.

property OnSetHostParameters: THYHostParametersChangeEvent read write
delegate:  procedure OnSetHostParameters(const aHost: IHYVCLHost; aParameters: TStrings)

OnStart (declared in THYNonVisualPlugin)

Gets or sets event handler that reacts on Start calls.

property OnStart: TNotifyEvent read write

OnStop (declared in THYNonVisualPlugin)

Gets or sets event handler that reacts on Stop calls.

property OnStop: TNotifyEvent read write

IHYVCLNonVisualPlugin