The IRadioButton class creates and manages radio button control windows. A radio button is a circle or a diamond with associated text representing a choice. When a user selects the choice, the radio button is filled to indicate that the choice is selected. The user can clear the radio button by selecting another radio button. Radio buttons are mutually exclusive.
You can process a radio button's selection by deriving a handler from ISelectHandler and adding your handler either to the radio button or to its owner window.
You can attach the following handlers to this control:
The IRadioButton constructor creates objects of this class using the XmToggleButton widget. IWindow::handle returns the handle of the XmToggleButton widget.
Constructors & DestructorYou can construct and destruct objects of the IRadioButton class. You cannot copy or assign IRadioButton objects because both the copy constructor and assignment operator are private functions.
![]() |
public:
virtual ~IRadioButton()
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
IRadioButton(unsigned long id, IWindow* parent)
Creates an object for a radio button control that exists in a dialog window.
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
public:
IRadioButton(const IWindowHandle& handle)
Creates an object for an existing radio button control.
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
public:
IRadioButton( unsigned long id, IWindow* parent, IWindow* owner, const IRectangle& initial = IRectangle ( ), const Style& style = defaultStyle ( ) )
Creates a radio button control and an object for it.
| IInvalidParameter | The parent window pointer specified was invalid. You must specify a valid IWindow pointer as the parent. |
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
Auto SelectAuto select members query and modify the autoSelect style of a radio button object. The autoSelect style determines whether the state of the radio button is automatically changed when the user clicks on it.
![]() |
public:
virtual IRadioButton& disableAutoSelect()
Removes the style autoSelect from the radio button control. If auto select is disabled, the application is responsible for changing the state of the radio buttons when the radio button is clicked.
The application determines when the user clicks on the radio button by attaching a handler derived from ISelectHandler to the radio button or its owner and overriding the ISelectHandler::selected member function. The application can then use the selection functions to change the state of the radio button.
| Windows | OS/2 | AIX |
| Yes | Yes | Ignored |
The autoSelect style is always in effect in the AIX environment. This function has no effect.
![]() |
public:
virtual IRadioButton& enableAutoSelect(bool enable = true)
Adds or removes the style autoSelect.
| Windows | OS/2 | AIX |
| Yes | Yes | Ignored |
The autoSelect style is always in effect.
![]() |
public:
virtual bool isAutoSelect() const
If the radio button control has the style autoSelect set, true is returned. Otherwise, false is returned.
| Windows | OS/2 | AIX |
| Yes | Yes | Ignored |
This function always returns true.
Cursor SelectCursor select members query and modify the noCursorSelect style of a radio button object. If enabled, the noCursorSelect style prevents the radio button from selecting itself when given the focus as a result of an arrow key or tab key.
![]() |
public:
virtual IRadioButton& disableCursorSelect()
Adds the radio button style noCursorSelect.
| Windows | OS/2 | AIX |
| Ignored | Yes | Ignored |
The noCursorSelect style is not supported in the AIX environment. This function has no effect in that environment.
The noCursorSelect style is not supported in the Windows environment. This function has no effect in that enviroment.
![]() |
public:
virtual IRadioButton& enableCursorSelect( bool enable = true )
Removes or adds the radio button style noCursorSelect. If removed, the radio button is cursor-selectable.
| Windows | OS/2 | AIX |
| Ignored | Yes | Ignored |
The noCursorSelect style is not supported in the AIX environment. This function has no effect in that environment.
The noCursorSelect style is not supported in the Windows environment. This function has no effect in that enviroment.
![]() |
public:
bool isCursorSelect() const
If the radio button is cursor-selectable, true is returned. Otherwise, false is returned.
| Windows | OS/2 | AIX |
| Ignored | Yes | Ignored |
This function returns false.
Radio buttons are always cursor-selectable in the Windows environment. This function always returns true in that environment.
Layout SupportLayout support members supply information used by the canvas classes to provide dialog-like behavior.
![]() |
protected:
virtual ISize calcMinimumSize() const
Returns the minimum size that this radio button control based on the text string length and the current font.
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
SelectionUse these members to query the index of the selected radio button. The selection state of a button is typically changed by the user clicking on it using the mouse or pressing a key to select it. You can also change or query the state using Open Class Library functions.
![]() |
public:
unsigned long selectedIndex() const
Returns the 0-based index of the selected radio button in a group.
If no radio button is selected, noSelections is returned.
Note:
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
The index of any control in the group can be returned.
![]() |
public:
static const unsigned long noSelections
The value returned by selectedIndex when there are no buttons selected in the group.
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
StylesThese style members provide a set of valid styles for this class. Use these members to query and set the radio button styles. You can use these styles with the styles in the following classes:
![]() |
public:
virtual unsigned long convertToGUIStyle( const IBitFlag& style, bool extendedOnly = false ) const
Converts a style object into a value appropriate for the presentation system. The default action is to return the base GUI styles for the platform. Extended styles defined by the application are returned if you set extendedOnly to true.
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
static Style defaultStyle()
Returns the default style. The default style is classDefaultStyle unless you have changed the style using setDefaultStyle.
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
static void setDefaultStyle(const Style& style)
Sets the default style for all subsequent radio buttons.
This member function is not thread safe. In a multithreaded application, it should only be called when a conflict is not possible. A conflict can arise if you set the default style on one thread at the same time that it is being queried on another. In this situation, the query would take place while the style is in an unknown state.
When you create a window class and do not specifically specify window styles in the constructor, the Open Class Library queries the default style. Therefore, the only safe place to call this member function is when no other application threads that create windows are active.
Another way to avoid a conflict in a multithreaded application is to specifically specify window styles on window construction, rather than calling this member function.
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
static const Style autoSelect
Specifies a selection technique in which the user changes the current selection automatically by moving the keyboard cursor. If auto select is enabled, the state of the button automatically changes to the next appropriate state. For radio buttons, when auto select is enabled, all other buttons in the same group are deselected automatically when a button is selected. If auto select is disabled, the application must change the state of the button when it is clicked.
The application determines when the user clicks on the radio button by attaching a handler derived from ISelectHandler to the radio button or its owner and overriding the ISelectHandler::selected member function. The application can then use the selection functions to change the state of the radio button.
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
The autoSelect style is always enabled in the Motif version.
![]() |
public:
static const Style classDefaultStyle
Provides the original default style for this class, which is the following: IRadioButton::autoSelect | IWindow::visible.
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
static const Style noCursorSelect
Prevents the radio button from selecting itself when given the focus as a result of an arrow key or tab key.
| Windows | OS/2 | AIX |
| Ignored | Yes | Yes |
The Motif version ignores the noCursorSelect style.
This style is ignored in the windows environment.
virtual ~IButton()
bool allowsMouseClickFocus() const
virtual IColor backgroundColor() const
virtual IButton& click()
virtual IColor disabledForegroundColor() const
virtual IButton& disableMouseClickFocus()
virtual IButton& enableMouseClickFocus(bool enable = true)
virtual IButton& enableNotification(bool enable = true)
virtual IColor foregroundColor() const
virtual IButton& highlight(bool highlight = true)
virtual IColor hiliteBackgroundColor() const
virtual IColor hiliteForegroundColor() const
bool isHighlighted() const
virtual IButton& setText(const char* text)
virtual IButton& setText(const IResourceId& text)
virtual IButton& unhighlight()
virtual ~IControl()
virtual ~INotifier()
virtual INotifier& disableNotification() = 0
virtual INotifier& enableNotification( bool enable = true ) = 0
INotifier()
virtual bool isEnabledForNotification() const = 0
virtual INotifier& notifyObservers( const INotificationEvent& event ) = 0
virtual INotifier& notifyObserversAsync( const INotificationEvent& event )
const IThreadId& threadId() const
virtual ~ISettingButton()
virtual ISettingButton& deselect()
virtual ISettingButton& disableAutoSelect() = 0
virtual ISettingButton& enableAutoSelect(bool enable) = 0
virtual ISettingButton& enableNotification( bool enable = true )
virtual bool isAutoSelect() const = 0
ISettingButton()
bool isSelected() const
virtual ISettingButton& select(bool select = true)
virtual ~ITextControl()
static bool clipboardHasTextFormat()
virtual ISize displaySize(const char* text = 0) const
virtual ITextControl&
setLayoutDistorted( unsigned long layoutAttributeOn,
unsigned long layoutAttributeOff )
virtual ITextControl& setText(const IResourceId& text)
virtual ITextControl& setText(const char* text)
virtual IString text() const
virtual unsigned long textLength() const
virtual ~IWindow()
IAccelTblHandle acceleratorHandle() const
IAcceleratorTable acceleratorTable() const
virtual IColor activeColor() const
IWindow& addOrReplaceAttribute( const IAttributeName& name, const IAttribute& attribute )
IWindow& adoptWindowData( const DataHandle& typeToken, IWindowData* windowData )
virtual IString asDebugInfo() const
virtual IString asString() const
IAttributeName attributeNameAt( const AttributeCursor& cursor ) const
const IAttribute* attributeWithName( const IAttributeName& name, ESearchType search = kWindowOnly ) const
virtual IWindow& capturePointer(bool capture = true)
ISize characterSize() const
IWindowHandle childAt(const ChildCursor& cursor) const
IWindow* childWindowAt(const ChildCursor& cursor) const
virtual IArgList convertToArgList( const IBitFlag& style ) const
static DataHandle dataHandleWithKey( const char* dataKeyName )
virtual IWindowHandle defaultEmphasisButton() const
static SiblingOrder defaultOrdering()
virtual IWindowHandle defaultPushButton() const
static IWindow* desktopWindow()
virtual IWindow& disable()
virtual IColor disabledBackgroundColor() const
virtual IWindow& disableGroup()
IWindow& disableMinimumSizeCaching()
virtual IWindow& disableNotification()
virtual IWindow& disableTabStop()
virtual IWindow& disableUpdate()
bool dispatchRemainingHandlers( IEvent& event, bool callDefProc = true )
virtual IWindow& enable(bool enableWindow = true)
virtual IWindow& enableGroup(bool enable = true)
IWindow& enableMinimumSizeCaching( bool enableCaching = true )
virtual IWindow& enableNotification(bool enable = true)
virtual IWindow& enableTabStop(bool enable = true)
virtual IWindow& enableUpdate(bool enableWindow = true)
static IWindow::ExceptionFn* exceptionFunction()
virtual IFont font() const
virtual IWindowHandle handle() const
virtual bool handleException( IException& dispatcherException, IEvent& exceptionEvent )
virtual IWindowHandle handleForChildCreation() const
static IWindowHandle handleWithParent( unsigned long identifier, const IWindowHandle& parent )
static IWindowHandle handleWithPointerCaptured()
virtual bool hasFocus() const
virtual bool hasPointerCaptured() const
unsigned long helpId() const
virtual IWindow& hide()
virtual IWindow& hideSourceEmphasis()
virtual unsigned long id() const
virtual IColor inactiveColor() const
virtual IRectangle invalidatedRect() const
virtual IRegionHandle invalidatedRegion() const
bool isAutoDeleteObject() const
bool isAutoDestroyWindow() const
bool isEnabled() const
virtual bool isEnabledForNotification() const
virtual bool isFrameWindow() const
virtual bool isGroup() const
bool isHandling(const EventMask& events) const
virtual bool isLayoutDistorted( unsigned long layoutAttribute ) const
bool isMinimumSizeCachingEnabled() const
bool isShowing() const
virtual bool isTabStop() const
bool isUpdateEnabled() const
virtual bool isValid() const
bool isVisible() const
static bool isWindowValid(const IWindow* window)
IDMItemProvider* itemProvider() const
IWindow(const IWindowHandle& handle)
IWindow(unsigned long identifier, IWindow* parent)
virtual IRectangle layoutAdjustment() const
static IPoint mapPoint( const IPoint& point, const IWindowHandle& from, const IWindowHandle& to )
virtual IWindowHandle matchForMnemonic( unsigned short character ) const
IMessageQueueHandle messageQueue() const
ISize minimumSize(bool windowCalculatedSize = false) const
virtual IPointerHandle mousePointer() const
static void movePointerTo(const IPoint& position)
virtual IWindow& moveSizeTo( const IRectangle& newSizeAndPosition )
virtual IWindow& moveTo(const IPoint& newPosition)
virtual IRectangle nativeRect() const
virtual INotifierAddress notifierAddress() const
virtual IWindow& notifyObservers( const INotificationEvent& event )
virtual IWindow& notifyObserversAsync( const INotificationEvent& event )
static IWindow* objectWindow()
virtual IWindow* owner() const
IWindow* parent() const
virtual ISize parentSize() const
static ISize parentSize(const IWindowHandle& windowHandle)
static IPoint pointerPosition()
virtual IPoint position() const
virtual IWindow& positionBehindSibling( const IWindowHandle& siblingWindow )
virtual IWindow& positionBehindSiblings()
virtual IWindow& positionOnSiblings()
virtual const IWindow& postEvent(const IEvent& event) const
virtual const IWindow& postEvent( EventType eventType, const IEventParameter1& parm1 = 0, const IEventParameter2& parm2 = 0 ) const
virtual const IWindow&
postEvent( unsigned long eventId,
const IEventParameter1& parm1 = 0,
const IEventParameter2& parm2 = 0 ) const
virtual IPresSpaceHandle presSpace() const
virtual IRectangle rect() const
virtual IWindow& refresh( const IRectangle& invalidRectangle, bool immediate = false )
virtual IWindow& refresh(RefreshType type = paintAll)
virtual IWindow& releasePointer()
virtual void releasePresSpace( const IPresSpaceHandle& presentationSpaceHandle ) const
IWindow& removeAllAttributes()
IWindow& removeAttribute(const IAttributeName& name)
virtual IWindow& resetActiveColor()
virtual IWindow& resetBackgroundColor()
virtual IWindow& resetDisabledBackgroundColor()
virtual IWindow& resetDisabledForegroundColor()
virtual IWindow& resetFont()
virtual IWindow& resetForegroundColor()
virtual IWindow& resetHiliteBackgroundColor()
virtual IWindow& resetHiliteForegroundColor()
virtual IWindow& resetInactiveColor()
IWindow& resetMinimumSize()
virtual IWindow& resetShadowColor()
virtual IEventResult sendEvent(const IEvent& event) const
virtual IEventResult sendEvent( unsigned long eventId, const IEventParameter1& parm1 = 0, const IEventParameter2& parm2 = 0 ) const
virtual IEventResult sendEvent( EventType eventType, const IEventParameter1& parm1 = 0, const IEventParameter2& parm2 = 0 ) const
IWindow& setAcceleratorHandle( const IAccelTblHandle& handle )
IWindow& setAcceleratorTable( const IAcceleratorTable* acceleratorTable )
virtual IWindow& setActiveColor(const IColor& color)
IWindow& setAutoDeleteObject(bool autoDelete = true)
IWindow& setAutoDestroyWindow(bool autoDestroy = false)
virtual IWindow& setBackgroundColor(const IColor& color)
static void setDefaultOrdering(SiblingOrder order)
virtual IWindow& setDisabledBackgroundColor( const IColor& color )
virtual IWindow& setDisabledForegroundColor( const IColor& color )
static IWindow::ExceptionFn* setExceptionFunction( IWindow::ExceptionFn* exceptionFunction )
virtual IWindow& setFocus()
virtual IWindow& setFont(const IFont& font)
virtual IWindow& setForegroundColor(const IColor& color)
IWindow& setHelpId(unsigned long helpTopicId)
virtual IWindow& setHiliteBackgroundColor( const IColor& color )
virtual IWindow& setHiliteForegroundColor( const IColor& color )
virtual IWindow& setId(unsigned long newIdentifier)
virtual IWindow& setInactiveColor(const IColor& color)
IWindow& setItemProvider(IDMItemProvider* dragProvider)
virtual IWindow&
setLayoutDistorted( unsigned long layoutAttributesOn,
unsigned long layoutAttributesOff )
IWindow& setMinimumSize(const ISize& size)
virtual IWindow& setMousePointer( const IPointerHandle& mousePointer )
virtual IWindow& setOwner(const IWindow* newOwner)
virtual IWindow& setParent(const IWindow* newParent)
virtual IWindow& setShadowColor(const IColor& color)
virtual IColor shadowColor() const
virtual IWindow& show(bool showWindow = true)
virtual IWindow& showSourceEmphasis(bool show = true)
virtual ISize size() const
virtual IWindow& sizeTo(const ISize& newSize)
IWindow& startHandling(const EventMask& events)
IWindow& stopHandling(const EventMask& events)
virtual IWindow& validateRect( const IRectangle& validatedRectangle )
virtual IWindow& validateRegion( const IRegionHandle& validatedRegion )
virtual IRectangle visibleRectangle() const
IWindowData* windowData(const DataHandle& typeToken) const
static IWindow* windowWithHandle( const IWindowHandle& windowHandle, bool allThreads = true )
static IWindow*
windowWithOwner( unsigned long identifier,
const IWindow* owner,
bool allThreads = true )
static IWindow*
windowWithParent( unsigned long identifier,
const IWindow* parent,
bool allThreads = true )
static INotificationId const activeColorId
static const EventMask allMouseMoves
static INotificationId const attributeAddReplaceId
static INotificationId const attributeRemoveId
static INotificationId const backgroundColorId
static INotificationId const borderColorId
static const Style clipChildren
static const Style clipSiblings
static const Style clipToParent
static INotificationId const commandId
static const Style disabled
static INotificationId const disabledBackgroundColorId
static INotificationId const disabledForegroundColorId
static INotificationId const enableId
static INotificationId const focusId
static INotificationId const fontId
static INotificationId const foregroundColorId
static const Style group
static INotificationId const hiliteBackgroundColorId
static INotificationId const hiliteForegroundColorId
static INotificationId const inactiveColorId
static const Style leftToRight
static const EventMask mouseEntersLeaves
static const Style noStyle
static INotificationId const positionId
static const Style rightToLeft
static const Style saveBits
static INotificationId const shadowColorId
static INotificationId const sizeId
static const EventMask someMouseMoves
static const Style synchPaint
static INotificationId const systemCommandId
static const Style tabStop
static const Style visible
static INotificationId const visibleId
static INotificationId const allChangesId
static INotificationId const deleteId
static INotificationId const buttonClickId
static const Style noPointerFocus
static INotificationId const selectId
static INotificationId const textId
IWindow& addHandler(IHandler* newHandler)
virtual IWindow& addObserver( IObserver& observer, const IInterest& interest )
static void
addToWindowSet( IWindow* window,
const IWindowHandle& windowHandle )
IWindow& bindMessageQueue(bool bindToMessageQueue = true)
IColor color(unsigned long colorArea) const
IColor color( unsigned long colorArea, const IColor& defaultColor ) const
virtual IWindowHandle create( unsigned long id, const char* text, const IBitFlag& style, const char* windowClass, const IWindow* parent, const IWindow* owner, const IRectangle& initRect, const void* ctlData, const void* presParams, IWindow::SiblingOrder ordering = defaultOrdering ( ) )
virtual IWindowHandle create( unsigned long id, const char* text, const IBitFlag& style, IXmCreateFunction createFunction, const IWindow* parent, const IWindow* owner, const IRectangle& initRect, IWindow::SiblingOrder ordering = defaultOrdering ( ) )
virtual IWindowHandle create( unsigned long id, const char* text, unsigned long style, IXmCreateFunction createFunction, const IWindowHandle& parent, const IWindowHandle& owner, const IRectangle& initRect, const void* callerArgList, unsigned int callerNumberArguments, IWindow::SiblingOrder ordering = defaultOrdering ( ), unsigned long extendedStyle = 0 )
virtual IWindowHandle create( unsigned long id, const char* text, unsigned long style, const char* windowClass, const IWindowHandle& parent, const IWindowHandle& owner, const IRectangle& initRect, const void* ctlData, const void* presParams, IWindow::SiblingOrder ordering = defaultOrdering ( ), unsigned long extendedStyle = 0 )
IWindow& defaultProcedure(IEvent& event)
bool deleteIsInProcess() const
bool dispatch(IEvent& event)
virtual unsigned long extendedStyle() const
bool isBoundToMessageQueue() const
virtual bool isDragStarting(IEvent& event)
bool isPrimaryWindow() const
bool isUserWindowWordReserved() const
IWindow()
IWindowNotifyHandler* notificationHandler() const
virtual IWindow& notifyObservers( const INotificationId& notification )
IObserverList& observerList( const IInterest* interest = 0 ) const
virtual IWindow& prepareForUse( const IWindowHandle& windowHandle )
virtual IWindow& removeAllObservers()
static void removeFromWindowSet(IWindow* window)
IWindow& removeHandler(IHandler* oldHandler)
virtual IWindow& removeObserver(IObserver& observer)
virtual IWindow& removeObserver( IObserver& observer, const IInterest& interest )
IWindow& reserveUserWindowWord(bool reserve = true)
virtual IWindow& resetColor(unsigned long colorArea)
ISize savedMinimumSize() const
IWindow& saveMinimumSize(const ISize& size)
virtual IWindow& setBidiSettings( const IBidiSettings& bidiSettings, bool childInherit, bool refresh )
virtual IWindow&
setColor( unsigned long colorArea,
const IColor& color )
virtual IWindow& setDefaultEmphasisButton( const IWindowHandle& defaultEmphasisButton, bool enable )
virtual IWindow& setDefaultPushButton( const IWindowHandle& defaultPushButton )
virtual IWindow& setExtendedStyle( unsigned long extendedStyle )
IWindow& setNotificationHandler( IWindowNotifyHandler* notifyHandler )
virtual IWindow& setStyle(unsigned long style)
IWindow& setWindowData(long index, unsigned long dataValue)
IWindow&
setWindowData( long index,
unsigned short dataValue )
IWindow&
startHandlingEventsFor( unsigned long identifier,
IWindow* parent )
IWindow& startHandlingEventsFor( const IWindowHandle& windowHandle )
virtual unsigned long style() const
IWindow& unbindMessageQueue()
unsigned long windowULong(long index) const
unsigned short windowUShort(long index) const
virtual INotifier& addObserver( IObserver& observer, const IInterest& interest )
virtual INotifier& notifyObservers( const INotificationId& id ) = 0
virtual IObserverList& observerList( const IInterest* anInterest = 0 ) const = 0
virtual INotifier& removeAllObservers() = 0
virtual INotifier& removeObserver( IObserver& observer, const IInterest& interest )
virtual INotifier& removeObserver(IObserver& observer) = 0
IButton()
IControl()
ITextControl()
virtual bool passEventToOwner(IEvent& event)
virtual ISettingButton& setBidiSettings( const IBidiSettings& bidiSettings, bool childInherit, bool refresh )