All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Dialog Class CATDlgIconBox

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATEventSubscriber
        |
        +---System.CATCommand
          |
          +---Dialog.CATDialog
            |
            +---Dialog.CATDlgBox
              |
              +---CATDlgIconBox
 

Usage: you must use this class as is. You should never derive it.


public class CATDlgIconBox

Class to make a dropdown menu in a toolbar.
Role: Makes a dropdown menu in a toolbar. The icon box is used in a toolbar to build a pull-down (dropdown) menu composed of icons. Each of these icons represents a command and can be clicked to fire an action. To open the icon box, the end user clicks the arrow. This displays the icons available in the icon box. The icon the user will click will remain the only one displayed afterwards.


Constructor and Destructor Index


o CATDlgIconBox(CATDialog*,CATString&,CATDlgStyle)
Makes a dropdown menu in a toolbar.

Method Index


o GetIBoxModifyNotification()
Returns the CATDlgIconBoxModifyNotification event notification.
o GetIBoxSelectNotification()
Returns the CATDlgIconBoxSelectNotification event notification.
o GetNumIconPerRow()
Get the number of icons per line.
o GetSelect()
Gets the selected icon.
o SetNumIconPerRow(int)
Set the number of icons per line.
o SetSelect(CATString&,int)
Set the selected icon.
o SetSelect(int,int)
Set the selected icon.

Constructor and Destructor


o CATDlgIconBox
public CATDlgIconBox(CATDialog* iParent,
const CATString& iDialogObjectName,
CATDlgStyle iStyle=NULL)
Makes a dropdown menu in a toolbar.
Role: Makes a dropdown menu in a toolbar.
Parameters:
iParent
The parent of the icon box.
iDialogObjectName
The dialog object name.
iStyle
The application window styles. You can cumulate several styles using a logical or.
Legal values:
  • NULL (default) so that the icon box be vertical
  • CATDlgCtrHorizontal if the icon box is horizontal

Methods


o GetIBoxModifyNotification
public CATNotification * GetIBoxModifyNotification()const
Returns the CATDlgIconBoxModifyNotification event notification. It is sent whenever the icon displayed as the icon box is selected..
o GetIBoxSelectNotification
public CATNotification * GetIBoxSelectNotification()const
Returns the CATDlgIconBoxSelectNotification event notification. It is sent whenever an icon of an icon box is selected.
o GetNumIconPerRow
public int GetNumIconPerRow()
Get the number of icons per line.
Returns:
The number of icons per line. It begins with 0.
o GetSelect
public int GetSelect()
Gets the selected icon.
Returns:
The index of the selected icon. It begins with 0.
o SetNumIconPerRow
public void SetNumIconPerRow(int iIconPerLineCount)
Set the number of icons per line.
Parameters:
iIconPerLineCount
The icon per line count.
o SetSelect
public int SetSelect( const CATString& iIconToSelectName,
int iSendingNotificationFlag= 1 )
Set the selected icon.
Parameters:
iIconToSelectName
Name of the icon to select
iSendingNotificationFlag
To specify if you want the corresponding notification to be sent.
Legal values: 1: default (or any non NULL value) if you want the notification to be sent, or NULL otherwise.
Returns:
The index of the selected icon. It begins with 0.
o SetSelect
public int SetSelect(int iIconToSelectIndex,
int iSendingNotificationFlag= 1 )
Set the selected icon.
Parameters:
iIconToSelectIndex
Index of the icon to select
iSendingNotificationFlag
To specify if you want the corresponding notification to be sent.
Legal values: 1: default (or any non NULL value) if you want the notification to be sent, or NULL otherwise.
Returns:
The index of the selected icon. It begins with 0.

This object is included in the file: CATDlgIconBox.h
If needed, your Imakefile.mk should include the module: DI0PANV2

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