Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QStyleOptionFocusRect Class Reference

\variable QStyleOption::palette More...

#include <qstyleoption.h>

+ Inheritance diagram for QStyleOptionFocusRect:
+ Collaboration diagram for QStyleOptionFocusRect:

Public Types

enum  StyleOptionType { Type = SO_FocusRect }
 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_DockWidget , SO_ViewItem , SO_TabWidgetFrame ,
  SO_TabBarBase , SO_RubberBand , SO_ToolBar , SO_GraphicsItem ,
  SO_Complex = 0xf0000 , SO_Slider , SO_SpinBox , SO_ToolButton ,
  SO_ComboBox , 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 Member Functions

 QStyleOptionFocusRect ()
 Constructs a QStyleOptionFocusRect, initializing the members variables to their default values.
 
 QStyleOptionFocusRect (const QStyleOptionFocusRect &other)
 Constructs a copy of the other style option.
 
QStyleOptionFocusRectoperator= (const QStyleOptionFocusRect &)=default
 
- Public Member Functions inherited from QStyleOption
 QStyleOption (int version=QStyleOption::Version, int type=SO_Default)
 Constructs a QStyleOption with the specified version and type.
 
 QStyleOption (const QStyleOption &other)
 Constructs a copy of other.
 
 ~QStyleOption ()
 Destroys this style option object.
 
void initFrom (const QWidget *w)
 
QStyleOptionoperator= (const QStyleOption &other)
 Assign other to this QStyleOption.
 

Public Attributes

QColor backgroundColor
 
- Public Attributes inherited from QStyleOption
int version
 
int type
 
QStyle::State state
 
Qt::LayoutDirection direction
 
QRect rect
 
QFontMetrics fontMetrics
 
QPalette palette
 
QObjectstyleObject
 

Protected Member Functions

 QStyleOptionFocusRect (int version)
 

Additional Inherited Members

Detailed Description

\variable QStyleOption::palette

the palette that should be used when painting the control

By default, the application's default palette is used.

See also
initFrom()

\variable QStyleOption::direction

the text layout direction that should be used when drawing text in the control

By default, the layout direction is Qt::LeftToRight.

See also
initFrom()

\variable QStyleOption::fontMetrics

the font metrics that should be used when drawing text in the control

By default, the application's default font is used.

See also
initFrom()

\variable QStyleOption::styleObject

the object being styled

The built-in styles support the following types: QWidget, QGraphicsObject and QQuickItem.

See also
initFrom()

\variable QStyleOption::rect

the area that should be used for various calculations and painting

This can have different meanings for different types of elements. For example, for a \l QStyle::CE_PushButton element it would be the rectangle for the entire button, while for a \l QStyle::CE_PushButtonLabel element it would be just the area for the push button label.

The default value is a null rectangle, i.e. a rectangle with both the width and the height set to 0.

See also
initFrom()

\variable QStyleOption::state

the style flags that are used when drawing the control

The default value is QStyle::State_None.

See also
initFrom(), QStyle::drawPrimitive(), QStyle::drawControl(), QStyle::drawComplexControl(), QStyle::State

\variable QStyleOption::type

the option type of the style option

The default value is SO_Default.

See also
OptionType

\variable QStyleOption::version

the version of the style option

This value can be used by subclasses to implement extensions without breaking compatibility. If you use the qstyleoption_cast() function, you normally do not need to check it.

The default value is 1.

The QStyleOptionFocusRect class is used to describe the parameters for drawing a focus rectangle with QStyle.

\inmodule QtWidgets

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

See also
QStyleOption

Definition at line 74 of file qstyleoption.h.

Member Enumeration Documentation

◆ StyleOptionType

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

\value Type The type of style option provided (\l{SO_FocusRect} 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
Enumerator
Type 

Definition at line 77 of file qstyleoption.h.

◆ StyleOptionVersion

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

\value Version 1

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 78 of file qstyleoption.h.

Constructor & Destructor Documentation

◆ QStyleOptionFocusRect() [1/3]

QStyleOptionFocusRect::QStyleOptionFocusRect ( )

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

Definition at line 337 of file qstyleoption.cpp.

◆ QStyleOptionFocusRect() [2/3]

QStyleOptionFocusRect::QStyleOptionFocusRect ( const QStyleOptionFocusRect & other)
inline

Constructs a copy of the other style option.

Definition at line 83 of file qstyleoption.h.

References other().

+ Here is the call graph for this function:

◆ QStyleOptionFocusRect() [3/3]

QStyleOptionFocusRect::QStyleOptionFocusRect ( int version)
protected

Definition at line 345 of file qstyleoption.cpp.

References QStyleOption::state, and QStyle::State_KeyboardFocusChange.

Member Function Documentation

◆ operator=()

QStyleOptionFocusRect & QStyleOptionFocusRect::operator= ( const QStyleOptionFocusRect & )
default

Member Data Documentation

◆ backgroundColor

QColor QStyleOptionFocusRect::backgroundColor

Definition at line 80 of file qstyleoption.h.


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