THYBaseToolbarController

Overview

The THYBaseToolbarController base class provides methods for dealing with toolbar objects. The Hydra framework uses controller classes to establish a connection with a specific toolbar object.

You will not have to use this class directly, instead, you can use one of its descendants to specify the toolbar component that will be used by the Hydra framework for toolbar merging.

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

Creates a new instance of the class.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Reference to the owner object.

Add  protected

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 virtual abstract

Gets number of the toolbars from the underlying control.

function DoGetCount: Integer

DoGetItems  protected virtual abstract

Gets item with specified index from the underlying control.

function DoGetItems(Index: Integer): IHYVCLToolbar

Parameters:

  • Index: Index of the item.

DoInsert  protected virtual abstract

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

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

Gets item with specified index.

function GetItems(Index: Integer): IHYVCLToolbar

Parameters:

  • Index: Index of the item.

GetSupportsMultipleBars  protected dynamic

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

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.