All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Dialog Class CATDlgRadioButton

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATEventSubscriber
        |
        +---System.CATCommand
          |
          +---Dialog.CATDialog
            |
            +---Dialog.CATDlgControl
              |
              +---CATDlgRadioButton
 

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


public class CATDlgRadioButton

Base class for radio buttons.
Role: A radio button is used for selecting mutually exclusive options.
Use radio buttons whenever you propose to the end user a choice among several mutually exclusive options, that is when one option only can be selected among all the options proposed.


Constructor and Destructor Index


o CATDlgRadioButton(CATDialog*,CATString&,CATDlgStyle)
Constructs a CATDlgRadioButton.
o ~CATDlgRadioButton()

Method Index


o GetRadBModifyNotification()
Returns the event notification sent whenever the radio button is checked or unchecked.
o GetState()
Returns the state of the radio button.
o SetState(CATULong,int)
Sets the state of the radio button.

Constructor and Destructor


o CATDlgRadioButton
public CATDlgRadioButton(CATDialog* iParent,
const CATString& iObjectName,
CATDlgStyle iStyle=NULL)
Constructs a CATDlgRadioButton.
Parameters:
iParent
The parent of the radio button.
iObjectName
The name of the radio button.
iStyle
The style of the radio 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 ~CATDlgRadioButton
public virtual ~CATDlgRadioButton()

Methods


o GetRadBModifyNotification
public CATNotification * GetRadBModifyNotification()const
Returns the event notification sent whenever the radio button is checked or unchecked.
o GetState
public CATULong GetState()
Returns the state of the radio button.
The state of the radio button can be:
CATDlgCheck
if the radio button is checked,
CATDlgUncheck
if it is unchecked.
o SetState
public void SetState(CATULong iState,
int iNotify=1)
Sets the state of the radio button.
Parameters:
iState
The state of the radio button to set.
Legal values : It can be set to either :
CATDlgCheck
to check the radio 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: CATDlgRadioButton.h
If needed, your Imakefile.mk should include the module: DI0PANV2

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