IHYVCLToolbar
Overview
The IHYVCLToolbar 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.
Location
- Unit: Hydra.VCL.Interfaces.pas
- Ancestry: IHYVCLObjectReference | IHYVCLToolbar
Add
Adds a new item and fills it with information from the action object.
function Add(anAction: TBasicAction): IHYVCLToolbarItem
Parameters:
- anAction: Reference to an action.
AddSeparator
Adds a separator line.
procedure AddSeparator
BeginModify
The BeginModify method must be called before starting to add to or remove buttons from the toolbar.
Component sets like Developer Express 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 wrapped component set.
A call to BeginModify must be followed by one to EndModify.
procedure BeginModify
Count
Returns the number of toolbar items owned by the toolbar.
property Count: Integer read
DestroyObject (declared in IHYVCLObjectReference)
Destroys referenced object.
procedure DestroyObject
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.
property Dockable: Boolean read
EndModify
The EndModify method must be called after adding/removing toolbar buttons.
Component sets like Developer Express 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 wrapped component set.
A call to BeginModify must be followed by one to EndModify.
procedure EndModify
GetCount
function GetCount: Integer
GetDockable
function GetDockable: Boolean
GetIsModifying
function GetIsModifying: Boolean
GetItems
function GetItems(Index: Integer): IHYVCLToolbarItem
Parameters:
- Index:
GetLeft
function GetLeft: Integer
GetProperty (declared in IHYVCLObjectReference)
function GetProperty(const aName: string): Variant
Parameters:
- aName:
GetRefObject (declared in IHYVCLObjectReference)
function GetRefObject: TObject
GetRow
function GetRow: Integer
GetShowHint
function GetShowHint: Boolean
GetTop
function GetTop: Integer
Insert
Inserts a new item into the position specified by the anIndex parameter and fills it with information from the given action object.
function Insert(anIndex: Integer; anAction: TBasicAction): IHYVCLToolbarItem
Parameters:
- anIndex: Index of the item.
- anAction: Reference to an action.
InsertSeparator
Inserts a separator line into the position specified by the anIndex parameter.
procedure InsertSeparator(anIndex: Integer)
Parameters:
- anIndex: Index of the item.
IsModifying
Gets the value which indicates whether toolbar is being modified at the moment.
property IsModifying: Boolean read
Items
Gets the reference to the toolbar item with specified index.
property Items[Index: Integer]: IHYVCLToolbarItem read
Left
Gets or sets the Left position of the toolbar.
property Left: Integer read write
Properties (declared in IHYVCLObjectReference)
Gets or sets the value of the published properties of the referenced object with specified name.
property Properties[aName: string]: Variant read write
RefObject (declared in IHYVCLObjectReference)
Gets a pointer to the referenced object.
property RefObject: TObject read
Row
Gets or sets the Row of the toolbar.
property Row: Integer read write
SetLeft
procedure SetLeft(Value: Integer)
Parameters:
- Value:
SetProperty (declared in IHYVCLObjectReference)
procedure SetProperty(const aName: string; const aPropertyValue: Variant)
Parameters:
- aName:
- aPropertyValue:
SetRow
procedure SetRow(Value: Integer)
Parameters:
- Value:
SetShowHint
procedure SetShowHint(Value: Boolean)
Parameters:
- Value:
SetTop
procedure SetTop(Value: Integer)
Parameters:
- Value:
ShowHint
property ShowHint: Boolean read write
Top
Gets or sets the Top position of the toolbar.
property Top: Integer read write
Count
Returns the number of toolbar items owned by the toolbar.
property Count: Integer read
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.
property Dockable: Boolean read
IsModifying
Gets the value which indicates whether toolbar is being modified at the moment.
property IsModifying: Boolean read
Items
Gets the reference to the toolbar item with specified index.
property Items[Index: Integer]: IHYVCLToolbarItem read
Left
Gets or sets the Left position of the toolbar.
property Left: Integer read write
Properties (declared in IHYVCLObjectReference)
Gets or sets the value of the published properties of the referenced object with specified name.
property Properties[aName: string]: Variant read write
RefObject (declared in IHYVCLObjectReference)
Gets a pointer to the referenced object.
property RefObject: TObject read
Row
Gets or sets the Row of the toolbar.
property Row: Integer read write
ShowHint
property ShowHint: Boolean read write
Top
Gets or sets the Top position of the toolbar.
property Top: Integer read write
Add
Adds a new item and fills it with information from the action object.
function Add(anAction: TBasicAction): IHYVCLToolbarItem
Parameters:
- anAction: Reference to an action.
AddSeparator
Adds a separator line.
procedure AddSeparator
BeginModify
The BeginModify method must be called before starting to add to or remove buttons from the toolbar.
Component sets like Developer Express 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 wrapped component set.
A call to BeginModify must be followed by one to EndModify.
procedure BeginModify
DestroyObject (declared in IHYVCLObjectReference)
Destroys referenced object.
procedure DestroyObject
EndModify
The EndModify method must be called after adding/removing toolbar buttons.
Component sets like Developer Express 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 wrapped component set.
A call to BeginModify must be followed by one to EndModify.
procedure EndModify
GetCount
function GetCount: Integer
GetDockable
function GetDockable: Boolean
GetIsModifying
function GetIsModifying: Boolean
GetItems
function GetItems(Index: Integer): IHYVCLToolbarItem
Parameters:
- Index:
GetLeft
function GetLeft: Integer
GetProperty (declared in IHYVCLObjectReference)
function GetProperty(const aName: string): Variant
Parameters:
- aName:
GetRefObject (declared in IHYVCLObjectReference)
function GetRefObject: TObject
GetRow
function GetRow: Integer
GetShowHint
function GetShowHint: Boolean
GetTop
function GetTop: Integer
Insert
Inserts a new item into the position specified by the anIndex parameter and fills it with information from the given action object.
function Insert(anIndex: Integer; anAction: TBasicAction): IHYVCLToolbarItem
Parameters:
- anIndex: Index of the item.
- anAction: Reference to an action.
InsertSeparator
Inserts a separator line into the position specified by the anIndex parameter.
procedure InsertSeparator(anIndex: Integer)
Parameters:
- anIndex: Index of the item.
SetLeft
procedure SetLeft(Value: Integer)
Parameters:
- Value:
SetProperty (declared in IHYVCLObjectReference)
procedure SetProperty(const aName: string; const aPropertyValue: Variant)
Parameters:
- aName:
- aPropertyValue:
SetRow
procedure SetRow(Value: Integer)
Parameters:
- Value:
SetShowHint
procedure SetShowHint(Value: Boolean)
Parameters:
- Value:
SetTop
procedure SetTop(Value: Integer)
Parameters:
- Value: