QStyleOptionToolBar Class Reference

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionToolBar:

Inheritance graph
[legend]
Collaboration diagram for QStyleOptionToolBar:

Collaboration graph
[legend]
List of all members.

Detailed Description

a bitwise OR of the features that describe this buttonthe text of the buttonthe icon of the buttonthe size of the icon for the buttonThe QStyleOptionToolBar class is used to describe the parameters for drawing a toolbar.

Since:
4.1
QStyleOptionToolBar contains all the information that QStyle functions need to draw QToolBar.

For performance reasons, the access to the member variables is direct (i.e., using the . or -> operator). This low-level feel makes the structures straightforward to use and emphasizes that these are simply parameters used by the style functions.

The QStyleOptionToolBar class holds the lineWidth and the midLineWidth for drawing the widget. It also stores information about which {toolBarArea}{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 a couple of enums: The ToolBarFeature enum is used to describe whether a toolbar is movable or not, and the ToolBarPosition enum is used to describe the position of a toolbar line, as well as the toolbar's position within the line.

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

See also:
QStyleOption

Definition at line 274 of file qstyleoption.h.

Public Types

enum  StyleOptionType
enum  StyleOptionVersion
enum  ToolBarPosition
enum  ToolBarFeature

Public Member Functions

 QStyleOptionToolBar ()
 QStyleOptionToolBar (const QStyleOptionToolBar &other)

Public Attributes

ToolBarPosition positionOfLine
ToolBarPosition positionWithinLine
Qt::ToolBarArea toolBarArea
ToolBarFeatures features
int lineWidth
int midLineWidth

Protected Member Functions

 QStyleOptionToolBar (int version)


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.

Type The type of style option provided ({SO_ToolBar} 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

Reimplemented from QStyleOption.

Definition at line 277 of file qstyleoption.h.

00277 { Type = SO_ToolBar };

enum QStyleOptionToolBar::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 don't need to check it.

See also:
StyleOptionType

Reimplemented from QStyleOption.

Definition at line 278 of file qstyleoption.h.

00278 { Version = 1 };

enum QStyleOptionToolBar::ToolBarPosition

This enum is used to describe the position of a toolbar line, as well as the toolbar's position within the line.

The order of the positions within a line starts at the top of a vertical line, and from the left within a horizontal line. The order of the positions for the lines is always from the the parent widget's boundary edges.

Beginning The 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. Middle The 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. End The 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. OnlyOne There is only one toolbar or line. This is the default value of the positionOfLine and positionWithinLine variables.

See also:
positionWithinLine, positionOfLine

Definition at line 279 of file qstyleoption.h.

00279 { Beginning, Middle, End, OnlyOne };

enum QStyleOptionToolBar::ToolBarFeature

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

None The toolbar cannot be moved. The default value. Movable The toolbar is movable, and a handle will appear when holding the cursor over the toolbar's boundary.

See also:
features, QToolBar::isMovable()

Definition at line 280 of file qstyleoption.h.

00280 { None = 0x0, Movable = 0x1 };


Constructor & Destructor Documentation

QStyleOptionToolBar::QStyleOptionToolBar (  ) 

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

Definition at line 1237 of file qstyleoption.cpp.

QStyleOptionToolBar::QStyleOptionToolBar ( const QStyleOptionToolBar other  )  [inline]

Constructs a copy of the other style option.

Definition at line 289 of file qstyleoption.h.

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

QStyleOptionToolBar::QStyleOptionToolBar ( int  version  )  [protected]

Definition at line 1252 of file qstyleoption.cpp.


Member Data Documentation

ToolBarPosition QStyleOptionToolBar::positionOfLine

Definition at line 282 of file qstyleoption.h.

Referenced by getStyleOption().

ToolBarPosition QStyleOptionToolBar::positionWithinLine

Definition at line 283 of file qstyleoption.h.

Referenced by getStyleOption().

Qt::ToolBarArea QStyleOptionToolBar::toolBarArea

Definition at line 284 of file qstyleoption.h.

Referenced by getStyleOption().

ToolBarFeatures QStyleOptionToolBar::features

Definition at line 285 of file qstyleoption.h.

Referenced by getStyleOption().

int QStyleOptionToolBar::lineWidth

Definition at line 286 of file qstyleoption.h.

Referenced by getStyleOption().

int QStyleOptionToolBar::midLineWidth

Definition at line 287 of file qstyleoption.h.


The documentation for this class was generated from the following files:
Generated on Thu Mar 15 19:10:58 2007 for Qt 4.2 User's Guide by  doxygen 1.5.1