QButtonGroup

NAME

SYNOPSIS

Inherits QGroupBox.

Inherited by QHButtonGroup and QVButtonGroup.

Public Members

Signals

Properties

DESCRIPTION

A button group widget makes it easier to deal with groups of buttons. Each button in a button group has a unique identifier. The button group emits a clicked() signal with this identifier when a button in the group is clicked. This makes a button group particularly useful when you have several similar buttons and want to connect all their clicked() signals to a single slot.

An exclusive button group switches off all toggle buttons except the one that was clicked. A button group is, by default, non-exclusive. Note that all radio buttons that are inserted into a button group are mutually exclusive even if the button group is non-exclusive. (See setRadioButtonExclusive().)

There are two ways of using a button group:

The button group is the parent widget of a number of buttons, i.e. the button group is the parent argument in the button constructor. The buttons are assigned identifiers 0, 1, 2, etc., in the order they are created. A QButtonGroup can display a frame and a title because it inherits QGroupBox.

The button group is an invisible widget and the contained buttons have some other parent widget. In this usage, each button must be manually inserted, using insert(), into the button group and given an identifier.

A button can be removed from the group with remove(). A pointer to a button with a given id can be obtained using find(). The id of a button is available using id(). A button can be set on with setButton(). The number of buttons in the group is returned by count().

See also QPushButton, QCheckBox, QRadioButton, Widget Appearance and Style, Layout Management, and Organizers.  

MEMBER FUNCTION DOCUMENTATION

QButtonGroup::QButtonGroup ( QWidget * parent = 0, const char * name = 0 )

The parent and name arguments are passed to the QWidget constructor.  

QButtonGroup::QButtonGroup ( const QString & title, QWidget * parent = 0, const char * name = 0 )

The parent and name arguments are passed to the QWidget constructor.  

QButtonGroup::QButtonGroup ( int strips, Orientation orientation, QWidget * parent = 0, const char * name = 0 )

The parent and name arguments are passed to the QWidget constructor.  

QButtonGroup::QButtonGroup ( int strips, Orientation orientation, const QString & title, QWidget * parent = 0, const char * name = 0 )

The parent and name arguments are passed to the QWidget constructor.  

void QButtonGroup::clicked ( int id ) [signal]

See also insert().

Examples:  

int QButtonGroup::count () const

QButton * QButtonGroup::find ( int id ) const

int QButtonGroup::id ( QButton * button ) const

See also selectedId.  

int QButtonGroup::insert ( QButton * button, int id = -1 )

Buttons are normally inserted into a button group automatically by passing the button group as the parent when the button is constructed. So it is not necessary to manually insert buttons that have this button group as their parent widget. An exception is when you want custom identifiers instead of the default 0, 1, 2, etc., or if you want the buttons to have some other parent.

The button is assigned the identifier id or an automatically generated identifier. It works as follows: If id >= 0, this identifier is assigned. If id == -1 (default), the identifier is equal to the number of buttons in the group. If id is any other negative integer, for instance -2, a unique identifier (negative integer <= -2) is generated. No button has an id of -1.

See also find(), remove(), and exclusive.

Examples:  

bool QButtonGroup::isExclusive () const

bool QButtonGroup::isRadioButtonExclusive () const

void QButtonGroup::moveFocus ( int key ) [virtual]

This function does nothing unless the keyboard focus points to one of the button group members and key is one of Key_Up, Key_Down, Key_Left and Key_Right.  

void QButtonGroup::pressed ( int id ) [signal]

See also insert().  

void QButtonGroup::released ( int id ) [signal]

See also insert().  

void QButtonGroup::remove ( QButton * button )

See also insert().  

QButton * QButtonGroup::selected () const

See also selectedId.  

int QButtonGroup::selectedId () const

void QButtonGroup::setButton ( int id ) [virtual]

void QButtonGroup::setExclusive ( bool ) [virtual]

void QButtonGroup::setRadioButtonExclusive ( bool ) [virtual]

Property Documentation

bool exclusive

If this property is TRUE, then the buttons in the group are toggled, and to untoggle a button you must click on another button in the group. The default value is FALSE.

Set this property's value with setExclusive() and get this property's value with isExclusive().  

bool radioButtonExclusive

If this property is TRUE (the default), the radiobuttons in the group are treated exclusively.

Set this property's value with setRadioButtonExclusive() and get this property's value with isRadioButtonExclusive().  

int selectedId

The toggle button is specified as an ID.

If no toggle button is selected, this property holds -1.

If setButton() is called on an exclusive group, the button with the given id will be set to on and all the others will be set to off.

See also selected().

Set this property's value with setButton() and get this property's value with selectedId().

SEE ALSO

COPYRIGHT

AUTHOR

BUGS