IHYVCLHost

Overview

The IHYVCLHost interface is implemented by the host side THYModuleManager component. The plugin uses the IHYVCLHost interface for access to the host, such as calling the SendMessage method for callbacks into the host.

In order to create menu items and toolbars, the host uses MenuController and ToolbarController components. Since also the plugins might need to access such controllers, I extended IHYVCLHost so that the plugins have a way to access the controllers.

Location

  • Unit: Hydra.VCL.Interfaces.pas
  • Ancestry: IHYVCLHost


 

Form

Gets reference to a host parent form.

property Form: TForm read

GetForm

function GetForm: TForm

GetInstanceCount

function GetInstanceCount: Integer

GetInstances

function GetInstances(Index: Integer): IHYVCLPlugin

Parameters:

  • Index:

GetMenuController

function GetMenuController: IHYVCLMenuController

GetToolbarController

function GetToolbarController: IHYVCLToolbarController

HostParameters

Gets or sets reference to the list of host parameters.

property HostParameters: TStrings read write

InstanceCount

Gets the number of plugin instances created by the host.

property InstanceCount: Integer read

Instances

Gets reference to an instance of a plugin created by the host with specified index.

property Instances[Index: Integer]: IHYVCLPlugin read

Gets reference to the menu controller associated with the host.

property MenuController: IHYVCLMenuController read

SendMessage  deprecated

Used by a plugins to send message to the host. Deprecated.

procedure SendMessage(const Sender: IHYVCLPlugin; aMessageID: Integer; const aMessageData: pointer)

Parameters:

  • Sender: Reference to an instance of a plugin that sends message.
  • aMessageID: Custom message identifier.
  • aMessageData: Pointer to the custom message data.

ToolbarController

Gets reference to the toolbar controller associated with the host.

property ToolbarController: IHYVCLToolbarController read

 

Form

Gets reference to a host parent form.

property Form: TForm read

HostParameters

Gets or sets reference to the list of host parameters.

property HostParameters: TStrings read write

InstanceCount

Gets the number of plugin instances created by the host.

property InstanceCount: Integer read

Instances

Gets reference to an instance of a plugin created by the host with specified index.

property Instances[Index: Integer]: IHYVCLPlugin read

Gets reference to the menu controller associated with the host.

property MenuController: IHYVCLMenuController read

ToolbarController

Gets reference to the toolbar controller associated with the host.

property ToolbarController: IHYVCLToolbarController read

 

GetForm

function GetForm: TForm

GetInstanceCount

function GetInstanceCount: Integer

GetInstances

function GetInstances(Index: Integer): IHYVCLPlugin

Parameters:

  • Index:

GetMenuController

function GetMenuController: IHYVCLMenuController

GetToolbarController

function GetToolbarController: IHYVCLToolbarController

SendMessage  deprecated

Used by a plugins to send message to the host. Deprecated.

procedure SendMessage(const Sender: IHYVCLPlugin; aMessageID: Integer; const aMessageData: pointer)

Parameters:

  • Sender: Reference to an instance of a plugin that sends message.
  • aMessageID: Custom message identifier.
  • aMessageData: Pointer to the custom message data.