IHYVCLToolbarController

Overview

The IHYVCLToolbarController interface defines the standard interface all menu controllers need to implement.

Location

Unit: Hydra.VCL.Interfaces.pas
Ancestry: IHYVCLUpdateableController | IHYVCLToolbarController

Add

Creates a new IHYVCLToolbar element, appends it to the end of the collection and returns a reference to the created element.

function Add(const aName: string): IHYVCLToolbar

Parameters:

aName: Specifies the name for creating an IHYVCLToolbar element.

AddReference (declared in IHYVCLUpdateableController)

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

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.

Count

Gets the number of toolbars.

property Count: Integer read

DeleteUpdates (declared in IHYVCLUpdateableController)

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.

EndUpdate (declared in IHYVCLUpdateableController)

Calls EndUpdate following call(s) to AddReference preceded by BeginUpdate.

procedure EndUpdate(const aGUID: TGUID)

Parameters:

aGUID: Unique identifier of the session.

GetIsUpdating (declared in IHYVCLUpdateableController)

function GetIsUpdating: Boolean

GetUpdateCount (declared in IHYVCLUpdateableController)

Returns the number of processed updates.

function GetUpdateCount(const aGUID: TGUID): Integer

Parameters:

aGUID: Unique identifier of the session.

Insert

The same as the Add method, but the created element is added at the specified position.

function Insert(const aName: string; anIndex: Integer): IHYVCLToolbar

Parameters:

aName: Specifies the name for creating IHYVCLToolbar elements.
anIndex: Specifies the position where the created IHYVCLToolbar element should be inserted.

IsUpdating (declared in IHYVCLUpdateableController)

Gets the value which defines whether controller is performing update.

property IsUpdating: Boolean read

Items

Gets reference to a toolbar with specified index.

property Items[Index: Integer]: IHYVCLToolbar read

Count

Gets the number of toolbars.

property Count: Integer read

IsUpdating (declared in IHYVCLUpdateableController)

Gets the value which defines whether controller is performing update.

property IsUpdating: Boolean read

Items

Gets reference to a toolbar with specified index.

property Items[Index: Integer]: IHYVCLToolbar read

Add

Creates a new IHYVCLToolbar element, appends it to the end of the collection and returns a reference to the created element.

function Add(const aName: string): IHYVCLToolbar

Parameters:

aName: Specifies the name for creating an IHYVCLToolbar element.

AddReference (declared in IHYVCLUpdateableController)

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

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

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.

EndUpdate (declared in IHYVCLUpdateableController)

Calls EndUpdate following call(s) to AddReference preceded by BeginUpdate.

procedure EndUpdate(const aGUID: TGUID)

Parameters:

aGUID: Unique identifier of the session.

GetIsUpdating (declared in IHYVCLUpdateableController)

function GetIsUpdating: Boolean

GetUpdateCount (declared in IHYVCLUpdateableController)

Returns the number of processed updates.

function GetUpdateCount(const aGUID: TGUID): Integer

Parameters:

aGUID: Unique identifier of the session.

Insert

The same as the Add method, but the created element is added at the specified position.

function Insert(const aName: string; anIndex: Integer): IHYVCLToolbar

Parameters:

aName: Specifies the name for creating IHYVCLToolbar elements.
anIndex: Specifies the position where the created IHYVCLToolbar element should be inserted.

THYBaseToolbarController