Dialog CATDlgCheckItem
Usage: you must use this class as is. You should never derive it.
public class CATDlgCheckItem
Base class for check menu items.
Role:
A check menu item is used to build menus and submenus and allows the user to set an option among
several available options in a menu, a submenu, or a toolbar.
A check item has two states, "on" or "off".
Selecting a check item sets its state to "on" if it was "off" or to "off" if it was "on",
regardless the state of the other check items. So several check items can be in
the state "on" while several others can be in the state "off".
Use check items whenever you propose to the end user a choice among several inclusive options,
that is when several options can be selected at the same time, in a menu, a submenu, a toolbar, or an icon box.
Constructor and Destructor Index
- o
CATDlgCheckItem(CATDialog*,CATString&,CATDlgStyle)
- Constructs a CATDlgCheckItem.
- o
~CATDlgCheckItem()
-
Method Index
- o
GetChkIModifyNotification()
- Returns the event notification sent whenever the check item is checked or unchecked.
- o
GetState()
- Returns the state of the check item.
- o
SetState(CATULong,int)
- Sets the state of the check item.
Constructor and Destructor
o CATDlgCheckItem
| public CATDlgCheckItem( | | iParent, |
| const | iObjectName, |
| | iStyle | =NULL) |
-
Constructs a CATDlgCheckItem.
- Parameters:
-
- iParent
- The parent of the check item.
- iObjectName
- The name of the check item.
- iStyle
- The style of the check item.
o ~CATDlgCheckItem
| public virtual ~CATDlgCheckItem( | ) |
-
Methods
o GetChkIModifyNotification
| public GetChkIModifyNotification( | ) |
-
Returns the event notification sent whenever the check item is checked or unchecked.
o GetState
-
Returns the state of the check item.
The state of the check item can be.
- CATDlgCheck
- if the check item is checked,
- CATDlgUncheck
- if it is unchecked.
o SetState
| public SetState( | | iState, |
| | iNotify | =1) |
-
Sets the state of the check item.
- Parameters:
-
- iState
- The state of the check item to set.
Legal values : It can be set to either :
- CATDlgCheck
- to check the check item,
- CATDlgUncheck
- to uncheck it.
- iNotify
- Set this parameter to a non null value if you want the corresponding notification to be sent.
Otherwise set it to 0, so no notification will be sent.
This object is included in the file: CATDlgCheckItem.h
If needed, your Imakefile.mk should include the module: DI0PANV2
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.