QButtonGroup - Organizes
#include <qbuttongroup.h>
Inherits QGroupBox.
Inherited by QHButtonGroup and QVButtonGroup.
Public Members
QButtonGroup ( QWidget * parent=0, const char * name=0 )
QButtonGroup ( const QString & title, QWidget * parent=0,
const char * name=0 )
QButtonGroup ( int columns, Orientation o, QWidget *
parent=0, const char * name=0 )
QButtonGroup ( int columns, Orientation o, const QString &
title, QWidget * parent=0, const char * name=0 )
bool isExclusive () const
bool isRadioButtonExclusive () const
virtual void setExclusive ( bool )
virtual void setRadioButtonExclusive ( bool )
int insert ( QButton *, int id=-1 )
void remove ( QButton * )
QButton* find ( int id ) const
int id ( QButton * ) const
int count () const
virtual void setButton ( int id )
virtual void moveFocus ( int )
QButton* selected ()
Signals
void pressed ( int id )
void released ( int id )
void clicked ( int id )
Protected Slots
void buttonPressed () (internal)
void buttonReleased () (internal)
void buttonClicked () (internal)
void buttonToggled ( bool on ) (internal)
Properties
Type Name READ WRITE Options
-----------------------------------------------------------------------------------------
bool exclusive isExclusive setExclusive
bool radioButtonExclusive isRadioButtonExclusive setRadioButtonExclusive
DESCRIPTION
The QButtonGroup widget organizes QButton widgets in a
group.
A button group widget makes it easier to deal with groups
a unique identifer. The button group emits a clicked()
signal with this identifier when the button is clicked.
Thus, a button group is an ideal solution when you have
several similar buttons and want to connect all their
clicked() signals, for example, to one slot.
An exclusive button group switches off all toggle buttons
except the one that was clicked. A button group is by
default non-exclusive. All radio buttons that are
inserted, will be mutually exclusive even if the button
group is non-exclusive.
There are two ways of using a button group:
1 The button group is a 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.
2 The button group is an invisible widget and the
contained buttons have some other parent widget. A
button must then be manually inserted using the
insert() function with an identifer.
[Image Omitted]
[Image Omitted]
See also QButton, QPushButton, QCheckBox and QRadioButton.
Examples: xform/xform.cpp i18n/main.cpp
drawdemo/drawdemo.cpp
MEMBER FUNCTION DOCUMENTATION
QButtonGroup::QButtonGroup ( QWidget * parent=0, const char *
name=0 )
Constructs a button group with no title.
The parent and name arguments are passed to the QWidget
constructor.
QButtonGroup::QButtonGroup ( const QString & title, QWidget *
parent=0, const char * name=0 )
Constructs a button group with a title.
The parent and name arguments are passed to the QWidget
constructor.
QButtonGroup::QButtonGroup ( int strips, Orientation orientation,
QWidget * parent=0, const char * name=0 )
will be arranged in strips rows or columns (depending on
orientation).
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 )
Constructs a button group with a title. Child widgets will
be arranged in strips rows or columns (depending on
orientation).
The parent and name arguments are passed to the QWidget
constructor.
QButtonGroup::~QButtonGroup ()
Reimplemented for internal reasons; the API is not
affected.
void QButtonGroup::clicked ( int id ) [signal]
This signal is emitted when a button in the group is
clicked. The id argument is the button's identifier.
int QButtonGroup::count () const
Returns the number of buttons in the group.
QButton * QButtonGroup::find ( int id ) const
Finds and returns a pointer to the button with the
specified identifier id.
Returns null if the button was not found.
int QButtonGroup::id ( QButton * button ) const
Returns the id of button, or -1 if button is not a member
of this group.
int QButtonGroup::insert ( QButton * button, int id=-1 )
Inserts a button with the identifier id into the button
group. Returns the button identifier.
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.
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.
identifiers 0, 1, 2, etc.
See also find(), remove() and setExclusive().
Examples: xform/xform.cpp
bool QButtonGroup::isExclusive () const
Returns TRUE if the button group is exclusive, otherwise
FALSE.
See also setExclusive().
bool QButtonGroup::isRadioButtonExclusive () const
Returns whether this button group will treat radio buttons
as mutually exclusive. The default is TRUE.
See also setRadioButtonExclusive().
void QButtonGroup::moveFocus ( int key ) [virtual]
Moves the keyboard focus according to key, and if
appropriate checks the new focus item.
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]
This signal is emitted when a button in the group is
pressed. The id argument is the button's identifier.
void QButtonGroup::released ( int id ) [signal]
This signal is emitted when a button in the group is
released. The id argument is the button's identifier.
void QButtonGroup::remove ( QButton * button )
Removes a button from the button group.
See also insert().
QButton * QButtonGroup::selected ()
Returns a pointer to the selected radio button in this
group, if one exists, or 0 if there is no selected radio
button in this group.
Warning: In future versions of Qt, the selected toggle
button will be returned.
void QButtonGroup::setButton ( int id ) [virtual]
Sets the button with id id to be on, and if this is an
exclusive group, all other button in the group to be off.
void QButtonGroup::setExclusive ( bool enable ) [virtual]
Sets the button group to be exclusive if enable is TRUE,
An exclusive button group switches off all other toggle
buttons when one is switched on. This is ideal for groups
of radio buttons. A non-exclusive group allow many buttons
to be switched on at the same time.
The default setting is FALSE.
See also isExclusive().
void QButtonGroup::setRadioButtonExclusive ( bool on ) [virtual]
If on is TRUE, this button group will treat radio buttons
as mutually exclusive, and other buttons according to
isExclusive().
void QButtonGroup::buttonClicked () [protected slot]
For internal use only.
void QButtonGroup::buttonPressed () [protected slot]
For internal use only.
void QButtonGroup::buttonReleased () [protected slot]
For internal use only.
void QButtonGroup::buttonToggled ( bool on ) [protected slot]
For internal use only.
SEE ALSO
http://doc.trolltech.com/qbuttongroup.html
http://www.trolltech.com/faq/tech.html
COPYRIGHT
Copyright 1992-2001 Trolltech AS,
http://www.trolltech.com. See the license file included
in the distribution for a complete license statement.
AUTHOR
Generated automatically from the source code.
BUGS
If you find a bug in Qt, please report it as described in
http://doc.trolltech.com/bughowto.html. Good bug reports
make our job much simpler. Thank you.
In case of content or formattting problems with this
manual page, please report them to qt-bugs@trolltech.com.
Please include the name of the manual page
(qbuttongroup.3qt) and the Qt version (2.3.1).
Man(1) output converted with
man2html