IHYVCLUpdateableController

Overview

Updateable controllers provide a batch mechanism to manage every set of menu items, menus, toolbars etc. that a plugin adds to the host.

Supplying AddReference calls within BeginUpate and EndUpdate pairs allows the subsequent deletion of all added items via a single call to DeleteUpdates.

Location


 

AddReference

procedure AddReference(const anItem: IHYVCLObjectReference)

Parameters:

  • anItem:

BeginUpdate

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

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

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

procedure EndUpdate(const aGUID: TGUID)

Parameters:

  • aGUID: Unique identifier of the session.

GetIsUpdating

function GetIsUpdating: Boolean

GetUpdateCount

Returns the number of processed updates.

function GetUpdateCount(const aGUID: TGUID): Integer

Parameters:

  • aGUID: Unique identifier of the session.

IsUpdating

Gets the value which defines whether controller is performing update.

property IsUpdating: Boolean read write

 

IsUpdating

Gets the value which defines whether controller is performing update.

property IsUpdating: Boolean read write

 

AddReference

procedure AddReference(const anItem: IHYVCLObjectReference)

Parameters:

  • anItem:

BeginUpdate

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

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

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

procedure EndUpdate(const aGUID: TGUID)

Parameters:

  • aGUID: Unique identifier of the session.

GetIsUpdating

function GetIsUpdating: Boolean

GetUpdateCount

Returns the number of processed updates.

function GetUpdateCount(const aGUID: TGUID): Integer

Parameters:

  • aGUID: Unique identifier of the session.