The QStyleOptionProgressBar class is used to describe the parameters necessary for drawing a progress bar. More...

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionProgressBar:

Public Types
enum	StyleOptionType { Type = SO_ProgressBar }
	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
	QStyleOptionProgressBar ()
	Constructs a QStyleOptionProgressBar, initializing the members variables to their default values. More...

	QStyleOptionProgressBar (const QStyleOptionProgressBar &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
int	maximum
	the maximum value for the progress bar More...

int	minimum
	the minimum value for the progress bar More...

int	progress
	the current progress for the progress bar More...

QString	text
	the text for the progress bar More...

Qt::Alignment	textAlignment
	the text alignment for the text in the QProgressBar More...

bool	textVisible
	a flag indicating whether or not text is visible 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
	QStyleOptionProgressBar (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 QStyleOptionProgressBar class is used to describe the parameters necessary for drawing a progress bar.

Since Qt 4.1, Qt uses the QStyleOptionProgressBarV2 subclass for drawing QProgressBar.

An instance of the QStyleOptionProgressBar class has type SO_ProgressBar and version 1.

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. 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.

If you create your own QStyle subclass, you should handle both QStyleOptionProgressBar and QStyleOptionProgressBarV2.

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

See also: QStyleOptionProgressBarV2, QStyleOption

Definition at line 396 of file qstyleoption.h.

Enumerations

◆ StyleOptionType

enum QStyleOptionProgressBar::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_ProgressBar 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 399 of file qstyleoption.h.

399 { Type = SO_ProgressBar };

QStyleOption::SO_ProgressBar

Definition: qstyleoption.h:72

QStyleOptionProgressBar::Type

Definition: qstyleoption.h:399

◆ StyleOptionVersion

enum QStyleOptionProgressBar::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 400 of file qstyleoption.h.

400 { Version = 1 };

QStyleOptionProgressBar::Version

Definition: qstyleoption.h:400

Constructors and Destructors

◆ QStyleOptionProgressBar() [1/3]

QStyleOptionProgressBar::QStyleOptionProgressBar ( )

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

Definition at line 2640 of file qstyleoption.cpp.

     : QStyleOption(QStyleOptionProgressBar::Version, SO_ProgressBar),
       minimum(0), maximum(0), progress(0), textAlignment(Qt::AlignLeft), textVisible(false)
 {
 }

◆ QStyleOptionProgressBar() [2/3]

QStyleOptionProgressBar::QStyleOptionProgressBar ( const QStyleOptionProgressBar & other )

inline

Constructs a copy of the other style option.

Definition at line 410 of file qstyleoption.h.

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

QStyleOptionProgressBar::Version

Definition: qstyleoption.h:400

QStyleOptionProgressBar::Type

Definition: qstyleoption.h:399

QStyleOption::QStyleOption

QStyleOption(int version=QStyleOption::Version, int type=SO_Default)

Constructs a QStyleOption with the specified version and type.

Definition: qstyleoption.cpp:167

◆ QStyleOptionProgressBar() [3/3]

QStyleOptionProgressBar::QStyleOptionProgressBar ( int version )

protected

Warning: This function is not part of the public interface.

Definition at line 2649 of file qstyleoption.cpp.

     : QStyleOption(version, SO_ProgressBar),
       minimum(0), maximum(0), progress(0), textAlignment(Qt::AlignLeft), textVisible(false)
 {
 }

Properties

◆ maximum

QStyleOptionProgressBar::maximum

the maximum value for the progress bar

This is the maximum value in the progress bar. The default value is 0.

See also: QProgressBar::maximum

Definition at line 403 of file qstyleoption.h.

Referenced by QProgressBar::initStyleOption().

◆ minimum

QStyleOptionProgressBar::minimum

the minimum value for the progress bar

This is the minimum value in the progress bar. The default value is 0.

See also: QProgressBar::minimum

Definition at line 402 of file qstyleoption.h.

Referenced by QProgressBar::initStyleOption().

◆ progress

QStyleOptionProgressBar::progress

the current progress for the progress bar

The current progress. A value of QStyleOptionProgressBar::minimum

1 indicates that the progress hasn't started yet. The default value is 0.

See also: QProgressBar::value

Definition at line 404 of file qstyleoption.h.

Referenced by QProgressBar::initStyleOption().

◆ text

QStyleOptionProgressBar::text

the text for the progress bar

The progress bar text is usually just the progress expressed as a string. An empty string indicates that the progress bar has not started yet. The default value is an empty string.

See also: QProgressBar::text

Definition at line 405 of file qstyleoption.h.

Referenced by QProgressBar::initStyleOption().

◆ textAlignment

QStyleOptionProgressBar::textAlignment

the text alignment for the text in the QProgressBar

This can be used as a guide on where the text should be in the progress bar. The default value is Qt::AlignLeft.

Definition at line 406 of file qstyleoption.h.

Referenced by QProgressBar::initStyleOption().

◆ textVisible

QStyleOptionProgressBar::textVisible

a flag indicating whether or not text is visible

If this flag is true then the text is visible. Otherwise, the text is not visible. The default value is false.

See also: QProgressBar::textVisible

Definition at line 407 of file qstyleoption.h.

Referenced by QProgressBar::initStyleOption().

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

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

Public Types

Public Functions

Public Variables

Protected Functions

Additional Inherited Members

Detailed Description

Enumerations

◆ StyleOptionType

◆ StyleOptionVersion

Constructors and Destructors

◆ QStyleOptionProgressBar() [1/3]

◆ QStyleOptionProgressBar() [2/3]

◆ QStyleOptionProgressBar() [3/3]

Properties

◆ maximum

◆ minimum

◆ progress

◆ text

◆ textAlignment

◆ textVisible