THYDXToolbarController

Overview

The THYDXToolbarController class provides methods for dealing with DevExpress toolbar objects. This class is used to establish a connection between the Hydra framework and a specific toolbar component.

Use Case

If you wish to use DevExpress ExpressBars as your toolbar, you will need to use the THYDXToolbarController component for communication between the toolbar component and the Hydra framework. In order to do so, you have to perform the following steps: * Create an instance of the THYDXToolbarController and set the reference in the BarManager property to your TdxBarManager component. * Set the reference to the THYDXToolbarController in your THYModuleManager.ToolbarController property.

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


 

constructor Create  override    (declared in THYBaseToolbarController)

Creates a new instance of the class.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Reference to the owner object.

Add  protected    (declared in THYBaseToolbarController)

function Add(const aName: string): IHYVCLToolbar

Parameters:

  • aName:

AddReference  protected    (declared in THYUpdateableController)

procedure AddReference(const anItem: IHYVCLObjectReference)

Parameters:

  • anItem:

BarManager

References to the TdxBarManager that will be used to manage your toolbars.

property BarManager: TdxBarManager read write

BeginUpdate  protected override

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 override

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 override

Gets number of the toolbars from the underlying control.

function DoGetCount: Integer

DoGetItems  protected override

function DoGetItems(Index: Integer): IHYVCLToolbar

Parameters:

  • Index:

DoInsert (string, Integer): IHYVCLToolbar  protected override

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

Parameters:

  • aName:
  • anIndex:

DoInsert (string, Integer): IHYVCLToolbar  protected virtual abstract    (declared in THYBaseToolbarController)

function DoInsert(const Name: string; anIndex: Integer): IHYVCLToolbar

Parameters:

  • Name:
  • anIndex:

EndUpdate  protected override

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

procedure EndUpdate(const aGUID: TGUID)

Parameters:

  • aGUID: Unique identifier of the session.

GetCount  protected    (declared in THYBaseToolbarController)

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

function GetItems(Index: Integer): IHYVCLToolbar

Parameters:

  • Index:

GetSupportsMultipleBars  protected dynamic    (declared in THYBaseToolbarController)

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

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

Parameters:

  • aName:
  • anIndex:

 

BarManager

References to the TdxBarManager that will be used to manage your toolbars.

property BarManager: TdxBarManager read write

 

constructor Create  override    (declared in THYBaseToolbarController)

Creates a new instance of the class.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Reference to the owner object.

Add  protected    (declared in THYBaseToolbarController)

function Add(const aName: string): IHYVCLToolbar

Parameters:

  • aName:

AddReference  protected    (declared in THYUpdateableController)

procedure AddReference(const anItem: IHYVCLObjectReference)

Parameters:

  • anItem:

BeginUpdate  protected override

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 override

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 override

Gets number of the toolbars from the underlying control.

function DoGetCount: Integer

DoGetItems  protected override

function DoGetItems(Index: Integer): IHYVCLToolbar

Parameters:

  • Index:

DoInsert (string, Integer): IHYVCLToolbar  protected override

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

Parameters:

  • aName:
  • anIndex:

DoInsert (string, Integer): IHYVCLToolbar  protected virtual abstract    (declared in THYBaseToolbarController)

function DoInsert(const Name: string; anIndex: Integer): IHYVCLToolbar

Parameters:

  • Name:
  • anIndex:

EndUpdate  protected override

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

procedure EndUpdate(const aGUID: TGUID)

Parameters:

  • aGUID: Unique identifier of the session.

GetCount  protected    (declared in THYBaseToolbarController)

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

function GetItems(Index: Integer): IHYVCLToolbar

Parameters:

  • Index:

GetSupportsMultipleBars  protected dynamic    (declared in THYBaseToolbarController)

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

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

Parameters:

  • aName:
  • anIndex: