IHYVCLMenuController

Overview

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

Location

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

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

GetItems

function GetItems: IHYVCLMenuItem

GetUpdateCount (declared in IHYVCLUpdateableController)

Returns the number of processed updates.

function GetUpdateCount(const aGUID: TGUID): Integer

Parameters:

aGUID: Unique identifier of the session.

IsUpdating (declared in IHYVCLUpdateableController)

Gets the value which defines whether controller is performing update.

property IsUpdating: Boolean read

Items

Gets reference to a top level menu item.

property Items: IHYVCLMenuItem read

IsUpdating (declared in IHYVCLUpdateableController)

Gets the value which defines whether controller is performing update.

property IsUpdating: Boolean read

Items

Gets reference to a top level menu item.

property Items: IHYVCLMenuItem read

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

GetItems

function GetItems: IHYVCLMenuItem

GetUpdateCount (declared in IHYVCLUpdateableController)

Returns the number of processed updates.

function GetUpdateCount(const aGUID: TGUID): Integer

Parameters:

aGUID: Unique identifier of the session.

THYBaseMenuController