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

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