CopperSpice API  2.0.0
Public Types | Public Methods | Public Members | List of all members
QStyleOptionToolBar Class Reference
CsGui

The QStyleOptionToolBar class is used to describe the parameters for drawing a toolbar. More...

Inheritance diagram for QStyleOptionToolBar:
QStyleOption

Public Types

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

Public Methods

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

Public Members

ToolBarFeatures features
 
int lineWidth
 
int midLineWidth
 
ToolBarPosition positionOfLine
 
ToolBarPosition positionWithinLine
 
Qt::ToolBarArea toolBarArea
 
- Public Members inherited from QStyleOption
int m_styleType
 
int m_styleVersion
 

Additional Inherited Members

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

Detailed Description

The QStyleOptionToolBar class is used to describe the parameters for drawing a toolbar. This class contains all the information a QStyle needs to draw a QToolBar.

The QStyleOptionToolBar class holds the lineWidth and the midLineWidth for drawing the widget. It also stores information about which area the toolbar should be located in, whether it is movable or not, which position the toolbar line should have (positionOfLine), and the toolbar's position within the line (positionWithinLine).

In addition the class provides several enums. The ToolBarFeature enum is used to describe whether a toolbar is movable and the ToolBarPosition enum is used to describe the position of a toolbar.

See also
QStyleOption

Member Enumeration Documentation

enum QStyleOptionToolBar::StyleOptionType

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

ConstantValueDescription
QStyleOptionToolBar::Type SO_ToolBar Type of style option for this class
See also
StyleOptionVersion, qstyleoption_cast()
enum QStyleOptionToolBar::StyleOptionVersion

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

ConstantValueDescription
QStyleOptionToolBar::Version 1 1
See also
StyleOptionType, qstyleoption_cast()
enum QStyleOptionToolBar::ToolBarFeature

This enum is used to describe whether a toolbar is movable or not.

ConstantValueDescription
QStyleOptionToolBar::None 0x0 Toolbar can not be moved. The default value.
QStyleOptionToolBar::Movable 0x1 Toolbar is movable and a handle will appear when holding the cursor over the toolbar's boundary.
See also
QToolBar::isMovable(), QStyleOptionToolBar::features
enum QStyleOptionToolBar::ToolBarPosition

This enum is used to describe the position of a toolbar line and the position within the line.

ConstantValueDescription
QStyleOptionToolBar::Beginning 0 Toolbar is located at the beginning of the line or the toolbar line is the first of several lines. There can only be one toolbar (and only one line) with this position.
QStyleOptionToolBar::Middle 1 Toolbar is located in the middle of the line or the toolbar line is in the middle of several lines. There can several toolbars (and lines) with this position.
QStyleOptionToolBar::End 2 Toolbar is located at the end of the line or the toolbar line is the last of several lines. There can only be one toolbar (and only one line) with this position.
QStyleOptionToolBar::OnlyOne 3 There is only one toolbar or line. This is the default value of the positionOfLine and positionWithinLine variables.
See also
positionWithinLine, positionOfLine

Constructor & Destructor Documentation

QStyleOptionToolBar::QStyleOptionToolBar ( )

Constructs an empty QStyleOptionToolBar.

QStyleOptionToolBar::QStyleOptionToolBar ( const QStyleOptionToolBar &  other)
inline

Copy constructs a new QStyleOptionToolBar from other.

Method Documentation

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

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

Member Data Documentation

QStyleOptionToolBar::ToolBarFeatures QStyleOptionToolBar::features

This variable holds whether the toolbar is movable or not. The default value is QStyleOptionToolBar::None.

int QStyleOptionToolBar::lineWidth

This variable holds the line width for drawing the toolbar. The default value is 0.

int QStyleOptionToolBar::midLineWidth

This variable holds the mid-line width for drawing the toolbar. The default value is 0.

QStyleOptionToolBar::ToolBarPosition QStyleOptionToolBar::positionOfLine

This variable holds the position of the toolbar line. The default value is QStyleOptionToolBar::OnlyOne.

QStyleOptionToolBar::ToolBarPosition QStyleOptionToolBar::positionWithinLine

This variable holds the position of the toolbar within a line. The default value is QStyleOptionToolBar::OnlyOne.

Qt::ToolBarArea QStyleOptionToolBar::toolBarArea

This variable holds the location for drawing the toolbar. The default value is Qt::TopToolBarArea.

See also
Qt::ToolBarArea