Detailed Description
The QGroupBox widget provides a group box frame with a title.
A group box provides a frame, a title and a keyboard shortcut, and
displays various other widgets inside itself. The title is on top,
the keyboard shortcut moves keyboard focus to one of the group
box's child widgets, and the child widgets are usually laid out
horizontally (or vertically) inside the frame.
The simplest way to use it is to create a group box with the
desired number of columns (or rows) and orientation, and then just
create widgets with the group box as parent.
It is also possible to change the orientation() and number of
columns() after construction, or to ignore all the automatic
layout support and manage the layout yourself. You can add 'empty'
spaces to the group box with addSpace().
QGroupBox also lets you set the title() (normally set in the
constructor) and the title's alignment().
You can change the spacing used by the group box with
setInsideMargin() and setInsideSpacing(). To minimize space
consumption, you can remove the right, left and bottom edges of
the frame with setFlat().
See also QButtonGroup, Widget Appearance and Style, Layout Management, and Organizers.
Member Function Documentation
QGroupBox::QGroupBox ( QWidget * parent = 0, const char * name = 0 )
Constructs a group box widget with no title.
The parent and name arguments are passed to the QWidget
constructor.
This constructor does not do automatic layout.
QGroupBox::QGroupBox ( const QString & title, QWidget * parent = 0, const char * name = 0 )
Constructs a group box with the title title.
The parent and name arguments are passed to the QWidget
constructor.
This constructor does not do automatic layout.
QGroupBox::QGroupBox ( int strips, Orientation orientation, QWidget * parent = 0, const char * name = 0 )
Constructs a group box with no 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.
QGroupBox::QGroupBox ( int strips, Orientation orientation, const QString & title, QWidget * parent = 0, const char * name = 0 )
Constructs a group box titled 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.
QGroupBox::~QGroupBox ()
Destroys the group box.
void QGroupBox::addSpace ( int size )
Adds an empty cell at the next free position. If size is
greater than 0, the empty cell takes size to be its fixed width
(if orientation() is Horizontal) or height (if orientation() is
Vertical).
Use this method to separate the widgets in the group box or to
skip the next free cell. For performance reasons, call this method
after calling setColumnLayout() or by changing the QGroupBox::columns or QGroupBox::orientation properties. It is
generally a good idea to call these methods first (if needed at
all), and insert the widgets and spaces afterwards.
int QGroupBox::alignment () const
Returns the alignment of the group box title.
See the "alignment" property for details.
int QGroupBox::columns () const
Returns the number of columns or rows (depending on QGroupBox::orientation) in the group box.
See the "columns" property for details.
int QGroupBox::insideMargin () const
Returns the width of the empty space between the items in the
group and the frame of the group.
Only applies if the group box has a defined orientation.
The default is usually 11, by may vary depending on the platform
and style.
See also setInsideMargin() and orientation.
int QGroupBox::insideSpacing () const
Returns the width of the empty space between each of the items
in the group.
Only applies if the group box has a defined orientation.
The default is usually 5, by may vary depending on the platform
and style.
See also setInsideSpacing() and orientation.
bool QGroupBox::isCheckable () const
Returns TRUE if the group box has a checkbox in its title; otherwise returns FALSE.
See the "checkable" property for details.
bool QGroupBox::isChecked () const
Returns TRUE if the group box's checkbox is checked; otherwise returns FALSE.
See the "checked" property for details.
bool QGroupBox::isFlat () const
Returns TRUE if the group box is painted flat or has a frame; otherwise returns FALSE.
See the "flat" property for details.
Orientation QGroupBox::orientation () const
Returns the group box's orientation.
See the "orientation" property for details.
void QGroupBox::setAlignment ( int ) [virtual]
Sets the alignment of the group box title.
See the "alignment" property for details.
void QGroupBox::setCheckable ( bool b )
Sets whether the group box has a checkbox in its title to b.
See the "checkable" property for details.
void QGroupBox::setChecked ( bool b ) [slot]
Sets whether the group box's checkbox is checked to b.
See the "checked" property for details.
void QGroupBox::setColumnLayout ( int strips, Orientation direction ) [virtual]
Changes the layout of the group box. This function is only useful
in combination with the default constructor that does not take any
layout information. This function will put all existing children
in the new layout. It is not good Qt programming style to call
this function after children have been inserted. Sets the number
of columns or rows to be strips, depending on direction.
See also orientation and columns.
Example: chart/optionsform.cpp.
void QGroupBox::setColumns ( int )
Sets the number of columns or rows (depending on QGroupBox::orientation) in the group box.
See the "columns" property for details.
void QGroupBox::setFlat ( bool b )
Sets whether the group box is painted flat or has a frame to b.
See the "flat" property for details.
void QGroupBox::setInsideMargin ( int m )
Sets the the width of the inside margin to m pixels.
See also insideMargin().
void QGroupBox::setInsideSpacing ( int s )
Sets the width of the empty space between each of the items in
the group to s pixels.
See also insideSpacing().
void QGroupBox::setOrientation ( Orientation )
Sets the group box's orientation.
See the "orientation" property for details.
void QGroupBox::setTitle ( const QString & ) [virtual]
Sets the group box title text.
See the "title" property for details.
QString QGroupBox::title () const
Returns the group box title text.
See the "title" property for details.
void QGroupBox::toggled ( bool on ) [signal]
If the group box has a check box (see isCheckable()) this signal
is emitted when the check box is toggled. on is TRUE if the check
box is checked; otherwise it is FALSE.
Property Documentation
Alignment alignment
This property holds the alignment of the group box title.
The title is always placed on the upper frame line. The horizontal
alignment can be specified by the alignment parameter.
The alignment is one of the following flags:
- AlignAuto aligns the title according to the language,
usually to the left.
- AlignLeft aligns the title text to the left.
- AlignRight aligns the title text to the right.
- AlignHCenter aligns the title text centered.
The default alignment is AlignAuto.
See also Qt::AlignmentFlags.
Set this property's value with setAlignment() and get this property's value with alignment().
bool checkable
This property holds whether the group box has a checkbox in its title.
If this property is TRUE, the group box has a checkbox. If the
checkbox is checked (which is the default), the group box's
children are enabled.
setCheckable() controls whether or not the group box has a
checkbox, and isCheckable() controls whether the checkbox is
checked or not.
Set this property's value with setCheckable() and get this property's value with isCheckable().
bool checked
This property holds whether the group box's checkbox is checked.
If the group box has a check box (see isCheckable()), and the
check box is checked (see isChecked()), the group box's children
are enabled. If the checkbox is unchecked the children are
disabled.
Set this property's value with setChecked() and get this property's value with isChecked().
int columns
This property holds the number of columns or rows (depending on QGroupBox::orientation) in the group box.
Usually it is not a good idea to set this property because it is
slow (it does a complete layout). It is best to set the number
of columns directly in the constructor.
Set this property's value with setColumns() and get this property's value with columns().
bool flat
This property holds whether the group box is painted flat or has a frame.
By default a group box has a surrounding frame, with the title
being placed on the upper frame line. In flat mode the right, left
and bottom frame lines are omitted, and only the thin line at the
top is drawn.
See also title.
Set this property's value with setFlat() and get this property's value with isFlat().
This property holds the group box's orientation.
A horizontal group box arranges it's children in columns, while a
vertical group box arranges them in rows.
Usually it is not a good idea to set this property because it is
slow (it does a complete layout). It is better to set the
orientation directly in the constructor.
Set this property's value with setOrientation() and get this property's value with orientation().
This property holds the group box title text.
The group box title text will have a focus-change keyboard
accelerator if the title contains &, followed by a letter.
g->setTitle( "&User information" );
This produces "User information"; Alt+U moves the keyboard focus to the group box.
There is no default title text.
Set this property's value with setTitle() and get this property's value with title().
This file is part of the Qt toolkit.
Copyright © 1995-2003
Trolltech. All Rights Reserved.
