ISettingButton

The ISettingButton class is an abstract base class for the following control window classes:


ISettingButton - Member Functions and Data by Group

Constructors & Destructor

You can construct and destruct objects of the ISettingButton class from derived classes. You cannot copy or assign ISettingButton objects because both the copy constructor and assignment operator are private functions.


[view class]
~ISettingButton
public:
virtual ~ISettingButton()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
ISettingButton
public:
ISettingButton()

Because this class is an abstract base class, you cannot construct objects of this class. This constructor is provided for use in derived classes.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Auto Select

The auto select setting determines whether the state of the button is automatically changed when the user clicks on it. If auto select is enabled, the state of the button automatically changes to the next appropriate state. 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 thebutton 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 selection state of the button.


[view class]
disableAutoSelect
public:
virtual ISettingButton& disableAutoSelect() = 0

Disables the automatic selection style for a button.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes

AIX Considerations

The AIX version is always autoSelect; therefore, this function has no effect in that environment.


[view class]
enableAutoSelect
public:
virtual ISettingButton& enableAutoSelect(bool enable) = 0

Enables the automatic selection style for a button.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes

AIX Considerations

The AIX version is always autoSelect; therefore, this function has no effect in that environment.


[view class]
isAutoSelect
public:
virtual bool isAutoSelect() const = 0

If the automatic selection style for a button is set on, true is returned. Otherwise, false is returned.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes

AIX Considerations

The AIX version is always autoSelect; therefore, this function returns true.


Bidirectional Language Support

These members allow a window to support bidirectional languages, such as Arabic and Hebrew. These languages are written and read right-to-left, but text in these languages may also contain strings that are written and read left-to-right.


[view class]
setBidiSettings
protected:
virtual ISettingButton& setBidiSettings( const IBidiSettings& bidiSettings, bool childInherit, bool refresh )

This function allows a button object to provide special processing to support a change in its bidirectional characteristics. This function is called just before the bidirectional characteristics of the button object change. This function is not called when you create a button object.

bidiSettings
The new bidirectional settings for the button object.
childInherit
This flag specifies if the child windows of the button control will inherit the new bidirectional attributes.
refresh
This flag specifies if the button control will paint after receiving the new directional attributes.

Supported Platforms

Windows OS/2 AIX
Yes Yes No

AIX Considerations

This function is not provided because you cannot change the bidirectional attributes of a window on that platform after you create it.

OS/2 Considerations

ISettingButton does not override IWindow::setBidiSettings on this platform.

Windows Considerations

If the window layout direction is changing, the button changes its window styles that control the position of its text.


Event-Handling Implementation

Event-handling implementation members perform processing needed to allow handlers to properly receive GUI events and to route these events.


[view class]
passEventToOwner
protected:
virtual bool passEventToOwner(IEvent& event)

Determines if the event is passed on to the owner.

Supported Platforms

Windows OS/2 AIX
Yes No Yes


Notification Members

Use these members to identify and enable notifications sent to observer objects.


[view class]
enableNotification
public:
virtual ISettingButton& enableNotification( bool enable = true )

Enables the button to send notifications to any observer objects.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
selectId
public:
static INotificationId const selectId

Notification identifier provided to observers when the selection state of a setting button control changes. ISettingButton provides a boolean value in the INotificationEvent::eventData field of the INotificationEvent. This value is true if the setting button is selected, and false if the setting button is not selected.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Selection

Use these members to query and change the selection state of a setting 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.


[view class]
deselect
public:
virtual ISettingButton& deselect()

Deselects the button. This function does not call ISelectHandler. Use IButton::click instead to ensure that ISelectHandler is called.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
isSelected
public:
bool isSelected() const

If the button is selected, true is returned. Otherwise, false is returned.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
select
public:
virtual ISettingButton& select(bool select = true)

Selects the button. This function does not call ISelectHandler. Use IButton::click instead to ensure that ISelectHandler is called.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


ISettingButton - Inherited Member Functions and Data

Inherited Public Functions

IButton
IControl
INotifier
ITextControl
IWindow

Inherited Public Data

IWindow
INotifier
IButton
ITextControl

Inherited Protected Functions

IWindow
INotifier
IButton
IControl
ITextControl

Inherited Protected Data