Dialog CATDlgCheckButton
Usage: you must use this class as is. You should never derive it.
public class CATDlgCheckButton
Base class for check buttons.
Role:
The check buttons allow to select several options among all the proposed options,
that is several can be checked while the others are unchecked.
Use check buttons 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.
Constructor and Destructor Index
- o
CATDlgCheckButton(CATDialog*,CATString&,CATDlgStyle)
- Constructs a CATDlgCheckButton.
- o
~CATDlgCheckButton()
-
Method Index
- o
GetChkBDoubleClickNotification()
- Returns the event notification sent whenever the check button is double clicked.
- o
GetChkBModifyNotification()
- Returns the event notification sent whenever the check button is checked or unchecked.
- o
GetState()
- Returns the state of the check button.
- o
SetState(CATULong,int)
- Sets the state of the check button.
Constructor and Destructor
o CATDlgCheckButton
| public CATDlgCheckButton( | | iParent, |
| const | iObjectName, |
| | iStyle | =NULL) |
-
Constructs a CATDlgCheckButton.
- Parameters:
-
- iParent
- The parent of the check button.
- iObjectName
- The name of the check button.
- iStyle
- The style of the check button.
Legal values: NULL (default) so that the
title is placed at the right of the button, or
CATDlgBtnNoIndicator if the text is placed in the button.
o ~CATDlgCheckButton
| public virtual ~CATDlgCheckButton( | ) |
-
Methods
o GetChkBDoubleClickNotification
| public GetChkBDoubleClickNotification( | ) |
-
Returns the event notification sent whenever the check button is double clicked.
The expected behavior is to loop on the associated command.
o GetChkBModifyNotification
| public GetChkBModifyNotification( | ) |
-
Returns the event notification sent whenever the check button is checked or unchecked.
o GetState
-
Returns the state of the check button.
The state of the check button can be.
- CATDlgCheck
- if the check button is checked,
- CATDlgUncheck
- if it is unchecked.
o SetState
| public SetState( | | iState, |
| | iNotify | =1) |
-
Sets the state of the check button.
- Parameters:
-
- iState
- The state of the check button to set.
Legal values : It can be set to either :
- CATDlgCheck
- to check the check button,
- 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: CATDlgCheckButton.h
If needed, your Imakefile.mk should include the module: DI0PANV2
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.