QStyleOptionProgressBar Class | Qt Widgets 6.4.1

- Qt 6.4
- Qt Widgets
- C++ Classes
- QStyleOptionProgressBar
- Qt 6.4.1 Reference Documentation

# QStyleOptionProgressBar Class

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

Header: | #include <QStyleOptionProgressBar>
CMake: | find_package(Qt6 REQUIRED COMPONENTS Widgets) target_link_libraries(mytarget PRIVATE Qt6::Widgets)
qmake: | QT += widgets
Inherits: | QStyleOption

- List of all members, including inherited members

## Public Types

enum | StyleOptionType { Type }
enum | StyleOptionVersion { Version }

## Public Functions

| QStyleOptionProgressBar(const QStyleOptionProgressBar &other)
| QStyleOptionProgressBar()

## Public Variables

bool | bottomToTop
bool | invertedAppearance
int | maximum
int | minimum
int | progress
QString | text
Qt::Alignment | textAlignment
bool | textVisible

## Detailed Description

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

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.

For performance reasons, there are few member functions and the access to the member variables is direct (i.e., using the `.` or `->` operator). This 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 Styles example.

See also QStyleOption.

## Member Type Documentation

### enum QStyleOptionProgressBar::StyleOptionType

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

Constant | Value | Description
--- | --- | ---
`QStyleOptionProgressBar::Type` | `SO_ProgressBar` | 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.

### enum QStyleOptionProgressBar::StyleOptionVersion

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

Constant | Value | Description
--- | --- | ---
`QStyleOptionProgressBar::Version` | `1` | 2

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.

## Member Function Documentation

### QStyleOptionProgressBar::QStyleOptionProgressBar(const QStyleOptionProgressBar &other)

Constructs a copy of the other style option.

### QStyleOptionProgressBar::QStyleOptionProgressBar()

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

## Member Variable Documentation

### bool QStyleOptionProgressBar::bottomToTop

This variable holds whether the text reads from bottom to top when the progress bar is vertical

The default value is false.

See also QProgressBar::textDirection.

### bool QStyleOptionProgressBar::invertedAppearance

This variable holds whether the progress bar's appearance is inverted

The default value is false.

See also QProgressBar::invertedAppearance.

### int QStyleOptionProgressBar::maximum

This variable holds 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.

### int QStyleOptionProgressBar::minimum

This variable holds 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.

### int QStyleOptionProgressBar::progress

This variable holds 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.

### QString QStyleOptionProgressBar::text

This variable holds 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.

### Qt::Alignment QStyleOptionProgressBar::textAlignment

This variable holds 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.

### bool QStyleOptionProgressBar::textVisible

This variable holds 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.