THYPluginDescriptor
Overview
THYPluginDescriptor is the class that holds description of a plugin.
Location
- Unit: Hydra.Core.PluginDescriptors.pas
- Ancestry: TPersistent | THYBaseDescriptor | THYPluginDescriptor
constructor Create overload (declared in THYBaseDescriptor)
Creates a new instance of the class.
constructor Create
constructor Create (string, Integer, Integer, string, string, string)
Creates an instance of the object with specifed parameters.
constructor Create(const aName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aRequiredPrivilege: string; const aDescription: string; const aUserData: string)
Parameters:
- aName: Name of the object.
- aMajorVersion: Major version number.
- aMinorVersion: Minor version number.
- aRequiredPrivilege: Plrivileges reuiqred to use this object.
- aDescription: Description of the object.
- aUserData: User defined data.
AddRef virtual
Increments the reference count for an interface on an object.
procedure AddRef
Assign override (declared in THYBaseDescriptor)
Copies the properties of a source object.
procedure Assign(Source: TPersistent)
Parameters:
- Source: Source object.
CheckPluginInterface virtual abstract
Checks whether plugin implements specified interface.
function CheckPluginInterface(const anIID: TGUID): Boolean
Parameters:
- anIID: GUID of the inteface.
CheckPluginType virtual abstract
Checks whether plugin is inherited from specified type.
function CheckPluginType(const aType: string): WordBool
Parameters:
- aType: Name of the type.
Description (declared in THYBaseDescriptor)
User defined description.
property Description: string read write
InstanceCount
Stores number of active instances.
property InstanceCount: Integer read write
LargeImageIndex
Gets or sets large image index. Deprecated.
property LargeImageIndex: Integer read write
MajorVersion (declared in THYBaseDescriptor)
Gets or sets major version number.
property MajorVersion: Integer read write
MinorVersion (declared in THYBaseDescriptor)
Gets or sets minor version number.
property MinorVersion: Integer read write
Name (declared in THYBaseDescriptor)
Gets or sets name of an object.
property Name: string read write
PluginType
Stores the type of the plugin.
property PluginType: THYPluginType read
Release virtual
Decrements the reference count for an interface on an object.
procedure Release
RequiredPrivilege (declared in THYBaseDescriptor)
Gets or sets user defined string that holds privilages that is required to use an object.
property RequiredPrivilege: string read write
SmallImageIndex
Gets or sets small image index. Deprecated.
property SmallImageIndex: Integer read write
UserData (declared in THYBaseDescriptor)
Gets or sets string that holds user defined data.
property UserData: string read write
Description (declared in THYBaseDescriptor)
User defined description.
property Description: string read write
InstanceCount
Stores number of active instances.
property InstanceCount: Integer read write
LargeImageIndex
Gets or sets large image index. Deprecated.
property LargeImageIndex: Integer read write
MajorVersion (declared in THYBaseDescriptor)
Gets or sets major version number.
property MajorVersion: Integer read write
MinorVersion (declared in THYBaseDescriptor)
Gets or sets minor version number.
property MinorVersion: Integer read write
Name (declared in THYBaseDescriptor)
Gets or sets name of an object.
property Name: string read write
PluginType
Stores the type of the plugin.
property PluginType: THYPluginType read
RequiredPrivilege (declared in THYBaseDescriptor)
Gets or sets user defined string that holds privilages that is required to use an object.
property RequiredPrivilege: string read write
SmallImageIndex
Gets or sets small image index. Deprecated.
property SmallImageIndex: Integer read write
UserData (declared in THYBaseDescriptor)
Gets or sets string that holds user defined data.
property UserData: string read write
constructor Create overload (declared in THYBaseDescriptor)
Creates a new instance of the class.
constructor Create
constructor Create (string, Integer, Integer, string, string, string)
Creates an instance of the object with specifed parameters.
constructor Create(const aName: string; aMajorVersion: Integer; aMinorVersion: Integer; const aRequiredPrivilege: string; const aDescription: string; const aUserData: string)
Parameters:
- aName: Name of the object.
- aMajorVersion: Major version number.
- aMinorVersion: Minor version number.
- aRequiredPrivilege: Plrivileges reuiqred to use this object.
- aDescription: Description of the object.
- aUserData: User defined data.
AddRef virtual
Increments the reference count for an interface on an object.
procedure AddRef
Assign override (declared in THYBaseDescriptor)
Copies the properties of a source object.
procedure Assign(Source: TPersistent)
Parameters:
- Source: Source object.
CheckPluginInterface virtual abstract
Checks whether plugin implements specified interface.
function CheckPluginInterface(const anIID: TGUID): Boolean
Parameters:
- anIID: GUID of the inteface.
CheckPluginType virtual abstract
Checks whether plugin is inherited from specified type.
function CheckPluginType(const aType: string): WordBool
Parameters:
- aType: Name of the type.
Release virtual
Decrements the reference count for an interface on an object.
procedure Release