QStyleOptionGroupBox Class Reference

The QStyleOptionGroupBox class describes the parameters for drawing a group box. More...

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionGroupBox:

Public Types
enum	StyleOptionType { Type = SO_GroupBox }
	This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass. More...
enum	StyleOptionVersion { Version = 1 }
	This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
Public Types inherited from QStyleOptionComplex
enum	StyleOptionType { Type = SO_Complex }
	This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass. More...
enum	StyleOptionVersion { Version = 1 }
	This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
Public Types inherited from QStyleOption
enum	OptionType {   SO_Default, SO_FocusRect, SO_Button, SO_Tab,   SO_MenuItem, SO_Frame, SO_ProgressBar, SO_ToolBox,   SO_Header, SO_Q3DockWindow, SO_DockWidget, SO_Q3ListViewItem,   SO_ViewItem, SO_TabWidgetFrame, SO_TabBarBase, SO_RubberBand,   SO_ToolBar, SO_GraphicsItem, SO_Complex = 0xf0000, SO_Slider,   SO_SpinBox, SO_ToolButton, SO_ComboBox, SO_Q3ListView,   SO_TitleBar, SO_GroupBox, SO_SizeGrip, SO_CustomBase = 0xf00,   SO_ComplexCustomBase = 0xf000000 }
	This enum is used internally by QStyleOption, its subclasses, and qstyleoption_cast() to determine the type of style option. More...
enum	StyleOptionType { Type = SO_Default }
	This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass. More...
enum	StyleOptionVersion { Version = 1 }
	This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...

Public Functions
	QStyleOptionGroupBox ()
	Constructs a QStyleOptionGroupBox, initializing the members variables to their default values. More...
	QStyleOptionGroupBox (const QStyleOptionGroupBox &other)
	Constructs a copy of the other style option. More...
Public Functions inherited from QStyleOptionComplex
	QStyleOptionComplex (int version=QStyleOptionComplex::Version, int type=SO_Complex)
	Constructs a QStyleOptionComplex of the specified type and version, initializing the member variables to their default values. More...
	QStyleOptionComplex (const QStyleOptionComplex &other)
	Constructs a copy of the other style option. More...
Public Functions inherited from QStyleOption
void	init (const QWidget *w)
	Use initFrom(widget) instead. More...
void	initFrom (const QWidget *w)
QStyleOption &	operator= (const QStyleOption &other)
	Assign other to this QStyleOption. More...
	QStyleOption (int version=QStyleOption::Version, int type=SO_Default)
	Constructs a QStyleOption with the specified version and type. More...
	QStyleOption (const QStyleOption &other)
	Constructs a copy of other. More...
	~QStyleOption ()
	Destroys this style option object. More...

Public Variables
QStyleOptionFrameV2::FrameFeatures	features
	the features of the group box frame More...
int	lineWidth
	the line width for drawing the panel More...
int	midLineWidth
	the mid-line width for drawing the panel More...
QString	text
	the text of the group box More...
Qt::Alignment	textAlignment
	the alignment of the group box title More...
QColor	textColor
	the color of the group box title More...
Public Variables inherited from QStyleOptionComplex
QStyle::SubControls	activeSubControls
	This variable holds a bitwise OR of the sub-controls that are active for the complex control. More...
QStyle::SubControls	subControls
	This variable holds a bitwise OR of the sub-controls to be drawn for the complex control. More...
Public Variables inherited from QStyleOption
Qt::LayoutDirection	direction
	the text layout direction that should be used when drawing text in the control More...
QFontMetrics	fontMetrics
	the font metrics that should be used when drawing text in the control More...
QPalette	palette
	the palette that should be used when painting the control More...
QRect	rect
	the area that should be used for various calculations and painting More...
QStyle::State	state
	the style flags that are used when drawing the control More...
int	type
	the option type of the style option More...
int	version
	the version of the style option More...

Protected Functions
	QStyleOptionGroupBox (int version)

Additional Inherited Members
Related Functions inherited from QStyleOption
T	qstyleoption_cast (const QStyleOption *option)
T	qstyleoption_cast (QStyleOption *option)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

Detailed Description

The QStyleOptionGroupBox class describes the parameters for drawing a group box.

Since

4.1

QStyleOptionButton contains all the information that QStyle functions need the various graphical elements of a group box.

It holds the lineWidth and the midLineWidth for drawing the panel, the group box's text {title} and the title's textAlignment {alignment} and textColor {color}.

For performance reasons, the access to the member variables is direct (i.e., using the . or -> operator). This low-level feel makes the structures straightforward to use and emphasizes that these are simply parameters used by the style functions.

For an example demonstrating how style options can be used, see the widgets/styles {Styles} example.

See also

QStyleOption, QStyleOptionComplex, QGroupBox

Definition at line 834 of file qstyleoption.h.

Enumerations

StyleOptionType

enum QStyleOptionGroupBox::StyleOptionType

This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass.

• Type The type of style option provided (SO_GroupBox for this class).

The type is used internally by QStyleOption, its subclasses, and qstyleoption_cast() to determine the type of style option. In general you do not need to worry about this unless you want to create your own QStyleOption subclass and your own styles.

See also

StyleOptionVersion

Enumerator
Type

Definition at line 837 of file qstyleoption.h.

{ Type = SO_GroupBox };

StyleOptionVersion

enum QStyleOptionGroupBox::StyleOptionVersion

This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass.

• Version 1

The version is used by QStyleOption subclasses to implement extensions without breaking compatibility. If you use qstyleoption_cast(), you normally do not need to check it.

See also

StyleOptionType

Enumerator
Version

Definition at line 838 of file qstyleoption.h.

{ Version = 1 };

Constructors and Destructors

QStyleOptionGroupBox() [1/3]

QStyleOptionGroupBox::QStyleOptionGroupBox

(

)

Constructs a QStyleOptionGroupBox, initializing the members variables to their default values.

Definition at line 1442 of file qstyleoption.cpp.

    : QStyleOptionComplex(Version, Type), features(QStyleOptionFrameV2::None),
      textAlignment(Qt::AlignLeft), lineWidth(0), midLineWidth(0)
{
}

QStyleOptionGroupBox() [2/3]

QStyleOptionGroupBox::QStyleOptionGroupBox ( const QStyleOptionGroupBox &  other )

inline

Constructs a copy of the other style option.

Definition at line 848 of file qstyleoption.h.

: QStyleOptionComplex(Version, Type) { *this = other; }

QStyleOptionGroupBox() [3/3]

QStyleOptionGroupBox::QStyleOptionGroupBox ( int  version )

protected

Warning

This function is not part of the public interface.

Definition at line 1460 of file qstyleoption.cpp.

    : QStyleOptionComplex(version, Type), features(QStyleOptionFrameV2::None),
      textAlignment(Qt::AlignLeft), lineWidth(0), midLineWidth(0)
{
}

Properties

features

QStyleOptionGroupBox::features

the features of the group box frame

The frame is flat by default.

See also

QStyleOptionFrameV2::FrameFeature

Definition at line 840 of file qstyleoption.h.

Referenced by QGroupBox::initStyleOption().

lineWidth

QStyleOptionGroupBox::lineWidth

the line width for drawing the panel

The value of this variable is, currently, always 1.

See also

QFrame::lineWidth

Definition at line 844 of file qstyleoption.h.

Referenced by QGroupBox::initStyleOption().

midLineWidth

QStyleOptionGroupBox::midLineWidth

the mid-line width for drawing the panel

The mid-line width is usually used when drawing sunken or raised group box frames. The value of this variable is, currently, always 0.

See also

QFrame::midLineWidth

Definition at line 845 of file qstyleoption.h.

Referenced by QGroupBox::initStyleOption().

text

QStyleOptionGroupBox::text

the text of the group box

The default value is an empty string.

See also

QGroupBox::title

Definition at line 841 of file qstyleoption.h.

Referenced by QGroupBox::initStyleOption().

textAlignment

QStyleOptionGroupBox::textAlignment

the alignment of the group box title

The default value is Qt::AlignLeft.

See also

QGroupBox::alignment

Definition at line 842 of file qstyleoption.h.

Referenced by QGroupBox::initStyleOption().

textColor

QStyleOptionGroupBox::textColor

the color of the group box title

The default value is an invalid color with the RGB value (0, 0, 0). An invalid color is a color that is not properly set up for the underlying window system.

Definition at line 843 of file qstyleoption.h.

Referenced by QGroupBox::initStyleOption().

---

The documentation for this class was generated from the following files:

• /src/gui/styles/qstyleoption.h
• /src/gui/styles/qstyleoption.cpp