IHYVCLToolbarController

Overview

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

Location

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

Add

function Add(const aName: string): IHYVCLToolbar

Parameters:

aName:

AddReference (declared in IHYVCLUpdateableController)

procedure AddReference(const anItem: IHYVCLObjectReference)

Parameters:

anItem:

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 write

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

GetItems

function GetItems(Index: Integer): IHYVCLToolbar

Parameters:

Index:

GetUpdateCount (declared in IHYVCLUpdateableController)

Returns the number of processed updates.

function GetUpdateCount(const aGUID: TGUID): Integer

Parameters:

aGUID: Unique identifier of the session.

Insert

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

Parameters:

aName:
anIndex:

IsUpdating (declared in IHYVCLUpdateableController)

Gets the value which defines whether controller is performing update.

property IsUpdating: Boolean read write

Items

property Items[Index: Integer]: IHYVCLToolbar read write

Count

Gets the number of toolbars.

property Count: Integer read write

IsUpdating (declared in IHYVCLUpdateableController)

Gets the value which defines whether controller is performing update.

property IsUpdating: Boolean read write

Items

property Items[Index: Integer]: IHYVCLToolbar read write

Add

function Add(const aName: string): IHYVCLToolbar

Parameters:

aName:

AddReference (declared in IHYVCLUpdateableController)

procedure AddReference(const anItem: IHYVCLObjectReference)

Parameters:

anItem:

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

GetItems

function GetItems(Index: Integer): IHYVCLToolbar

Parameters:

Index:

GetUpdateCount (declared in IHYVCLUpdateableController)

Returns the number of processed updates.

function GetUpdateCount(const aGUID: TGUID): Integer

Parameters:

aGUID: Unique identifier of the session.

Insert

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

Parameters:

aName:
anIndex:

THYBaseToolbarController