Qt 4.8
Public Types | Public Functions | Public Variables | Protected Functions | List of all members
QStyleOptionFrameV2 Class Reference

The QStyleOptionFrameV2 class is used to describe the parameters necessary for drawing a frame in Qt 4.1 or above. More...

#include <qstyleoption.h>

Inheritance diagram for QStyleOptionFrameV2:
QStyleOptionFrame QStyleOption QStyleOptionFrameV3

Public Types

enum  FrameFeature { None = 0x00, Flat = 0x01 }
 This enum describes the different types of features a frame can have. More...
 
enum  StyleOptionVersion { Version = 2 }
 This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
 
- Public Types inherited from QStyleOptionFrame
enum  StyleOptionType { Type = SO_Frame }
 This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass. More...
 
enum  StyleOptionVersion { Version = 1 }
 This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
 
- Public Types inherited from QStyleOption
enum  OptionType {
  SO_Default, SO_FocusRect, SO_Button, SO_Tab,
  SO_MenuItem, SO_Frame, SO_ProgressBar, SO_ToolBox,
  SO_Header, SO_Q3DockWindow, SO_DockWidget, SO_Q3ListViewItem,
  SO_ViewItem, SO_TabWidgetFrame, SO_TabBarBase, SO_RubberBand,
  SO_ToolBar, SO_GraphicsItem, SO_Complex = 0xf0000, SO_Slider,
  SO_SpinBox, SO_ToolButton, SO_ComboBox, SO_Q3ListView,
  SO_TitleBar, SO_GroupBox, SO_SizeGrip, SO_CustomBase = 0xf00,
  SO_ComplexCustomBase = 0xf000000
}
 This enum is used internally by QStyleOption, its subclasses, and qstyleoption_cast() to determine the type of style option. More...
 
enum  StyleOptionType { Type = SO_Default }
 This enum is used to hold information about the type of the style option, and is defined for each QStyleOption subclass. More...
 
enum  StyleOptionVersion { Version = 1 }
 This enum is used to hold information about the version of the style option, and is defined for each QStyleOption subclass. More...
 

Public Functions

QStyleOptionFrameV2operator= (const QStyleOptionFrame &other)
 Assigns the other style option to this style option. More...
 
 QStyleOptionFrameV2 ()
 Constructs a QStyleOptionFrameV2 object. More...
 
 QStyleOptionFrameV2 (const QStyleOptionFrameV2 &other)
 Constructs a QStyleOptionFrameV2 copy of the other style option. More...
 
 QStyleOptionFrameV2 (const QStyleOptionFrame &other)
 Constructs a QStyleOptionFrameV2 copy of the other style option which can be either of the QStyleOptionFrameV2 or QStyleOptionFrame types. More...
 
- Public Functions inherited from QStyleOptionFrame
 QStyleOptionFrame ()
 Constructs a QStyleOptionFrame, initializing the members variables to their default values. More...
 
 QStyleOptionFrame (const QStyleOptionFrame &other)
 Constructs a copy of the other style option. More...
 
- Public Functions inherited from QStyleOption
void init (const QWidget *w)
 Use initFrom(widget) instead. More...
 
void initFrom (const QWidget *w)
 
QStyleOptionoperator= (const QStyleOption &other)
 Assign other to this QStyleOption. More...
 
 QStyleOption (int version=QStyleOption::Version, int type=SO_Default)
 Constructs a QStyleOption with the specified version and type. More...
 
 QStyleOption (const QStyleOption &other)
 Constructs a copy of other. More...
 
 ~QStyleOption ()
 Destroys this style option object. More...
 

Public Variables

FrameFeatures features
 a bitwise OR of the features that describe this frame. More...
 
- Public Variables inherited from QStyleOptionFrame
int lineWidth
 the line width for drawing the frame More...
 
int midLineWidth
 the mid-line width for drawing the frame More...
 
- Public Variables inherited from QStyleOption
Qt::LayoutDirection direction
 the text layout direction that should be used when drawing text in the control More...
 
QFontMetrics fontMetrics
 the font metrics that should be used when drawing text in the control More...
 
QPalette palette
 the palette that should be used when painting the control More...
 
QRect rect
 the area that should be used for various calculations and painting More...
 
QStyle::State state
 the style flags that are used when drawing the control More...
 
int type
 the option type of the style option More...
 
int version
 the version of the style option More...
 

Protected Functions

 QStyleOptionFrameV2 (int version)
 
- Protected Functions inherited from QStyleOptionFrame
 QStyleOptionFrame (int version)
 

Additional Inherited Members

Detailed Description

The QStyleOptionFrameV2 class is used to describe the parameters necessary for drawing a frame in Qt 4.1 or above.

Since
4.1

QStyleOptionFrameV2 inherits QStyleOptionFrame which is used for drawing several built-in Qt widgets, including QFrame, QGroupBox, QLineEdit, and QMenu.

An instance of the QStyleOptionFrameV2 class has type SO_Frame 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.

If you create your own QStyle subclass, you should handle both QStyleOptionFrame and QStyleOptionFrameV2. One way to achieve this is to use the QStyleOptionFrameV2 copy constructor. For example:

if (const QStyleOptionFrame *frameOption =
qstyleoption_cast<const QStyleOptionFrame *>(option)) {
QStyleOptionFrameV2 frameOptionV2(*frameOption);
// draw the frame using frameOptionV2
}

In the example above: If the frameOption's version is 1, FrameFeature is set to None for frameOptionV2. If frameOption's version is 2, the constructor will simply copy the frameOption's FrameFeature value.

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

See also
QStyleOptionFrame, QStyleOption

Definition at line 134 of file qstyleoption.h.

Enumerations

◆ FrameFeature

This enum describes the different types of features a frame can have.

  • None Indicates a normal frame.
  • Flat Indicates a flat frame.
Enumerator
None 
Flat 

Definition at line 138 of file qstyleoption.h.

138  {
139  None = 0x00,
140  Flat = 0x01
141  };

◆ StyleOptionVersion

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

  • Version 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
Enumerator
Version 

Definition at line 137 of file qstyleoption.h.

Constructors and Destructors

◆ QStyleOptionFrameV2() [1/4]

QStyleOptionFrameV2::QStyleOptionFrameV2 ( )

Constructs a QStyleOptionFrameV2 object.

Definition at line 664 of file qstyleoption.cpp.

666 {
667 }
QStyleOptionFrame()
Constructs a QStyleOptionFrame, initializing the members variables to their default values...
FrameFeatures features
a bitwise OR of the features that describe this frame.
Definition: qstyleoption.h:143

◆ QStyleOptionFrameV2() [2/4]

QStyleOptionFrameV2::QStyleOptionFrameV2 ( const QStyleOptionFrameV2 other)
inline

Constructs a QStyleOptionFrameV2 copy of the other style option.

Definition at line 146 of file qstyleoption.h.

146 : QStyleOptionFrame(Version) { *this = other; }
QStyleOptionFrame()
Constructs a QStyleOptionFrame, initializing the members variables to their default values...

◆ QStyleOptionFrameV2() [3/4]

QStyleOptionFrameV2::QStyleOptionFrameV2 ( const QStyleOptionFrame other)

Constructs a QStyleOptionFrameV2 copy of the other style option which can be either of the QStyleOptionFrameV2 or QStyleOptionFrame types.

If the other style option's version is 1, the new style option's FrameFeature value is set to QStyleOptionFrameV2::None . If its version is 2, its FrameFeature value is simply copied to the new style option.

See also
version

Definition at line 697 of file qstyleoption.cpp.

698 {
700 
701  const QStyleOptionFrameV2 *f2 = qstyleoption_cast<const QStyleOptionFrameV2 *>(&other);
702  features = f2 ? f2->features : FrameFeatures(QStyleOptionFrameV2::None);
703  version = Version;
704 }
int version
the version of the style option
Definition: qstyleoption.h:86
T qstyleoption_cast(const QStyleOption *option)
Definition: qstyleoption.h:885
QStyleOption & operator=(const QStyleOption &other)
Assign other to this QStyleOption.
FrameFeatures features
a bitwise OR of the features that describe this frame.
Definition: qstyleoption.h:143
The QStyleOptionFrameV2 class is used to describe the parameters necessary for drawing a frame in Qt ...
Definition: qstyleoption.h:134

◆ QStyleOptionFrameV2() [4/4]

QStyleOptionFrameV2::QStyleOptionFrameV2 ( int  version)
protected
Warning
This function is not part of the public interface.

Definition at line 681 of file qstyleoption.cpp.

683 {
684 }
int version
the version of the style option
Definition: qstyleoption.h:86
QStyleOptionFrame()
Constructs a QStyleOptionFrame, initializing the members variables to their default values...
FrameFeatures features
a bitwise OR of the features that describe this frame.
Definition: qstyleoption.h:143

Functions

◆ operator=()

QStyleOptionFrameV2 & QStyleOptionFrameV2::operator= ( const QStyleOptionFrame other)

Assigns the other style option to this style option.

The other style option can be either of the QStyleOptionFrameV2 or QStyleOptionFrame types.

If the {other} style option's version is 1, this style option's FrameFeature value is set to QStyleOptionFrameV2::None . If its version is 2, its FrameFeature value is simply copied to this style option.

Definition at line 716 of file qstyleoption.cpp.

Referenced by QStyleOptionFrameV3::operator=().

717 {
719 
720  const QStyleOptionFrameV2 *f2 = qstyleoption_cast<const QStyleOptionFrameV2 *>(&other);
721  features = f2 ? f2->features : FrameFeatures(QStyleOptionFrameV2::None);
722  version = Version;
723  return *this;
724 }
int version
the version of the style option
Definition: qstyleoption.h:86
T qstyleoption_cast(const QStyleOption *option)
Definition: qstyleoption.h:885
QStyleOption & operator=(const QStyleOption &other)
Assign other to this QStyleOption.
FrameFeatures features
a bitwise OR of the features that describe this frame.
Definition: qstyleoption.h:143
The QStyleOptionFrameV2 class is used to describe the parameters necessary for drawing a frame in Qt ...
Definition: qstyleoption.h:134

Properties

◆ features

QStyleOptionFrameV2::features

The documentation for this class was generated from the following files: