THYFMXModuleController
Overview
The purpose of the THYFMXModuleController component is to centralize plugin registration in the Hydra module DLL. Each Hydra plugin in the DLL registers itself with the module controller, and the host application uses the module controller for accessing the plugins.
Location
- Unit: Hydra.FMX.ModuleController.pas
- Ancestry: TDataModule | THYSimpleModuleController | THYFMXModuleController
constructor Create (TComponent) overload override (declared in THYSimpleModuleController)
Creates a new instance of the class.
constructor Create(aOwner: TComponent)
Parameters:
- aOwner:
constructor Create (string, Integer, Integer, string, string) reintroduce overload virtual (declared in THYSimpleModuleController)
Creates a new instance of the class.
constructor Create(const aLibraryName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aRequiredPrivilege: string; const aDescription: string)
Parameters:
- aLibraryName:
- aMajorVersion:
- aMinorVersion:
- aRequiredPrivilege:
- aDescription:
constructor CreateNew (string, Integer, Integer, string, string, Integer) reintroduce overload virtual (declared in THYSimpleModuleController)
Creates a new instance of the class.
constructor CreateNew(const aLibraryName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aRequiredPrivilege: string; const aDescription: string; Dummy: Integer)
Parameters:
- aLibraryName:
- aMajorVersion:
- aMinorVersion:
- aRequiredPrivilege:
- aDescription:
- Dummy:
CreateInstance protected virtual safecall (declared in THYSimpleModuleController)
Creates a new instance of the plugin with specified name.
function CreateInstance(const aPluginName: WideString): IHYCrossPlatformPlugin
Parameters:
- aPluginName: Name of the plugin instance.
CrossPlatformHost (declared in THYSimpleModuleController)
Reference to an instance of a cross platform host.
property CrossPlatformHost: IHYCrossPlatformHost read
Descriptor (declared in THYSimpleModuleController)
property Descriptor: THYBaseDescriptor read
DuplicatePluginDescriptor protected (declared in THYSimpleModuleController)
function DuplicatePluginDescriptor(Index: Integer): THYPluginDescriptor
Parameters:
- Index:
get_Plugin protected virtual safecall (declared in THYSimpleModuleController)
Returns the reference to a plugin descriptor with specified index.
function get_Plugin(aIndex: Integer): IHYCrossPlatformPluginDescriptor
Parameters:
- aIndex:
GetModuleController protected safecall (declared in THYSimpleModuleController)
Returns the interface of the current module controller.
function GetModuleController: IHYCrossPlatformModuleController
GetPluginDescriptor (declared in THYSimpleModuleController)
Receives reference to a plugin descriptor with specified name.
function GetPluginDescriptor(aPluginName: string): THYPluginDescriptor
Parameters:
- aPluginName: plugin name.
Host protected
The reference to the plugin host interface.
property Host: IHYFMXHost read
IHYCrossPlatformModuleController_GetLargeImages protected virtual safecall (declared in THYSimpleModuleController)
Returns the handle of the image list used for large images.
function IHYCrossPlatformModuleController_GetLargeImages: THandle
IHYCrossPlatformModuleController_GetSmallImages protected virtual safecall (declared in THYSimpleModuleController)
Returns the handle of the image list used for small images.
function IHYCrossPlatformModuleController_GetSmallImages: THandle
InitializeObject protected virtual (declared in THYSimpleModuleController)
procedure InitializeObject
OnSetHost
Fires when reference to a host is changed.
property OnSetHost: THYHostSetEvent read write
delegate: procedure OnSetHost(const Sender: TObject; const aHost: IHYFMXHost)
PluginDescriptorCount (declared in THYSimpleModuleController)
Gets number of registered plugin descriptors.
property PluginDescriptorCount: Integer read
PluginDescriptors (declared in THYSimpleModuleController)
The reference to a plugin descriptor with specified index.
property PluginDescriptors[Index: Integer]: THYPluginDescriptor read
CrossPlatformHost (declared in THYSimpleModuleController)
Reference to an instance of a cross platform host.
property CrossPlatformHost: IHYCrossPlatformHost read
Descriptor (declared in THYSimpleModuleController)
property Descriptor: THYBaseDescriptor read
Host protected
The reference to the plugin host interface.
property Host: IHYFMXHost read
PluginDescriptorCount (declared in THYSimpleModuleController)
Gets number of registered plugin descriptors.
property PluginDescriptorCount: Integer read
PluginDescriptors (declared in THYSimpleModuleController)
The reference to a plugin descriptor with specified index.
property PluginDescriptors[Index: Integer]: THYPluginDescriptor read
constructor Create (TComponent) overload override (declared in THYSimpleModuleController)
Creates a new instance of the class.
constructor Create(aOwner: TComponent)
Parameters:
- aOwner:
constructor Create (string, Integer, Integer, string, string) reintroduce overload virtual (declared in THYSimpleModuleController)
Creates a new instance of the class.
constructor Create(const aLibraryName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aRequiredPrivilege: string; const aDescription: string)
Parameters:
- aLibraryName:
- aMajorVersion:
- aMinorVersion:
- aRequiredPrivilege:
- aDescription:
constructor CreateNew (string, Integer, Integer, string, string, Integer) reintroduce overload virtual (declared in THYSimpleModuleController)
Creates a new instance of the class.
constructor CreateNew(const aLibraryName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aRequiredPrivilege: string; const aDescription: string; Dummy: Integer)
Parameters:
- aLibraryName:
- aMajorVersion:
- aMinorVersion:
- aRequiredPrivilege:
- aDescription:
- Dummy:
CreateInstance protected virtual safecall (declared in THYSimpleModuleController)
Creates a new instance of the plugin with specified name.
function CreateInstance(const aPluginName: WideString): IHYCrossPlatformPlugin
Parameters:
- aPluginName: Name of the plugin instance.
DuplicatePluginDescriptor protected (declared in THYSimpleModuleController)
function DuplicatePluginDescriptor(Index: Integer): THYPluginDescriptor
Parameters:
- Index:
get_Plugin protected virtual safecall (declared in THYSimpleModuleController)
Returns the reference to a plugin descriptor with specified index.
function get_Plugin(aIndex: Integer): IHYCrossPlatformPluginDescriptor
Parameters:
- aIndex:
GetModuleController protected safecall (declared in THYSimpleModuleController)
Returns the interface of the current module controller.
function GetModuleController: IHYCrossPlatformModuleController
GetPluginDescriptor (declared in THYSimpleModuleController)
Receives reference to a plugin descriptor with specified name.
function GetPluginDescriptor(aPluginName: string): THYPluginDescriptor
Parameters:
- aPluginName: plugin name.
IHYCrossPlatformModuleController_GetLargeImages protected virtual safecall (declared in THYSimpleModuleController)
Returns the handle of the image list used for large images.
function IHYCrossPlatformModuleController_GetLargeImages: THandle
IHYCrossPlatformModuleController_GetSmallImages protected virtual safecall (declared in THYSimpleModuleController)
Returns the handle of the image list used for small images.
function IHYCrossPlatformModuleController_GetSmallImages: THandle
InitializeObject protected virtual (declared in THYSimpleModuleController)
procedure InitializeObject
OnSetHost
Fires when reference to a host is changed.
property OnSetHost: THYHostSetEvent read write
delegate: procedure OnSetHost(const Sender: TObject; const aHost: IHYFMXHost)