THYTB2KToolbarController
Overview
The THYTB2KToolbarController class provides methods for dealing with ToolBar2000 toolbar objects. This class is used to establish a connection between the Hydra framework and a specific toolbar component.
Use Case
If you wish to use the ToolBar2000 TTBDock as your toolbar, you will need to use the THYTB2KToolbarController component for communication between the toolbar component and the Hydra framework. In order to do so, you have to perform the following steps:
- Create an instance of the THYTB2KToolbarController and set the reference in the
Dock
property to your TTBDock component. - Set the reference to the THYTB2KToolbarController in your THYModuleManager
.ToolbarController
property.
Note: You can read about menu and toolbar usage in the Hydra framework in this article. Please also look at the Actions sample shipped with Hydra to see menu and toolbar merging in action.
Location
- Unit: Hydra.TB2K.UI.pas
- Ancestry: TComponent | THYUpdateableController | THYBaseController | THYBaseToolbarController | THYTB2KToolbarController
constructor Create override (declared in THYBaseToolbarController)
Creates a new instance of the class.
constructor Create(aOwner: TComponent)
Parameters:
- aOwner: Reference to the owner object.
Add protected (declared in THYBaseToolbarController)
Adds a new toolbar with a specified name.
function Add(const aName: string): IHYVCLToolbar
Parameters:
- aName: Name of the item.
AddReference protected (declared in THYUpdateableController)
Supplying AddReference
calls within BeginUpate
and EndUpdate
pairs allows the subsequent deletion of all added items via a single call to DeleteUpdates
.
procedure AddReference(const anItem: IHYVCLObjectReference)
Parameters:
- anItem: Reference to an object.
BeginUpdate protected override
Calls BeginUpdate
prior to call(s) to AddReference
. Each BeginUpdate
must have an associated EndUpdate
.
Items added by AddReference
can subsequently be removed by a single call to DeleteUpdates
.
procedure BeginUpdate(const aGUID: TGUID)
Parameters:
- aGUID: Unique identifier of the session.
DeleteUpdates protected override
DeleteUpdates
removes all items added to the host's menu and toolbars via AddReference
calls.
procedure DeleteUpdates(const aGUID: TGUID)
Parameters:
- aGUID: Unique identifier of the session.
Dock
References to the TTBDock that will be used to manage your toolbars.
property Dock: TTBDock read write
DoGetCount protected override
Gets number of the toolbars from the underlying control.
function DoGetCount: Integer
DoGetItems protected override
Gets item with specified index from the underlying control.
function DoGetItems(Index: Integer): IHYVCLToolbar
Parameters:
- Index: Index of the item.
DoInsert (string, Integer): IHYVCLToolbar protected override
Inserts a new item with a given name into the position specified by the anIndex
parameter.
function DoInsert(const aName: string; anIndex: Integer): IHYVCLToolbar
Parameters:
- aName:
- anIndex:
DoInsert (string, Integer): IHYVCLToolbar protected virtual abstract (declared in THYBaseToolbarController)
Inserts a new item into the underlying toolbar class.
function DoInsert(const Name: string; anIndex: Integer): IHYVCLToolbar
Parameters:
- Name: Name of the item.
- anIndex: Index of the item.
EndUpdate protected override
Calls EndUpdate
following call(s) to AddReference
preceded by BeginUpdate
.
procedure EndUpdate(const aGUID: TGUID)
Parameters:
- aGUID: Unique identifier of the session.
GetCount protected (declared in THYBaseToolbarController)
Gets number of the toolbars.
function GetCount: Integer
GetIsUpdating protected (declared in THYUpdateableController)
Returns the value which indicates whether controller is being updated.
function GetIsUpdating: Boolean
GetItems protected (declared in THYBaseToolbarController)
Gets item with specified index.
function GetItems(Index: Integer): IHYVCLToolbar
Parameters:
- Index: Index of the item.
GetSupportsMultipleBars protected dynamic (declared in THYBaseToolbarController)
Specifies if the controller supports multiple toolbars. The default value is true.
function GetSupportsMultipleBars: Boolean
GetUpdateCount protected (declared in THYUpdateableController)
Returns the number of processed updates.
function GetUpdateCount(const aGUID: TGUID): Integer
Parameters:
- aGUID: Unique identifier of the session.
Insert protected (declared in THYBaseToolbarController)
Inserts a new item with the given caption into the position specified by the anIndex
parameter.
function Insert(const aName: string; anIndex: Integer): IHYVCLToolbar
Parameters:
- aName: Name of the item.
- anIndex: Index of the item.
Dock
References to the TTBDock that will be used to manage your toolbars.
property Dock: TTBDock read write
constructor Create override (declared in THYBaseToolbarController)
Creates a new instance of the class.
constructor Create(aOwner: TComponent)
Parameters:
- aOwner: Reference to the owner object.
Add protected (declared in THYBaseToolbarController)
Adds a new toolbar with a specified name.
function Add(const aName: string): IHYVCLToolbar
Parameters:
- aName: Name of the item.
AddReference protected (declared in THYUpdateableController)
Supplying AddReference
calls within BeginUpate
and EndUpdate
pairs allows the subsequent deletion of all added items via a single call to DeleteUpdates
.
procedure AddReference(const anItem: IHYVCLObjectReference)
Parameters:
- anItem: Reference to an object.
BeginUpdate protected override
Calls BeginUpdate
prior to call(s) to AddReference
. Each BeginUpdate
must have an associated EndUpdate
.
Items added by AddReference
can subsequently be removed by a single call to DeleteUpdates
.
procedure BeginUpdate(const aGUID: TGUID)
Parameters:
- aGUID: Unique identifier of the session.
DeleteUpdates protected override
DeleteUpdates
removes all items added to the host's menu and toolbars via AddReference
calls.
procedure DeleteUpdates(const aGUID: TGUID)
Parameters:
- aGUID: Unique identifier of the session.
DoGetCount protected override
Gets number of the toolbars from the underlying control.
function DoGetCount: Integer
DoGetItems protected override
Gets item with specified index from the underlying control.
function DoGetItems(Index: Integer): IHYVCLToolbar
Parameters:
- Index: Index of the item.
DoInsert (string, Integer): IHYVCLToolbar protected override
Inserts a new item with a given name into the position specified by the anIndex
parameter.
function DoInsert(const aName: string; anIndex: Integer): IHYVCLToolbar
Parameters:
- aName:
- anIndex:
DoInsert (string, Integer): IHYVCLToolbar protected virtual abstract (declared in THYBaseToolbarController)
Inserts a new item into the underlying toolbar class.
function DoInsert(const Name: string; anIndex: Integer): IHYVCLToolbar
Parameters:
- Name: Name of the item.
- anIndex: Index of the item.
EndUpdate protected override
Calls EndUpdate
following call(s) to AddReference
preceded by BeginUpdate
.
procedure EndUpdate(const aGUID: TGUID)
Parameters:
- aGUID: Unique identifier of the session.
GetCount protected (declared in THYBaseToolbarController)
Gets number of the toolbars.
function GetCount: Integer
GetIsUpdating protected (declared in THYUpdateableController)
Returns the value which indicates whether controller is being updated.
function GetIsUpdating: Boolean
GetItems protected (declared in THYBaseToolbarController)
Gets item with specified index.
function GetItems(Index: Integer): IHYVCLToolbar
Parameters:
- Index: Index of the item.
GetSupportsMultipleBars protected dynamic (declared in THYBaseToolbarController)
Specifies if the controller supports multiple toolbars. The default value is true.
function GetSupportsMultipleBars: Boolean
GetUpdateCount protected (declared in THYUpdateableController)
Returns the number of processed updates.
function GetUpdateCount(const aGUID: TGUID): Integer
Parameters:
- aGUID: Unique identifier of the session.
Insert protected (declared in THYBaseToolbarController)
Inserts a new item with the given caption into the position specified by the anIndex
parameter.
function Insert(const aName: string; anIndex: Integer): IHYVCLToolbar
Parameters:
- aName: Name of the item.
- anIndex: Index of the item.