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