IHYCrossPlatformVisualPlugin

Overview

The IHYCrossPlatformVisualPlugin interface represents a cross platform visual plugin. In the Hydra framework, this interface is used internally to define and provide implementations for visual plugins that can be used in cross platform applications.

There is no need to use this class directly, since all visual plugins in the Hydra framework already implement this interface.

Location


 

GetDialogCode  safecall

This method is called whenever the host processes a WM_GETDLGCODE message. The visual plugin has to respond to the message to indicate the types of input it wants to process itself.

function GetDialogCode: Integer

GetHandle  safecall

Gets the window handle that the plugin is bound to.

function GetHandle: THandle

HandleKeyboardAccelerator  safecall

This method is called whenever the parent control is resized.

function HandleKeyboardAccelerator(const aChar: Word): WordBool

Parameters:

  • aChar: Key code.

Hide  safecall

Hides the visual plugin.

procedure Hide

ProcessTabKey  safecall

This method is called when the focus is changed by using the keyboard (TAB, SHIFT+TAB, and so on). This method has to process focus changes inside the plugin.

function ProcessTabKey(const aForward: WordBool): WordBool

Parameters:

  • aForward: Indicates whether the focus must move forward or backward in the tab order

SelectEntryControl  safecall

This method is called by the host whenever the focus is passed to the visual plugin.

function SelectEntryControl(aForward: WordBool): WordBool

Parameters:

  • aForward: Indicates whether the focus must move forward or backward in the tab order

SetFocus  safecall

Sets the focus to the visual plugin.

procedure SetFocus

SetSize  safecall

This method is called whenever the parent control is resized.

procedure SetSize(aWidth: Integer; aHeight: Integer)

Parameters:

  • aWidth: New width of the control
  • aHeight: New height of the control

Show  safecall

Shows the visual plugin.

procedure Show

ShowParented  safecall

Shows the visual plugin and sets its parent handle to the provided value.

procedure ShowParented(aParentHandle: THandle)

Parameters:

  • aParentHandle: Handle of the parent window

Visible

This property changes the plugin visibility.

property Visible: WordBool read write

 

Visible

This property changes the plugin visibility.

property Visible: WordBool read write

 

GetDialogCode  safecall

This method is called whenever the host processes a WM_GETDLGCODE message. The visual plugin has to respond to the message to indicate the types of input it wants to process itself.

function GetDialogCode: Integer

GetHandle  safecall

Gets the window handle that the plugin is bound to.

function GetHandle: THandle

HandleKeyboardAccelerator  safecall

This method is called whenever the parent control is resized.

function HandleKeyboardAccelerator(const aChar: Word): WordBool

Parameters:

  • aChar: Key code.

Hide  safecall

Hides the visual plugin.

procedure Hide

ProcessTabKey  safecall

This method is called when the focus is changed by using the keyboard (TAB, SHIFT+TAB, and so on). This method has to process focus changes inside the plugin.

function ProcessTabKey(const aForward: WordBool): WordBool

Parameters:

  • aForward: Indicates whether the focus must move forward or backward in the tab order

SelectEntryControl  safecall

This method is called by the host whenever the focus is passed to the visual plugin.

function SelectEntryControl(aForward: WordBool): WordBool

Parameters:

  • aForward: Indicates whether the focus must move forward or backward in the tab order

SetFocus  safecall

Sets the focus to the visual plugin.

procedure SetFocus

SetSize  safecall

This method is called whenever the parent control is resized.

procedure SetSize(aWidth: Integer; aHeight: Integer)

Parameters:

  • aWidth: New width of the control
  • aHeight: New height of the control

Show  safecall

Shows the visual plugin.

procedure Show

ShowParented  safecall

Shows the visual plugin and sets its parent handle to the provided value.

procedure ShowParented(aParentHandle: THandle)

Parameters:

  • aParentHandle: Handle of the parent window