THYVCLCrossPlatformVisualPluginWrapper

Overview

The THYVCLCrossPlatformVisualPluginWrapper class is a base class for wrappers for VCL cross-platform visual plugin instances.

Location

Implements

 

constructor Create    (declared in THYVCLCrossPlatformPluginWrapper)

Creates a new instance of the class.

constructor Create(aPluginInstance: IDispatch; Descriptor: THYPluginDescriptor)

Parameters:

  • aPluginInstance: Cross-platform instance
  • Descriptor: Descriptor

CrossPlatformInstance  protected    (declared in THYBaseCrossPlatformPluginWrapper)

Plugin instance

property CrossPlatformInstance: IDispatch read write

Descriptor  protected    (declared in THYBaseCrossPlatformPluginWrapper)

property Descriptor: THYPluginDescriptor read write

GetHost  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Gets reference to a host instance.

function GetHost: IHYHost

GetHostParameters  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Gets list of a host parameters.

function GetHostParameters: TStrings

GetIDsOfNames  protected stdcall    (declared in THYFakeIDispatch)

Maps a single member and an optional set of argument names to a corresponding set of integer DISPIDs. Empty.

function GetIDsOfNames(const IID: TGUID; Names: Pointer; NameCount: Integer; LocaleID: Integer; DispIDs: Pointer): HResult

Parameters:

  • IID: Reserved for future use. Must be IID_NULL.
  • Names: The array of names to be mapped.
  • NameCount: The count of the names to be mapped.
  • LocaleID: The locale context in which to interpret the names.
  • DispIDs: Caller-allocated array, each element of which contains an identifier (ID) corresponding to one of the names passed in the rgszNames array.

GetInstanceID  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Gets the run-time identifier of the plugin instance. Deprecated.

function GetInstanceID: integer

GetObject  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Returns a reference to the associated object.

function GetObject: TObject

GetPluginActions  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Gets reference to the associated action list.

function GetPluginActions: TActionList

GetTypeInfo  protected stdcall    (declared in THYFakeIDispatch)

Retrieves the type information for an object, which can then be used to get the type information for an interface. Empty.

function GetTypeInfo(Index: Integer; LocaleID: Integer; out TypeInfo: ): HResult

Parameters:

  • Index: Index of the type information to return.
  • LocaleID: The locale identifier for the type information.
  • TypeInfo: The requested type information object.

GetTypeInfoCount  protected stdcall    (declared in THYFakeIDispatch)

Retrieves the number of type information interfaces that an object provides (either 0 or 1). Empty

function GetTypeInfoCount(out Count: Integer): HResult

Parameters:

  • Count: The number of type information interfaces provided by the object. If the object provides type information, this number is 1; otherwise the number is 0.

GetVisible  protected

Gets value that defines whether plugin is visible.

function GetVisible: boolean

Hide  protected

Hides a plugin control.

procedure Hide

InterfaceSupportsErrorInfo  protected stdcall    (declared in THYFakeIDispatch)

Indicates whether an interface supports the IErrorInfo interface.

function InterfaceSupportsErrorInfo(const iid: TIID): HResult

Parameters:

  • iid: An interface identifier (IID).

Invoke  protected stdcall    (declared in THYFakeIDispatch)

Provides access to properties and methods exposed by an object. Empty.

function Invoke(DispID: Integer; const IID: TGUID; LocaleID: Integer; Flags: Word; var Params: ; VarResult: Pointer; ExcepInfo: Pointer; ArgErr: Pointer): HResult

Parameters:

  • DispID: Identifies the member.
  • IID: Reserved for future use. Must be IID_NULL.
  • LocaleID: The locale context in which to interpret arguments.
  • Flags: Flags describing the context of the Invoke call.
  • Params: Pointer to a DISPPARAMS structure containing an array of arguments, an array of argument DISPIDs for named arguments, and counts for the number of elements in the arrays.
  • VarResult: Pointer to the location where the result is to be stored, or nil if the caller expects no result.
  • ExcepInfo: Pointer to a structure that contains exception information.
  • ArgErr: The index within rgvarg of the first argument that has an error.

PluginInstance

Plugin instance

property PluginInstance: IHYCrossPlatformVisualPlugin read write

PluginInstanceAsIDispatch    (declared in THYVCLCrossPlatformPluginWrapper)

Plugin Instance

property PluginInstanceAsIDispatch: IDispatch read write

PluginInstanceAsVariant    (declared in THYVCLCrossPlatformPluginWrapper)

Plugin Instance

property PluginInstanceAsVariant: OleVariant read write

ReferenceCount    (declared in THYFakeIDispatch)

Gets the number of the references to this object.

property ReferenceCount: Integer read write

SafeCallException  override    (declared in THYFakeIDispatch)

Handles exceptions in methods declared using the safecall calling convention.

function SafeCallException(ExceptObject: TObject; ExceptAddr: Pointer): HResult

Parameters:

  • ExceptObject: Exception object.
  • ExceptAddr: Addres of the exception.

SetHost  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Sets reference to a host instance.

procedure SetHost(const aValue: IHYHost)

Parameters:

  • aValue: reference to a host instance

SetHostParameters  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Sets list of a host parameters.

procedure SetHostParameters(Value: TStrings)

Parameters:

  • Value: list of a host parameters

SetVisible  protected

Sets value that defines whether plugin is visible.

procedure SetVisible(Value: boolean)

Parameters:

  • Value: value

Show  protected

Shows a plugin control.

procedure Show

ShowParented  protected

Displays content of a plugin within specified parent control.

procedure ShowParented(aParent: TWinControl)

Parameters:

  • aParent: Reference to a parent control.

ShowWindowed  protected

Displays plugin content in the specified parent control.

procedure ShowWindowed

 

CrossPlatformInstance  protected    (declared in THYBaseCrossPlatformPluginWrapper)

Plugin instance

property CrossPlatformInstance: IDispatch read write

Descriptor  protected    (declared in THYBaseCrossPlatformPluginWrapper)

property Descriptor: THYPluginDescriptor read write

PluginInstance

Plugin instance

property PluginInstance: IHYCrossPlatformVisualPlugin read write

PluginInstanceAsIDispatch    (declared in THYVCLCrossPlatformPluginWrapper)

Plugin Instance

property PluginInstanceAsIDispatch: IDispatch read write

PluginInstanceAsVariant    (declared in THYVCLCrossPlatformPluginWrapper)

Plugin Instance

property PluginInstanceAsVariant: OleVariant read write

ReferenceCount    (declared in THYFakeIDispatch)

Gets the number of the references to this object.

property ReferenceCount: Integer read write

 

constructor Create    (declared in THYVCLCrossPlatformPluginWrapper)

Creates a new instance of the class.

constructor Create(aPluginInstance: IDispatch; Descriptor: THYPluginDescriptor)

Parameters:

  • aPluginInstance: Cross-platform instance
  • Descriptor: Descriptor

GetHost  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Gets reference to a host instance.

function GetHost: IHYHost

GetHostParameters  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Gets list of a host parameters.

function GetHostParameters: TStrings

GetIDsOfNames  protected stdcall    (declared in THYFakeIDispatch)

Maps a single member and an optional set of argument names to a corresponding set of integer DISPIDs. Empty.

function GetIDsOfNames(const IID: TGUID; Names: Pointer; NameCount: Integer; LocaleID: Integer; DispIDs: Pointer): HResult

Parameters:

  • IID: Reserved for future use. Must be IID_NULL.
  • Names: The array of names to be mapped.
  • NameCount: The count of the names to be mapped.
  • LocaleID: The locale context in which to interpret the names.
  • DispIDs: Caller-allocated array, each element of which contains an identifier (ID) corresponding to one of the names passed in the rgszNames array.

GetInstanceID  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Gets the run-time identifier of the plugin instance. Deprecated.

function GetInstanceID: integer

GetObject  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Returns a reference to the associated object.

function GetObject: TObject

GetPluginActions  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Gets reference to the associated action list.

function GetPluginActions: TActionList

GetTypeInfo  protected stdcall    (declared in THYFakeIDispatch)

Retrieves the type information for an object, which can then be used to get the type information for an interface. Empty.

function GetTypeInfo(Index: Integer; LocaleID: Integer; out TypeInfo: ): HResult

Parameters:

  • Index: Index of the type information to return.
  • LocaleID: The locale identifier for the type information.
  • TypeInfo: The requested type information object.

GetTypeInfoCount  protected stdcall    (declared in THYFakeIDispatch)

Retrieves the number of type information interfaces that an object provides (either 0 or 1). Empty

function GetTypeInfoCount(out Count: Integer): HResult

Parameters:

  • Count: The number of type information interfaces provided by the object. If the object provides type information, this number is 1; otherwise the number is 0.

GetVisible  protected

Gets value that defines whether plugin is visible.

function GetVisible: boolean

Hide  protected

Hides a plugin control.

procedure Hide

InterfaceSupportsErrorInfo  protected stdcall    (declared in THYFakeIDispatch)

Indicates whether an interface supports the IErrorInfo interface.

function InterfaceSupportsErrorInfo(const iid: TIID): HResult

Parameters:

  • iid: An interface identifier (IID).

Invoke  protected stdcall    (declared in THYFakeIDispatch)

Provides access to properties and methods exposed by an object. Empty.

function Invoke(DispID: Integer; const IID: TGUID; LocaleID: Integer; Flags: Word; var Params: ; VarResult: Pointer; ExcepInfo: Pointer; ArgErr: Pointer): HResult

Parameters:

  • DispID: Identifies the member.
  • IID: Reserved for future use. Must be IID_NULL.
  • LocaleID: The locale context in which to interpret arguments.
  • Flags: Flags describing the context of the Invoke call.
  • Params: Pointer to a DISPPARAMS structure containing an array of arguments, an array of argument DISPIDs for named arguments, and counts for the number of elements in the arrays.
  • VarResult: Pointer to the location where the result is to be stored, or nil if the caller expects no result.
  • ExcepInfo: Pointer to a structure that contains exception information.
  • ArgErr: The index within rgvarg of the first argument that has an error.

SafeCallException  override    (declared in THYFakeIDispatch)

Handles exceptions in methods declared using the safecall calling convention.

function SafeCallException(ExceptObject: TObject; ExceptAddr: Pointer): HResult

Parameters:

  • ExceptObject: Exception object.
  • ExceptAddr: Addres of the exception.

SetHost  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Sets reference to a host instance.

procedure SetHost(const aValue: IHYHost)

Parameters:

  • aValue: reference to a host instance

SetHostParameters  protected    (declared in THYVCLCrossPlatformPluginWrapper)

Sets list of a host parameters.

procedure SetHostParameters(Value: TStrings)

Parameters:

  • Value: list of a host parameters

SetVisible  protected

Sets value that defines whether plugin is visible.

procedure SetVisible(Value: boolean)

Parameters:

  • Value: value

Show  protected

Shows a plugin control.

procedure Show

ShowParented  protected

Displays content of a plugin within specified parent control.

procedure ShowParented(aParent: TWinControl)

Parameters:

  • aParent: Reference to a parent control.

ShowWindowed  protected

Displays plugin content in the specified parent control.

procedure ShowWindowed