QtGui.QStyleOptionProgressBar Class Reference

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

Inheritance diagram for QtGui.QStyleOptionProgressBar:

Collaboration diagram for QtGui.QStyleOptionProgressBar:

Public Types
enum	StyleOptionType { Type = 6 }
	More...
enum	StyleOptionVersion { Version = 1 }
	More...
Public Types inherited from QtGui.QStyleOption
enum	OptionType {   SO_Button = 2, SO_ComboBox = 983044, SO_Complex = 983040, SO_ComplexCustomBase = 251658240,   SO_CustomBase = 3840, SO_Default = 0, SO_DockWidget = 10, SO_FocusRect = 1,   SO_Frame = 5, SO_GraphicsItem = 17, SO_GroupBox = 983047, SO_Header = 8,   SO_MenuItem = 4, SO_ProgressBar = 6, SO_Q3DockWindow = 9, SO_Q3ListView = 983045,   SO_Q3ListViewItem = 11, SO_RubberBand = 15, SO_SizeGrip = 983048, SO_Slider = 983041,   SO_SpinBox = 983042, SO_Tab = 3, SO_TabBarBase = 14, SO_TabWidgetFrame = 13,   SO_TitleBar = 983046, SO_ToolBar = 16, SO_ToolBox = 7, SO_ToolButton = 983043,   SO_ViewItem = 12 }
	More...
enum	StyleOptionType { Type = 0 }
	More...
enum	StyleOptionVersion { Version = 1 }
	More...

Public Member Functions
	QStyleOptionProgressBar ()
	QStyleOptionProgressBar (QStyleOptionProgressBar other)
override void	CreateProxy ()
new void	Dispose ()
Public Member Functions inherited from QtGui.QStyleOption
	QStyleOption (QStyleOption other)
	QStyleOption (int version=(int) QStyleOption.StyleOptionVersion.Version, int type=(int) QStyleOption.OptionType.SO_Default)
new void	Init (QWidget w)
new void	InitFrom (QWidget w)
new void	Dispose ()

Protected Member Functions
	QStyleOptionProgressBar (System.Type dummy)
	QStyleOptionProgressBar (int version)
Protected Member Functions inherited from QtGui.QStyleOption
	QStyleOption (System.Type dummy)

Properties
new int	Maximum [get, set]
new int	Minimum [get, set]
new int	Progress [get, set]
new string	Text [get, set]
new Qt.AlignmentFlag	TextAlignment [get, set]
new bool	TextVisible [get, set]
Properties inherited from QtGui.QStyleOption
virtual System.IntPtr	SmokeObject [get, set]
new Qt.LayoutDirection	Direction [get, set]
new QFontMetrics	FontMetrics [get, set]
new QPalette	Palette [get, set]
new QRect	Rect [get, set]
new QStyle.StateFlag	State [get, set]
new int	Type [get, set]
new int	Version [get, set]

Additional Inherited Members
Protected Attributes inherited from QtGui.QStyleOption
SmokeInvocation	interceptor

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

See also QStyleOptionProgressBarV2 and QStyleOption.

Member Enumeration Documentation

enum QtGui.QStyleOptionProgressBar.StyleOptionType

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

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	The type of style option provided (SO_ProgressBar for this class).

enum QtGui.QStyleOptionProgressBar.StyleOptionVersion

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

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

1

Constructor & Destructor Documentation

QtGui.QStyleOptionProgressBar.QStyleOptionProgressBar ( System.Type  dummy )

protected

QtGui.QStyleOptionProgressBar.QStyleOptionProgressBar

(

)

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

QtGui.QStyleOptionProgressBar.QStyleOptionProgressBar

(

QStyleOptionProgressBar

other

)

Constructs a copy of the other style option.

QtGui.QStyleOptionProgressBar.QStyleOptionProgressBar ( int  version )

protected

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

Member Function Documentation

override void QtGui.QStyleOptionProgressBar.CreateProxy ( )

virtual

Reimplemented from QtGui.QStyleOption.

Reimplemented in QtGui.QStyleOptionProgressBarV2.

new void QtGui.QStyleOptionProgressBar.Dispose

(

)

Property Documentation

new int QtGui.QStyleOptionProgressBar.Maximum

getset

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.

new int QtGui.QStyleOptionProgressBar.Minimum

getset

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.

new int QtGui.QStyleOptionProgressBar.Progress

getset

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.

new string QtGui.QStyleOptionProgressBar.Text

getset

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.

new Qt.AlignmentFlag QtGui.QStyleOptionProgressBar.TextAlignment

getset

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.

new bool QtGui.QStyleOptionProgressBar.TextVisible

getset

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.