IHYNonVisualPlugin
From RemObjects Software
This is a Hydra Architecture entry
Feel free to add your notes to this topic below.
Overview
IHYNonVisualPlugin is the interface of non-visual Hydra plugins. It is implemented by the THYNonVisualPlugin data module class.
Use non-visual plugins for encapsulation of processes. IHYNonVisualPlugin has methods that will let the host application Start, Pause, Resume and Stop the process encapsulated by the plugin.
File
uHYIntf
Declaration
IHYNonVisualPlugin = interface(IHYPlugin);
Hierarchy
- IInterface
- IHYHostAware
- IHYPlugin
- IHYNonVisualPlugin
- IHYPlugin
- IHYHostAware
Properties
| | | |
|---|---|---|
| InstanceID | Inherited from IHYPlugin
Read InstanceID to determine the run-time identifier of the plugin instance. | |
| PluginActions | Inherited from IHYPlugin
Set PluginActions to a VCL ActionList component in the Hydra plugin. The host application should use PluginActions for accessing the action objects of the plugin. | |
| Host | Inherited from IHYHostAware
Read Host to access the IHYHost interface of the THYModuleManager component of the host application. | |
| HostParameters | Inherited from IHYHostAware
The purpose of HostParameters is to provide initialization parameters for the plugin creation. HostParameters will be assigned by the host immediately after the module controller has been loaded or the plugin has been created. The plugin should assign an event handler to OnSetHostParameters to respond to this event. |
Methods
| | |
|---|---|
| Pause | Call Pause from the host application to pause the execution of the non-visual plugin.
As implemented by THYNonVisualPlugin, Pause will just invoke the OnPause event. |
| Resume | Call Resume from the host application to resume execution of the non-visual plugin.
As implemented by THYNonVisualPlugin, Resume will just invoke the OnResume event. |
| Start | Call Start from the host application to start execution of the non-visual plugin.
As implemented by THYNonVisualPlugin, Start will just invoke the OnStart event. |
| Stop | Call Stop from the host application to stop execution of the non-visual plugin.
As implemented by THYNonVisualPlugin, Stop will just invoke the OnStop event. |
| GetObject | Inherited from IHYPlugin
Call GetObject to obtain a TObject reference to the plugin instance. |
See Also
Lists — Glossary — Features — How To — Components — Tools — Samples — Articles — Architecture — Issues
