1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#include "qstyle.h"
5#include "qapplication.h"
6#include "qpainter.h"
7#include "qwidget.h"
8#include "qbitmap.h"
9#include "qpixmapcache.h"
10#include "qset.h"
11#include "qstyleoption.h"
12#include "private/qstyle_p.h"
13#include "private/qstylehelper_p.h"
14#include "private/qguiapplication_p.h"
15#include <qpa/qplatformtheme.h>
16#ifndef QT_NO_DEBUG
17#include "qdebug.h"
18#endif
19#include <QtCore/q20utility.h>
20
21#include <limits.h>
22#include <algorithm>
23
24QT_BEGIN_NAMESPACE
25
26static const int MaxBits = 8 * sizeof(QSizePolicy::ControlType);
27
28static int unpackControlTypes(QSizePolicy::ControlTypes controls, QSizePolicy::ControlType *array)
29{
30 if (!controls)
31 return 0;
32
33 // optimization: exactly one bit is set
34 if (qPopulationCount(v: uint(controls)) == 1) {
35 array[0] = QSizePolicy::ControlType(uint(controls));
36 return 1;
37 }
38
39 int count = 0;
40 for (int i = 0; i < MaxBits; ++i) {
41 if (uint bit = (controls & (0x1 << i)))
42 array[count++] = QSizePolicy::ControlType(bit);
43 }
44 return count;
45}
46
47/*!
48 \page qwidget-styling.html
49 \title Styling
50
51 Qt's built-in widgets use the QStyle class to perform nearly all
52 of their drawing. QStyle is an abstract base class that
53 encapsulates the look and feel of a GUI, and can be used to make
54 the widgets look exactly like the equivalent native widgets or to
55 give the widgets a custom look.
56
57 Qt provides a set of QStyle subclasses that emulate the native
58 look of the different platforms supported by Qt (QWindowsStyle,
59 QMacStyle, etc.). These styles are built into the
60 Qt GUI module, other styles can be made available using Qt's
61 plugin mechanism.
62
63 Most functions for drawing style elements take four arguments:
64
65 \list
66 \li an enum value specifying which graphical element to draw
67 \li a QStyleOption object specifying how and where to render that element
68 \li a QPainter object that should be used to draw the element
69 \li a QWidget object on which the drawing is performed (optional)
70 \endlist
71
72 The style gets all the information it needs to render the
73 graphical element from the QStyleOption class. The widget is
74 passed as the last argument in case the style needs it to perform
75 special effects (such as animated default buttons on \macos),
76 but it isn't mandatory. In fact, QStyle can be used to draw on any
77 paint device (not just widgets), in which case the widget argument
78 is a zero pointer.
79
80 \image paintsystem-stylepainter.png
81
82 The paint system also provides the QStylePainter class inheriting
83 from QPainter. QStylePainter is a convenience class for drawing
84 QStyle elements inside a widget, and extends QPainter with a set
85 of high-level drawing functions implemented on top of QStyle's
86 API. The advantage of using QStylePainter is that the parameter
87 lists get considerably shorter.
88
89 \table 100%
90 \row
91 \li \inlineimage paintsystem-icon.png
92 \li \b QIcon
93
94 The QIcon class provides scalable icons in different modes and states.
95
96 QIcon can generate pixmaps reflecting an icon's state, mode and
97 size. These pixmaps are generated from the set of pixmaps
98 made available to the icon, and are used by Qt widgets to show an
99 icon representing a particular action.
100
101 The rendering of a QIcon object is handled by the QIconEngine
102 class. Each icon has a corresponding icon engine that is
103 responsible for drawing the icon with a requested size, mode and
104 state.
105
106 \endtable
107
108 For more information about widget styling and appearance, see the
109 \l{Styles and Style Aware Widgets}.
110*/
111
112
113/*!
114 \class QStyle
115 \brief The QStyle class is an abstract base class that encapsulates the look and feel of a GUI.
116
117 \ingroup appearance
118 \inmodule QtWidgets
119
120 Qt contains a set of QStyle subclasses that emulate the styles of
121 the different platforms supported by Qt (QWindowsStyle,
122 QMacStyle etc.). By default, these styles are built
123 into the Qt GUI module. Styles can also be made available as
124 plugins.
125
126 Qt's built-in widgets use QStyle to perform nearly all of their
127 drawing, ensuring that they look exactly like the equivalent
128 native widgets. The diagram below shows a QComboBox in nine
129 different styles.
130
131 \image qstyle-comboboxes.png Nine combo boxes
132
133 Topics:
134
135 \section1 Setting a Style
136
137 The style of the entire application can be set using the
138 QApplication::setStyle() function. It can also be specified by the
139 user of the application, using the \c -style command-line option:
140
141 \snippet code/src_gui_styles_qstyle.cpp 0
142
143 If no style is specified, Qt will choose the most appropriate
144 style for the user's platform or desktop environment.
145
146 A style can also be set on an individual widget using the
147 QWidget::setStyle() function.
148
149 \section1 Developing Style-Aware Custom Widgets
150
151 If you are developing custom widgets and want them to look good on
152 all platforms, you can use QStyle functions to perform parts of
153 the widget drawing, such as drawItemText(), drawItemPixmap(),
154 drawPrimitive(), drawControl(), and drawComplexControl().
155
156 Most QStyle draw functions take four arguments:
157 \list
158 \li an enum value specifying which graphical element to draw
159 \li a QStyleOption specifying how and where to render that element
160 \li a QPainter that should be used to draw the element
161 \li a QWidget on which the drawing is performed (optional)
162 \endlist
163
164 For example, if you want to draw a focus rectangle on your
165 widget, you can write:
166
167 \snippet styles/styles.cpp 1
168
169 QStyle gets all the information it needs to render the graphical
170 element from QStyleOption. The widget is passed as the last
171 argument in case the style needs it to perform special effects
172 (such as animated default buttons on \macos), but it isn't
173 mandatory. In fact, you can use QStyle to draw on any paint
174 device, not just widgets, by setting the QPainter properly.
175
176 QStyleOption has various subclasses for the various types of
177 graphical elements that can be drawn. For example,
178 PE_FrameFocusRect expects a QStyleOptionFocusRect argument.
179
180 To ensure that drawing operations are as fast as possible,
181 QStyleOption and its subclasses have public data members. See the
182 QStyleOption class documentation for details on how to use it.
183
184 For convenience, Qt provides the QStylePainter class, which
185 combines a QStyle, a QPainter, and a QWidget. This makes it
186 possible to write
187
188 \snippet styles/styles.cpp 5
189 \dots
190 \snippet styles/styles.cpp 7
191
192 instead of
193
194 \snippet styles/styles.cpp 2
195 \dots
196 \snippet styles/styles.cpp 3
197
198 \section1 Creating a Custom Style
199
200 You can create a custom look and feel for your application by
201 creating a custom style. There are two approaches to creating a
202 custom style. In the static approach, you either choose an
203 existing QStyle class, subclass it, and reimplement virtual
204 functions to provide the custom behavior, or you create an entire
205 QStyle class from scratch. In the dynamic approach, you modify the
206 behavior of your system style at runtime. The static approach is
207 described below. The dynamic approach is described in QProxyStyle.
208
209 The first step in the static approach is to pick one of the styles
210 provided by Qt from which you will build your custom style. Your
211 choice of QStyle class will depend on which style resembles your
212 desired style the most. The most general class that you can use as
213 a base is QCommonStyle (not QStyle). This is because Qt requires
214 its styles to be \l{QCommonStyle}s.
215
216 Depending on which parts of the base style you want to change,
217 you must reimplement the functions that are used to draw those
218 parts of the interface. To illustrate this, we will modify the
219 look of the spin box arrows drawn by QWindowsStyle. The arrows
220 are \e{primitive elements} that are drawn by the drawPrimitive()
221 function, so we need to reimplement that function. We need the
222 following class declaration:
223
224 \snippet customstyle/customstyle.h 0
225
226 To draw its up and down arrows, QSpinBox uses the
227 PE_IndicatorSpinUp and PE_IndicatorSpinDown primitive elements.
228 Here's how to reimplement the drawPrimitive() function to draw
229 them differently:
230
231 \snippet customstyle/customstyle.cpp 2
232 \snippet customstyle/customstyle.cpp 3
233 \snippet customstyle/customstyle.cpp 4
234
235 Notice that we don't use the \c widget argument, except to pass it
236 on to the QWindowStyle::drawPrimitive() function. As mentioned
237 earlier, the information about what is to be drawn and how it
238 should be drawn is specified by a QStyleOption object, so there is
239 no need to ask the widget.
240
241 If you need to use the \c widget argument to obtain additional
242 information, be careful to ensure that it isn't 0 and that it is
243 of the correct type before using it. For example:
244
245 \snippet customstyle/customstyle.cpp 0
246 \dots
247 \snippet customstyle/customstyle.cpp 1
248
249 When implementing a custom style, you cannot assume that the
250 widget is a QSpinBox just because the enum value is called
251 PE_IndicatorSpinUp or PE_IndicatorSpinDown.
252
253 \warning Qt style sheets are currently not supported for custom QStyle
254 subclasses. We plan to address this in some future release.
255
256
257 \section1 Using a Custom Style
258
259 There are several ways of using a custom style in a Qt
260 application. The simplest way is to pass the custom style to the
261 QApplication::setStyle() static function before creating the
262 QApplication object:
263
264 \snippet customstyle/main.cpp using a custom style
265
266 You can call QApplication::setStyle() at any time, but by calling
267 it before the constructor, you ensure that the user's preference,
268 set using the \c -style command-line option, is respected.
269
270 You may want to make your custom style available for use in other
271 applications, which may not be yours and hence not available for
272 you to recompile. The Qt Plugin system makes it possible to create
273 styles as plugins. Styles created as plugins are loaded as shared
274 objects at runtime by Qt itself. Please refer to the \l{How to Create Qt Plugins}{Qt Plugin}
275 documentation for more information on how to go about creating a style
276 plugin.
277
278 Compile your plugin and put it into Qt's \c plugins/styles
279 directory. We now have a pluggable style that Qt can load
280 automatically. To use your new style with existing applications,
281 simply start the application with the following argument:
282
283 \snippet code/src_gui_styles_qstyle.cpp 1
284
285 The application will use the look and feel from the custom style you
286 implemented.
287
288 \section1 Right-to-Left Desktops
289
290 Languages written from right to left (such as Arabic and Hebrew)
291 usually also mirror the whole layout of widgets, and require the
292 light to come from the screen's top-right corner instead of
293 top-left.
294
295 If you create a custom style, you should take special care when
296 drawing asymmetric elements to make sure that they also look
297 correct in a mirrored layout. An easy way to test your styles is
298 to run applications with the \c -reverse command-line option or
299 to call QApplication::setLayoutDirection() in your \c main()
300 function.
301
302 Here are some things to keep in mind when making a style work well in a
303 right-to-left environment:
304
305 \list
306 \li subControlRect() and subElementRect() return rectangles in screen coordinates
307 \li QStyleOption::direction indicates in which direction the item should be drawn in
308 \li If a style is not right-to-left aware it will display items as if it were left-to-right
309 \li visualRect(), visualPos(), and visualAlignment() are helpful functions that will
310 translate from logical to screen representations.
311 \li alignedRect() will return a logical rect aligned for the current direction
312 \endlist
313
314 \section1 Styles in Item Views
315
316 The painting of items in views is performed by a delegate. Qt's
317 default delegate, QStyledItemDelegate, is also used for calculating bounding
318 rectangles of items, and their sub-elements for the various kind
319 of item \l{Qt::ItemDataRole}{data roles}
320 QStyledItemDelegate supports. See the QStyledItemDelegate class
321 description to find out which datatypes and roles are supported. You
322 can read more about item data roles in \l{Model/View Programming}.
323
324 When QStyledItemDelegate paints its items, it draws
325 CE_ItemViewItem, and calculates their size with CT_ItemViewItem.
326 Note also that it uses SE_ItemViewItemText to set the size of
327 editors. When implementing a style to customize drawing of item
328 views, you need to check the implementation of QCommonStyle (and
329 any other subclasses from which your style
330 inherits). This way, you find out which and how
331 other style elements are painted, and you can then reimplement the
332 painting of elements that should be drawn differently.
333
334 We include a small example where we customize the drawing of item
335 backgrounds.
336
337 \snippet customviewstyle/customviewstyle.cpp 0
338
339 The primitive element PE_PanelItemViewItem is responsible for
340 painting the background of items, and is called from
341 \l{QCommonStyle}'s implementation of CE_ItemViewItem.
342
343 To add support for drawing of new datatypes and item data roles,
344 it is necessary to create a custom delegate. But if you only
345 need to support the datatypes implemented by the default
346 delegate, a custom style does not need an accompanying
347 delegate. The QStyledItemDelegate class description gives more
348 information on custom delegates.
349
350 The drawing of item view headers is also done by the style, giving
351 control over size of header items and row and column sizes.
352
353 \sa QStyleOption, QStylePainter,
354 {Styles and Style Aware Widgets}, QStyledItemDelegate, {Styling}
355*/
356
357/*!
358 Constructs a style object.
359*/
360QStyle::QStyle()
361 : QObject(*new QStylePrivate)
362{
363 Q_D(QStyle);
364 d->proxyStyle = this;
365}
366
367/*!
368 \internal
369
370 Constructs a style object.
371*/
372QStyle::QStyle(QStylePrivate &dd)
373 : QObject(dd)
374{
375 Q_D(QStyle);
376 d->proxyStyle = this;
377 Q_STATIC_ASSERT_X(int(StandardPixmap::NStandardPixmap) ==
378 int(QPlatformTheme::StandardPixmap::NStandardPixmap),
379 "StandardPixmap in QPlatformTheme and QStyle out of sync");
380}
381
382/*!
383 Destroys the style object.
384*/
385QStyle::~QStyle()
386{
387}
388
389/*!
390 Returns the name of the style.
391
392 This value can be used to create a style with QStyleFactory::create().
393
394 \sa QStyleFactory::create()
395 \since 6.1
396*/
397QString QStyle::name() const
398{
399 Q_D(const QStyle);
400 return d->name;
401}
402
403/*!
404 \internal
405 Set the style name
406*/
407void QStyle::setName(const QString &name)
408{
409 Q_D(QStyle);
410 d->name = name;
411}
412
413/*!
414 Initializes the appearance of the given \a widget.
415
416 This function is called for every widget at some point after it
417 has been fully created but just \e before it is shown for the very
418 first time.
419
420 Note that the default implementation does nothing. Reasonable
421 actions in this function might be to call the
422 QWidget::setBackgroundMode() function for the widget. Do not use
423 the function to set, for example, the geometry. Reimplementing
424 this function provides a back-door through which the appearance
425 of a widget can be changed, but with Qt's style engine it is
426 rarely necessary to implement this function; reimplement
427 drawItemPixmap(), drawItemText(), drawPrimitive(), etc. instead.
428
429 The QWidget::inherits() function may provide enough information to
430 allow class-specific customizations. But because new QStyle
431 subclasses are expected to work reasonably with all current and \e
432 future widgets, limited use of hard-coded customization is
433 recommended.
434
435 \sa unpolish()
436*/
437void QStyle::polish(QWidget * /* widget */)
438{
439}
440
441/*!
442 Uninitialize the given \a{widget}'s appearance.
443
444 This function is the counterpart to polish(). It is called for
445 every polished widget whenever the style is dynamically changed;
446 the former style has to unpolish its settings before the new style
447 can polish them again.
448
449 Note that unpolish() will only be called if the widget is
450 destroyed. This can cause problems in some cases, e.g, if you
451 remove a widget from the UI, cache it, and then reinsert it after
452 the style has changed; some of Qt's classes cache their widgets.
453
454 \sa polish()
455*/
456void QStyle::unpolish(QWidget * /* widget */)
457{
458}
459
460/*!
461 \fn void QStyle::polish(QApplication * application)
462 \overload
463
464 Late initialization of the given \a application object.
465*/
466void QStyle::polish(QApplication * /* app */)
467{
468}
469
470/*!
471 \fn void QStyle::unpolish(QApplication * application)
472 \overload
473
474 Uninitialize the given \a application.
475*/
476void QStyle::unpolish(QApplication * /* app */)
477{
478}
479
480/*!
481 \fn void QStyle::polish(QPalette & palette)
482 \overload
483
484 Changes the \a palette according to style specific requirements
485 for color palettes (if any).
486
487 \sa QPalette, QApplication::setPalette()
488*/
489void QStyle::polish(QPalette & /* pal */)
490{
491}
492
493/*!
494 \fn QRect QStyle::itemTextRect(const QFontMetrics &metrics, const QRect &rectangle, int alignment, bool enabled, const QString &text) const
495
496 Returns the area within the given \a rectangle in which to draw
497 the provided \a text according to the specified font \a metrics
498 and \a alignment. The \a enabled parameter indicates whether or
499 not the associated item is enabled.
500
501 If the given \a rectangle is larger than the area needed to render
502 the \a text, the rectangle that is returned will be offset within
503 \a rectangle according to the specified \a alignment. For
504 example, if \a alignment is Qt::AlignCenter, the returned
505 rectangle will be centered within \a rectangle. If the given \a
506 rectangle is smaller than the area needed, the returned rectangle
507 will be the smallest rectangle large enough to render the \a text.
508
509 \sa Qt::Alignment
510*/
511QRect QStyle::itemTextRect(const QFontMetrics &metrics, const QRect &rect, int alignment, bool enabled,
512 const QString &text) const
513{
514 QRect result;
515 int x, y, w, h;
516 rect.getRect(ax: &x, ay: &y, aw: &w, ah: &h);
517 if (!text.isEmpty()) {
518 result = metrics.boundingRect(x, y, w, h, flags: alignment, text);
519 if (!enabled && proxy()->styleHint(stylehint: SH_EtchDisabledText)) {
520 result.setWidth(result.width()+1);
521 result.setHeight(result.height()+1);
522 }
523 } else {
524 result = QRect(x, y, w, h);
525 }
526 return result;
527}
528
529/*!
530 \fn QRect QStyle::itemPixmapRect(const QRect &rectangle, int alignment, const QPixmap &pixmap) const
531
532 Returns the area within the given \a rectangle in which to draw
533 the specified \a pixmap according to the defined \a alignment.
534*/
535QRect QStyle::itemPixmapRect(const QRect &rect, int alignment, const QPixmap &pixmap) const
536{
537 QRect result;
538 int x, y, w, h;
539 rect.getRect(ax: &x, ay: &y, aw: &w, ah: &h);
540
541 QSizeF pixmapSize = pixmap.deviceIndependentSize();
542 const int pixmapWidth = pixmapSize.width();
543 const int pixmapHeight = pixmapSize.height();
544
545 if ((alignment & Qt::AlignVCenter) == Qt::AlignVCenter)
546 y += h/2 - pixmapHeight/2;
547 else if ((alignment & Qt::AlignBottom) == Qt::AlignBottom)
548 y += h - pixmapHeight;
549 if ((alignment & Qt::AlignRight) == Qt::AlignRight)
550 x += w - pixmapWidth;
551 else if ((alignment & Qt::AlignHCenter) == Qt::AlignHCenter)
552 x += w/2 - pixmapWidth/2;
553 else if ((alignment & Qt::AlignLeft) != Qt::AlignLeft && QGuiApplication::isRightToLeft())
554 x += w - pixmapWidth;
555 result = QRect(x, y, pixmapWidth, pixmapHeight);
556 return result;
557}
558
559/*!
560 \fn void QStyle::drawItemText(QPainter *painter, const QRect &rectangle, int alignment, const QPalette &palette, bool enabled, const QString& text, QPalette::ColorRole textRole) const
561
562 Draws the given \a text in the specified \a rectangle using the
563 provided \a painter and \a palette.
564
565 The text is drawn using the painter's pen, and aligned and wrapped
566 according to the specified \a alignment. If an explicit \a
567 textRole is specified, the text is drawn using the \a palette's
568 color for the given role. The \a enabled parameter indicates
569 whether or not the item is enabled; when reimplementing this
570 function, the \a enabled parameter should influence how the item is
571 drawn.
572
573 \sa Qt::Alignment, drawItemPixmap()
574*/
575void QStyle::drawItemText(QPainter *painter, const QRect &rect, int alignment, const QPalette &pal,
576 bool enabled, const QString& text, QPalette::ColorRole textRole) const
577{
578 if (text.isEmpty())
579 return;
580 QPen savedPen;
581 if (textRole != QPalette::NoRole) {
582 savedPen = painter->pen();
583 painter->setPen(QPen(pal.brush(cr: textRole), savedPen.widthF()));
584 }
585 if (!enabled) {
586 if (proxy()->styleHint(stylehint: SH_DitherDisabledText)) {
587 QRect br;
588 painter->drawText(r: rect, flags: alignment, text, br: &br);
589 painter->fillRect(br, QBrush(painter->background().color(), Qt::Dense5Pattern));
590 return;
591 } else if (proxy()->styleHint(stylehint: SH_EtchDisabledText)) {
592 QPen pen = painter->pen();
593 painter->setPen(pal.light().color());
594 painter->drawText(r: rect.adjusted(xp1: 1, yp1: 1, xp2: 1, yp2: 1), flags: alignment, text);
595 painter->setPen(pen);
596 }
597 }
598 painter->drawText(r: rect, flags: alignment, text);
599 if (textRole != QPalette::NoRole)
600 painter->setPen(savedPen);
601}
602
603/*!
604 \fn void QStyle::drawItemPixmap(QPainter *painter, const QRect &rectangle, int alignment,
605 const QPixmap &pixmap) const
606
607 Draws the given \a pixmap in the specified \a rectangle, according
608 to the specified \a alignment, using the provided \a painter.
609
610 \sa drawItemText()
611*/
612
613void QStyle::drawItemPixmap(QPainter *painter, const QRect &rect, int alignment,
614 const QPixmap &pixmap) const
615{
616 qreal scale = pixmap.devicePixelRatio();
617 QRect aligned = alignedRect(direction: QGuiApplication::layoutDirection(), alignment: QFlag(alignment), size: pixmap.size() / scale, rectangle: rect);
618 QRect inter = aligned.intersected(other: rect);
619
620 painter->drawPixmap(x: inter.x(), y: inter.y(), pm: pixmap, sx: inter.x() - aligned.x(), sy: inter.y() - aligned.y(), sw: qRound(d: inter.width() * scale), sh: qRound(d: inter.height() *scale));
621}
622
623/*!
624 \enum QStyle::PrimitiveElement
625
626 This enum describes the various primitive elements. A
627 primitive element is a common GUI element, such as a checkbox
628 indicator or button bevel.
629
630 \value PE_PanelButtonCommand Button used to initiate an action, for
631 example, a QPushButton.
632
633 \value PE_FrameDefaultButton This frame around a default button, e.g. in a dialog.
634 \value PE_PanelButtonBevel Generic panel with a button bevel.
635 \value PE_PanelButtonTool Panel for a Tool button, used with QToolButton.
636 \value PE_PanelLineEdit Panel for a QLineEdit.
637 \value PE_IndicatorButtonDropDown Indicator for a drop down button, for example, a tool
638 button that displays a menu.
639
640 \value PE_FrameFocusRect Generic focus indicator.
641
642 \value PE_IndicatorArrowUp Generic Up arrow.
643 \value PE_IndicatorArrowDown Generic Down arrow.
644 \value PE_IndicatorArrowRight Generic Right arrow.
645 \value PE_IndicatorArrowLeft Generic Left arrow.
646
647 \value PE_IndicatorSpinUp Up symbol for a spin widget, for example a QSpinBox.
648 \value PE_IndicatorSpinDown Down symbol for a spin widget.
649 \value PE_IndicatorSpinPlus Increase symbol for a spin widget.
650 \value PE_IndicatorSpinMinus Decrease symbol for a spin widget.
651
652 \value PE_IndicatorItemViewItemCheck On/off indicator for a view item.
653
654 \value PE_IndicatorCheckBox On/off indicator, for example, a QCheckBox.
655 \value PE_IndicatorRadioButton Exclusive on/off indicator, for example, a QRadioButton.
656
657 \value PE_IndicatorDockWidgetResizeHandle Resize handle for dock windows.
658
659 \value PE_Frame Generic frame
660 \value PE_FrameMenu Frame for popup windows/menus; see also QMenu.
661 \value PE_PanelMenuBar Panel for menu bars.
662 \value PE_PanelScrollAreaCorner Panel at the bottom-right (or
663 bottom-left) corner of a scroll area.
664
665 \value PE_FrameDockWidget Panel frame for dock windows and toolbars.
666 \value PE_FrameTabWidget Frame for tab widgets.
667 \value PE_FrameLineEdit Panel frame for line edits.
668 \value PE_FrameGroupBox Panel frame around group boxes.
669 \value PE_FrameButtonBevel Panel frame for a button bevel.
670 \value PE_FrameButtonTool Panel frame for a tool button.
671
672 \value PE_IndicatorHeaderArrow Arrow used to indicate sorting on a list or table
673 header.
674 \value PE_FrameStatusBarItem Frame for an item of a status bar; see also QStatusBar.
675
676 \value PE_FrameWindow Frame around a MDI window or a docking window.
677
678 \value PE_IndicatorMenuCheckMark Check mark used in a menu.
679
680 \value PE_IndicatorProgressChunk Section of a progress bar indicator; see also QProgressBar.
681
682 \value PE_IndicatorBranch Lines used to represent the branch of a tree in a tree view.
683 \value PE_IndicatorToolBarHandle The handle of a toolbar.
684 \value PE_IndicatorToolBarSeparator The separator in a toolbar.
685 \value PE_PanelToolBar The panel for a toolbar.
686 \value PE_PanelTipLabel The panel for a tip label.
687 \value PE_FrameTabBarBase The frame that is drawn for a tab bar, usually drawn for a tab bar that isn't part of a tab widget.
688 \value PE_IndicatorTabTear Deprecated. Use \l{PE_IndicatorTabTearLeft} instead.
689 \value PE_IndicatorTabTearLeft An indicator that a tab is partially scrolled out on the left side of the visible tab bar when there are many tabs.
690 \value PE_IndicatorTabTearRight An indicator that a tab is partially scrolled out on the right side of the visible tab bar when there are many tabs.
691 \value PE_IndicatorColumnViewArrow An arrow in a QColumnView.
692
693 \value PE_Widget A plain QWidget.
694
695 \value PE_CustomBase Base value for custom primitive elements.
696 All values above this are reserved for custom use. Custom values
697 must be greater than this value.
698
699 \value PE_IndicatorItemViewItemDrop An indicator that is drawn to show where an item in an item view is about to be dropped
700 during a drag-and-drop operation in an item view.
701 \value PE_PanelItemViewItem The background for an item in an item view.
702 \value PE_PanelItemViewRow The background of a row in an item view.
703
704 \value PE_PanelStatusBar The panel for a status bar.
705
706 \value PE_IndicatorTabClose The close button on a tab bar.
707 \value PE_PanelMenu The panel for a menu.
708
709 \sa drawPrimitive()
710*/
711
712
713/*!
714 \enum QStyle::StateFlag
715
716 This enum describes flags that are used when drawing primitive
717 elements.
718
719 Note that not all primitives use all of these flags, and that the
720 flags may mean different things to different items.
721
722 \value State_None Indicates that the widget does not have a state.
723 \value State_Active Indicates that the widget is active.
724 \value State_AutoRaise Used to indicate if auto-raise appearance should be used on a tool button.
725 \value State_Children Used to indicate if an item view branch has children.
726 \value State_DownArrow Used to indicate if a down arrow should be visible on the widget.
727 \value State_Editing Used to indicate if an editor is opened on the widget.
728 \value State_Enabled Used to indicate if the widget is enabled.
729 \value State_HasEditFocus Used to indicate if the widget currently has edit focus.
730 \value State_HasFocus Used to indicate if the widget has focus.
731 \value State_Horizontal Used to indicate if the widget is laid out horizontally, for example. a tool bar.
732 \value State_KeyboardFocusChange Used to indicate if the focus was changed with the keyboard, e.g., tab, backtab or shortcut.
733 \value State_MouseOver Used to indicate if the widget is under the mouse.
734 \value State_NoChange Used to indicate a tri-state checkbox.
735 \value State_Off Used to indicate if the widget is not checked.
736 \value State_On Used to indicate if the widget is checked.
737 \value State_Raised Used to indicate if a button is raised.
738 \value State_ReadOnly Used to indicate if a widget is read-only.
739 \value State_Selected Used to indicate if a widget is selected.
740 \value State_Item Used by item views to indicate if a horizontal branch should be drawn.
741 \value State_Open Used by item views to indicate if the tree branch is open.
742 \value State_Sibling Used by item views to indicate if a vertical line needs to be drawn (for siblings).
743 \value State_Sunken Used to indicate if the widget is sunken or pressed.
744 \value State_UpArrow Used to indicate if an up arrow should be visible on the widget.
745 \value State_Mini Used to indicate a mini style Mac widget or button.
746 \value State_Small Used to indicate a small style Mac widget or button.
747 \omitvalue State_Window
748 \omitvalue State_Bottom
749 \omitvalue State_FocusAtBorder
750 \omitvalue State_Top
751
752 \sa drawPrimitive()
753*/
754
755/*!
756 \fn void QStyle::drawPrimitive(PrimitiveElement element, const QStyleOption *option, QPainter *painter, const QWidget *widget) const
757
758 Draws the given primitive \a element with the provided \a painter using the style
759 options specified by \a option.
760
761 The \a widget argument is optional and may contain a widget that may
762 aid in drawing the primitive element.
763
764 The table below is listing the primitive elements and their
765 associated style option subclasses. The style options contain all
766 the parameters required to draw the elements, including
767 QStyleOption::state which holds the style flags that are used when
768 drawing. The table also describes which flags that are set when
769 casting the given option to the appropriate subclass.
770
771 Note that if a primitive element is not listed here, it is because
772 it uses a plain QStyleOption object.
773
774 \table
775 \header \li Primitive Element \li QStyleOption Subclass \li Style Flag \li Remark
776 \row \li \l PE_FrameFocusRect \li \l QStyleOptionFocusRect
777 \li \l State_FocusAtBorder
778 \li Whether the focus is is at the border or inside the widget.
779 \row \li{1,2} \l PE_IndicatorCheckBox \li{1,2} \l QStyleOptionButton
780 \li \l State_NoChange \li Indicates a "tri-state" checkbox.
781 \row \li \l State_On \li Indicates the indicator is checked.
782 \row \li \l PE_IndicatorRadioButton \li \l QStyleOptionButton
783 \li \l State_On \li Indicates that a radio button is selected.
784 \row \li \l State_NoChange \li Indicates a "tri-state" controller.
785 \row \li \l State_Enabled \li Indicates the controller is enabled.
786 \row \li{1,4} \l PE_IndicatorBranch \li{1,4} \l QStyleOption
787 \li \l State_Children \li Indicates that the control for expanding the tree to show child items, should be drawn.
788 \row \li \l State_Item \li Indicates that a horizontal branch (to show a child item), should be drawn.
789 \row \li \l State_Open \li Indicates that the tree branch is expanded.
790 \row \li \l State_Sibling \li Indicates that a vertical line (to show a sibling item), should be drawn.
791 \row \li \l PE_IndicatorHeaderArrow \li \l QStyleOptionHeader
792 \li \l State_UpArrow \li Indicates that the arrow should be drawn up;
793 otherwise it should be down.
794 \row \li \l PE_FrameGroupBox, \l PE_Frame, \l PE_FrameLineEdit,
795 \l PE_FrameMenu, \l PE_FrameDockWidget, \l PE_FrameWindow
796 \li \l QStyleOptionFrame \li \l State_Sunken
797 \li Indicates that the Frame should be sunken.
798 \row \li \l PE_IndicatorToolBarHandle \li \l QStyleOption
799 \li \l State_Horizontal \li Indicates that the window handle is horizontal
800 instead of vertical.
801 \row \li \l PE_IndicatorSpinPlus, \l PE_IndicatorSpinMinus, \l PE_IndicatorSpinUp,
802 \l PE_IndicatorSpinDown,
803 \li \l QStyleOptionSpinBox
804 \li \l State_Sunken \li Indicates that the button is pressed.
805 \row \li{1,5} \l PE_PanelButtonCommand
806 \li{1,5} \l QStyleOptionButton
807 \li \l State_Enabled \li Set if the button is enabled.
808 \row \li \l State_HasFocus \li Set if the button has input focus.
809 \row \li \l State_Raised \li Set if the button is not down, not on and not flat.
810 \row \li \l State_On \li Set if the button is a toggle button and is toggled on.
811 \row \li \l State_Sunken
812 \li Set if the button is down (i.e., the mouse button or the
813 space bar is pressed on the button).
814 \endtable
815
816 \sa drawComplexControl(), drawControl()
817*/
818
819/*!
820 \enum QStyle::ControlElement
821
822 This enum represents a control element. A control element is a
823 part of a widget that performs some action or displays information
824 to the user.
825
826 \value CE_PushButton A QPushButton, draws CE_PushButtonBevel, CE_PushButtonLabel and PE_FrameFocusRect.
827 \value CE_PushButtonBevel The bevel and default indicator of a QPushButton.
828 \value CE_PushButtonLabel The label (an icon with text or pixmap) of a QPushButton.
829
830 \value CE_DockWidgetTitle Dock window title.
831 \value CE_Splitter Splitter handle; see also QSplitter.
832
833
834 \value CE_CheckBox A QCheckBox, draws a PE_IndicatorCheckBox, a CE_CheckBoxLabel and a PE_FrameFocusRect.
835 \value CE_CheckBoxLabel The label (text or pixmap) of a QCheckBox.
836
837 \value CE_RadioButton A QRadioButton, draws a PE_IndicatorRadioButton, a CE_RadioButtonLabel and a PE_FrameFocusRect.
838 \value CE_RadioButtonLabel The label (text or pixmap) of a QRadioButton.
839
840 \value CE_TabBarTab The tab and label within a QTabBar.
841 \value CE_TabBarTabShape The tab shape within a tab bar.
842 \value CE_TabBarTabLabel The label within a tab.
843
844 \value CE_ProgressBar A QProgressBar, draws CE_ProgressBarGroove, CE_ProgressBarContents and CE_ProgressBarLabel.
845 \value CE_ProgressBarGroove The groove where the progress
846 indicator is drawn in a QProgressBar.
847 \value CE_ProgressBarContents The progress indicator of a QProgressBar.
848 \value CE_ProgressBarLabel The text label of a QProgressBar.
849
850 \value CE_ToolButtonLabel A tool button's label.
851
852 \value CE_MenuBarItem A menu item in a QMenuBar.
853 \value CE_MenuBarEmptyArea The empty area of a QMenuBar.
854
855 \value CE_MenuItem A menu item in a QMenu.
856 \value CE_MenuScroller Scrolling areas in a QMenu when the
857 style supports scrolling.
858 \value CE_MenuTearoff A menu item representing the tear off section of
859 a QMenu.
860 \value CE_MenuEmptyArea The area in a menu without menu items.
861 \value CE_MenuHMargin The horizontal extra space on the left/right of a menu.
862 \value CE_MenuVMargin The vertical extra space on the top/bottom of a menu.
863
864 \value CE_ToolBoxTab The toolbox's tab and label within a QToolBox.
865 \value CE_SizeGrip Window resize handle; see also QSizeGrip.
866
867 \value CE_Header A header.
868 \value CE_HeaderSection A header section.
869 \value CE_HeaderLabel The header's label.
870
871 \value CE_ScrollBarAddLine Scroll bar line increase indicator.
872 (i.e., scroll down); see also QScrollBar.
873 \value CE_ScrollBarSubLine Scroll bar line decrease indicator (i.e., scroll up).
874 \value CE_ScrollBarAddPage Scolllbar page increase indicator (i.e., page down).
875 \value CE_ScrollBarSubPage Scroll bar page decrease indicator (i.e., page up).
876 \value CE_ScrollBarSlider Scroll bar slider.
877 \value CE_ScrollBarFirst Scroll bar first line indicator (i.e., home).
878 \value CE_ScrollBarLast Scroll bar last line indicator (i.e., end).
879
880 \value CE_RubberBand Rubber band used in for example an icon view.
881
882 \value CE_FocusFrame Focus frame that is style controlled.
883
884 \value CE_ItemViewItem An item inside an item view.
885
886 \value CE_CustomBase Base value for custom control elements;
887 custom values must be greater than this value.
888 \value CE_ComboBoxLabel The label of a non-editable QComboBox.
889 \value CE_ToolBar A toolbar like QToolBar.
890 \value CE_ToolBoxTabShape The toolbox's tab shape.
891 \value CE_ToolBoxTabLabel The toolbox's tab label.
892 \value CE_HeaderEmptyArea The area of a header view where there are no header sections.
893
894 \value CE_ShapedFrame The frame with the shape specified in the QStyleOptionFrame; see QFrame.
895
896 \omitvalue CE_ColumnViewGrip
897
898 \sa drawControl()
899*/
900
901/*!
902 \fn void QStyle::drawControl(ControlElement element, const QStyleOption *option, QPainter *painter, const QWidget *widget) const
903
904 Draws the given \a element with the provided \a painter with the
905 style options specified by \a option.
906
907 The \a widget argument is optional and can be used as aid in
908 drawing the control. The \a option parameter is a pointer to a
909 QStyleOption object that can be cast to the correct subclass
910 using the qstyleoption_cast() function.
911
912 The table below is listing the control elements and their
913 associated style option subclass. The style options contain all
914 the parameters required to draw the controls, including
915 QStyleOption::state which holds the style flags that are used when
916 drawing. The table also describes which flags that are set when
917 casting the given option to the appropriate subclass.
918
919 Note that if a control element is not listed here, it is because
920 it uses a plain QStyleOption object.
921
922 \table
923 \header \li Control Element \li QStyleOption Subclass \li Style Flag \li Remark
924 \row \li{1,5} \l CE_MenuItem, \l CE_MenuBarItem
925 \li{1,5} \l QStyleOptionMenuItem
926 \li \l State_Selected \li The menu item is currently selected item.
927 \row \li \l State_Enabled \li The item is enabled.
928 \row \li \l State_DownArrow \li Indicates that a scroll down arrow should be drawn.
929 \row \li \l State_UpArrow \li Indicates that a scroll up arrow should be drawn
930 \row \li \l State_HasFocus \li Set if the menu bar has input focus.
931
932 \row \li{1,5} \l CE_PushButton, \l CE_PushButtonBevel, \l CE_PushButtonLabel
933 \li{1,5} \l QStyleOptionButton
934 \li \l State_Enabled \li Set if the button is enabled.
935 \row \li \l State_HasFocus \li Set if the button has input focus.
936 \row \li \l State_Raised \li Set if the button is not down, not on and not flat.
937 \row \li \l State_On \li Set if the button is a toggle button and is toggled on.
938 \row \li \l State_Sunken
939 \li Set if the button is down (i.e., the mouse button or the
940 space bar is pressed on the button).
941
942 \row \li{1,6} \l CE_RadioButton, \l CE_RadioButtonLabel,
943 \l CE_CheckBox, \l CE_CheckBoxLabel
944 \li{1,6} \l QStyleOptionButton
945 \li \l State_Enabled \li Set if the button is enabled.
946 \row \li \l State_HasFocus \li Set if the button has input focus.
947 \row \li \l State_On \li Set if the button is checked.
948 \row \li \l State_Off \li Set if the button is not checked.
949 \row \li \l State_NoChange \li Set if the button is in the NoChange state.
950 \row \li \l State_Sunken
951 \li Set if the button is down (i.e., the mouse button or
952 the space bar is pressed on the button).
953
954 \row \li{1,2} \l CE_ProgressBarContents, \l CE_ProgressBarLabel,
955 \l CE_ProgressBarGroove
956 \li{1,2} \l QStyleOptionProgressBar
957 \li \l State_Enabled \li Set if the progress bar is enabled.
958 \row \li \l State_HasFocus \li Set if the progress bar has input focus.
959
960 \row \li \l CE_Header, \l CE_HeaderSection, \l CE_HeaderLabel \li \l QStyleOptionHeader \li \li
961
962 \row \li{1,3} \l CE_TabBarTab, CE_TabBarTabShape, CE_TabBarTabLabel
963 \li{1,3} \l QStyleOptionTab
964 \li \l State_Enabled \li Set if the tab bar is enabled.
965 \row \li \l State_Selected \li The tab bar is the currently selected tab bar.
966 \row \li \l State_HasFocus \li Set if the tab bar tab has input focus.
967
968 \row \li{1,7} \l CE_ToolButtonLabel
969 \li{1,7} \l QStyleOptionToolButton
970 \li \l State_Enabled \li Set if the tool button is enabled.
971 \row \li \l State_HasFocus \li Set if the tool button has input focus.
972 \row \li \l State_Sunken
973 \li Set if the tool button is down (i.e., a mouse button or
974 the space bar is pressed).
975 \row \li \l State_On \li Set if the tool button is a toggle button and is toggled on.
976 \row \li \l State_AutoRaise \li Set if the tool button has auto-raise enabled.
977 \row \li \l State_MouseOver \li Set if the mouse pointer is over the tool button.
978 \row \li \l State_Raised \li Set if the button is not down and is not on.
979
980 \row \li \l CE_ToolBoxTab \li \l QStyleOptionToolBox
981 \li \l State_Selected \li The tab is the currently selected tab.
982 \row \li{1,3} \l CE_HeaderSection \li{1,3} \l QStyleOptionHeader
983 \li \l State_Sunken \li Indicates that the section is pressed.
984 \row \li \l State_UpArrow \li Indicates that the sort indicator should be pointing up.
985 \row \li \l State_DownArrow \li Indicates that the sort indicator should be pointing down.
986 \endtable
987
988 \sa drawPrimitive(), drawComplexControl()
989*/
990
991/*!
992 \enum QStyle::SubElement
993
994 This enum represents a sub-area of a widget. Style implementations
995 use these areas to draw the different parts of a widget.
996
997 \value SE_PushButtonContents Area containing the label (icon
998 with text or pixmap).
999 \value SE_PushButtonFocusRect Area for the focus rect (usually
1000 larger than the contents rect).
1001 \value SE_PushButtonLayoutItem Area that counts for the parent layout.
1002 \value SE_PushButtonBevel [since 5.15] Area used for the bevel of the button.
1003
1004 \value SE_CheckBoxIndicator Area for the state indicator (e.g., check mark).
1005 \value SE_CheckBoxContents Area for the label (text or pixmap).
1006 \value SE_CheckBoxFocusRect Area for the focus indicator.
1007 \value SE_CheckBoxClickRect Clickable area, defaults to SE_CheckBoxFocusRect.
1008 \value SE_CheckBoxLayoutItem Area that counts for the parent layout.
1009
1010 \value SE_DateTimeEditLayoutItem Area that counts for the parent layout.
1011
1012 \value SE_RadioButtonIndicator Area for the state indicator.
1013 \value SE_RadioButtonContents Area for the label.
1014 \value SE_RadioButtonFocusRect Area for the focus indicator.
1015 \value SE_RadioButtonClickRect Clickable area, defaults to SE_RadioButtonFocusRect.
1016 \value SE_RadioButtonLayoutItem Area that counts for the parent layout.
1017
1018 \value SE_ComboBoxFocusRect Area for the focus indicator.
1019
1020 \value SE_SliderFocusRect Area for the focus indicator.
1021 \value SE_SliderLayoutItem Area that counts for the parent layout.
1022
1023 \value SE_SpinBoxLayoutItem Area that counts for the parent layout.
1024
1025 \value SE_ProgressBarGroove Area for the groove.
1026 \value SE_ProgressBarContents Area for the progress indicator.
1027 \value SE_ProgressBarLabel Area for the text label.
1028 \value SE_ProgressBarLayoutItem Area that counts for the parent layout.
1029
1030 \value SE_FrameContents Area for a frame's contents.
1031 \value SE_ShapedFrameContents Area for a frame's contents using the shape in QStyleOptionFrame; see QFrame
1032 \value SE_FrameLayoutItem Area that counts for the parent layout.
1033
1034 \value SE_HeaderArrow Area for the sort indicator for a header.
1035 \value SE_HeaderLabel Area for the label in a header.
1036
1037 \value SE_LabelLayoutItem Area that counts for the parent layout.
1038
1039 \value SE_LineEditContents Area for a line edit's contents.
1040
1041 \value SE_TabWidgetLeftCorner Area for the left corner widget in a tab widget.
1042 \value SE_TabWidgetRightCorner Area for the right corner widget in a tab widget.
1043 \value SE_TabWidgetTabBar Area for the tab bar widget in a tab widget.
1044 \value SE_TabWidgetTabContents Area for the contents of the tab widget.
1045 \value SE_TabWidgetTabPane Area for the pane of a tab widget.
1046 \value SE_TabWidgetLayoutItem Area that counts for the parent layout.
1047
1048 \value SE_ToolBoxTabContents Area for a toolbox tab's icon and label.
1049
1050 \value SE_ToolButtonLayoutItem Area that counts for the parent layout.
1051
1052 \value SE_ItemViewItemCheckIndicator Area for a view item's check mark.
1053
1054 \value SE_TabBarTearIndicator Deprecated. Use SE_TabBarTearIndicatorLeft instead.
1055 \value SE_TabBarTearIndicatorLeft Area for the tear indicator on the left side of a tab bar with scroll arrows.
1056 \value SE_TabBarTearIndicatorRight Area for the tear indicator on the right side of a tab bar with scroll arrows.
1057
1058 \value SE_TabBarScrollLeftButton Area for the scroll left button on a tab bar with scroll buttons.
1059 \value SE_TabBarScrollRightButton Area for the scroll right button on a tab bar with scroll buttons.
1060
1061 \value SE_TreeViewDisclosureItem Area for the actual disclosure item in a tree branch.
1062
1063 \value SE_GroupBoxLayoutItem Area that counts for the parent layout.
1064
1065 \value SE_CustomBase Base value for custom sub-elements.
1066 Custom values must be greater than this value.
1067
1068 \value SE_DockWidgetFloatButton The float button of a dock
1069 widget.
1070 \value SE_DockWidgetTitleBarText The text bounds of the dock
1071 widgets title.
1072 \value SE_DockWidgetCloseButton The close button of a dock
1073 widget.
1074 \value SE_DockWidgetIcon The icon of a dock widget.
1075 \value SE_ComboBoxLayoutItem Area that counts for the parent layout.
1076
1077
1078 \value SE_ItemViewItemDecoration Area for a view item's decoration (icon).
1079 \value SE_ItemViewItemText Area for a view item's text.
1080 \value SE_ItemViewItemFocusRect Area for a view item's focus rect.
1081
1082 \value SE_TabBarTabLeftButton Area for a widget on the left side of a tab in a tab bar.
1083 \value SE_TabBarTabRightButton Area for a widget on the right side of a tab in a tab bar.
1084 \value SE_TabBarTabText Area for the text on a tab in a tab bar.
1085
1086 \value SE_ToolBarHandle Area for the handle of a tool bar.
1087
1088 \sa subElementRect()
1089*/
1090
1091/*!
1092 \fn QRect QStyle::subElementRect(SubElement element, const QStyleOption *option, const QWidget *widget) const
1093
1094 Returns the sub-area for the given \a element as described in the
1095 provided style \a option. The returned rectangle is defined in
1096 screen coordinates.
1097
1098 The \a widget argument is optional and can be used to aid
1099 determining the area. The QStyleOption object can be cast to the
1100 appropriate type using the qstyleoption_cast() function. See the
1101 table below for the appropriate \a option casts:
1102
1103 \table
1104 \header \li Sub Element \li QStyleOption Subclass
1105 \row \li \l SE_PushButtonContents \li \l QStyleOptionButton
1106 \row \li \l SE_PushButtonFocusRect \li \l QStyleOptionButton
1107 \row \li \l SE_PushButtonBevel \li \l QStyleOptionButton
1108 \row \li \l SE_CheckBoxIndicator \li \l QStyleOptionButton
1109 \row \li \l SE_CheckBoxContents \li \l QStyleOptionButton
1110 \row \li \l SE_CheckBoxFocusRect \li \l QStyleOptionButton
1111 \row \li \l SE_RadioButtonIndicator \li \l QStyleOptionButton
1112 \row \li \l SE_RadioButtonContents \li \l QStyleOptionButton
1113 \row \li \l SE_RadioButtonFocusRect \li \l QStyleOptionButton
1114 \row \li \l SE_ComboBoxFocusRect \li \l QStyleOptionComboBox
1115 \row \li \l SE_ProgressBarGroove \li \l QStyleOptionProgressBar
1116 \row \li \l SE_ProgressBarContents \li \l QStyleOptionProgressBar
1117 \row \li \l SE_ProgressBarLabel \li \l QStyleOptionProgressBar
1118 \endtable
1119*/
1120
1121/*!
1122 \enum QStyle::ComplexControl
1123
1124 This enum describes the available complex controls. Complex
1125 controls have different behavior depending upon where the user
1126 clicks on them or which keys are pressed.
1127
1128 \value CC_SpinBox A spinbox, like QSpinBox.
1129 \value CC_ComboBox A combobox, like QComboBox.
1130 \value CC_ScrollBar A scroll bar, like QScrollBar.
1131 \value CC_Slider A slider, like QSlider.
1132 \value CC_ToolButton A tool button, like QToolButton.
1133 \value CC_TitleBar A Title bar, like those used in QMdiSubWindow.
1134 \value CC_GroupBox A group box, like QGroupBox.
1135 \value CC_Dial A dial, like QDial.
1136 \value CC_MdiControls The minimize, close, and normal
1137 button in the menu bar for a
1138 maximized MDI subwindow.
1139
1140 \value CC_CustomBase Base value for custom complex controls. Custom
1141 values must be greater than this value.
1142
1143 \sa SubControl, drawComplexControl()
1144*/
1145
1146/*!
1147 \enum QStyle::SubControl
1148
1149 This enum describes the available sub controls. A subcontrol is a
1150 control element within a complex control (ComplexControl).
1151
1152 \value SC_None Special value that matches no other sub control.
1153
1154 \value SC_ScrollBarAddLine Scroll bar add line (i.e., down/right
1155 arrow); see also QScrollBar.
1156 \value SC_ScrollBarSubLine Scroll bar sub line (i.e., up/left arrow).
1157 \value SC_ScrollBarAddPage Scroll bar add page (i.e., page down).
1158 \value SC_ScrollBarSubPage Scroll bar sub page (i.e., page up).
1159 \value SC_ScrollBarFirst Scroll bar first line (i.e., home).
1160 \value SC_ScrollBarLast Scroll bar last line (i.e., end).
1161 \value SC_ScrollBarSlider Scroll bar slider handle.
1162 \value SC_ScrollBarGroove Special sub-control which contains the
1163 area in which the slider handle may move.
1164
1165 \value SC_SpinBoxUp Spin widget up/increase; see also QSpinBox.
1166 \value SC_SpinBoxDown Spin widget down/decrease.
1167 \value SC_SpinBoxFrame Spin widget frame.
1168 \value SC_SpinBoxEditField Spin widget edit field.
1169
1170 \value SC_ComboBoxEditField Combobox edit field; see also QComboBox.
1171 \value SC_ComboBoxArrow Combobox arrow button.
1172 \value SC_ComboBoxFrame Combobox frame.
1173 \value SC_ComboBoxListBoxPopup The reference rectangle for the combobox popup.
1174 Used to calculate the position of the popup.
1175
1176 \value SC_SliderGroove Special sub-control which contains the area
1177 in which the slider handle may move.
1178 \value SC_SliderHandle Slider handle.
1179 \value SC_SliderTickmarks Slider tickmarks.
1180
1181 \value SC_ToolButton Tool button (see also QToolButton).
1182 \value SC_ToolButtonMenu Sub-control for opening a popup menu in a
1183 tool button.
1184
1185 \value SC_TitleBarSysMenu System menu button (i.e., restore, close, etc.).
1186 \value SC_TitleBarMinButton Minimize button.
1187 \value SC_TitleBarMaxButton Maximize button.
1188 \value SC_TitleBarCloseButton Close button.
1189 \value SC_TitleBarLabel Window title label.
1190 \value SC_TitleBarNormalButton Normal (restore) button.
1191 \value SC_TitleBarShadeButton Shade button.
1192 \value SC_TitleBarUnshadeButton Unshade button.
1193 \value SC_TitleBarContextHelpButton Context Help button.
1194
1195 \value SC_DialHandle The handle of the dial (i.e. what you use to control the dial).
1196 \value SC_DialGroove The groove for the dial.
1197 \value SC_DialTickmarks The tickmarks for the dial.
1198
1199 \value SC_GroupBoxFrame The frame of a group box.
1200 \value SC_GroupBoxLabel The title of a group box.
1201 \value SC_GroupBoxCheckBox The optional check box of a group box.
1202 \value SC_GroupBoxContents The group box contents.
1203
1204 \value SC_MdiNormalButton The normal button for a MDI
1205 subwindow in the menu bar.
1206 \value SC_MdiMinButton The minimize button for a MDI
1207 subwindow in the menu bar.
1208 \value SC_MdiCloseButton The close button for a MDI subwindow
1209 in the menu bar.
1210
1211 \value SC_All Special value that matches all sub-controls.
1212 \omitvalue SC_CustomBase
1213
1214 \sa ComplexControl
1215*/
1216
1217/*!
1218 \fn void QStyle::drawComplexControl(ComplexControl control, const QStyleOptionComplex *option, QPainter *painter, const QWidget *widget) const
1219
1220 Draws the given \a control using the provided \a painter with the
1221 style options specified by \a option.
1222
1223 The \a widget argument is optional and can be used as aid in
1224 drawing the control.
1225
1226 The \a option parameter is a pointer to a QStyleOptionComplex
1227 object that can be cast to the correct subclass using the
1228 qstyleoption_cast() function. Note that the \c rect member of the
1229 specified \a option must be in logical
1230 coordinates. Reimplementations of this function should use
1231 visualRect() to change the logical coordinates into screen
1232 coordinates before calling the drawPrimitive() or drawControl()
1233 function.
1234
1235 The table below is listing the complex control elements and their
1236 associated style option subclass. The style options contain all
1237 the parameters required to draw the controls, including
1238 QStyleOption::state which holds the \l {QStyle::StateFlag}{style
1239 flags} that are used when drawing. The table also describes which
1240 flags that are set when casting the given \a option to the
1241 appropriate subclass.
1242
1243 \table
1244 \header \li Complex Control \li QStyleOptionComplex Subclass \li Style Flag \li Remark
1245 \row \li{1,2} \l{CC_SpinBox} \li{1,2} \l QStyleOptionSpinBox
1246 \li \l State_Enabled \li Set if the spin box is enabled.
1247 \row \li \l State_HasFocus \li Set if the spin box has input focus.
1248
1249 \row \li{1,2} \l {CC_ComboBox} \li{1,2} \l QStyleOptionComboBox
1250 \li \l State_Enabled \li Set if the combobox is enabled.
1251 \row \li \l State_HasFocus \li Set if the combobox has input focus.
1252
1253 \row \li{1,2} \l {CC_ScrollBar} \li{1,2} \l QStyleOptionSlider
1254 \li \l State_Enabled \li Set if the scroll bar is enabled.
1255 \row \li \l State_HasFocus \li Set if the scroll bar has input focus.
1256
1257 \row \li{1,2} \l {CC_Slider} \li{1,2} \l QStyleOptionSlider
1258 \li \l State_Enabled \li Set if the slider is enabled.
1259 \row \li \l State_HasFocus \li Set if the slider has input focus.
1260
1261 \row \li{1,2} \l {CC_Dial} \li{1,2} \l QStyleOptionSlider
1262 \li \l State_Enabled \li Set if the dial is enabled.
1263 \row \li \l State_HasFocus \li Set if the dial has input focus.
1264
1265 \row \li{1,6} \l {CC_ToolButton} \li{1,6} \l QStyleOptionToolButton
1266 \li \l State_Enabled \li Set if the tool button is enabled.
1267 \row \li \l State_HasFocus \li Set if the tool button has input focus.
1268 \row \li \l State_DownArrow \li Set if the tool button is down (i.e., a mouse
1269 button or the space bar is pressed).
1270 \row \li \l State_On \li Set if the tool button is a toggle button
1271 and is toggled on.
1272 \row \li \l State_AutoRaise \li Set if the tool button has auto-raise enabled.
1273 \row \li \l State_Raised \li Set if the button is not down, not on, and doesn't
1274 contain the mouse when auto-raise is enabled.
1275
1276 \row \li \l{CC_TitleBar} \li \l QStyleOptionTitleBar
1277 \li \l State_Enabled \li Set if the title bar is enabled.
1278
1279 \endtable
1280
1281 \sa drawPrimitive(), drawControl()
1282*/
1283
1284
1285/*!
1286 \fn QRect QStyle::subControlRect(ComplexControl control,
1287 const QStyleOptionComplex *option, SubControl subControl,
1288 const QWidget *widget) const = 0
1289
1290 Returns the rectangle containing the specified \a subControl of
1291 the given complex \a control (with the style specified by \a
1292 option). The rectangle is defined in screen coordinates.
1293
1294 The \a option argument is a pointer to QStyleOptionComplex or
1295 one of its subclasses, and can be cast to the appropriate type
1296 using the qstyleoption_cast() function. See drawComplexControl()
1297 for details. The \a widget is optional and can contain additional
1298 information for the function.
1299
1300 \sa drawComplexControl()
1301*/
1302
1303/*!
1304 \fn QStyle::SubControl QStyle::hitTestComplexControl(ComplexControl control,
1305 const QStyleOptionComplex *option, const QPoint &position,
1306 const QWidget *widget) const = 0
1307
1308 Returns the sub control at the given \a position in the given
1309 complex \a control (with the style options specified by \a
1310 option).
1311
1312 Note that the \a position is expressed in screen coordinates.
1313
1314 The \a option argument is a pointer to a QStyleOptionComplex
1315 object (or one of its subclasses). The object can be cast to the
1316 appropriate type using the qstyleoption_cast() function. See
1317 drawComplexControl() for details. The \a widget argument is
1318 optional and can contain additional information for the function.
1319
1320 \sa drawComplexControl(), subControlRect()
1321*/
1322
1323/*!
1324 \enum QStyle::PixelMetric
1325
1326 This enum describes the various available pixel metrics. A pixel
1327 metric is a style dependent size represented by a single pixel
1328 value.
1329
1330 \value PM_ButtonMargin Amount of whitespace between push button
1331 labels and the frame.
1332 \value PM_DockWidgetTitleBarButtonMargin Amount of whitespace between dock widget's
1333 title bar button labels and the frame.
1334 \value PM_ButtonDefaultIndicator Width of the default-button indicator frame.
1335 \value PM_MenuButtonIndicator Width of the menu button indicator
1336 proportional to the widget height.
1337 \value PM_ButtonShiftHorizontal Horizontal contents shift of a
1338 button when the button is down.
1339 \value PM_ButtonShiftVertical Vertical contents shift of a button when the
1340 button is down.
1341
1342 \value PM_DefaultFrameWidth Default frame width (usually 2).
1343 \value PM_SpinBoxFrameWidth Frame width of a spin box, defaults to PM_DefaultFrameWidth.
1344 \value PM_ComboBoxFrameWidth Frame width of a combo box, defaults to PM_DefaultFrameWidth.
1345
1346 \value PM_MdiSubWindowFrameWidth Frame width of an MDI window.
1347 \value PM_MdiSubWindowMinimizedWidth Width of a minimized MDI window.
1348
1349 \value PM_LayoutLeftMargin Default \l{QLayout::setContentsMargins()}{left margin} for a
1350 QLayout.
1351 \value PM_LayoutTopMargin Default \l{QLayout::setContentsMargins()}{top margin} for a QLayout.
1352 \value PM_LayoutRightMargin Default \l{QLayout::setContentsMargins()}{right margin} for a
1353 QLayout.
1354 \value PM_LayoutBottomMargin Default \l{QLayout::setContentsMargins()}{bottom margin} for a
1355 QLayout.
1356 \value PM_LayoutHorizontalSpacing Default \l{QLayout::spacing}{horizontal spacing} for a
1357 QLayout.
1358 \value PM_LayoutVerticalSpacing Default \l{QLayout::spacing}{vertical spacing} for a QLayout.
1359
1360 \value PM_MaximumDragDistance The maximum allowed distance between
1361 the mouse and a scrollbar when dragging. Exceeding the specified
1362 distance will cause the slider to jump back to the original
1363 position; a value of -1 disables this behavior.
1364
1365 \value PM_ScrollBarExtent Width of a vertical scroll bar and the
1366 height of a horizontal scroll bar.
1367 \value PM_ScrollBarSliderMin The minimum height of a vertical
1368 scroll bar's slider and the minimum width of a horizontal
1369 scroll bar's slider.
1370
1371 \value PM_SliderThickness Total slider thickness.
1372 \value PM_SliderControlThickness Thickness of the slider handle.
1373 \value PM_SliderLength Length of the slider.
1374 \value PM_SliderTickmarkOffset The offset between the tickmarks
1375 and the slider.
1376 \value PM_SliderSpaceAvailable The available space for the slider to move.
1377
1378 \value PM_DockWidgetSeparatorExtent Width of a separator in a
1379 horizontal dock window and the height of a separator in a
1380 vertical dock window.
1381 \value PM_DockWidgetHandleExtent Width of the handle in a
1382 horizontal dock window and the height of the handle in a
1383 vertical dock window.
1384 \value PM_DockWidgetFrameWidth Frame width of a dock window.
1385 \value PM_DockWidgetTitleMargin Margin of the dock window title.
1386
1387 \value PM_MenuBarPanelWidth Frame width of a menu bar, defaults to PM_DefaultFrameWidth.
1388 \value PM_MenuBarItemSpacing Spacing between menu bar items.
1389 \value PM_MenuBarHMargin Spacing between menu bar items and left/right of bar.
1390 \value PM_MenuBarVMargin Spacing between menu bar items and top/bottom of bar.
1391
1392 \value PM_ToolBarFrameWidth Width of the frame around toolbars.
1393 \value PM_ToolBarHandleExtent Width of a toolbar handle in a
1394 horizontal toolbar and the height of the handle in a vertical toolbar.
1395 \value PM_ToolBarItemMargin Spacing between the toolbar frame and the items.
1396 \value PM_ToolBarItemSpacing Spacing between toolbar items.
1397 \value PM_ToolBarSeparatorExtent Width of a toolbar separator in a
1398 horizontal toolbar and the height of a separator in a vertical toolbar.
1399 \value PM_ToolBarExtensionExtent Width of a toolbar extension
1400 button in a horizontal toolbar and the height of the button in a
1401 vertical toolbar.
1402
1403 \value PM_TabBarTabOverlap Number of pixels the tabs should overlap.
1404 (Currently only used in styles, not inside of QTabBar)
1405 \value PM_TabBarTabHSpace Extra space added to the tab width.
1406 \value PM_TabBarTabVSpace Extra space added to the tab height.
1407 \value PM_TabBarBaseHeight Height of the area between the tab bar
1408 and the tab pages.
1409 \value PM_TabBarBaseOverlap Number of pixels the tab bar overlaps
1410 the tab bar base.
1411 \value PM_TabBarScrollButtonWidth
1412 \value PM_TabBarTabShiftHorizontal Horizontal pixel shift when a
1413 tab is selected.
1414 \value PM_TabBarTabShiftVertical Vertical pixel shift when a
1415 tab is selected.
1416
1417 \value PM_ProgressBarChunkWidth Width of a chunk in a progress bar indicator.
1418
1419 \value PM_SplitterWidth Width of a splitter.
1420
1421 \value PM_TitleBarHeight Height of the title bar.
1422
1423 \value PM_IndicatorWidth Width of a check box indicator.
1424 \value PM_IndicatorHeight Height of a checkbox indicator.
1425 \value PM_ExclusiveIndicatorWidth Width of a radio button indicator.
1426 \value PM_ExclusiveIndicatorHeight Height of a radio button indicator.
1427
1428 \value PM_MenuPanelWidth Border width (applied on all sides) for a QMenu.
1429 \value PM_MenuHMargin Additional border (used on left and right) for a QMenu.
1430 \value PM_MenuVMargin Additional border (used for bottom and top) for a QMenu.
1431 \value PM_MenuScrollerHeight Height of the scroller area in a QMenu.
1432 \value PM_MenuTearoffHeight Height of a tear off area in a QMenu.
1433 \value PM_MenuDesktopFrameWidth The frame width for the menu on the desktop.
1434
1435 \omitvalue PM_DialogButtonsSeparator
1436 \omitvalue PM_DialogButtonsButtonWidth
1437 \omitvalue PM_DialogButtonsButtonHeight
1438
1439 \value PM_HeaderMarkSize The size of the sort indicator in a header.
1440 \value PM_HeaderGripMargin The size of the resize grip in a header.
1441 \value PM_HeaderMargin The size of the margin between the sort indicator and the text.
1442 \value PM_SpinBoxSliderHeight The height of the optional spin box slider.
1443
1444 \value PM_ToolBarIconSize Default tool bar icon size
1445 \value PM_SmallIconSize Default small icon size
1446 \value PM_LargeIconSize Default large icon size
1447
1448 \value PM_FocusFrameHMargin Horizontal margin that the focus frame will outset the widget by.
1449 \value PM_FocusFrameVMargin Vertical margin that the focus frame will outset the widget by.
1450 \value PM_IconViewIconSize The default size for icons in an icon view.
1451 \value PM_ListViewIconSize The default size for icons in a list view.
1452
1453 \value PM_ToolTipLabelFrameWidth The frame width for a tool tip label.
1454 \value PM_CheckBoxLabelSpacing The spacing between a check box indicator and its label.
1455 \value PM_RadioButtonLabelSpacing The spacing between a radio button indicator and its label.
1456 \value PM_TabBarIconSize The default icon size for a tab bar.
1457 \value PM_SizeGripSize The size of a size grip.
1458 \value PM_MessageBoxIconSize The size of the standard icons in a message box
1459 \value PM_ButtonIconSize The default size of button icons
1460 \value PM_TextCursorWidth The width of the cursor in a line edit or text edit
1461 \value PM_TabBar_ScrollButtonOverlap The distance between the left and right buttons in a tab bar.
1462
1463 \value PM_TabCloseIndicatorWidth The default width of a close button on a tab in a tab bar.
1464 \value PM_TabCloseIndicatorHeight The default height of a close button on a tab in a tab bar.
1465
1466 \value PM_ScrollView_ScrollBarSpacing Distance between frame and scrollbar
1467 with SH_ScrollView_FrameOnlyAroundContents set.
1468 \value PM_ScrollView_ScrollBarOverlap Overlap between scroll bars and scroll content
1469
1470 \value PM_SubMenuOverlap The horizontal overlap between a submenu and its parent.
1471
1472 \value [since 5.4] PM_TreeViewIndentation The indentation of items in a tree view.
1473
1474 \value PM_HeaderDefaultSectionSizeHorizontal The default size of sections
1475 in a horizontal header. This enum value has been introduced in Qt 5.5.
1476 \value PM_HeaderDefaultSectionSizeVertical The default size of sections
1477 in a vertical header. This enum value has been introduced in Qt 5.5.
1478
1479 \value [since 5.8] PM_TitleBarButtonIconSize The size of button icons on a title bar.
1480 \value [since 5.8] PM_TitleBarButtonSize The size of buttons on a title bar.
1481
1482 \value [since 6.2] PM_LineEditIconSize The default size for icons in a line edit.
1483
1484 \value [since 6.3] PM_LineEditIconMargin The margin around icons in a line edit.
1485
1486 \value PM_CustomBase Base value for custom pixel metrics. Custom
1487 values must be greater than this value.
1488
1489 \sa pixelMetric()
1490*/
1491
1492/*!
1493 \fn int QStyle::pixelMetric(PixelMetric metric, const QStyleOption *option, const QWidget *widget) const;
1494
1495 Returns the value of the given pixel \a metric.
1496
1497 The specified \a option and \a widget can be used for calculating
1498 the metric. The \a option can be cast to the appropriate type using the
1499 qstyleoption_cast() function. Note that the \a option may be zero
1500 even for PixelMetrics that can make use of it. See the table below
1501 for the appropriate \a option casts:
1502
1503 \table
1504 \header \li Pixel Metric \li QStyleOption Subclass
1505 \row \li \l PM_SliderControlThickness \li \l QStyleOptionSlider
1506 \row \li \l PM_SliderLength \li \l QStyleOptionSlider
1507 \row \li \l PM_SliderTickmarkOffset \li \l QStyleOptionSlider
1508 \row \li \l PM_SliderSpaceAvailable \li \l QStyleOptionSlider
1509 \row \li \l PM_ScrollBarExtent \li \l QStyleOptionSlider
1510 \row \li \l PM_TabBarTabOverlap \li \l QStyleOptionTab
1511 \row \li \l PM_TabBarTabHSpace \li \l QStyleOptionTab
1512 \row \li \l PM_TabBarTabVSpace \li \l QStyleOptionTab
1513 \row \li \l PM_TabBarBaseHeight \li \l QStyleOptionTab
1514 \row \li \l PM_TabBarBaseOverlap \li \l QStyleOptionTab
1515 \endtable
1516
1517 Some pixel metrics are called from widgets and some are only called
1518 internally by the style. If the metric is not called by a widget, it is the
1519 discretion of the style author to make use of it. For some styles, this
1520 may not be appropriate.
1521*/
1522
1523/*!
1524 \enum QStyle::ContentsType
1525
1526 This enum describes the available contents types. These are used to
1527 calculate sizes for the contents of various widgets.
1528
1529 \value CT_CheckBox A check box, like QCheckBox.
1530 \value CT_ComboBox A combo box, like QComboBox.
1531 \omitvalue CT_DialogButtons
1532 \value CT_HeaderSection A header section, like QHeader.
1533 \value CT_LineEdit A line edit, like QLineEdit.
1534 \value CT_Menu A menu, like QMenu.
1535 \value CT_MenuBar A menu bar, like QMenuBar.
1536 \value CT_MenuBarItem A menu bar item, like the buttons in a QMenuBar.
1537 \value CT_MenuItem A menu item, like QMenuItem.
1538 \value CT_ProgressBar A progress bar, like QProgressBar.
1539 \value CT_PushButton A push button, like QPushButton.
1540 \value CT_RadioButton A radio button, like QRadioButton.
1541 \value CT_SizeGrip A size grip, like QSizeGrip.
1542 \value CT_Slider A slider, like QSlider.
1543 \value CT_ScrollBar A scroll bar, like QScrollBar.
1544 \value CT_SpinBox A spin box, like QSpinBox.
1545 \value CT_Splitter A splitter, like QSplitter.
1546 \value CT_TabBarTab A tab on a tab bar, like QTabBar.
1547 \value CT_TabWidget A tab widget, like QTabWidget.
1548 \value CT_ToolButton A tool button, like QToolButton.
1549 \value CT_GroupBox A group box, like QGroupBox.
1550 \value CT_ItemViewItem An item inside an item view.
1551
1552 \value CT_CustomBase Base value for custom contents types.
1553 Custom values must be greater than this value.
1554
1555 \value CT_MdiControls The minimize, normal, and close button
1556 in the menu bar for a maximized MDI
1557 subwindow.
1558
1559 \sa sizeFromContents()
1560*/
1561
1562/*!
1563 \fn QSize QStyle::sizeFromContents(ContentsType type, const QStyleOption *option, const QSize &contentsSize, const QWidget *widget) const
1564
1565 Returns the size of the element described by the specified
1566 \a option and \a type, based on the provided \a contentsSize.
1567
1568 The \a option argument is a pointer to a QStyleOption or one of
1569 its subclasses. The \a option can be cast to the appropriate type
1570 using the qstyleoption_cast() function. The \a widget is an
1571 optional argument and can contain extra information used for
1572 calculating the size.
1573
1574 See the table below for the appropriate \a option casts:
1575
1576 \table
1577 \header \li Contents Type \li QStyleOption Subclass
1578 \row \li \l CT_CheckBox \li \l QStyleOptionButton
1579 \row \li \l CT_ComboBox \li \l QStyleOptionComboBox
1580 \row \li \l CT_GroupBox \li \l QStyleOptionGroupBox
1581 \row \li \l CT_HeaderSection \li \l QStyleOptionHeader
1582 \row \li \l CT_ItemViewItem \li \l QStyleOptionViewItem
1583 \row \li \l CT_LineEdit \li \l QStyleOptionFrame
1584 \row \li \l CT_MdiControls \li \l QStyleOptionComplex
1585 \row \li \l CT_Menu \li \l QStyleOption
1586 \row \li \l CT_MenuItem \li \l QStyleOptionMenuItem
1587 \row \li \l CT_MenuBar \li \l QStyleOptionMenuItem
1588 \row \li \l CT_MenuBarItem \li \l QStyleOptionMenuItem
1589 \row \li \l CT_ProgressBar \li \l QStyleOptionProgressBar
1590 \row \li \l CT_PushButton \li \l QStyleOptionButton
1591 \row \li \l CT_RadioButton \li \l QStyleOptionButton
1592 \row \li \l CT_ScrollBar \li \l QStyleOptionSlider
1593 \row \li \l CT_SizeGrip \li \l QStyleOption
1594 \row \li \l CT_Slider \li \l QStyleOptionSlider
1595 \row \li \l CT_SpinBox \li \l QStyleOptionSpinBox
1596 \row \li \l CT_Splitter \li \l QStyleOption
1597 \row \li \l CT_TabBarTab \li \l QStyleOptionTab
1598 \row \li \l CT_TabWidget \li \l QStyleOptionTabWidgetFrame
1599 \row \li \l CT_ToolButton \li \l QStyleOptionToolButton
1600 \endtable
1601
1602 \sa ContentsType, QStyleOption
1603*/
1604
1605/*!
1606 \enum QStyle::RequestSoftwareInputPanel
1607
1608 This enum describes under what circumstances a software input panel will be
1609 requested by input capable widgets.
1610
1611 \value RSIP_OnMouseClickAndAlreadyFocused Requests an input panel if the user
1612 clicks on the widget, but only if it is already focused.
1613 \value RSIP_OnMouseClick Requests an input panel if the user clicks on the
1614 widget.
1615
1616 \sa QInputMethod
1617*/
1618
1619/*!
1620 \enum QStyle::StyleHint
1621
1622 This enum describes the available style hints. A style hint is a general look
1623 and/or feel hint.
1624
1625 \value SH_EtchDisabledText Disabled text is "etched" as it is on Windows.
1626
1627 \value SH_DitherDisabledText Disabled text is dithered as it is on Motif.
1628
1629 \value SH_ScrollBar_ContextMenu Whether or not a scroll bar has a context menu.
1630
1631 \value SH_ScrollBar_MiddleClickAbsolutePosition A boolean value.
1632 If true, middle clicking on a scroll bar causes the slider to
1633 jump to that position. If false, middle clicking is
1634 ignored.
1635
1636 \value SH_ScrollBar_LeftClickAbsolutePosition A boolean value.
1637 If true, left clicking on a scroll bar causes the slider to
1638 jump to that position. If false, left clicking will
1639 behave as appropriate for each control.
1640
1641 \value SH_ScrollBar_ScrollWhenPointerLeavesControl A boolean
1642 value. If true, when clicking a scroll bar SubControl, holding
1643 the mouse button down and moving the pointer outside the
1644 SubControl, the scroll bar continues to scroll. If false, the
1645 scollbar stops scrolling when the pointer leaves the
1646 SubControl.
1647
1648 \value SH_ScrollBar_RollBetweenButtons A boolean value.
1649 If true, when clicking a scroll bar button (SC_ScrollBarAddLine or
1650 SC_ScrollBarSubLine) and dragging over to the opposite button (rolling)
1651 will press the new button and release the old one. When it is false, the
1652 original button is released and nothing happens (like a push button).
1653
1654 \value SH_TabBar_Alignment The alignment for tabs in a
1655 QTabWidget. Possible values are Qt::AlignLeft,
1656 Qt::AlignCenter and Qt::AlignRight.
1657
1658 \value SH_Header_ArrowAlignment The placement of the sorting
1659 indicator may appear in list or table headers. Possible values
1660 are Qt::Alignment values (that is, an OR combination of
1661 Qt::AlignmentFlag flags).
1662
1663 \value SH_Slider_SnapToValue Sliders snap to values while moving,
1664 as they do on Windows.
1665
1666 \value SH_Slider_SloppyKeyEvents Key presses handled in a sloppy
1667 manner, i.e., left on a vertical slider subtracts a line.
1668
1669 \value SH_ProgressDialog_CenterCancelButton Center button on
1670 progress dialogs, otherwise right aligned.
1671
1672 \value SH_ProgressDialog_TextLabelAlignment The alignment for text
1673 labels in progress dialogs; Qt::AlignCenter on Windows,
1674 Qt::AlignVCenter otherwise.
1675
1676 \value SH_PrintDialog_RightAlignButtons Right align buttons in
1677 the print dialog, as done on Windows.
1678
1679 \value SH_MainWindow_SpaceBelowMenuBar One or two pixel space between
1680 the menu bar and the dockarea, as done on Windows.
1681
1682 \value SH_FontDialog_SelectAssociatedText Select the text in the
1683 line edit, or when selecting an item from the listbox, or when
1684 the line edit receives focus, as done on Windows.
1685
1686 \value SH_Menu_KeyboardSearch Typing causes a menu to be search
1687 for relevant items, otherwise only mnemonic is considered.
1688
1689 \value SH_Menu_AllowActiveAndDisabled Allows disabled menu
1690 items to be active.
1691
1692 \value SH_Menu_SpaceActivatesItem Pressing the space bar activates
1693 the item, as done on Motif.
1694
1695 \value SH_Menu_SubMenuPopupDelay The number of milliseconds
1696 to wait before opening a submenu (256 on Windows, 96 on Motif).
1697
1698 \value SH_Menu_Scrollable Whether popup menus must support scrolling.
1699
1700 \value SH_Menu_SloppySubMenus Whether popup menus must support
1701 the user moving the mouse cursor to a submenu while crossing
1702 other items of the menu. This is supported on most modern
1703 desktop platforms.
1704
1705 \value SH_Menu_SubMenuUniDirection Since Qt 5.5. If the cursor has
1706 to move towards the submenu (like it is on \macos), or if the
1707 cursor can move in any direction as long as it reaches the
1708 submenu before the sloppy timeout.
1709
1710 \value SH_Menu_SubMenuUniDirectionFailCount Since Qt 5.5. When
1711 SH_Menu_SubMenuUniDirection is defined this enum defines the
1712 number of failed mouse moves before the sloppy submenu is
1713 discarded. This can be used to control the "strictness" of the
1714 uni direction algorithm.
1715
1716 \value SH_Menu_SubMenuSloppySelectOtherActions Since Qt 5.5. Should
1717 other action items be selected when the mouse moves towards a
1718 sloppy submenu.
1719
1720 \value SH_Menu_SubMenuSloppyCloseTimeout Since Qt 5.5. The timeout
1721 used to close sloppy submenus.
1722
1723 \value SH_Menu_SubMenuResetWhenReenteringParent Since Qt 5.5. When
1724 entering parent from child submenu, should the sloppy state be
1725 reset, effectively closing the child and making the current
1726 submenu active.
1727
1728 \value SH_Menu_SubMenuDontStartSloppyOnLeave Since Qt 5.5. Do not
1729 start sloppy timers when the mouse leaves a sub-menu.
1730
1731 \value SH_ScrollView_FrameOnlyAroundContents Whether scrollviews
1732 draw their frame only around contents (like Motif), or around
1733 contents, scroll bars and corner widgets (like Windows).
1734
1735 \value SH_MenuBar_AltKeyNavigation Menu bars items are navigable
1736 by pressing Alt, followed by using the arrow keys to select
1737 the desired item.
1738
1739 \value SH_ComboBox_ListMouseTracking Mouse tracking in combobox
1740 drop-down lists.
1741
1742 \value SH_Menu_MouseTracking Mouse tracking in popup menus.
1743
1744 \value SH_MenuBar_MouseTracking Mouse tracking in menu bars.
1745
1746 \value SH_Menu_FillScreenWithScroll Whether scrolling popups
1747 should fill the screen as they are scrolled.
1748
1749 \value SH_Menu_SelectionWrap Whether popups should allow the selections
1750 to wrap, that is when selection should the next item be the first item.
1751
1752 \value SH_ItemView_ChangeHighlightOnFocus Gray out selected items
1753 when losing focus.
1754
1755 \value SH_Widget_ShareActivation Turn on sharing activation with
1756 floating modeless dialogs.
1757
1758 \value SH_TabBar_SelectMouseType Which type of mouse event should
1759 cause a tab to be selected.
1760
1761 \value SH_ListViewExpand_SelectMouseType Which type of mouse event should
1762 cause a list view expansion to be selected.
1763
1764 \value SH_TabBar_PreferNoArrows Whether a tab bar should suggest a size
1765 to prevent scroll arrows.
1766
1767 \value SH_ComboBox_Popup Allows popups as a combobox drop-down
1768 menu.
1769
1770 \omitvalue SH_ComboBox_UseNativePopup
1771
1772 \value SH_Workspace_FillSpaceOnMaximize The workspace should
1773 maximize the client area.
1774
1775 \value SH_TitleBar_NoBorder The title bar has no border.
1776
1777 \value SH_Slider_StopMouseOverSlider Stops auto-repeat when
1778 the slider reaches the mouse position.
1779
1780 \value SH_BlinkCursorWhenTextSelected Whether cursor should blink
1781 when text is selected.
1782
1783 \value SH_RichText_FullWidthSelection Whether richtext selections
1784 should extend to the full width of the document.
1785
1786 \value SH_GroupBox_TextLabelVerticalAlignment How to vertically align a
1787 group box's text label.
1788
1789 \value SH_GroupBox_TextLabelColor How to paint a group box's text label.
1790
1791 \value SH_DialogButtons_DefaultButton Which button gets the
1792 default status in a dialog's button widget.
1793
1794 \value SH_ToolBox_SelectedPageTitleBold Boldness of the selected
1795 page title in a QToolBox.
1796
1797 \value SH_LineEdit_PasswordCharacter The Unicode character to be
1798 used for passwords.
1799
1800 \value SH_LineEdit_PasswordMaskDelay Determines the delay before visible character is masked
1801 with password character, in milliseconds. This enum value was added in Qt 5.4.
1802
1803 \value SH_Table_GridLineColor The RGBA value of the grid for a table.
1804
1805 \value SH_UnderlineShortcut Whether shortcuts are underlined.
1806
1807 \value SH_SpinBox_AnimateButton Animate a click when up or down is
1808 pressed in a spin box.
1809 \value SH_SpinBox_KeyPressAutoRepeatRate Auto-repeat interval for
1810 spinbox key presses.
1811 \value SH_SpinBox_ClickAutoRepeatRate Auto-repeat interval for
1812 spinbox mouse clicks.
1813 \value SH_SpinBox_ClickAutoRepeatThreshold Auto-repeat threshold for
1814 spinbox mouse clicks.
1815 \value [since 6.3] SH_SpinBox_SelectOnStep Whether changing the value using
1816 the buttons or up/down keys automatically selects the text.
1817
1818 \value SH_ToolTipLabel_Opacity An integer indicating the opacity for
1819 the tip label, 0 is completely transparent, 255 is completely
1820 opaque.
1821 \value SH_DrawMenuBarSeparator Indicates whether or not the menu bar draws separators.
1822 \value SH_TitleBar_ModifyNotification Indicates if the title bar should show
1823 a '*' for windows that are modified.
1824
1825 \value SH_Button_FocusPolicy The default focus policy for buttons.
1826
1827 \value SH_CustomBase Base value for custom style hints.
1828 Custom values must be greater than this value.
1829
1830 \value SH_MessageBox_UseBorderForButtonSpacing A boolean indicating what the to
1831 use the border of the buttons (computed as half the button height) for the spacing
1832 of the button in a message box.
1833
1834 \value SH_MessageBox_CenterButtons A boolean indicating whether the buttons in the
1835 message box should be centered or not (see QDialogButtonBox::setCentered()).
1836
1837 \value SH_MessageBox_TextInteractionFlags A boolean indicating if
1838 the text in a message box should allow user interactions (e.g.
1839 selection) or not.
1840
1841 \value SH_TitleBar_AutoRaise A boolean indicating whether
1842 controls on a title bar ought to update when the mouse is over them.
1843
1844 \value SH_ToolButton_PopupDelay An int indicating the popup delay in milliseconds
1845 for menus attached to tool buttons.
1846
1847 \value SH_FocusFrame_Mask The mask of the focus frame.
1848
1849 \value SH_RubberBand_Mask The mask of the rubber band.
1850
1851 \value SH_WindowFrame_Mask The mask of the window frame.
1852
1853 \value SH_SpinControls_DisableOnBounds Determines if the spin controls will shown
1854 as disabled when reaching the spin range boundary.
1855
1856 \value SH_Dial_BackgroundRole Defines the style's preferred
1857 background role (as QPalette::ColorRole) for a dial widget.
1858
1859 \value SH_ComboBox_LayoutDirection The layout direction for the
1860 combo box. By default it should be the same as indicated by the
1861 QStyleOption::direction variable.
1862
1863 \value SH_ItemView_EllipsisLocation The location where ellipses should be
1864 added for item text that is too long to fit in an view item.
1865
1866 \value SH_ItemView_ShowDecorationSelected When an item in an item
1867 view is selected, also highlight the branch or other decoration.
1868
1869 \value SH_ItemView_ActivateItemOnSingleClick Emit the activated signal
1870 when the user single clicks on an item in an item in an item view.
1871 Otherwise the signal is emitted when the user double clicks on an item.
1872
1873 \value SH_Slider_AbsoluteSetButtons Which mouse buttons cause a slider
1874 to set the value to the position clicked on.
1875
1876 \value SH_Slider_PageSetButtons Which mouse buttons cause a slider
1877 to page step the value.
1878
1879 \value SH_TabBar_ElideMode The default eliding style for a tab bar.
1880
1881 \value SH_DialogButtonLayout Controls how buttons are laid out in a QDialogButtonBox, returns a QDialogButtonBox::ButtonLayout enum.
1882
1883 \value SH_WizardStyle Controls the look and feel of a QWizard. Returns a QWizard::WizardStyle enum.
1884
1885 \value SH_FormLayoutWrapPolicy Provides a default for how rows are wrapped in a QFormLayout. Returns a QFormLayout::RowWrapPolicy enum.
1886 \value SH_FormLayoutFieldGrowthPolicy Provides a default for how fields can grow in a QFormLayout. Returns a QFormLayout::FieldGrowthPolicy enum.
1887 \value SH_FormLayoutFormAlignment Provides a default for how a QFormLayout aligns its contents within the available space. Returns a Qt::Alignment enum.
1888 \value SH_FormLayoutLabelAlignment Provides a default for how a QFormLayout aligns labels within the available space. Returns a Qt::Alignment enum.
1889
1890 \value SH_ItemView_ArrowKeysNavigateIntoChildren Controls whether the tree view will select the first child when it is exapanded and the right arrow key is pressed.
1891 \value SH_ComboBox_PopupFrameStyle The frame style used when drawing a combobox popup menu.
1892
1893 \value SH_DialogButtonBox_ButtonsHaveIcons Indicates whether or not StandardButtons in QDialogButtonBox should have icons or not.
1894 \value SH_ItemView_MovementWithoutUpdatingSelection The item view is able to indicate a current item without changing the selection.
1895 \value SH_ToolTip_Mask The mask of a tool tip.
1896
1897 \value SH_FocusFrame_AboveWidget The FocusFrame is stacked above the widget that it is "focusing on".
1898
1899 \value SH_TextControl_FocusIndicatorTextCharFormat Specifies the text format used to highlight focused anchors in rich text
1900 documents displayed for example in QTextBrowser. The format has to be a QTextCharFormat returned in the variant of the
1901 QStyleHintReturnVariant return value. The QTextFormat::OutlinePen property is used for the outline and QTextFormat::BackgroundBrush
1902 for the background of the highlighted area.
1903
1904 \value SH_Menu_FlashTriggeredItem Flash triggered item.
1905 \value SH_Menu_FadeOutOnHide Fade out the menu instead of hiding it immediately.
1906
1907 \value SH_TabWidget_DefaultTabPosition Default position of the tab bar in a tab widget.
1908
1909 \value SH_ToolBar_Movable Determines if the tool bar is movable by default.
1910
1911 \value SH_ItemView_PaintAlternatingRowColorsForEmptyArea Whether QTreeView paints alternating row colors for the area that does not have any items.
1912
1913 \value SH_Menu_Mask The mask for a popup menu.
1914
1915 \value SH_ItemView_DrawDelegateFrame Determines if there should be a frame for a delegate widget.
1916
1917 \value SH_TabBar_CloseButtonPosition Determines the position of the close button on a tab in a tab bar.
1918
1919 \value SH_DockWidget_ButtonsHaveFrame Determines if dockwidget buttons should have frames. Default is true.
1920
1921 \value SH_ToolButtonStyle Determines the default system style for tool buttons that uses Qt::ToolButtonFollowStyle.
1922
1923 \value SH_RequestSoftwareInputPanel Determines when a software input panel should
1924 be requested by input widgets. Returns an enum of type QStyle::RequestSoftwareInputPanel.
1925
1926 \value SH_ScrollBar_Transient Determines if the style supports transient scroll bars. Transient
1927 scroll bars appear when the content is scrolled and disappear when they are no longer needed.
1928
1929 \value SH_Menu_SupportsSections Determines if the style displays sections in menus or treat them as
1930 plain separators. Sections are separators with a text and icon hint.
1931
1932 \value SH_ToolTip_WakeUpDelay Determines the delay before a tooltip is shown, in milliseconds.
1933
1934 \value SH_ToolTip_FallAsleepDelay Determines the delay (in milliseconds) before a new wake time is needed when
1935 a tooltip is shown (notice: shown, not hidden). When a new wake isn't needed, a user-requested tooltip
1936 will be shown nearly instantly.
1937
1938 \value SH_Widget_Animate Deprecated. Use \l{SH_Widget_Animation_Duration} instead.
1939
1940 \value SH_Splitter_OpaqueResize Determines if widgets are resized dynamically (opaquely) while
1941 interactively moving the splitter. This enum value was introduced in Qt 5.2.
1942
1943 \value SH_TabBar_ChangeCurrentDelay Determines the delay before the current
1944 tab is changed while dragging over the tabbar, in milliseconds. This
1945 enum value has been introduced in Qt 5.4
1946
1947 \value SH_ItemView_ScrollMode The default vertical and horizontal scroll mode as specified
1948 by the style. Can be overridden with QAbstractItemView::setVerticalScrollMode() and
1949 QAbstractItemView::setHorizontalScrollMode(). This enum value has been introduced in Qt 5.7.
1950
1951 \value SH_TitleBar_ShowToolTipsOnButtons
1952 Determines if tool tips are shown on window title bar buttons.
1953 The Mac style, for example, sets this to false.
1954 This enum value has been introduced in Qt 5.10.
1955
1956 \value SH_Widget_Animation_Duration
1957 Determines how much an animation should last (in ms).
1958 A value equal to zero means that the animations will be disabled.
1959 This enum value has been introduced in Qt 5.10.
1960
1961 \value SH_ComboBox_AllowWheelScrolling
1962 Determines if the mouse wheel can be used to scroll inside a QComboBox.
1963 This is on by default in all styles except the Mac style.
1964 This enum value has been introduced in Qt 5.10.
1965
1966 \value SH_SpinBox_ButtonsInsideFrame
1967 Determines if the spin box buttons are inside the line edit frame.
1968 This enum value has been introduced in Qt 5.11.
1969
1970 \value SH_SpinBox_StepModifier
1971 Determines which Qt::KeyboardModifier increases the step rate of
1972 QAbstractSpinBox. Possible values are Qt::NoModifier,
1973 Qt::ControlModifier (default) or Qt::ShiftModifier. Qt::NoModifier
1974 disables this feature.
1975 This enum value has been introduced in Qt 5.12.
1976
1977 \value SH_TabBar_AllowWheelScrolling
1978 Determines if the mouse wheel can be used to cycle through the tabs
1979 of a QTabBar.
1980 This enum value has been introduced in Qt 6.1.
1981
1982 \value SH_Table_AlwaysDrawLeftTopGridLines
1983 Determines if the far left and top grid lines are drawn in a table or
1984 not when the header is hidden. Defaults to false.
1985 This enum value has been introduced in Qt 6.3.
1986
1987 \sa styleHint()
1988*/
1989
1990/*!
1991 \fn int QStyle::styleHint(StyleHint hint, const QStyleOption *option, const QWidget *widget, QStyleHintReturn *returnData) const
1992
1993 Returns an integer representing the specified style \a hint for
1994 the given \a widget described by the provided style \a option.
1995
1996 \a returnData is used when the querying widget needs more detailed data than
1997 the integer that styleHint() returns. See the QStyleHintReturn class
1998 description for details.
1999*/
2000
2001/*!
2002 \enum QStyle::StandardPixmap
2003
2004 This enum describes the available standard pixmaps. A standard pixmap is a pixmap that
2005 can follow some existing GUI style or guideline.
2006
2007 \value SP_TitleBarMinButton Minimize button on title bars (e.g.,
2008 in QMdiSubWindow).
2009 \value SP_TitleBarMenuButton Menu button on a title bar.
2010 \value SP_TitleBarMaxButton Maximize button on title bars.
2011 \value SP_TitleBarCloseButton Close button on title bars.
2012 \value SP_TitleBarNormalButton Normal (restore) button on title bars.
2013 \value SP_TitleBarShadeButton Shade button on title bars.
2014 \value SP_TitleBarUnshadeButton Unshade button on title bars.
2015 \value SP_TitleBarContextHelpButton The Context help button on title bars.
2016 \value SP_MessageBoxInformation The "information" icon.
2017 \value SP_MessageBoxWarning The "warning" icon.
2018 \value SP_MessageBoxCritical The "critical" icon.
2019 \value SP_MessageBoxQuestion The "question" icon.
2020 \value SP_DesktopIcon The "desktop" icon.
2021 \value SP_TrashIcon The "trash" icon.
2022 \value SP_ComputerIcon The "My computer" icon.
2023 \value SP_DriveFDIcon The floppy icon.
2024 \value SP_DriveHDIcon The harddrive icon.
2025 \value SP_DriveCDIcon The CD icon.
2026 \value SP_DriveDVDIcon The DVD icon.
2027 \value SP_DriveNetIcon The network icon.
2028 \value SP_DirHomeIcon The home directory icon.
2029 \value SP_DirOpenIcon The open directory icon.
2030 \value SP_DirClosedIcon The closed directory icon.
2031 \value SP_DirIcon The directory icon.
2032 \value SP_DirLinkIcon The link to directory icon.
2033 \value SP_DirLinkOpenIcon The link to open directory icon.
2034 \value SP_FileIcon The file icon.
2035 \value SP_FileLinkIcon The link to file icon.
2036 \value SP_FileDialogStart The "start" icon in a file dialog.
2037 \value SP_FileDialogEnd The "end" icon in a file dialog.
2038 \value SP_FileDialogToParent The "parent directory" icon in a file dialog.
2039 \value SP_FileDialogNewFolder The "create new folder" icon in a file dialog.
2040 \value SP_FileDialogDetailedView The detailed view icon in a file dialog.
2041 \value SP_FileDialogInfoView The file info icon in a file dialog.
2042 \value SP_FileDialogContentsView The contents view icon in a file dialog.
2043 \value SP_FileDialogListView The list view icon in a file dialog.
2044 \value SP_FileDialogBack The back arrow in a file dialog.
2045 \value SP_DockWidgetCloseButton Close button on dock windows (see also QDockWidget).
2046 \value SP_ToolBarHorizontalExtensionButton Extension button for horizontal toolbars.
2047 \value SP_ToolBarVerticalExtensionButton Extension button for vertical toolbars.
2048 \value SP_DialogOkButton Icon for a standard OK button in a QDialogButtonBox.
2049 \value SP_DialogCancelButton Icon for a standard Cancel button in a QDialogButtonBox.
2050 \value SP_DialogHelpButton Icon for a standard Help button in a QDialogButtonBox.
2051 \value SP_DialogOpenButton Icon for a standard Open button in a QDialogButtonBox.
2052 \value SP_DialogSaveButton Icon for a standard Save button in a QDialogButtonBox.
2053 \value SP_DialogCloseButton Icon for a standard Close button in a QDialogButtonBox.
2054 \value SP_DialogApplyButton Icon for a standard Apply button in a QDialogButtonBox.
2055 \value SP_DialogResetButton Icon for a standard Reset button in a QDialogButtonBox.
2056 \value SP_DialogDiscardButton Icon for a standard Discard button in a QDialogButtonBox.
2057 \value SP_DialogYesButton Icon for a standard Yes button in a QDialogButtonBox.
2058 \value SP_DialogNoButton Icon for a standard No button in a QDialogButtonBox.
2059 \value SP_ArrowUp Icon arrow pointing up.
2060 \value SP_ArrowDown Icon arrow pointing down.
2061 \value SP_ArrowLeft Icon arrow pointing left.
2062 \value SP_ArrowRight Icon arrow pointing right.
2063 \value SP_ArrowBack Equivalent to SP_ArrowLeft when the current layout direction is Qt::LeftToRight, otherwise SP_ArrowRight.
2064 \value SP_ArrowForward Equivalent to SP_ArrowRight when the current layout direction is Qt::LeftToRight, otherwise SP_ArrowLeft.
2065 \value SP_CommandLink Icon used to indicate a Vista style command link glyph.
2066 \value SP_VistaShield Icon used to indicate UAC prompts on Windows Vista. This will return a null pixmap or icon on all other platforms.
2067 \value SP_BrowserReload Icon indicating that the current page should be reloaded.
2068 \value SP_BrowserStop Icon indicating that the page loading should stop.
2069 \value SP_MediaPlay Icon indicating that media should begin playback.
2070 \value SP_MediaStop Icon indicating that media should stop playback.
2071 \value SP_MediaPause Icon indicating that media should pause playback.
2072 \value SP_MediaSkipForward Icon indicating that media should skip forward.
2073 \value SP_MediaSkipBackward Icon indicating that media should skip backward.
2074 \value SP_MediaSeekForward Icon indicating that media should seek forward.
2075 \value SP_MediaSeekBackward Icon indicating that media should seek backward.
2076 \value SP_MediaVolume Icon indicating a volume control.
2077 \value SP_MediaVolumeMuted Icon indicating a muted volume control.
2078 \value [since 5.2] SP_LineEditClearButton Icon for a standard clear button in a QLineEdit.
2079 \value [since 5.14] SP_DialogYesToAllButton Icon for a standard YesToAll button in a QDialogButtonBox.
2080 \value [since 5.14] SP_DialogNoToAllButton Icon for a standard NoToAll button in a QDialogButtonBox.
2081 \value [since 5.14] SP_DialogSaveAllButton Icon for a standard SaveAll button in a QDialogButtonBox.
2082 \value [since 5.14] SP_DialogAbortButton Icon for a standard Abort button in a QDialogButtonBox.
2083 \value [since 5.14] SP_DialogRetryButton Icon for a standard Retry button in a QDialogButtonBox.
2084 \value [since 5.14] SP_DialogIgnoreButton Icon for a standard Ignore button in a QDialogButtonBox.
2085 \value [since 5.14] SP_RestoreDefaultsButton Icon for a standard RestoreDefaults button in a QDialogButtonBox.
2086 \value [since 6.3] SP_TabCloseButton Icon for the close button in the tab of a QTabBar.
2087 \omitvalue NStandardPixmap
2088 \value SP_CustomBase Base value for custom standard pixmaps;
2089 custom values must be greater than this value.
2090
2091 \sa standardIcon()
2092*/
2093
2094/*!
2095 \fn QPixmap QStyle::generatedIconPixmap(QIcon::Mode iconMode,
2096 const QPixmap &pixmap, const QStyleOption *option) const
2097
2098 Returns a copy of the given \a pixmap, styled to conform to the
2099 specified \a iconMode and taking into account the palette
2100 specified by \a option.
2101
2102 The \a option parameter can pass extra information, but
2103 it must contain a palette.
2104
2105 Note that not all pixmaps will conform, in which case the returned
2106 pixmap is a plain copy.
2107
2108 \sa QIcon
2109*/
2110
2111/*!
2112 \fn QPixmap QStyle::standardPixmap(StandardPixmap standardPixmap, const QStyleOption *option, const QWidget *widget) const
2113
2114 \deprecated
2115 Returns a pixmap for the given \a standardPixmap.
2116
2117 A standard pixmap is a pixmap that can follow some existing GUI
2118 style or guideline. The \a option argument can be used to pass
2119 extra information required when defining the appropriate
2120 pixmap. The \a widget argument is optional and can also be used to
2121 aid the determination of the pixmap.
2122
2123 Developers calling standardPixmap() should instead call standardIcon()
2124 Developers who re-implemented standardPixmap() should instead re-implement
2125 standardIcon().
2126
2127 \sa standardIcon()
2128*/
2129
2130
2131/*!
2132 \fn QRect QStyle::visualRect(Qt::LayoutDirection direction, const QRect &boundingRectangle, const QRect &logicalRectangle)
2133
2134 Returns the given \a logicalRectangle converted to screen
2135 coordinates based on the specified \a direction. The \a
2136 boundingRectangle is used when performing the translation.
2137
2138 This function is provided to support right-to-left desktops, and
2139 is typically used in implementations of the subControlRect()
2140 function.
2141
2142 \sa QWidget::layoutDirection
2143*/
2144QRect QStyle::visualRect(Qt::LayoutDirection direction, const QRect &boundingRect, const QRect &logicalRect)
2145{
2146 if (direction == Qt::LeftToRight)
2147 return logicalRect;
2148 QRect rect = logicalRect;
2149 rect.translate(dx: 2 * (boundingRect.right() - logicalRect.right()) +
2150 logicalRect.width() - boundingRect.width(), dy: 0);
2151 return rect;
2152}
2153
2154/*!
2155 \fn QPoint QStyle::visualPos(Qt::LayoutDirection direction, const QRect &boundingRectangle, const QPoint &logicalPosition)
2156
2157 Returns the given \a logicalPosition converted to screen
2158 coordinates based on the specified \a direction. The \a
2159 boundingRectangle is used when performing the translation.
2160
2161 \sa QWidget::layoutDirection
2162*/
2163QPoint QStyle::visualPos(Qt::LayoutDirection direction, const QRect &boundingRect, const QPoint &logicalPos)
2164{
2165 if (direction == Qt::LeftToRight)
2166 return logicalPos;
2167 return QPoint(boundingRect.right() - logicalPos.x(), logicalPos.y());
2168}
2169
2170/*!
2171 Returns a new rectangle of the specified \a size that is aligned to the given \a
2172 rectangle according to the specified \a alignment and \a direction.
2173 */
2174QRect QStyle::alignedRect(Qt::LayoutDirection direction, Qt::Alignment alignment, const QSize &size, const QRect &rectangle)
2175{
2176 alignment = visualAlignment(direction, alignment);
2177 int x = rectangle.x();
2178 int y = rectangle.y();
2179 int w = size.width();
2180 int h = size.height();
2181 if ((alignment & Qt::AlignVCenter) == Qt::AlignVCenter)
2182 y += rectangle.size().height()/2 - h/2;
2183 else if ((alignment & Qt::AlignBottom) == Qt::AlignBottom)
2184 y += rectangle.size().height() - h;
2185 if ((alignment & Qt::AlignRight) == Qt::AlignRight)
2186 x += rectangle.size().width() - w;
2187 else if ((alignment & Qt::AlignHCenter) == Qt::AlignHCenter)
2188 x += rectangle.size().width()/2 - w/2;
2189 return QRect(x, y, w, h);
2190}
2191
2192/*!
2193 Transforms an \a alignment of Qt::AlignLeft or Qt::AlignRight
2194 without Qt::AlignAbsolute into Qt::AlignLeft or Qt::AlignRight with
2195 Qt::AlignAbsolute according to the layout \a direction. The other
2196 alignment flags are left untouched.
2197
2198 If no horizontal alignment was specified, the function returns the
2199 default alignment for the given layout \a direction.
2200
2201 QWidget::layoutDirection
2202*/
2203Qt::Alignment QStyle::visualAlignment(Qt::LayoutDirection direction, Qt::Alignment alignment)
2204{
2205 return QGuiApplicationPrivate::visualAlignment(direction, alignment);
2206}
2207
2208/*!
2209 Converts the given \a logicalValue to a pixel position. The \a min
2210 parameter maps to 0, \a max maps to \a span and other values are
2211 distributed evenly in-between.
2212
2213 This function can handle the entire integer range without
2214 overflow, providing that \a span is less than 4096.
2215
2216 By default, this function assumes that the maximum value is on the
2217 right for horizontal items and on the bottom for vertical items.
2218 Set the \a upsideDown parameter to true to reverse this behavior.
2219
2220 \sa sliderValueFromPosition()
2221*/
2222
2223int QStyle::sliderPositionFromValue(int min, int max, int logicalValue, int span, bool upsideDown)
2224{
2225 if (span <= 0 || max <= min)
2226 return 0;
2227 if (logicalValue < min)
2228 return upsideDown ? span : 0;
2229 if (logicalValue > max)
2230 return upsideDown ? 0 : span;
2231
2232 const uint range = qint64(max) - min;
2233 const uint p = upsideDown ? qint64(max) - logicalValue : qint64(logicalValue) - min;
2234
2235 if (range > (uint)INT_MAX/4096) {
2236 double dpos = (double(p))/(double(range)/span);
2237 return int(dpos);
2238 } else if (q20::cmp_greater(t: range, u: span)) {
2239 return (2 * p * span + range) / (2*range);
2240 } else {
2241 uint div = span / range;
2242 uint mod = span % range;
2243 return p * div + (2 * p * mod + range) / (2 * range);
2244 }
2245 // equiv. to (p * span) / range + 0.5
2246 // no overflow because of this implicit assumption:
2247 // span <= 4096
2248}
2249
2250/*!
2251 \fn int QStyle::sliderValueFromPosition(int min, int max, int position, int span, bool upsideDown)
2252
2253 Converts the given pixel \a position to a logical value. 0 maps to
2254 the \a min parameter, \a span maps to \a max and other values are
2255 distributed evenly in-between.
2256
2257 This function can handle the entire integer range without
2258 overflow.
2259
2260 By default, this function assumes that the maximum value is on the
2261 right for horizontal items and on the bottom for vertical
2262 items. Set the \a upsideDown parameter to true to reverse this
2263 behavior.
2264
2265 \sa sliderPositionFromValue()
2266*/
2267
2268int QStyle::sliderValueFromPosition(int min, int max, int pos, int span, bool upsideDown)
2269{
2270 if (span <= 0 || pos <= 0)
2271 return upsideDown ? max : min;
2272 if (pos >= span)
2273 return upsideDown ? min : max;
2274
2275 const qint64 range = qint64(max) - min;
2276
2277 if (q20::cmp_greater(t: span, u: range)) {
2278 const int tmp = (2 * range * pos + span) / (qint64(2) * span);
2279 return upsideDown ? max - tmp : tmp + min;
2280 } else {
2281 const qint64 div = range / span;
2282 const qint64 mod = range % span;
2283 const int tmp = pos * div + (2 * mod * pos + span) / (qint64(2) * span);
2284 return upsideDown ? max - tmp : tmp + min;
2285 }
2286 // equiv. to min + (pos*range)/span + 0.5
2287 // no overflow because of this implicit assumption:
2288 // pos <= span < sqrt(INT_MAX+0.0625)+0.25 ~ sqrt(INT_MAX)
2289}
2290
2291/*!
2292 Returns the style's standard palette.
2293
2294 Note that on systems that support system colors, the style's
2295 standard palette is not used. In particular, the Windows
2296 Vista and Mac styles do not use the standard palette, but make
2297 use of native theme engines. With these styles, you should not set
2298 the palette with QApplication::setPalette().
2299
2300 \sa QApplication::setPalette()
2301 */
2302QPalette QStyle::standardPalette() const
2303{
2304 QColor background = QColor(0xd4, 0xd0, 0xc8); // win 2000 grey
2305
2306 QColor light(background.lighter());
2307 QColor dark(background.darker());
2308 QColor mid(Qt::gray);
2309 QPalette palette(Qt::black, background, light, dark, mid, Qt::black, Qt::white);
2310 palette.setBrush(cg: QPalette::Disabled, cr: QPalette::WindowText, brush: dark);
2311 palette.setBrush(cg: QPalette::Disabled, cr: QPalette::Text, brush: dark);
2312 palette.setBrush(cg: QPalette::Disabled, cr: QPalette::ButtonText, brush: dark);
2313 palette.setBrush(cg: QPalette::Disabled, cr: QPalette::Base, brush: background);
2314 return palette;
2315}
2316
2317/*!
2318 \since 4.1
2319
2320 \fn QIcon QStyle::standardIcon(StandardPixmap standardIcon, const QStyleOption *option = nullptr,
2321 const QWidget *widget = nullptr) const = 0;
2322
2323 Returns an icon for the given \a standardIcon.
2324
2325 The \a standardIcon is a standard pixmap which can follow some
2326 existing GUI style or guideline. The \a option argument can be
2327 used to pass extra information required when defining the
2328 appropriate icon. The \a widget argument is optional and can also
2329 be used to aid the determination of the icon.
2330*/
2331
2332/*!
2333 \since 4.3
2334
2335 \fn int QStyle::layoutSpacing(QSizePolicy::ControlType control1,
2336 QSizePolicy::ControlType control2, Qt::Orientation orientation,
2337 const QStyleOption *option = nullptr, const QWidget *widget = nullptr) const
2338
2339 Returns the spacing that should be used between \a control1 and
2340 \a control2 in a layout. \a orientation specifies whether the
2341 controls are laid out side by side or stacked vertically. The \a
2342 option parameter can be used to pass extra information about the
2343 parent widget. The \a widget parameter is optional and can also
2344 be used if \a option is \nullptr.
2345
2346 This function is called by the layout system. It is used only if
2347 PM_LayoutHorizontalSpacing or PM_LayoutVerticalSpacing returns a
2348 negative value.
2349
2350 \sa combinedLayoutSpacing()
2351*/
2352
2353/*!
2354 \since 4.3
2355
2356 Returns the spacing that should be used between \a controls1 and
2357 \a controls2 in a layout. \a orientation specifies whether the
2358 controls are laid out side by side or stacked vertically. The \a
2359 option parameter can be used to pass extra information about the
2360 parent widget. The \a widget parameter is optional and can also
2361 be used if \a option is \nullptr.
2362
2363 \a controls1 and \a controls2 are OR-combination of zero or more
2364 \l{QSizePolicy::ControlTypes}{control types}.
2365
2366 This function is called by the layout system. It is used only if
2367 PM_LayoutHorizontalSpacing or PM_LayoutVerticalSpacing returns a
2368 negative value.
2369
2370 \sa layoutSpacing()
2371*/
2372int QStyle::combinedLayoutSpacing(QSizePolicy::ControlTypes controls1,
2373 QSizePolicy::ControlTypes controls2, Qt::Orientation orientation,
2374 QStyleOption *option, QWidget *widget) const
2375{
2376 QSizePolicy::ControlType array1[MaxBits];
2377 QSizePolicy::ControlType array2[MaxBits];
2378 int count1 = unpackControlTypes(controls: controls1, array: array1);
2379 int count2 = unpackControlTypes(controls: controls2, array: array2);
2380 int result = -1;
2381
2382 for (int i = 0; i < count1; ++i) {
2383 for (int j = 0; j < count2; ++j) {
2384 int spacing = layoutSpacing(control1: array1[i], control2: array2[j], orientation, option, widget);
2385 result = qMax(a: spacing, b: result);
2386 }
2387 }
2388 return result;
2389}
2390
2391/*!
2392 \since 4.6
2393
2394 \fn const QStyle *QStyle::proxy() const
2395
2396 This function returns the current proxy for this style.
2397 By default most styles will return themselves. However
2398 when a proxy style is in use, it will allow the style to
2399 call back into its proxy.
2400*/
2401const QStyle * QStyle::proxy() const
2402{
2403 Q_D(const QStyle);
2404 return d->proxyStyle == this ? this : d->proxyStyle->proxy();
2405}
2406
2407/* \internal
2408
2409 This function sets the base style that style calls will be
2410 redirected to. Note that ownership is not transferred. \a style
2411 must be a valid pointer (not nullptr).
2412*/
2413void QStyle::setProxy(QStyle *style)
2414{
2415 Q_D(QStyle);
2416 Q_ASSERT(style);
2417 d->proxyStyle = style;
2418}
2419
2420//Windows and KDE allow menus to cover the taskbar, while GNOME and macOS don't
2421bool QStylePrivate::useFullScreenForPopup()
2422{
2423 auto theme = QGuiApplicationPrivate::platformTheme();
2424 return theme && theme->themeHint(hint: QPlatformTheme::UseFullScreenForPopupMenu).toBool();
2425}
2426
2427//
2428// QCachedPainter
2429QSet<QString> QCachedPainter::s_pixmapCacheKeys;
2430QCachedPainter::QCachedPainter(QPainter *painter, const QString &cachePrefix,
2431 const QStyleOption *option, QSize size, QRect paintRect)
2432 : m_painter(painter)
2433 , m_option(option)
2434 , m_paintRect(paintRect)
2435{
2436 const auto sz = size.isEmpty() ? option->rect.size() : size;
2437 const qreal dpr = QStyleHelper::getDpr(painter);
2438 m_pixmapName = QStyleHelper::uniqueName(key: cachePrefix, option, size: sz, dpr);
2439 m_alreadyCached = QPixmapCache::find(key: m_pixmapName, pixmap: &m_pixmap);
2440 if (!m_alreadyCached) {
2441 m_pixmap = styleCachePixmap(size: sz, pixelRatio: dpr);
2442 m_pixmapPainter = std::make_unique<QPainter>(args: &m_pixmap);
2443 m_pixmapPainter->setRenderHints(hints: painter->renderHints());
2444 s_pixmapCacheKeys += m_pixmapName;
2445 }
2446}
2447
2448QCachedPainter::~QCachedPainter()
2449{
2450 finish();
2451 if (!m_alreadyCached)
2452 QPixmapCache::insert(key: m_pixmapName, pixmap: m_pixmap);
2453}
2454
2455void QCachedPainter::finish()
2456{
2457 m_pixmapPainter.reset();
2458 if (!m_pixmapDrawn) {
2459 m_pixmapDrawn = true;
2460 if (m_paintRect.isNull())
2461 m_painter->drawPixmap(p: m_option->rect.topLeft(), pm: m_pixmap);
2462 else
2463 m_painter->drawPixmap(r: m_paintRect, pm: m_pixmap);
2464 }
2465}
2466
2467void QCachedPainter::cleanupPixmapCache()
2468{
2469 for (const auto &key : s_pixmapCacheKeys)
2470 QPixmapCache::remove(key);
2471 s_pixmapCacheKeys.clear();
2472}
2473
2474QT_END_NAMESPACE
2475
2476#include "moc_qstyle.cpp"
2477

source code of qtbase/src/widgets/styles/qstyle.cpp