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

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.

 

method GetDialogCode: Int32

 

Int32 GetDialogCode()

 

Function GetDialogCode() As Int32

GetHandle

Gets the window handle that the plugin is bound to.

 

method GetHandle: IntPtr

 

IntPtr GetHandle()

 

Function GetHandle() As IntPtr

HandleKeyboardAccelerator

This method is called during the processing of dialog characters, such as control mnemonics.

 

method HandleKeyboardAccelerator(char: UInt16): Boolean

 

Boolean HandleKeyboardAccelerator(UInt16 char)

 

Function HandleKeyboardAccelerator(char As UInt16) As Boolean

Parameters:

  • char: Key code.

Hide

Hides the visual plugin.

 

method Hide

 

void Hide()

 

Sub Hide()

ProcessTabKey

 

method ProcessTabKey(forward: Boolean): Boolean

 

Boolean ProcessTabKey(Boolean forward)

 

Function ProcessTabKey(forward As Boolean) As Boolean

Parameters:

  • forward:

SelectEntryControl

 

method SelectEntryControl(forward: Boolean): Boolean

 

Boolean SelectEntryControl(Boolean forward)

 

Function SelectEntryControl(forward As Boolean) As Boolean

Parameters:

  • forward:

SetFocus

Sets the focus to the visual plugin.

 

method SetFocus

 

void SetFocus()

 

Sub SetFocus()

SetSize

 

method SetSize(width: Int32; height: Int32)

 

void SetSize(Int32 width, Int32 height)

 

Sub SetSize(width As Int32, height As Int32)

Parameters:

  • width:
  • height:

Show

Shows the visual plugin.

 

method Show

 

void Show()

 

Sub Show()

ShowParented

 

method ShowParented(parent: IntPtr)

 

void ShowParented(IntPtr parent)

 

Sub ShowParented(parent As IntPtr)

Parameters:

  • parent:

Visible

This property changes the plugin visibility.

 

property Visible: Boolean read write;

 

Boolean Visible { get; set; }

 

Property Visible() As Boolean

 

Visible

This property changes the plugin visibility.

 

property Visible: Boolean read write;

 

Boolean Visible { get; set; }

 

Property Visible() As Boolean

 

GetDialogCode

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.

 

method GetDialogCode: Int32

 

Int32 GetDialogCode()

 

Function GetDialogCode() As Int32

GetHandle

Gets the window handle that the plugin is bound to.

 

method GetHandle: IntPtr

 

IntPtr GetHandle()

 

Function GetHandle() As IntPtr

HandleKeyboardAccelerator

This method is called during the processing of dialog characters, such as control mnemonics.

 

method HandleKeyboardAccelerator(char: UInt16): Boolean

 

Boolean HandleKeyboardAccelerator(UInt16 char)

 

Function HandleKeyboardAccelerator(char As UInt16) As Boolean

Parameters:

  • char: Key code.

Hide

Hides the visual plugin.

 

method Hide

 

void Hide()

 

Sub Hide()

ProcessTabKey

 

method ProcessTabKey(forward: Boolean): Boolean

 

Boolean ProcessTabKey(Boolean forward)

 

Function ProcessTabKey(forward As Boolean) As Boolean

Parameters:

  • forward:

SelectEntryControl

 

method SelectEntryControl(forward: Boolean): Boolean

 

Boolean SelectEntryControl(Boolean forward)

 

Function SelectEntryControl(forward As Boolean) As Boolean

Parameters:

  • forward:

SetFocus

Sets the focus to the visual plugin.

 

method SetFocus

 

void SetFocus()

 

Sub SetFocus()

SetSize

 

method SetSize(width: Int32; height: Int32)

 

void SetSize(Int32 width, Int32 height)

 

Sub SetSize(width As Int32, height As Int32)

Parameters:

  • width:
  • height:

Show

Shows the visual plugin.

 

method Show

 

void Show()

 

Sub Show()

ShowParented

 

method ShowParented(parent: IntPtr)

 

void ShowParented(IntPtr parent)

 

Sub ShowParented(parent As IntPtr)

Parameters:

  • parent: