IHYToolbar
From RemObjects Software
This is a Hydra Architecture entry
Feel free to add your notes to this topic below.
Overview
The IHYToolbar interface defines the interface all controllers must support for toolbars generated by the user.
Objects implementing this interface are returned by the events of the THYPluginControlsRepository and can be used by the plugin to access the user interface items in the host form.
File
uHYIntf
Declaration
IHYToolbar = interface(IHYObjectReference);
Hierarchy
- IInterface
- IHYObjectReference
- IHYToolbar
- IHYObjectReference
Properties
| | | |
|---|---|---|
| Count |
Returns the number of toolbar items owned by the toolbar. | |
| Dockable |
Used to set or get the Dockable property of the toolbar. How this property works depends on the component set that is wrapped by the host user interface controller. | |
| IsModifying |
The IsModifying property is set to true or false by calls to BeginModify and EndModify. | |
| Items |
Returns the list of toolbar items owned by the toolbar. | |
| Left |
Used to set or get the Left position of the toolbar. | |
| Row |
Used to set or get the Row of the toolbar. | |
| ShowHint | ||
| Top |
Used to set or get the Top position of the toolbar. | |
| Properties | Inherited from IHYObjectReference
Used to set the value of the published properties of the referenced TObject. This function uses the RTTI functions SetPropValue and GetPropValue internally. | |
| RefObject | Inherited from IHYObjectReference
Returns a pointer to the referenced TObject. |
Methods
| | |
|---|---|
| Add | Used to add new toolbar items to the toolbar. |
| BeginModify | The BeginModify method must be called before starting to add to or remove buttons from the toolbar.
Component sets such as the Developer Express one require that the developer calls certain utility methods before starting to customize toolbars or menus. In order to provide a consistent access to different component sets, Hydra follows this approach and makes it mandatory for every component set wrapped. A call to BeginModify must be followed by one to EndModify. |
| EndModify | The EndModify method must be called after to adding/removing toolbar buttons.
Component sets such as the Developer Express one require that the developer calls certain utility methods before starting to customize toolbars or menus. In order to provide a consistent access to different component sets, Hydra follows this approach and makes it mandatory for every component set wrapped. A call to BeginModify must be followed by one to EndModify. |
| GetShowHint | |
| Insert | Used to insert a new IHYToolbarItem in the Items collection at the position identified by the anIndex parameter. |
| SetShowHint | |
| DestroyObject | Inherited from IHYObjectReference
Used to destroy the referenced TObject. It is not normally necessary to call this method directly. |
See Also
Lists — Glossary — Features — How To — Components — Tools — Samples — Articles — Architecture — Issues
Categories: Text | Hydra | Architecture | Interface | Delphi
