THYStdVCLToolbarController

Overview

The THYStdVCLToolbarController class provides methods for dealing with VCL TToolbar 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 VCL TToolbar as your toolbar, you will need to use the THYStdVCLToolbarController 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 THYStdVCLToolbarController.
  • Set the reference to the THYStdVCLToolbarController 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


Instance Methods

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 virtual    (declared in THYUpdateableController)

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 virtual    (declared in THYUpdateableController)

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 virtual    (declared in THYUpdateableController)

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.