CopperSpice API  1.9.2
Public Types | Public Methods | Public Members | List of all members
QStyleOptionProgressBar Class Reference
CsGui

Describes the parameters used for drawing a progress bar. More...

Inheritance diagram for QStyleOptionProgressBar:
QStyleOption

Public Types

enum  StyleOptionType
 
enum  StyleOptionVersion
 
- Public Types inherited from QStyleOption
enum  OptionType
 
enum  StyleOptionType
 
enum  StyleOptionVersion
 

Public Methods

 QStyleOptionProgressBar ()
 
 QStyleOptionProgressBar (const QStyleOptionProgressBar &other)
 
QStyleOptionProgressBar & operator= (const QStyleOptionProgressBar &other) = default
 
- Public Methods inherited from QStyleOption
 QStyleOption (const QStyleOption &other)
 
 QStyleOption (int version=QStyleOption::Version, int type=SO_Default)
 
 ~QStyleOption ()
 
void initFrom (const QWidget *widget)
 
QStyleOption & operator= (const QStyleOption &other)
 

Public Members

bool bottomToTop
 
bool invertedAppearance
 
int maximum
 
int minimum
 
int progress
 
QString text
 
Qt::Alignment textAlignment
 
bool textVisible
 
- Public Members inherited from QStyleOption
int type
 
int version
 

Additional Inherited Members

- Related Functions inherited from QStyleOption
T qstyleoption_cast (const QStyleOption *option)
 
T qstyleoption_cast (QStyleOption *option)
 

Detailed Description

The QStyleOptionProgressBar class is used to describe the parameters necessary for drawing a progress bar. 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.

See also
QStyleOption

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

ConstantValueDescription
QStyleOptionProgressBar::Type SO_ProgressBarThe 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.

ConstantValueDescription
QStyleOptionProgressBar::Version 2 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

Constructor & Destructor Documentation

QStyleOptionProgressBar::QStyleOptionProgressBar ( )

Constructs an empty QStyleOptionProgressBar.

QStyleOptionProgressBar::QStyleOptionProgressBar ( const QStyleOptionProgressBar &  other)
inline

Copy constructs a new QStyleOptionProgressBar from other.

Method Documentation

QStyleOptionProgressBar & QStyleOptionProgressBar::operator= ( const QStyleOptionProgressBar &  other)
default

Copy assigns from other and returns a reference to this object.

Member Data 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 has not 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