3D PLM Enterprise Architecture

CATDialog
  |
  +---CATDlgBox
        |
        +---CATDlgIconBox

The Icon Box

The icon box is used to build a pull-down menu composed of icons, each of which can be selected to trigger an action. The icon box features a vertical arrow at its bottom left corner. When the mouse is located above this arrow, the cursor becomes and selecting the arrow opens the icon box and shows the icons available. The last selected icon is displayed when the icon box is closed. Each icon is the representation of a CATDlgPushButton instance.

Use icon box whenever you propose a single access to related command in a toolbar.

[Top]

[Top]

Programmer's Guide

The icon box gathers push buttons and displays their icon representation.

[Top]

Constructing an Icon Box

The different kinds of icon boxes can be constructed:

• Vertical icon box

  pIconBox = new CATDlgIconBox (this, "IconBoxId");

• Horizontal icon box

  pIconBox = new CATDlgIconBox (this, "IconBoxId", CATDlgCtrHorizontal);

[Top]

Managing the Selected Icon

To manage the selected icon, you can:

• Get the selected icon using the GetSelect method:

  int SelectedIcon; SelectedIcon = pIconBox->GetSelect();

  The index of the selected icon in the icon box is returned. This index begins with 0.

• Set the selected icon using the SetSelect method:

  int SelectedIcon; int IconToSelect = 2; int Notify = 1; SelectedIcon = pIconBox->SetSelect(IconToSelect, Notify); ... CATString NameOfIconToSelect = "IconName"; SelectedIcon = pIconBox->SetSelect(NameOfIconToSelect , Notify);

Set the first parameter to the index of the icon to select, or to its name, and the parameter Notify to a non null value if you want the corresponding notification to be sent. Otherwise set to 0, no notification is sent. The selected icon index is returned.

[Top]

Managing the Icon Number

To manage the icon number, you can:

• Get the number of icons per line using the GetNumIconPerRow method:

  int NumIcon; NumIcon = pIconBox->GetNumIconPerRow();

• Set the number of icons per line using the SetNumIconPerRow method: 

  int NumIcon = 5; pIconBox->SetNumIconPerRow(NumIcon);

[Top]

History

Copyright © 2000, Dassault Systèmes. All rights reserved.