THYFMXControlAsVisualPlugin

Overview

The THYFMXControlAsVisualPlugin wrapper class implements the IHYCrossPlatformVisualPlugin interface and provides methods needed to use FreMonkey visual plugins inside host.

There is no need to use this class directly since it is used by the THYFMXVisualPlugin to enable the usage of visual plugins inside hosts without additional configuration.

Location


 

constructor Create (TForm)

Creates a new instance of the class.

constructor Create(aControl: TForm)

Parameters:

  • aControl: Linked control that will actually perform the requested methods

constructor Create (TObject)    (declared in THYFMXObjectAsPlugin)

Creates a new instance of the class.

constructor Create(aPlugin: TObject)

Parameters:

  • aPlugin: Reference to a plugin object.

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.

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.

Host    (declared in THYFMXObjectAsPlugin)

The reference to the plugin host interface.

property Host: IHYFMXHost read

HostFocusLost

Notifys parent control that focus is tranfered to a plugin.

procedure HostFocusLost

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.

OnProcessTabKey

This event is fired whenever Tab key is pressed.

property OnProcessTabKey: THYProcessTabKeyEvent read write
delegate:  procedure OnProcessTabKey(Sender: TObject; const Shift: Boolean; var Handled: Boolean)

OnSetHost    (declared in THYFMXObjectAsPlugin)

This event is fired whenever reference to a host is changed.

property OnSetHost: THYHostSetEvent read write
delegate:  procedure OnSetHost(const Sender: TObject; const aHost: IHYFMXHost)

ParentHandle

Gets parent control handle.

property ParentHandle: HWND read

ReferenceCount    (declared in THYFakeIDispatch)

Gets the number of the references to this object.

property ReferenceCount: Integer read

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.

 

Host    (declared in THYFMXObjectAsPlugin)

The reference to the plugin host interface.

property Host: IHYFMXHost read

ParentHandle

Gets parent control handle.

property ParentHandle: HWND read

ReferenceCount    (declared in THYFakeIDispatch)

Gets the number of the references to this object.

property ReferenceCount: Integer read

 

constructor Create (TForm)

Creates a new instance of the class.

constructor Create(aControl: TForm)

Parameters:

  • aControl: Linked control that will actually perform the requested methods

constructor Create (TObject)    (declared in THYFMXObjectAsPlugin)

Creates a new instance of the class.

constructor Create(aPlugin: TObject)

Parameters:

  • aPlugin: Reference to a plugin object.

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.

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.

HostFocusLost

Notifys parent control that focus is tranfered to a plugin.

procedure HostFocusLost

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.

 

OnProcessTabKey

This event is fired whenever Tab key is pressed.

property OnProcessTabKey: THYProcessTabKeyEvent read write
delegate:  procedure OnProcessTabKey(Sender: TObject; const Shift: Boolean; var Handled: Boolean)

OnSetHost    (declared in THYFMXObjectAsPlugin)

This event is fired whenever reference to a host is changed.

property OnSetHost: THYHostSetEvent read write
delegate:  procedure OnSetHost(const Sender: TObject; const aHost: IHYFMXHost)