All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Dialog Class CATDlgRadioItem

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATEventSubscriber
        |
        +---System.CATCommand
          |
          +---Dialog.CATDialog
            |
            +---Dialog.CATDlgMenuItem
              |
              +---CATDlgRadioItem
 

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


public class CATDlgRadioItem

Base class for radio menu items.
Role: A radio menu item is used for selecting mutually exclusive options.
Use radio items 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 CATDlgRadioItem(CATDialog*,CATString&,CATDlgStyle)
Constructs a CATDlgRadioItem.
o ~CATDlgRadioItem()

Method Index


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

Constructor and Destructor


o CATDlgRadioItem
public CATDlgRadioItem(CATDialog* iParent,
const CATString& iObjectName,
CATDlgStyle iStyle=NULL)
Constructs a CATDlgRadioItem.
Parameters:
iParent
The parent of the radio item.
iObjectName
The name of the radio item.
iStyle
The style of the radio item. Only the default value is allowed.
o ~CATDlgRadioItem
public virtual ~CATDlgRadioItem()

Methods


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

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