| 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 | |
| 57 | QT_BEGIN_NAMESPACE |
| 58 | |
| 59 | static const int MaxBits = 8 * sizeof(QSizePolicy::ControlType); |
| 60 | |
| 61 | static 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(v: 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 | */ |
| 398 | QStyle::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 | */ |
| 410 | QStyle::QStyle(QStylePrivate &dd) |
| 411 | : QObject(dd) |
| 412 | { |
| 413 | Q_D(QStyle); |
| 414 | d->proxyStyle = this; |
| 415 | } |
| 416 | |
| 417 | /*! |
| 418 | Destroys the style object. |
| 419 | */ |
| 420 | QStyle::~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 | */ |
| 448 | void 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 | */ |
| 467 | void 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 | */ |
| 477 | void 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 | */ |
| 487 | void 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 | */ |
| 500 | void 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 | */ |
| 522 | QRect 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(ax: &x, ay: &y, aw: &w, ah: &h); |
| 528 | if (!text.isEmpty()) { |
| 529 | result = metrics.boundingRect(x, y, w, h, flags: alignment, text); |
| 530 | if (!enabled && proxy()->styleHint(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 | */ |
| 546 | QRect QStyle::itemPixmapRect(const QRect &rect, int alignment, const QPixmap &pixmap) const |
| 547 | { |
| 548 | QRect result; |
| 549 | int x, y, w, h; |
| 550 | rect.getRect(ax: &x, ay: &y, aw: &w, ah: &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 | */ |
| 585 | void 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(cr: textRole), savedPen.widthF())); |
| 594 | } |
| 595 | if (!enabled) { |
| 596 | if (proxy()->styleHint(stylehint: SH_DitherDisabledText)) { |
| 597 | QRect br; |
| 598 | painter->drawText(r: rect, flags: alignment, text, br: &br); |
| 599 | painter->fillRect(br, QBrush(painter->background().color(), Qt::Dense5Pattern)); |
| 600 | return; |
| 601 | } else if (proxy()->styleHint(stylehint: SH_EtchDisabledText)) { |
| 602 | QPen pen = painter->pen(); |
| 603 | painter->setPen(pal.light().color()); |
| 604 | painter->drawText(r: rect.adjusted(xp1: 1, yp1: 1, xp2: 1, yp2: 1), flags: alignment, text); |
| 605 | painter->setPen(pen); |
| 606 | } |
| 607 | } |
| 608 | painter->drawText(r: rect, flags: 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 | |
| 623 | void QStyle::drawItemPixmap(QPainter *painter, const QRect &rect, int alignment, |
| 624 | const QPixmap &pixmap) const |
| 625 | { |
| 626 | qreal scale = pixmap.devicePixelRatio(); |
| 627 | QRect aligned = alignedRect(direction: QGuiApplication::layoutDirection(), alignment: QFlag(alignment), size: pixmap.size() / scale, rectangle: rect); |
| 628 | QRect inter = aligned.intersected(other: rect); |
| 629 | |
| 630 | painter->drawPixmap(x: inter.x(), y: inter.y(), pm: pixmap, sx: inter.x() - aligned.x(), sy: inter.y() - aligned.y(), sw: qRound(d: inter.width() * scale), sh: qRound(d: inter.height() *scale)); |
| 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 | \omitvalue PE_IndicatorViewItemCheck |
| 641 | \value PE_FrameStatusBar Obsolete. Use PE_FrameStatusBarItem instead. |
| 642 | |
| 643 | \value PE_PanelButtonCommand Button used to initiate an action, for |
| 644 | example, a QPushButton. |
| 645 | |
| 646 | \value PE_FrameDefaultButton This frame around a default button, e.g. in a dialog. |
| 647 | \value PE_PanelButtonBevel Generic panel with a button bevel. |
| 648 | \value PE_PanelButtonTool Panel for a Tool button, used with QToolButton. |
| 649 | \value PE_PanelLineEdit Panel for a QLineEdit. |
| 650 | \value PE_IndicatorButtonDropDown Indicator for a drop down button, for example, a tool |
| 651 | button that displays a menu. |
| 652 | |
| 653 | \value PE_FrameFocusRect Generic focus indicator. |
| 654 | |
| 655 | \value PE_IndicatorArrowUp Generic Up arrow. |
| 656 | \value PE_IndicatorArrowDown Generic Down arrow. |
| 657 | \value PE_IndicatorArrowRight Generic Right arrow. |
| 658 | \value PE_IndicatorArrowLeft Generic Left arrow. |
| 659 | |
| 660 | \value PE_IndicatorSpinUp Up symbol for a spin widget, for example a QSpinBox. |
| 661 | \value PE_IndicatorSpinDown Down symbol for a spin widget. |
| 662 | \value PE_IndicatorSpinPlus Increase symbol for a spin widget. |
| 663 | \value PE_IndicatorSpinMinus Decrease symbol for a spin widget. |
| 664 | |
| 665 | \value PE_IndicatorItemViewItemCheck On/off indicator for a view item. |
| 666 | |
| 667 | \value PE_IndicatorCheckBox On/off indicator, for example, a QCheckBox. |
| 668 | \value PE_IndicatorRadioButton Exclusive on/off indicator, for example, a QRadioButton. |
| 669 | |
| 670 | \value PE_IndicatorDockWidgetResizeHandle Resize handle for dock windows. |
| 671 | |
| 672 | \value PE_Frame Generic frame |
| 673 | \value PE_FrameMenu Frame for popup windows/menus; see also QMenu. |
| 674 | \value PE_PanelMenuBar Panel for menu bars. |
| 675 | \value PE_PanelScrollAreaCorner Panel at the bottom-right (or |
| 676 | bottom-left) corner of a scroll area. |
| 677 | |
| 678 | \value PE_FrameDockWidget Panel frame for dock windows and toolbars. |
| 679 | \value PE_FrameTabWidget Frame for tab widgets. |
| 680 | \value PE_FrameLineEdit Panel frame for line edits. |
| 681 | \value PE_FrameGroupBox Panel frame around group boxes. |
| 682 | \value PE_FrameButtonBevel Panel frame for a button bevel. |
| 683 | \value PE_FrameButtonTool Panel frame for a tool button. |
| 684 | |
| 685 | \value PE_IndicatorHeaderArrow Arrow used to indicate sorting on a list or table |
| 686 | header. |
| 687 | \value PE_FrameStatusBarItem Frame for an item of a status bar; see also QStatusBar. |
| 688 | |
| 689 | \value PE_FrameWindow Frame around a MDI window or a docking window. |
| 690 | |
| 691 | \value PE_IndicatorMenuCheckMark Check mark used in a menu. |
| 692 | |
| 693 | \value PE_IndicatorProgressChunk Section of a progress bar indicator; see also QProgressBar. |
| 694 | |
| 695 | \value PE_IndicatorBranch Lines used to represent the branch of a tree in a tree view. |
| 696 | \value PE_IndicatorToolBarHandle The handle of a toolbar. |
| 697 | \value PE_IndicatorToolBarSeparator The separator in a toolbar. |
| 698 | \value PE_PanelToolBar The panel for a toolbar. |
| 699 | \value PE_PanelTipLabel The panel for a tip label. |
| 700 | \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. |
| 701 | \value PE_IndicatorTabTear Deprecated. Use \l{PE_IndicatorTabTearLeft} instead. |
| 702 | \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. |
| 703 | \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. |
| 704 | \value PE_IndicatorColumnViewArrow An arrow in a QColumnView. |
| 705 | |
| 706 | \value PE_Widget A plain QWidget. |
| 707 | |
| 708 | \value PE_CustomBase Base value for custom primitive elements. |
| 709 | All values above this are reserved for custom use. Custom values |
| 710 | must be greater than this value. |
| 711 | |
| 712 | \value PE_IndicatorItemViewItemDrop An indicator that is drawn to show where an item in an item view is about to be dropped |
| 713 | during a drag-and-drop operation in an item view. |
| 714 | \value PE_PanelItemViewItem The background for an item in an item view. |
| 715 | \value PE_PanelItemViewRow The background of a row in an item view. |
| 716 | |
| 717 | \value PE_PanelStatusBar The panel for a status bar. |
| 718 | |
| 719 | \value PE_IndicatorTabClose The close button on a tab bar. |
| 720 | \value PE_PanelMenu The panel for a menu. |
| 721 | |
| 722 | \sa drawPrimitive() |
| 723 | */ |
| 724 | |
| 725 | |
| 726 | /*! |
| 727 | \enum QStyle::StateFlag |
| 728 | |
| 729 | This enum describes flags that are used when drawing primitive |
| 730 | elements. |
| 731 | |
| 732 | Note that not all primitives use all of these flags, and that the |
| 733 | flags may mean different things to different items. |
| 734 | |
| 735 | \value State_None Indicates that the widget does not have a state. |
| 736 | \value State_Active Indicates that the widget is active. |
| 737 | \value State_AutoRaise Used to indicate if auto-raise appearance should be used on a tool button. |
| 738 | \value State_Children Used to indicate if an item view branch has children. |
| 739 | \value State_DownArrow Used to indicate if a down arrow should be visible on the widget. |
| 740 | \value State_Editing Used to indicate if an editor is opened on the widget. |
| 741 | \value State_Enabled Used to indicate if the widget is enabled. |
| 742 | \value State_HasEditFocus Used to indicate if the widget currently has edit focus. |
| 743 | \value State_HasFocus Used to indicate if the widget has focus. |
| 744 | \value State_Horizontal Used to indicate if the widget is laid out horizontally, for example. a tool bar. |
| 745 | \value State_KeyboardFocusChange Used to indicate if the focus was changed with the keyboard, e.g., tab, backtab or shortcut. |
| 746 | \value State_MouseOver Used to indicate if the widget is under the mouse. |
| 747 | \value State_NoChange Used to indicate a tri-state checkbox. |
| 748 | \value State_Off Used to indicate if the widget is not checked. |
| 749 | \value State_On Used to indicate if the widget is checked. |
| 750 | \value State_Raised Used to indicate if a button is raised. |
| 751 | \value State_ReadOnly Used to indicate if a widget is read-only. |
| 752 | \value State_Selected Used to indicate if a widget is selected. |
| 753 | \value State_Item Used by item views to indicate if a horizontal branch should be drawn. |
| 754 | \value State_Open Used by item views to indicate if the tree branch is open. |
| 755 | \value State_Sibling Used by item views to indicate if a vertical line needs to be drawn (for siblings). |
| 756 | \value State_Sunken Used to indicate if the widget is sunken or pressed. |
| 757 | \value State_UpArrow Used to indicate if an up arrow should be visible on the widget. |
| 758 | \value State_Mini Used to indicate a mini style Mac widget or button. |
| 759 | \value State_Small Used to indicate a small style Mac widget or button. |
| 760 | \omitvalue State_Window |
| 761 | \omitvalue State_Bottom |
| 762 | \omitvalue State_FocusAtBorder |
| 763 | \omitvalue State_Top |
| 764 | |
| 765 | \sa drawPrimitive() |
| 766 | */ |
| 767 | |
| 768 | /*! |
| 769 | \fn void QStyle::drawPrimitive(PrimitiveElement element, const QStyleOption *option, QPainter *painter, const QWidget *widget) const |
| 770 | |
| 771 | Draws the given primitive \a element with the provided \a painter using the style |
| 772 | options specified by \a option. |
| 773 | |
| 774 | The \a widget argument is optional and may contain a widget that may |
| 775 | aid in drawing the primitive element. |
| 776 | |
| 777 | The table below is listing the primitive elements and their |
| 778 | associated style option subclasses. The style options contain all |
| 779 | the parameters required to draw the elements, including |
| 780 | QStyleOption::state which holds the style flags that are used when |
| 781 | drawing. The table also describes which flags that are set when |
| 782 | casting the given option to the appropriate subclass. |
| 783 | |
| 784 | Note that if a primitive element is not listed here, it is because |
| 785 | it uses a plain QStyleOption object. |
| 786 | |
| 787 | \table |
| 788 | \header \li Primitive Element \li QStyleOption Subclass \li Style Flag \li Remark |
| 789 | \row \li \l PE_FrameFocusRect \li \l QStyleOptionFocusRect |
| 790 | \li \l State_FocusAtBorder |
| 791 | \li Whether the focus is is at the border or inside the widget. |
| 792 | \row \li{1,2} \l PE_IndicatorCheckBox \li{1,2} \l QStyleOptionButton |
| 793 | \li \l State_NoChange \li Indicates a "tri-state" checkbox. |
| 794 | \row \li \l State_On \li Indicates the indicator is checked. |
| 795 | \row \li \l PE_IndicatorRadioButton \li \l QStyleOptionButton |
| 796 | \li \l State_On \li Indicates that a radio button is selected. |
| 797 | \row \li \l State_NoChange \li Indicates a "tri-state" controller. |
| 798 | \row \li \l State_Enabled \li Indicates the controller is enabled. |
| 799 | \row \li{1,4} \l PE_IndicatorBranch \li{1,4} \l QStyleOption |
| 800 | \li \l State_Children \li Indicates that the control for expanding the tree to show child items, should be drawn. |
| 801 | \row \li \l State_Item \li Indicates that a horizontal branch (to show a child item), should be drawn. |
| 802 | \row \li \l State_Open \li Indicates that the tree branch is expanded. |
| 803 | \row \li \l State_Sibling \li Indicates that a vertical line (to show a sibling item), should be drawn. |
| 804 | \row \li \l PE_IndicatorHeaderArrow \li \l QStyleOptionHeader |
| 805 | \li \l State_UpArrow \li Indicates that the arrow should be drawn up; |
| 806 | otherwise it should be down. |
| 807 | \row \li \l PE_FrameGroupBox, \l PE_Frame, \l PE_FrameLineEdit, |
| 808 | \l PE_FrameMenu, \l PE_FrameDockWidget, \l PE_FrameWindow |
| 809 | \li \l QStyleOptionFrame \li \l State_Sunken |
| 810 | \li Indicates that the Frame should be sunken. |
| 811 | \row \li \l PE_IndicatorToolBarHandle \li \l QStyleOption |
| 812 | \li \l State_Horizontal \li Indicates that the window handle is horizontal |
| 813 | instead of vertical. |
| 814 | \row \li \l PE_IndicatorSpinPlus, \l PE_IndicatorSpinMinus, \l PE_IndicatorSpinUp, |
| 815 | \l PE_IndicatorSpinDown, |
| 816 | \li \l QStyleOptionSpinBox |
| 817 | \li \l State_Sunken \li Indicates that the button is pressed. |
| 818 | \row \li{1,5} \l PE_PanelButtonCommand |
| 819 | \li{1,5} \l QStyleOptionButton |
| 820 | \li \l State_Enabled \li Set if the button is enabled. |
| 821 | \row \li \l State_HasFocus \li Set if the button has input focus. |
| 822 | \row \li \l State_Raised \li Set if the button is not down, not on and not flat. |
| 823 | \row \li \l State_On \li Set if the button is a toggle button and is toggled on. |
| 824 | \row \li \l State_Sunken |
| 825 | \li Set if the button is down (i.e., the mouse button or the |
| 826 | space bar is pressed on the button). |
| 827 | \endtable |
| 828 | |
| 829 | \sa drawComplexControl(), drawControl() |
| 830 | */ |
| 831 | |
| 832 | /*! |
| 833 | \enum QStyle::ControlElement |
| 834 | |
| 835 | This enum represents a control element. A control element is a |
| 836 | part of a widget that performs some action or displays information |
| 837 | to the user. |
| 838 | |
| 839 | \value CE_PushButton A QPushButton, draws CE_PushButtonBevel, CE_PushButtonLabel and PE_FrameFocusRect. |
| 840 | \value CE_PushButtonBevel The bevel and default indicator of a QPushButton. |
| 841 | \value CE_PushButtonLabel The label (an icon with text or pixmap) of a QPushButton. |
| 842 | |
| 843 | \value CE_DockWidgetTitle Dock window title. |
| 844 | \value CE_Splitter Splitter handle; see also QSplitter. |
| 845 | |
| 846 | |
| 847 | \value CE_CheckBox A QCheckBox, draws a PE_IndicatorCheckBox, a CE_CheckBoxLabel and a PE_FrameFocusRect. |
| 848 | \value CE_CheckBoxLabel The label (text or pixmap) of a QCheckBox. |
| 849 | |
| 850 | \value CE_RadioButton A QRadioButton, draws a PE_IndicatorRadioButton, a CE_RadioButtonLabel and a PE_FrameFocusRect. |
| 851 | \value CE_RadioButtonLabel The label (text or pixmap) of a QRadioButton. |
| 852 | |
| 853 | \value CE_TabBarTab The tab and label within a QTabBar. |
| 854 | \value CE_TabBarTabShape The tab shape within a tab bar. |
| 855 | \value CE_TabBarTabLabel The label within a tab. |
| 856 | |
| 857 | \value CE_ProgressBar A QProgressBar, draws CE_ProgressBarGroove, CE_ProgressBarContents and CE_ProgressBarLabel. |
| 858 | \value CE_ProgressBarGroove The groove where the progress |
| 859 | indicator is drawn in a QProgressBar. |
| 860 | \value CE_ProgressBarContents The progress indicator of a QProgressBar. |
| 861 | \value CE_ProgressBarLabel The text label of a QProgressBar. |
| 862 | |
| 863 | \value CE_ToolButtonLabel A tool button's label. |
| 864 | |
| 865 | \value CE_MenuBarItem A menu item in a QMenuBar. |
| 866 | \value CE_MenuBarEmptyArea The empty area of a QMenuBar. |
| 867 | |
| 868 | \value CE_MenuItem A menu item in a QMenu. |
| 869 | \value CE_MenuScroller Scrolling areas in a QMenu when the |
| 870 | style supports scrolling. |
| 871 | \value CE_MenuTearoff A menu item representing the tear off section of |
| 872 | a QMenu. |
| 873 | \value CE_MenuEmptyArea The area in a menu without menu items. |
| 874 | \value CE_MenuHMargin The horizontal extra space on the left/right of a menu. |
| 875 | \value CE_MenuVMargin The vertical extra space on the top/bottom of a menu. |
| 876 | |
| 877 | \value CE_ToolBoxTab The toolbox's tab and label within a QToolBox. |
| 878 | \value CE_SizeGrip Window resize handle; see also QSizeGrip. |
| 879 | |
| 880 | \value CE_Header A header. |
| 881 | \value CE_HeaderSection A header section. |
| 882 | \value CE_HeaderLabel The header's label. |
| 883 | |
| 884 | \value CE_ScrollBarAddLine Scroll bar line increase indicator. |
| 885 | (i.e., scroll down); see also QScrollBar. |
| 886 | \value CE_ScrollBarSubLine Scroll bar line decrease indicator (i.e., scroll up). |
| 887 | \value CE_ScrollBarAddPage Scolllbar page increase indicator (i.e., page down). |
| 888 | \value CE_ScrollBarSubPage Scroll bar page decrease indicator (i.e., page up). |
| 889 | \value CE_ScrollBarSlider Scroll bar slider. |
| 890 | \value CE_ScrollBarFirst Scroll bar first line indicator (i.e., home). |
| 891 | \value CE_ScrollBarLast Scroll bar last line indicator (i.e., end). |
| 892 | |
| 893 | \value CE_RubberBand Rubber band used in for example an icon view. |
| 894 | |
| 895 | \value CE_FocusFrame Focus frame that is style controlled. |
| 896 | |
| 897 | \value CE_ItemViewItem An item inside an item view. |
| 898 | |
| 899 | \value CE_CustomBase Base value for custom control elements; |
| 900 | custom values must be greater than this value. |
| 901 | \value CE_ComboBoxLabel The label of a non-editable QComboBox. |
| 902 | \value CE_ToolBar A toolbar like QToolBar. |
| 903 | \value CE_ToolBoxTabShape The toolbox's tab shape. |
| 904 | \value CE_ToolBoxTabLabel The toolbox's tab label. |
| 905 | \value CE_HeaderEmptyArea The area of a header view where there are no header sections. |
| 906 | |
| 907 | \value CE_ShapedFrame The frame with the shape specified in the QStyleOptionFrame; see QFrame. |
| 908 | |
| 909 | \omitvalue CE_ColumnViewGrip |
| 910 | |
| 911 | \sa drawControl() |
| 912 | */ |
| 913 | |
| 914 | /*! |
| 915 | \fn void QStyle::drawControl(ControlElement element, const QStyleOption *option, QPainter *painter, const QWidget *widget) const |
| 916 | |
| 917 | Draws the given \a element with the provided \a painter with the |
| 918 | style options specified by \a option. |
| 919 | |
| 920 | The \a widget argument is optional and can be used as aid in |
| 921 | drawing the control. The \a option parameter is a pointer to a |
| 922 | QStyleOption object that can be cast to the correct subclass |
| 923 | using the qstyleoption_cast() function. |
| 924 | |
| 925 | The table below is listing the control elements and their |
| 926 | associated style option subclass. The style options contain all |
| 927 | the parameters required to draw the controls, including |
| 928 | QStyleOption::state which holds the style flags that are used when |
| 929 | drawing. The table also describes which flags that are set when |
| 930 | casting the given option to the appropriate subclass. |
| 931 | |
| 932 | Note that if a control element is not listed here, it is because |
| 933 | it uses a plain QStyleOption object. |
| 934 | |
| 935 | \table |
| 936 | \header \li Control Element \li QStyleOption Subclass \li Style Flag \li Remark |
| 937 | \row \li{1,5} \l CE_MenuItem, \l CE_MenuBarItem |
| 938 | \li{1,5} \l QStyleOptionMenuItem |
| 939 | \li \l State_Selected \li The menu item is currently selected item. |
| 940 | \row \li \l State_Enabled \li The item is enabled. |
| 941 | \row \li \l State_DownArrow \li Indicates that a scroll down arrow should be drawn. |
| 942 | \row \li \l State_UpArrow \li Indicates that a scroll up arrow should be drawn |
| 943 | \row \li \l State_HasFocus \li Set if the menu bar has input focus. |
| 944 | |
| 945 | \row \li{1,5} \l CE_PushButton, \l CE_PushButtonBevel, \l CE_PushButtonLabel |
| 946 | \li{1,5} \l QStyleOptionButton |
| 947 | \li \l State_Enabled \li Set if the button is enabled. |
| 948 | \row \li \l State_HasFocus \li Set if the button has input focus. |
| 949 | \row \li \l State_Raised \li Set if the button is not down, not on and not flat. |
| 950 | \row \li \l State_On \li Set if the button is a toggle button and is toggled on. |
| 951 | \row \li \l State_Sunken |
| 952 | \li Set if the button is down (i.e., the mouse button or the |
| 953 | space bar is pressed on the button). |
| 954 | |
| 955 | \row \li{1,6} \l CE_RadioButton, \l CE_RadioButtonLabel, |
| 956 | \l CE_CheckBox, \l CE_CheckBoxLabel |
| 957 | \li{1,6} \l QStyleOptionButton |
| 958 | \li \l State_Enabled \li Set if the button is enabled. |
| 959 | \row \li \l State_HasFocus \li Set if the button has input focus. |
| 960 | \row \li \l State_On \li Set if the button is checked. |
| 961 | \row \li \l State_Off \li Set if the button is not checked. |
| 962 | \row \li \l State_NoChange \li Set if the button is in the NoChange state. |
| 963 | \row \li \l State_Sunken |
| 964 | \li Set if the button is down (i.e., the mouse button or |
| 965 | the space bar is pressed on the button). |
| 966 | |
| 967 | \row \li{1,2} \l CE_ProgressBarContents, \l CE_ProgressBarLabel, |
| 968 | \l CE_ProgressBarGroove |
| 969 | \li{1,2} \l QStyleOptionProgressBar |
| 970 | \li \l State_Enabled \li Set if the progress bar is enabled. |
| 971 | \row \li \l State_HasFocus \li Set if the progress bar has input focus. |
| 972 | |
| 973 | \row \li \l CE_Header, \l CE_HeaderSection, \l CE_HeaderLabel \li \l QStyleOptionHeader \li \li |
| 974 | |
| 975 | \row \li{1,3} \l CE_TabBarTab, CE_TabBarTabShape, CE_TabBarTabLabel |
| 976 | \li{1,3} \l QStyleOptionTab |
| 977 | \li \l State_Enabled \li Set if the tab bar is enabled. |
| 978 | \row \li \l State_Selected \li The tab bar is the currently selected tab bar. |
| 979 | \row \li \l State_HasFocus \li Set if the tab bar tab has input focus. |
| 980 | |
| 981 | \row \li{1,7} \l CE_ToolButtonLabel |
| 982 | \li{1,7} \l QStyleOptionToolButton |
| 983 | \li \l State_Enabled \li Set if the tool button is enabled. |
| 984 | \row \li \l State_HasFocus \li Set if the tool button has input focus. |
| 985 | \row \li \l State_Sunken |
| 986 | \li Set if the tool button is down (i.e., a mouse button or |
| 987 | the space bar is pressed). |
| 988 | \row \li \l State_On \li Set if the tool button is a toggle button and is toggled on. |
| 989 | \row \li \l State_AutoRaise \li Set if the tool button has auto-raise enabled. |
| 990 | \row \li \l State_MouseOver \li Set if the mouse pointer is over the tool button. |
| 991 | \row \li \l State_Raised \li Set if the button is not down and is not on. |
| 992 | |
| 993 | \row \li \l CE_ToolBoxTab \li \l QStyleOptionToolBox |
| 994 | \li \l State_Selected \li The tab is the currently selected tab. |
| 995 | \row \li{1,3} \l CE_HeaderSection \li{1,3} \l QStyleOptionHeader |
| 996 | \li \l State_Sunken \li Indicates that the section is pressed. |
| 997 | \row \li \l State_UpArrow \li Indicates that the sort indicator should be pointing up. |
| 998 | \row \li \l State_DownArrow \li Indicates that the sort indicator should be pointing down. |
| 999 | \endtable |
| 1000 | |
| 1001 | \sa drawPrimitive(), drawComplexControl() |
| 1002 | */ |
| 1003 | |
| 1004 | /*! |
| 1005 | \enum QStyle::SubElement |
| 1006 | |
| 1007 | This enum represents a sub-area of a widget. Style implementations |
| 1008 | use these areas to draw the different parts of a widget. |
| 1009 | |
| 1010 | \value SE_PushButtonContents Area containing the label (icon |
| 1011 | with text or pixmap). |
| 1012 | \value SE_PushButtonFocusRect Area for the focus rect (usually |
| 1013 | larger than the contents rect). |
| 1014 | \value SE_PushButtonLayoutItem Area that counts for the parent layout. |
| 1015 | \value SE_PushButtonBevel [since 5.15] Area used for the bevel of the button. |
| 1016 | |
| 1017 | \value SE_CheckBoxIndicator Area for the state indicator (e.g., check mark). |
| 1018 | \value SE_CheckBoxContents Area for the label (text or pixmap). |
| 1019 | \value SE_CheckBoxFocusRect Area for the focus indicator. |
| 1020 | \value SE_CheckBoxClickRect Clickable area, defaults to SE_CheckBoxFocusRect. |
| 1021 | \value SE_CheckBoxLayoutItem Area that counts for the parent layout. |
| 1022 | |
| 1023 | \value SE_DateTimeEditLayoutItem Area that counts for the parent layout. |
| 1024 | |
| 1025 | \value SE_RadioButtonIndicator Area for the state indicator. |
| 1026 | \value SE_RadioButtonContents Area for the label. |
| 1027 | \value SE_RadioButtonFocusRect Area for the focus indicator. |
| 1028 | \value SE_RadioButtonClickRect Clickable area, defaults to SE_RadioButtonFocusRect. |
| 1029 | \value SE_RadioButtonLayoutItem Area that counts for the parent layout. |
| 1030 | |
| 1031 | \value SE_ComboBoxFocusRect Area for the focus indicator. |
| 1032 | |
| 1033 | \value SE_SliderFocusRect Area for the focus indicator. |
| 1034 | \value SE_SliderLayoutItem Area that counts for the parent layout. |
| 1035 | |
| 1036 | \value SE_SpinBoxLayoutItem Area that counts for the parent layout. |
| 1037 | |
| 1038 | \value SE_ProgressBarGroove Area for the groove. |
| 1039 | \value SE_ProgressBarContents Area for the progress indicator. |
| 1040 | \value SE_ProgressBarLabel Area for the text label. |
| 1041 | \value SE_ProgressBarLayoutItem Area that counts for the parent layout. |
| 1042 | |
| 1043 | \omitvalue SE_ViewItemCheckIndicator |
| 1044 | |
| 1045 | \value SE_FrameContents Area for a frame's contents. |
| 1046 | \value SE_ShapedFrameContents Area for a frame's contents using the shape in QStyleOptionFrame; see QFrame |
| 1047 | \value SE_FrameLayoutItem Area that counts for the parent layout. |
| 1048 | |
| 1049 | \value SE_HeaderArrow Area for the sort indicator for a header. |
| 1050 | \value SE_HeaderLabel Area for the label in a header. |
| 1051 | |
| 1052 | \value SE_LabelLayoutItem Area that counts for the parent layout. |
| 1053 | |
| 1054 | \value SE_LineEditContents Area for a line edit's contents. |
| 1055 | |
| 1056 | \value SE_TabWidgetLeftCorner Area for the left corner widget in a tab widget. |
| 1057 | \value SE_TabWidgetRightCorner Area for the right corner widget in a tab widget. |
| 1058 | \value SE_TabWidgetTabBar Area for the tab bar widget in a tab widget. |
| 1059 | \value SE_TabWidgetTabContents Area for the contents of the tab widget. |
| 1060 | \value SE_TabWidgetTabPane Area for the pane of a tab widget. |
| 1061 | \value SE_TabWidgetLayoutItem Area that counts for the parent layout. |
| 1062 | |
| 1063 | \value SE_ToolBoxTabContents Area for a toolbox tab's icon and label. |
| 1064 | |
| 1065 | \value SE_ToolButtonLayoutItem Area that counts for the parent layout. |
| 1066 | |
| 1067 | \value SE_ItemViewItemCheckIndicator Area for a view item's check mark. |
| 1068 | |
| 1069 | \value SE_TabBarTearIndicator Deprecated. Use SE_TabBarTearIndicatorLeft instead. |
| 1070 | \value SE_TabBarTearIndicatorLeft Area for the tear indicator on the left side of a tab bar with scroll arrows. |
| 1071 | \value SE_TabBarTearIndicatorRight Area for the tear indicator on the right side of a tab bar with scroll arrows. |
| 1072 | |
| 1073 | \value SE_TabBarScrollLeftButton Area for the scroll left button on a tab bar with scroll buttons. |
| 1074 | \value SE_TabBarScrollRightButton Area for the scroll right button on a tab bar with scroll buttons. |
| 1075 | |
| 1076 | \value SE_TreeViewDisclosureItem Area for the actual disclosure item in a tree branch. |
| 1077 | |
| 1078 | \omitvalue SE_DialogButtonBoxLayoutItem |
| 1079 | |
| 1080 | \value SE_GroupBoxLayoutItem Area that counts for the parent layout. |
| 1081 | |
| 1082 | \value SE_CustomBase Base value for custom sub-elements. |
| 1083 | Custom values must be greater than this value. |
| 1084 | |
| 1085 | \value SE_DockWidgetFloatButton The float button of a dock |
| 1086 | widget. |
| 1087 | \value SE_DockWidgetTitleBarText The text bounds of the dock |
| 1088 | widgets title. |
| 1089 | \value SE_DockWidgetCloseButton The close button of a dock |
| 1090 | widget. |
| 1091 | \value SE_DockWidgetIcon The icon of a dock widget. |
| 1092 | \value SE_ComboBoxLayoutItem Area that counts for the parent layout. |
| 1093 | |
| 1094 | |
| 1095 | \value SE_ItemViewItemDecoration Area for a view item's decoration (icon). |
| 1096 | \value SE_ItemViewItemText Area for a view item's text. |
| 1097 | \value SE_ItemViewItemFocusRect Area for a view item's focus rect. |
| 1098 | |
| 1099 | \value SE_TabBarTabLeftButton Area for a widget on the left side of a tab in a tab bar. |
| 1100 | \value SE_TabBarTabRightButton Area for a widget on the right side of a tab in a tab bar. |
| 1101 | \value SE_TabBarTabText Area for the text on a tab in a tab bar. |
| 1102 | |
| 1103 | \value SE_ToolBarHandle Area for the handle of a tool bar. |
| 1104 | |
| 1105 | \sa subElementRect() |
| 1106 | */ |
| 1107 | |
| 1108 | /*! |
| 1109 | \fn QRect QStyle::subElementRect(SubElement element, const QStyleOption *option, const QWidget *widget) const |
| 1110 | |
| 1111 | Returns the sub-area for the given \a element as described in the |
| 1112 | provided style \a option. The returned rectangle is defined in |
| 1113 | screen coordinates. |
| 1114 | |
| 1115 | The \a widget argument is optional and can be used to aid |
| 1116 | determining the area. The QStyleOption object can be cast to the |
| 1117 | appropriate type using the qstyleoption_cast() function. See the |
| 1118 | table below for the appropriate \a option casts: |
| 1119 | |
| 1120 | \table |
| 1121 | \header \li Sub Element \li QStyleOption Subclass |
| 1122 | \row \li \l SE_PushButtonContents \li \l QStyleOptionButton |
| 1123 | \row \li \l SE_PushButtonFocusRect \li \l QStyleOptionButton |
| 1124 | \row \li \l SE_PushButtonBevel \li \l QStyleOptionButton |
| 1125 | \row \li \l SE_CheckBoxIndicator \li \l QStyleOptionButton |
| 1126 | \row \li \l SE_CheckBoxContents \li \l QStyleOptionButton |
| 1127 | \row \li \l SE_CheckBoxFocusRect \li \l QStyleOptionButton |
| 1128 | \row \li \l SE_RadioButtonIndicator \li \l QStyleOptionButton |
| 1129 | \row \li \l SE_RadioButtonContents \li \l QStyleOptionButton |
| 1130 | \row \li \l SE_RadioButtonFocusRect \li \l QStyleOptionButton |
| 1131 | \row \li \l SE_ComboBoxFocusRect \li \l QStyleOptionComboBox |
| 1132 | \row \li \l SE_ProgressBarGroove \li \l QStyleOptionProgressBar |
| 1133 | \row \li \l SE_ProgressBarContents \li \l QStyleOptionProgressBar |
| 1134 | \row \li \l SE_ProgressBarLabel \li \l QStyleOptionProgressBar |
| 1135 | \endtable |
| 1136 | */ |
| 1137 | |
| 1138 | /*! |
| 1139 | \enum QStyle::ComplexControl |
| 1140 | |
| 1141 | This enum describes the available complex controls. Complex |
| 1142 | controls have different behavior depending upon where the user |
| 1143 | clicks on them or which keys are pressed. |
| 1144 | |
| 1145 | \value CC_SpinBox A spinbox, like QSpinBox. |
| 1146 | \value CC_ComboBox A combobox, like QComboBox. |
| 1147 | \value CC_ScrollBar A scroll bar, like QScrollBar. |
| 1148 | \value CC_Slider A slider, like QSlider. |
| 1149 | \value CC_ToolButton A tool button, like QToolButton. |
| 1150 | \value CC_TitleBar A Title bar, like those used in QMdiSubWindow. |
| 1151 | \value CC_GroupBox A group box, like QGroupBox. |
| 1152 | \value CC_Dial A dial, like QDial. |
| 1153 | \value CC_MdiControls The minimize, close, and normal |
| 1154 | button in the menu bar for a |
| 1155 | maximized MDI subwindow. |
| 1156 | |
| 1157 | \value CC_CustomBase Base value for custom complex controls. Custom |
| 1158 | values must be greater than this value. |
| 1159 | |
| 1160 | \sa SubControl, drawComplexControl() |
| 1161 | */ |
| 1162 | |
| 1163 | /*! |
| 1164 | \enum QStyle::SubControl |
| 1165 | |
| 1166 | This enum describes the available sub controls. A subcontrol is a |
| 1167 | control element within a complex control (ComplexControl). |
| 1168 | |
| 1169 | \value SC_None Special value that matches no other sub control. |
| 1170 | |
| 1171 | \value SC_ScrollBarAddLine Scroll bar add line (i.e., down/right |
| 1172 | arrow); see also QScrollBar. |
| 1173 | \value SC_ScrollBarSubLine Scroll bar sub line (i.e., up/left arrow). |
| 1174 | \value SC_ScrollBarAddPage Scroll bar add page (i.e., page down). |
| 1175 | \value SC_ScrollBarSubPage Scroll bar sub page (i.e., page up). |
| 1176 | \value SC_ScrollBarFirst Scroll bar first line (i.e., home). |
| 1177 | \value SC_ScrollBarLast Scroll bar last line (i.e., end). |
| 1178 | \value SC_ScrollBarSlider Scroll bar slider handle. |
| 1179 | \value SC_ScrollBarGroove Special sub-control which contains the |
| 1180 | area in which the slider handle may move. |
| 1181 | |
| 1182 | \value SC_SpinBoxUp Spin widget up/increase; see also QSpinBox. |
| 1183 | \value SC_SpinBoxDown Spin widget down/decrease. |
| 1184 | \value SC_SpinBoxFrame Spin widget frame. |
| 1185 | \value SC_SpinBoxEditField Spin widget edit field. |
| 1186 | |
| 1187 | \value SC_ComboBoxEditField Combobox edit field; see also QComboBox. |
| 1188 | \value SC_ComboBoxArrow Combobox arrow button. |
| 1189 | \value SC_ComboBoxFrame Combobox frame. |
| 1190 | \value SC_ComboBoxListBoxPopup The reference rectangle for the combobox popup. |
| 1191 | Used to calculate the position of the popup. |
| 1192 | |
| 1193 | \value SC_SliderGroove Special sub-control which contains the area |
| 1194 | in which the slider handle may move. |
| 1195 | \value SC_SliderHandle Slider handle. |
| 1196 | \value SC_SliderTickmarks Slider tickmarks. |
| 1197 | |
| 1198 | \value SC_ToolButton Tool button (see also QToolButton). |
| 1199 | \value SC_ToolButtonMenu Sub-control for opening a popup menu in a |
| 1200 | tool button. |
| 1201 | |
| 1202 | \value SC_TitleBarSysMenu System menu button (i.e., restore, close, etc.). |
| 1203 | \value SC_TitleBarMinButton Minimize button. |
| 1204 | \value SC_TitleBarMaxButton Maximize button. |
| 1205 | \value SC_TitleBarCloseButton Close button. |
| 1206 | \value SC_TitleBarLabel Window title label. |
| 1207 | \value SC_TitleBarNormalButton Normal (restore) button. |
| 1208 | \value SC_TitleBarShadeButton Shade button. |
| 1209 | \value SC_TitleBarUnshadeButton Unshade button. |
| 1210 | \value SC_TitleBarContextHelpButton Context Help button. |
| 1211 | |
| 1212 | \value SC_DialHandle The handle of the dial (i.e. what you use to control the dial). |
| 1213 | \value SC_DialGroove The groove for the dial. |
| 1214 | \value SC_DialTickmarks The tickmarks for the dial. |
| 1215 | |
| 1216 | \value SC_GroupBoxFrame The frame of a group box. |
| 1217 | \value SC_GroupBoxLabel The title of a group box. |
| 1218 | \value SC_GroupBoxCheckBox The optional check box of a group box. |
| 1219 | \value SC_GroupBoxContents The group box contents. |
| 1220 | |
| 1221 | \value SC_MdiNormalButton The normal button for a MDI |
| 1222 | subwindow in the menu bar. |
| 1223 | \value SC_MdiMinButton The minimize button for a MDI |
| 1224 | subwindow in the menu bar. |
| 1225 | \value SC_MdiCloseButton The close button for a MDI subwindow |
| 1226 | in the menu bar. |
| 1227 | |
| 1228 | \value SC_All Special value that matches all sub-controls. |
| 1229 | \omitvalue SC_CustomBase |
| 1230 | |
| 1231 | \sa ComplexControl |
| 1232 | */ |
| 1233 | |
| 1234 | /*! |
| 1235 | \fn void QStyle::drawComplexControl(ComplexControl control, const QStyleOptionComplex *option, QPainter *painter, const QWidget *widget) const |
| 1236 | |
| 1237 | Draws the given \a control using the provided \a painter with the |
| 1238 | style options specified by \a option. |
| 1239 | |
| 1240 | The \a widget argument is optional and can be used as aid in |
| 1241 | drawing the control. |
| 1242 | |
| 1243 | The \a option parameter is a pointer to a QStyleOptionComplex |
| 1244 | object that can be cast to the correct subclass using the |
| 1245 | qstyleoption_cast() function. Note that the \c rect member of the |
| 1246 | specified \a option must be in logical |
| 1247 | coordinates. Reimplementations of this function should use |
| 1248 | visualRect() to change the logical coordinates into screen |
| 1249 | coordinates before calling the drawPrimitive() or drawControl() |
| 1250 | function. |
| 1251 | |
| 1252 | The table below is listing the complex control elements and their |
| 1253 | associated style option subclass. The style options contain all |
| 1254 | the parameters required to draw the controls, including |
| 1255 | QStyleOption::state which holds the \l {QStyle::StateFlag}{style |
| 1256 | flags} that are used when drawing. The table also describes which |
| 1257 | flags that are set when casting the given \a option to the |
| 1258 | appropriate subclass. |
| 1259 | |
| 1260 | \table |
| 1261 | \header \li Complex Control \li QStyleOptionComplex Subclass \li Style Flag \li Remark |
| 1262 | \row \li{1,2} \l{CC_SpinBox} \li{1,2} \l QStyleOptionSpinBox |
| 1263 | \li \l State_Enabled \li Set if the spin box is enabled. |
| 1264 | \row \li \l State_HasFocus \li Set if the spin box has input focus. |
| 1265 | |
| 1266 | \row \li{1,2} \l {CC_ComboBox} \li{1,2} \l QStyleOptionComboBox |
| 1267 | \li \l State_Enabled \li Set if the combobox is enabled. |
| 1268 | \row \li \l State_HasFocus \li Set if the combobox has input focus. |
| 1269 | |
| 1270 | \row \li{1,2} \l {CC_ScrollBar} \li{1,2} \l QStyleOptionSlider |
| 1271 | \li \l State_Enabled \li Set if the scroll bar is enabled. |
| 1272 | \row \li \l State_HasFocus \li Set if the scroll bar has input focus. |
| 1273 | |
| 1274 | \row \li{1,2} \l {CC_Slider} \li{1,2} \l QStyleOptionSlider |
| 1275 | \li \l State_Enabled \li Set if the slider is enabled. |
| 1276 | \row \li \l State_HasFocus \li Set if the slider has input focus. |
| 1277 | |
| 1278 | \row \li{1,2} \l {CC_Dial} \li{1,2} \l QStyleOptionSlider |
| 1279 | \li \l State_Enabled \li Set if the dial is enabled. |
| 1280 | \row \li \l State_HasFocus \li Set if the dial has input focus. |
| 1281 | |
| 1282 | \row \li{1,6} \l {CC_ToolButton} \li{1,6} \l QStyleOptionToolButton |
| 1283 | \li \l State_Enabled \li Set if the tool button is enabled. |
| 1284 | \row \li \l State_HasFocus \li Set if the tool button has input focus. |
| 1285 | \row \li \l State_DownArrow \li Set if the tool button is down (i.e., a mouse |
| 1286 | button or the space bar is pressed). |
| 1287 | \row \li \l State_On \li Set if the tool button is a toggle button |
| 1288 | and is toggled on. |
| 1289 | \row \li \l State_AutoRaise \li Set if the tool button has auto-raise enabled. |
| 1290 | \row \li \l State_Raised \li Set if the button is not down, not on, and doesn't |
| 1291 | contain the mouse when auto-raise is enabled. |
| 1292 | |
| 1293 | \row \li \l{CC_TitleBar} \li \l QStyleOptionTitleBar |
| 1294 | \li \l State_Enabled \li Set if the title bar is enabled. |
| 1295 | |
| 1296 | \endtable |
| 1297 | |
| 1298 | \sa drawPrimitive(), drawControl() |
| 1299 | */ |
| 1300 | |
| 1301 | |
| 1302 | /*! |
| 1303 | \fn QRect QStyle::subControlRect(ComplexControl control, |
| 1304 | const QStyleOptionComplex *option, SubControl subControl, |
| 1305 | const QWidget *widget) const = 0 |
| 1306 | |
| 1307 | Returns the rectangle containing the specified \a subControl of |
| 1308 | the given complex \a control (with the style specified by \a |
| 1309 | option). The rectangle is defined in screen coordinates. |
| 1310 | |
| 1311 | The \a option argument is a pointer to QStyleOptionComplex or |
| 1312 | one of its subclasses, and can be cast to the appropriate type |
| 1313 | using the qstyleoption_cast() function. See drawComplexControl() |
| 1314 | for details. The \a widget is optional and can contain additional |
| 1315 | information for the function. |
| 1316 | |
| 1317 | \sa drawComplexControl() |
| 1318 | */ |
| 1319 | |
| 1320 | /*! |
| 1321 | \fn QStyle::SubControl QStyle::hitTestComplexControl(ComplexControl control, |
| 1322 | const QStyleOptionComplex *option, const QPoint &position, |
| 1323 | const QWidget *widget) const = 0 |
| 1324 | |
| 1325 | Returns the sub control at the given \a position in the given |
| 1326 | complex \a control (with the style options specified by \a |
| 1327 | option). |
| 1328 | |
| 1329 | Note that the \a position is expressed in screen coordinates. |
| 1330 | |
| 1331 | The \a option argument is a pointer to a QStyleOptionComplex |
| 1332 | object (or one of its subclasses). The object can be cast to the |
| 1333 | appropriate type using the qstyleoption_cast() function. See |
| 1334 | drawComplexControl() for details. The \a widget argument is |
| 1335 | optional and can contain additional information for the function. |
| 1336 | |
| 1337 | \sa drawComplexControl(), subControlRect() |
| 1338 | */ |
| 1339 | |
| 1340 | /*! |
| 1341 | \enum QStyle::PixelMetric |
| 1342 | |
| 1343 | This enum describes the various available pixel metrics. A pixel |
| 1344 | metric is a style dependent size represented by a single pixel |
| 1345 | value. |
| 1346 | |
| 1347 | \value PM_ButtonMargin Amount of whitespace between push button |
| 1348 | labels and the frame. |
| 1349 | \value PM_DockWidgetTitleBarButtonMargin Amount of whitespace between dock widget's |
| 1350 | title bar button labels and the frame. |
| 1351 | \value PM_ButtonDefaultIndicator Width of the default-button indicator frame. |
| 1352 | \value PM_MenuButtonIndicator Width of the menu button indicator |
| 1353 | proportional to the widget height. |
| 1354 | \value PM_ButtonShiftHorizontal Horizontal contents shift of a |
| 1355 | button when the button is down. |
| 1356 | \value PM_ButtonShiftVertical Vertical contents shift of a button when the |
| 1357 | button is down. |
| 1358 | |
| 1359 | \value PM_DefaultFrameWidth Default frame width (usually 2). |
| 1360 | \value PM_SpinBoxFrameWidth Frame width of a spin box, defaults to PM_DefaultFrameWidth. |
| 1361 | \value PM_ComboBoxFrameWidth Frame width of a combo box, defaults to PM_DefaultFrameWidth. |
| 1362 | |
| 1363 | \value PM_MDIFrameWidth Obsolete. Use PM_MdiSubWindowFrameWidth instead. |
| 1364 | \value PM_MdiSubWindowFrameWidth Frame width of an MDI window. |
| 1365 | \value PM_MDIMinimizedWidth Obsolete. Use PM_MdiSubWindowMinimizedWidth instead. |
| 1366 | \value PM_MdiSubWindowMinimizedWidth Width of a minimized MDI window. |
| 1367 | |
| 1368 | \value PM_LayoutLeftMargin Default \l{QLayout::setContentsMargins()}{left margin} for a |
| 1369 | QLayout. |
| 1370 | \value PM_LayoutTopMargin Default \l{QLayout::setContentsMargins()}{top margin} for a QLayout. |
| 1371 | \value PM_LayoutRightMargin Default \l{QLayout::setContentsMargins()}{right margin} for a |
| 1372 | QLayout. |
| 1373 | \value PM_LayoutBottomMargin Default \l{QLayout::setContentsMargins()}{bottom margin} for a |
| 1374 | QLayout. |
| 1375 | \value PM_LayoutHorizontalSpacing Default \l{QLayout::spacing}{horizontal spacing} for a |
| 1376 | QLayout. |
| 1377 | \value PM_LayoutVerticalSpacing Default \l{QLayout::spacing}{vertical spacing} for a QLayout. |
| 1378 | |
| 1379 | \value PM_MaximumDragDistance The maximum allowed distance between |
| 1380 | the mouse and a scrollbar when dragging. Exceeding the specified |
| 1381 | distance will cause the slider to jump back to the original |
| 1382 | position; a value of -1 disables this behavior. |
| 1383 | |
| 1384 | \value PM_ScrollBarExtent Width of a vertical scroll bar and the |
| 1385 | height of a horizontal scroll bar. |
| 1386 | \value PM_ScrollBarSliderMin The minimum height of a vertical |
| 1387 | scroll bar's slider and the minimum width of a horizontal |
| 1388 | scroll bar's slider. |
| 1389 | |
| 1390 | \value PM_SliderThickness Total slider thickness. |
| 1391 | \value PM_SliderControlThickness Thickness of the slider handle. |
| 1392 | \value PM_SliderLength Length of the slider. |
| 1393 | \value PM_SliderTickmarkOffset The offset between the tickmarks |
| 1394 | and the slider. |
| 1395 | \value PM_SliderSpaceAvailable The available space for the slider to move. |
| 1396 | |
| 1397 | \value PM_DockWidgetSeparatorExtent Width of a separator in a |
| 1398 | horizontal dock window and the height of a separator in a |
| 1399 | vertical dock window. |
| 1400 | \value PM_DockWidgetHandleExtent Width of the handle in a |
| 1401 | horizontal dock window and the height of the handle in a |
| 1402 | vertical dock window. |
| 1403 | \value PM_DockWidgetFrameWidth Frame width of a dock window. |
| 1404 | \value PM_DockWidgetTitleMargin Margin of the dock window title. |
| 1405 | |
| 1406 | \value PM_MenuBarPanelWidth Frame width of a menu bar, defaults to PM_DefaultFrameWidth. |
| 1407 | \value PM_MenuBarItemSpacing Spacing between menu bar items. |
| 1408 | \value PM_MenuBarHMargin Spacing between menu bar items and left/right of bar. |
| 1409 | \value PM_MenuBarVMargin Spacing between menu bar items and top/bottom of bar. |
| 1410 | |
| 1411 | \value PM_ToolBarFrameWidth Width of the frame around toolbars. |
| 1412 | \value PM_ToolBarHandleExtent Width of a toolbar handle in a |
| 1413 | horizontal toolbar and the height of the handle in a vertical toolbar. |
| 1414 | \value PM_ToolBarItemMargin Spacing between the toolbar frame and the items. |
| 1415 | \value PM_ToolBarItemSpacing Spacing between toolbar items. |
| 1416 | \value PM_ToolBarSeparatorExtent Width of a toolbar separator in a |
| 1417 | horizontal toolbar and the height of a separator in a vertical toolbar. |
| 1418 | \value PM_ToolBarExtensionExtent Width of a toolbar extension |
| 1419 | button in a horizontal toolbar and the height of the button in a |
| 1420 | vertical toolbar. |
| 1421 | |
| 1422 | \value PM_TabBarTabOverlap Number of pixels the tabs should overlap. |
| 1423 | (Currently only used in styles, not inside of QTabBar) |
| 1424 | \value PM_TabBarTabHSpace Extra space added to the tab width. |
| 1425 | \value PM_TabBarTabVSpace Extra space added to the tab height. |
| 1426 | \value PM_TabBarBaseHeight Height of the area between the tab bar |
| 1427 | and the tab pages. |
| 1428 | \value PM_TabBarBaseOverlap Number of pixels the tab bar overlaps |
| 1429 | the tab bar base. |
| 1430 | \value PM_TabBarScrollButtonWidth |
| 1431 | \value PM_TabBarTabShiftHorizontal Horizontal pixel shift when a |
| 1432 | tab is selected. |
| 1433 | \value PM_TabBarTabShiftVertical Vertical pixel shift when a |
| 1434 | tab is selected. |
| 1435 | |
| 1436 | \value PM_ProgressBarChunkWidth Width of a chunk in a progress bar indicator. |
| 1437 | |
| 1438 | \value PM_SplitterWidth Width of a splitter. |
| 1439 | |
| 1440 | \value PM_TitleBarHeight Height of the title bar. |
| 1441 | |
| 1442 | \value PM_IndicatorWidth Width of a check box indicator. |
| 1443 | \value PM_IndicatorHeight Height of a checkbox indicator. |
| 1444 | \value PM_ExclusiveIndicatorWidth Width of a radio button indicator. |
| 1445 | \value PM_ExclusiveIndicatorHeight Height of a radio button indicator. |
| 1446 | |
| 1447 | \value PM_MenuPanelWidth Border width (applied on all sides) for a QMenu. |
| 1448 | \value PM_MenuHMargin Additional border (used on left and right) for a QMenu. |
| 1449 | \value PM_MenuVMargin Additional border (used for bottom and top) for a QMenu. |
| 1450 | \value PM_MenuScrollerHeight Height of the scroller area in a QMenu. |
| 1451 | \value PM_MenuTearoffHeight Height of a tear off area in a QMenu. |
| 1452 | \value PM_MenuDesktopFrameWidth The frame width for the menu on the desktop. |
| 1453 | |
| 1454 | \omitvalue PM_DialogButtonsSeparator |
| 1455 | \omitvalue PM_DialogButtonsButtonWidth |
| 1456 | \omitvalue PM_DialogButtonsButtonHeight |
| 1457 | |
| 1458 | \value PM_HeaderMarkSize The size of the sort indicator in a header. |
| 1459 | \value PM_HeaderGripMargin The size of the resize grip in a header. |
| 1460 | \value PM_HeaderMargin The size of the margin between the sort indicator and the text. |
| 1461 | \value PM_SpinBoxSliderHeight The height of the optional spin box slider. |
| 1462 | |
| 1463 | \value PM_ToolBarIconSize Default tool bar icon size |
| 1464 | \value PM_SmallIconSize Default small icon size |
| 1465 | \value PM_LargeIconSize Default large icon size |
| 1466 | |
| 1467 | \value PM_FocusFrameHMargin Horizontal margin that the focus frame will outset the widget by. |
| 1468 | \value PM_FocusFrameVMargin Vertical margin that the focus frame will outset the widget by. |
| 1469 | \value PM_IconViewIconSize The default size for icons in an icon view. |
| 1470 | \value PM_ListViewIconSize The default size for icons in a list view. |
| 1471 | |
| 1472 | \value PM_ToolTipLabelFrameWidth The frame width for a tool tip label. |
| 1473 | \value PM_CheckBoxLabelSpacing The spacing between a check box indicator and its label. |
| 1474 | \value PM_RadioButtonLabelSpacing The spacing between a radio button indicator and its label. |
| 1475 | \value PM_TabBarIconSize The default icon size for a tab bar. |
| 1476 | \value PM_SizeGripSize The size of a size grip. |
| 1477 | \value PM_MessageBoxIconSize The size of the standard icons in a message box |
| 1478 | \value PM_ButtonIconSize The default size of button icons |
| 1479 | \value PM_TextCursorWidth The width of the cursor in a line edit or text edit |
| 1480 | \value PM_TabBar_ScrollButtonOverlap The distance between the left and right buttons in a tab bar. |
| 1481 | |
| 1482 | \value PM_TabCloseIndicatorWidth The default width of a close button on a tab in a tab bar. |
| 1483 | \value PM_TabCloseIndicatorHeight The default height of a close button on a tab in a tab bar. |
| 1484 | |
| 1485 | \value PM_ScrollView_ScrollBarSpacing Distance between frame and scrollbar |
| 1486 | with SH_ScrollView_FrameOnlyAroundContents set. |
| 1487 | \value PM_ScrollView_ScrollBarOverlap Overlap between scroll bars and scroll content |
| 1488 | |
| 1489 | \value PM_SubMenuOverlap The horizontal overlap between a submenu and its parent. |
| 1490 | |
| 1491 | \value PM_TreeViewIndentation The indentation of items in a tree view. |
| 1492 | This enum value has been introduced in Qt 5.4. |
| 1493 | |
| 1494 | \value PM_HeaderDefaultSectionSizeHorizontal The default size of sections |
| 1495 | in a horizontal header. This enum value has been introduced in Qt 5.5. |
| 1496 | \value PM_HeaderDefaultSectionSizeVertical The default size of sections |
| 1497 | in a vertical header. This enum value has been introduced in Qt 5.5. |
| 1498 | |
| 1499 | \value PM_TitleBarButtonIconSize The size of button icons on a title bar. |
| 1500 | This enum value has been introduced in Qt 5.8. |
| 1501 | \value PM_TitleBarButtonSize The size of buttons on a title bar. |
| 1502 | This enum value has been introduced in Qt 5.8. |
| 1503 | |
| 1504 | \value PM_CustomBase Base value for custom pixel metrics. Custom |
| 1505 | values must be greater than this value. |
| 1506 | |
| 1507 | The following values are obsolete: |
| 1508 | |
| 1509 | \value PM_DefaultTopLevelMargin Use PM_LayoutLeftMargin, |
| 1510 | PM_LayoutTopMargin, |
| 1511 | PM_LayoutRightMargin, and |
| 1512 | PM_LayoutBottomMargin instead. |
| 1513 | \value PM_DefaultChildMargin Use PM_LayoutLeftMargin, |
| 1514 | PM_LayoutTopMargin, |
| 1515 | PM_LayoutRightMargin, and |
| 1516 | PM_LayoutBottomMargin instead. |
| 1517 | \value PM_DefaultLayoutSpacing Use PM_LayoutHorizontalSpacing |
| 1518 | and PM_LayoutVerticalSpacing |
| 1519 | instead. |
| 1520 | |
| 1521 | |
| 1522 | \sa pixelMetric() |
| 1523 | */ |
| 1524 | |
| 1525 | /*! |
| 1526 | \fn int QStyle::pixelMetric(PixelMetric metric, const QStyleOption *option, const QWidget *widget) const; |
| 1527 | |
| 1528 | Returns the value of the given pixel \a metric. |
| 1529 | |
| 1530 | The specified \a option and \a widget can be used for calculating |
| 1531 | the metric. In general, the \a widget argument is not used. The \a |
| 1532 | option can be cast to the appropriate type using the |
| 1533 | qstyleoption_cast() function. Note that the \a option may be zero |
| 1534 | even for PixelMetrics that can make use of it. See the table below |
| 1535 | for the appropriate \a option casts: |
| 1536 | |
| 1537 | \table |
| 1538 | \header \li Pixel Metric \li QStyleOption Subclass |
| 1539 | \row \li \l PM_SliderControlThickness \li \l QStyleOptionSlider |
| 1540 | \row \li \l PM_SliderLength \li \l QStyleOptionSlider |
| 1541 | \row \li \l PM_SliderTickmarkOffset \li \l QStyleOptionSlider |
| 1542 | \row \li \l PM_SliderSpaceAvailable \li \l QStyleOptionSlider |
| 1543 | \row \li \l PM_ScrollBarExtent \li \l QStyleOptionSlider |
| 1544 | \row \li \l PM_TabBarTabOverlap \li \l QStyleOptionTab |
| 1545 | \row \li \l PM_TabBarTabHSpace \li \l QStyleOptionTab |
| 1546 | \row \li \l PM_TabBarTabVSpace \li \l QStyleOptionTab |
| 1547 | \row \li \l PM_TabBarBaseHeight \li \l QStyleOptionTab |
| 1548 | \row \li \l PM_TabBarBaseOverlap \li \l QStyleOptionTab |
| 1549 | \endtable |
| 1550 | |
| 1551 | Some pixel metrics are called from widgets and some are only called |
| 1552 | internally by the style. If the metric is not called by a widget, it is the |
| 1553 | discretion of the style author to make use of it. For some styles, this |
| 1554 | may not be appropriate. |
| 1555 | */ |
| 1556 | |
| 1557 | /*! |
| 1558 | \enum QStyle::ContentsType |
| 1559 | |
| 1560 | This enum describes the available contents types. These are used to |
| 1561 | calculate sizes for the contents of various widgets. |
| 1562 | |
| 1563 | \value CT_CheckBox A check box, like QCheckBox. |
| 1564 | \value CT_ComboBox A combo box, like QComboBox. |
| 1565 | \omitvalue CT_DialogButtons |
| 1566 | \value CT_HeaderSection A header section, like QHeader. |
| 1567 | \value CT_LineEdit A line edit, like QLineEdit. |
| 1568 | \value CT_Menu A menu, like QMenu. |
| 1569 | \value CT_MenuBar A menu bar, like QMenuBar. |
| 1570 | \value CT_MenuBarItem A menu bar item, like the buttons in a QMenuBar. |
| 1571 | \value CT_MenuItem A menu item, like QMenuItem. |
| 1572 | \value CT_ProgressBar A progress bar, like QProgressBar. |
| 1573 | \value CT_PushButton A push button, like QPushButton. |
| 1574 | \value CT_RadioButton A radio button, like QRadioButton. |
| 1575 | \value CT_SizeGrip A size grip, like QSizeGrip. |
| 1576 | \value CT_Slider A slider, like QSlider. |
| 1577 | \value CT_ScrollBar A scroll bar, like QScrollBar. |
| 1578 | \value CT_SpinBox A spin box, like QSpinBox. |
| 1579 | \value CT_Splitter A splitter, like QSplitter. |
| 1580 | \value CT_TabBarTab A tab on a tab bar, like QTabBar. |
| 1581 | \value CT_TabWidget A tab widget, like QTabWidget. |
| 1582 | \value CT_ToolButton A tool button, like QToolButton. |
| 1583 | \value CT_GroupBox A group box, like QGroupBox. |
| 1584 | \value CT_ItemViewItem An item inside an item view. |
| 1585 | |
| 1586 | \value CT_CustomBase Base value for custom contents types. |
| 1587 | Custom values must be greater than this value. |
| 1588 | |
| 1589 | \value CT_MdiControls The minimize, normal, and close button |
| 1590 | in the menu bar for a maximized MDI |
| 1591 | subwindow. |
| 1592 | |
| 1593 | \sa sizeFromContents() |
| 1594 | */ |
| 1595 | |
| 1596 | /*! |
| 1597 | \fn QSize QStyle::sizeFromContents(ContentsType type, const QStyleOption *option, const QSize &contentsSize, const QWidget *widget) const |
| 1598 | |
| 1599 | Returns the size of the element described by the specified |
| 1600 | \a option and \a type, based on the provided \a contentsSize. |
| 1601 | |
| 1602 | The \a option argument is a pointer to a QStyleOption or one of |
| 1603 | its subclasses. The \a option can be cast to the appropriate type |
| 1604 | using the qstyleoption_cast() function. The \a widget is an |
| 1605 | optional argument and can contain extra information used for |
| 1606 | calculating the size. |
| 1607 | |
| 1608 | See the table below for the appropriate \a option casts: |
| 1609 | |
| 1610 | \table |
| 1611 | \header \li Contents Type \li QStyleOption Subclass |
| 1612 | \row \li \l CT_CheckBox \li \l QStyleOptionButton |
| 1613 | \row \li \l CT_ComboBox \li \l QStyleOptionComboBox |
| 1614 | \row \li \l CT_GroupBox \li \l QStyleOptionGroupBox |
| 1615 | \row \li \l CT_HeaderSection \li \l QStyleOptionHeader |
| 1616 | \row \li \l CT_ItemViewItem \li \l QStyleOptionViewItem |
| 1617 | \row \li \l CT_LineEdit \li \l QStyleOptionFrame |
| 1618 | \row \li \l CT_MdiControls \li \l QStyleOptionComplex |
| 1619 | \row \li \l CT_Menu \li \l QStyleOption |
| 1620 | \row \li \l CT_MenuItem \li \l QStyleOptionMenuItem |
| 1621 | \row \li \l CT_MenuBar \li \l QStyleOptionMenuItem |
| 1622 | \row \li \l CT_MenuBarItem \li \l QStyleOptionMenuItem |
| 1623 | \row \li \l CT_ProgressBar \li \l QStyleOptionProgressBar |
| 1624 | \row \li \l CT_PushButton \li \l QStyleOptionButton |
| 1625 | \row \li \l CT_RadioButton \li \l QStyleOptionButton |
| 1626 | \row \li \l CT_ScrollBar \li \l QStyleOptionSlider |
| 1627 | \row \li \l CT_SizeGrip \li \l QStyleOption |
| 1628 | \row \li \l CT_Slider \li \l QStyleOptionSlider |
| 1629 | \row \li \l CT_SpinBox \li \l QStyleOptionSpinBox |
| 1630 | \row \li \l CT_Splitter \li \l QStyleOption |
| 1631 | \row \li \l CT_TabBarTab \li \l QStyleOptionTab |
| 1632 | \row \li \l CT_TabWidget \li \l QStyleOptionTabWidgetFrame |
| 1633 | \row \li \l CT_ToolButton \li \l QStyleOptionToolButton |
| 1634 | \endtable |
| 1635 | |
| 1636 | \sa ContentsType, QStyleOption |
| 1637 | */ |
| 1638 | |
| 1639 | /*! |
| 1640 | \enum QStyle::RequestSoftwareInputPanel |
| 1641 | |
| 1642 | This enum describes under what circumstances a software input panel will be |
| 1643 | requested by input capable widgets. |
| 1644 | |
| 1645 | \value RSIP_OnMouseClickAndAlreadyFocused Requests an input panel if the user |
| 1646 | clicks on the widget, but only if it is already focused. |
| 1647 | \value RSIP_OnMouseClick Requests an input panel if the user clicks on the |
| 1648 | widget. |
| 1649 | |
| 1650 | \sa QInputMethod |
| 1651 | */ |
| 1652 | |
| 1653 | /*! |
| 1654 | \enum QStyle::StyleHint |
| 1655 | |
| 1656 | This enum describes the available style hints. A style hint is a general look |
| 1657 | and/or feel hint. |
| 1658 | |
| 1659 | \value SH_EtchDisabledText Disabled text is "etched" as it is on Windows. |
| 1660 | |
| 1661 | \value SH_DitherDisabledText Disabled text is dithered as it is on Motif. |
| 1662 | |
| 1663 | \value SH_ScrollBar_ContextMenu Whether or not a scroll bar has a context menu. |
| 1664 | |
| 1665 | \value SH_ScrollBar_MiddleClickAbsolutePosition A boolean value. |
| 1666 | If true, middle clicking on a scroll bar causes the slider to |
| 1667 | jump to that position. If false, middle clicking is |
| 1668 | ignored. |
| 1669 | |
| 1670 | \value SH_ScrollBar_LeftClickAbsolutePosition A boolean value. |
| 1671 | If true, left clicking on a scroll bar causes the slider to |
| 1672 | jump to that position. If false, left clicking will |
| 1673 | behave as appropriate for each control. |
| 1674 | |
| 1675 | \value SH_ScrollBar_ScrollWhenPointerLeavesControl A boolean |
| 1676 | value. If true, when clicking a scroll bar SubControl, holding |
| 1677 | the mouse button down and moving the pointer outside the |
| 1678 | SubControl, the scroll bar continues to scroll. If false, the |
| 1679 | scollbar stops scrolling when the pointer leaves the |
| 1680 | SubControl. |
| 1681 | |
| 1682 | \value SH_ScrollBar_RollBetweenButtons A boolean value. |
| 1683 | If true, when clicking a scroll bar button (SC_ScrollBarAddLine or |
| 1684 | SC_ScrollBarSubLine) and dragging over to the opposite button (rolling) |
| 1685 | will press the new button and release the old one. When it is false, the |
| 1686 | original button is released and nothing happens (like a push button). |
| 1687 | |
| 1688 | \value SH_TabBar_Alignment The alignment for tabs in a |
| 1689 | QTabWidget. Possible values are Qt::AlignLeft, |
| 1690 | Qt::AlignCenter and Qt::AlignRight. |
| 1691 | |
| 1692 | \value SH_Header_ArrowAlignment The placement of the sorting |
| 1693 | indicator may appear in list or table headers. Possible values |
| 1694 | are Qt::Alignment values (that is, an OR combination of |
| 1695 | Qt::AlignmentFlag flags). |
| 1696 | |
| 1697 | \value SH_Slider_SnapToValue Sliders snap to values while moving, |
| 1698 | as they do on Windows. |
| 1699 | |
| 1700 | \value SH_Slider_SloppyKeyEvents Key presses handled in a sloppy |
| 1701 | manner, i.e., left on a vertical slider subtracts a line. |
| 1702 | |
| 1703 | \value SH_ProgressDialog_CenterCancelButton Center button on |
| 1704 | progress dialogs, otherwise right aligned. |
| 1705 | |
| 1706 | \value SH_ProgressDialog_TextLabelAlignment The alignment for text |
| 1707 | labels in progress dialogs; Qt::AlignCenter on Windows, |
| 1708 | Qt::AlignVCenter otherwise. |
| 1709 | |
| 1710 | \value SH_PrintDialog_RightAlignButtons Right align buttons in |
| 1711 | the print dialog, as done on Windows. |
| 1712 | |
| 1713 | \value SH_MainWindow_SpaceBelowMenuBar One or two pixel space between |
| 1714 | the menu bar and the dockarea, as done on Windows. |
| 1715 | |
| 1716 | \value SH_FontDialog_SelectAssociatedText Select the text in the |
| 1717 | line edit, or when selecting an item from the listbox, or when |
| 1718 | the line edit receives focus, as done on Windows. |
| 1719 | |
| 1720 | \value SH_Menu_KeyboardSearch Typing causes a menu to be search |
| 1721 | for relevant items, otherwise only mnemnonic is considered. |
| 1722 | |
| 1723 | \value SH_Menu_AllowActiveAndDisabled Allows disabled menu |
| 1724 | items to be active. |
| 1725 | |
| 1726 | \value SH_Menu_SpaceActivatesItem Pressing the space bar activates |
| 1727 | the item, as done on Motif. |
| 1728 | |
| 1729 | \value SH_Menu_SubMenuPopupDelay The number of milliseconds |
| 1730 | to wait before opening a submenu (256 on Windows, 96 on Motif). |
| 1731 | |
| 1732 | \value SH_Menu_Scrollable Whether popup menus must support scrolling. |
| 1733 | |
| 1734 | \value SH_Menu_SloppySubMenus Whether popup menus must support |
| 1735 | the user moving the mouse cursor to a submenu while crossing |
| 1736 | other items of the menu. This is supported on most modern |
| 1737 | desktop platforms. |
| 1738 | |
| 1739 | \value SH_Menu_SubMenuUniDirection Since Qt 5.5. If the cursor has |
| 1740 | to move towards the submenu (like it is on \macos), or if the |
| 1741 | cursor can move in any direction as long as it reaches the |
| 1742 | submenu before the sloppy timeout. |
| 1743 | |
| 1744 | \value SH_Menu_SubMenuUniDirectionFailCount Since Qt 5.5. When |
| 1745 | SH_Menu_SubMenuUniDirection is defined this enum defines the |
| 1746 | number of failed mouse moves before the sloppy submenu is |
| 1747 | discarded. This can be used to control the "strictness" of the |
| 1748 | uni direction algorithm. |
| 1749 | |
| 1750 | \value SH_Menu_SubMenuSloppySelectOtherActions Since Qt 5.5. Should |
| 1751 | other action items be selected when the mouse moves towards a |
| 1752 | sloppy submenu. |
| 1753 | |
| 1754 | \value SH_Menu_SubMenuSloppyCloseTimeout Since Qt 5.5. The timeout |
| 1755 | used to close sloppy submenus. |
| 1756 | |
| 1757 | \value SH_Menu_SubMenuResetWhenReenteringParent Since Qt 5.5. When |
| 1758 | entering parent from child submenu, should the sloppy state be |
| 1759 | reset, effectively closing the child and making the current |
| 1760 | submenu active. |
| 1761 | |
| 1762 | \value SH_Menu_SubMenuDontStartSloppyOnLeave Since Qt 5.5. Do not |
| 1763 | start sloppy timers when the mouse leaves a sub-menu. |
| 1764 | |
| 1765 | \value SH_ScrollView_FrameOnlyAroundContents Whether scrollviews |
| 1766 | draw their frame only around contents (like Motif), or around |
| 1767 | contents, scroll bars and corner widgets (like Windows). |
| 1768 | |
| 1769 | \value SH_MenuBar_AltKeyNavigation Menu bars items are navigable |
| 1770 | by pressing Alt, followed by using the arrow keys to select |
| 1771 | the desired item. |
| 1772 | |
| 1773 | \value SH_ComboBox_ListMouseTracking Mouse tracking in combobox |
| 1774 | drop-down lists. |
| 1775 | |
| 1776 | \value SH_Menu_MouseTracking Mouse tracking in popup menus. |
| 1777 | |
| 1778 | \value SH_MenuBar_MouseTracking Mouse tracking in menu bars. |
| 1779 | |
| 1780 | \value SH_Menu_FillScreenWithScroll Whether scrolling popups |
| 1781 | should fill the screen as they are scrolled. |
| 1782 | |
| 1783 | \value SH_Menu_SelectionWrap Whether popups should allow the selections |
| 1784 | to wrap, that is when selection should the next item be the first item. |
| 1785 | |
| 1786 | \value SH_ItemView_ChangeHighlightOnFocus Gray out selected items |
| 1787 | when losing focus. |
| 1788 | |
| 1789 | \value SH_Widget_ShareActivation Turn on sharing activation with |
| 1790 | floating modeless dialogs. |
| 1791 | |
| 1792 | \value SH_TabBar_SelectMouseType Which type of mouse event should |
| 1793 | cause a tab to be selected. |
| 1794 | |
| 1795 | \value SH_ListViewExpand_SelectMouseType Which type of mouse event should |
| 1796 | cause a list view expansion to be selected. |
| 1797 | |
| 1798 | \value SH_TabBar_PreferNoArrows Whether a tab bar should suggest a size |
| 1799 | to prevent scoll arrows. |
| 1800 | |
| 1801 | \value SH_ComboBox_Popup Allows popups as a combobox drop-down |
| 1802 | menu. |
| 1803 | |
| 1804 | \omitvalue SH_ComboBox_UseNativePopup |
| 1805 | |
| 1806 | \value SH_Workspace_FillSpaceOnMaximize The workspace should |
| 1807 | maximize the client area. |
| 1808 | |
| 1809 | \value SH_TitleBar_NoBorder The title bar has no border. |
| 1810 | |
| 1811 | \value SH_ScrollBar_StopMouseOverSlider Obsolete. Use |
| 1812 | SH_Slider_StopMouseOverSlider instead. |
| 1813 | |
| 1814 | \value SH_Slider_StopMouseOverSlider Stops auto-repeat when |
| 1815 | the slider reaches the mouse position. |
| 1816 | |
| 1817 | \value SH_BlinkCursorWhenTextSelected Whether cursor should blink |
| 1818 | when text is selected. |
| 1819 | |
| 1820 | \value SH_RichText_FullWidthSelection Whether richtext selections |
| 1821 | should extend to the full width of the document. |
| 1822 | |
| 1823 | \value SH_GroupBox_TextLabelVerticalAlignment How to vertically align a |
| 1824 | group box's text label. |
| 1825 | |
| 1826 | \value SH_GroupBox_TextLabelColor How to paint a group box's text label. |
| 1827 | |
| 1828 | \value SH_DialogButtons_DefaultButton Which button gets the |
| 1829 | default status in a dialog's button widget. |
| 1830 | |
| 1831 | \value SH_ToolBox_SelectedPageTitleBold Boldness of the selected |
| 1832 | page title in a QToolBox. |
| 1833 | |
| 1834 | \value SH_LineEdit_PasswordCharacter The Unicode character to be |
| 1835 | used for passwords. |
| 1836 | |
| 1837 | \value SH_LineEdit_PasswordMaskDelay Determines the delay before visible character is masked |
| 1838 | with password character, in milliseconds. This enum value was added in Qt 5.4. |
| 1839 | |
| 1840 | \value SH_Table_GridLineColor The RGBA value of the grid for a table. |
| 1841 | |
| 1842 | \value SH_UnderlineShortcut Whether shortcuts are underlined. |
| 1843 | |
| 1844 | \value SH_SpellCheckUnderlineStyle Obsolete. Use SpellCheckUnderlineStyle |
| 1845 | hint in QPlatformTheme instead. |
| 1846 | |
| 1847 | \value SH_SpinBox_AnimateButton Animate a click when up or down is |
| 1848 | pressed in a spin box. |
| 1849 | \value SH_SpinBox_KeyPressAutoRepeatRate Auto-repeat interval for |
| 1850 | spinbox key presses. |
| 1851 | \value SH_SpinBox_ClickAutoRepeatRate Auto-repeat interval for |
| 1852 | spinbox mouse clicks. |
| 1853 | \value SH_SpinBox_ClickAutoRepeatThreshold Auto-repeat threshold for |
| 1854 | spinbox mouse clicks. |
| 1855 | \value SH_ToolTipLabel_Opacity An integer indicating the opacity for |
| 1856 | the tip label, 0 is completely transparent, 255 is completely |
| 1857 | opaque. |
| 1858 | \value SH_DrawMenuBarSeparator Indicates whether or not the menu bar draws separators. |
| 1859 | \value SH_TitleBar_ModifyNotification Indicates if the title bar should show |
| 1860 | a '*' for windows that are modified. |
| 1861 | |
| 1862 | \value SH_Button_FocusPolicy The default focus policy for buttons. |
| 1863 | |
| 1864 | \value SH_CustomBase Base value for custom style hints. |
| 1865 | Custom values must be greater than this value. |
| 1866 | |
| 1867 | \value SH_MessageBox_UseBorderForButtonSpacing A boolean indicating what the to |
| 1868 | use the border of the buttons (computed as half the button height) for the spacing |
| 1869 | of the button in a message box. |
| 1870 | |
| 1871 | \value SH_MessageBox_CenterButtons A boolean indicating whether the buttons in the |
| 1872 | message box should be centered or not (see QDialogButtonBox::setCentered()). |
| 1873 | |
| 1874 | \value SH_MessageBox_TextInteractionFlags A boolean indicating if |
| 1875 | the text in a message box should allow user interfactions (e.g. |
| 1876 | selection) or not. |
| 1877 | |
| 1878 | \value SH_TitleBar_AutoRaise A boolean indicating whether |
| 1879 | controls on a title bar ought to update when the mouse is over them. |
| 1880 | |
| 1881 | \value SH_ToolButton_PopupDelay An int indicating the popup delay in milliseconds |
| 1882 | for menus attached to tool buttons. |
| 1883 | |
| 1884 | \value SH_FocusFrame_Mask The mask of the focus frame. |
| 1885 | |
| 1886 | \value SH_RubberBand_Mask The mask of the rubber band. |
| 1887 | |
| 1888 | \value SH_WindowFrame_Mask The mask of the window frame. |
| 1889 | |
| 1890 | \value SH_SpinControls_DisableOnBounds Determines if the spin controls will shown |
| 1891 | as disabled when reaching the spin range boundary. |
| 1892 | |
| 1893 | \value SH_Dial_BackgroundRole Defines the style's preferred |
| 1894 | background role (as QPalette::ColorRole) for a dial widget. |
| 1895 | |
| 1896 | \value SH_ComboBox_LayoutDirection The layout direction for the |
| 1897 | combo box. By default it should be the same as indicated by the |
| 1898 | QStyleOption::direction variable. |
| 1899 | |
| 1900 | \value SH_ItemView_EllipsisLocation The location where ellipses should be |
| 1901 | added for item text that is too long to fit in an view item. |
| 1902 | |
| 1903 | \value SH_ItemView_ShowDecorationSelected When an item in an item |
| 1904 | view is selected, also highlight the branch or other decoration. |
| 1905 | |
| 1906 | \value SH_ItemView_ActivateItemOnSingleClick Emit the activated signal |
| 1907 | when the user single clicks on an item in an item in an item view. |
| 1908 | Otherwise the signal is emitted when the user double clicks on an item. |
| 1909 | |
| 1910 | \value SH_Slider_AbsoluteSetButtons Which mouse buttons cause a slider |
| 1911 | to set the value to the position clicked on. |
| 1912 | |
| 1913 | \value SH_Slider_PageSetButtons Which mouse buttons cause a slider |
| 1914 | to page step the value. |
| 1915 | |
| 1916 | \value SH_TabBar_ElideMode The default eliding style for a tab bar. |
| 1917 | |
| 1918 | \value SH_DialogButtonLayout Controls how buttons are laid out in a QDialogButtonBox, returns a QDialogButtonBox::ButtonLayout enum. |
| 1919 | |
| 1920 | \value SH_WizardStyle Controls the look and feel of a QWizard. Returns a QWizard::WizardStyle enum. |
| 1921 | |
| 1922 | \value SH_FormLayoutWrapPolicy Provides a default for how rows are wrapped in a QFormLayout. Returns a QFormLayout::RowWrapPolicy enum. |
| 1923 | \value SH_FormLayoutFieldGrowthPolicy Provides a default for how fields can grow in a QFormLayout. Returns a QFormLayout::FieldGrowthPolicy enum. |
| 1924 | \value SH_FormLayoutFormAlignment Provides a default for how a QFormLayout aligns its contents within the available space. Returns a Qt::Alignment enum. |
| 1925 | \value SH_FormLayoutLabelAlignment Provides a default for how a QFormLayout aligns labels within the available space. Returns a Qt::Alignment enum. |
| 1926 | |
| 1927 | \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. |
| 1928 | \value SH_ComboBox_PopupFrameStyle The frame style used when drawing a combobox popup menu. |
| 1929 | |
| 1930 | \value SH_DialogButtonBox_ButtonsHaveIcons Indicates whether or not StandardButtons in QDialogButtonBox should have icons or not. |
| 1931 | \value SH_ItemView_MovementWithoutUpdatingSelection The item view is able to indicate a current item without changing the selection. |
| 1932 | \value SH_ToolTip_Mask The mask of a tool tip. |
| 1933 | |
| 1934 | \value SH_FocusFrame_AboveWidget The FocusFrame is stacked above the widget that it is "focusing on". |
| 1935 | |
| 1936 | \value SH_TextControl_FocusIndicatorTextCharFormat Specifies the text format used to highlight focused anchors in rich text |
| 1937 | documents displayed for example in QTextBrowser. The format has to be a QTextCharFormat returned in the variant of the |
| 1938 | QStyleHintReturnVariant return value. The QTextFormat::OutlinePen property is used for the outline and QTextFormat::BackgroundBrush |
| 1939 | for the background of the highlighted area. |
| 1940 | |
| 1941 | \value SH_Menu_FlashTriggeredItem Flash triggered item. |
| 1942 | \value SH_Menu_FadeOutOnHide Fade out the menu instead of hiding it immediately. |
| 1943 | |
| 1944 | \value SH_TabWidget_DefaultTabPosition Default position of the tab bar in a tab widget. |
| 1945 | |
| 1946 | \value SH_ToolBar_Movable Determines if the tool bar is movable by default. |
| 1947 | |
| 1948 | \value SH_ItemView_PaintAlternatingRowColorsForEmptyArea Whether QTreeView paints alternating row colors for the area that does not have any items. |
| 1949 | |
| 1950 | \value SH_Menu_Mask The mask for a popup menu. |
| 1951 | |
| 1952 | \value SH_ItemView_DrawDelegateFrame Determines if there should be a frame for a delegate widget. |
| 1953 | |
| 1954 | \value SH_TabBar_CloseButtonPosition Determines the position of the close button on a tab in a tab bar. |
| 1955 | |
| 1956 | \value SH_DockWidget_ButtonsHaveFrame Determines if dockwidget buttons should have frames. Default is true. |
| 1957 | |
| 1958 | \value SH_ToolButtonStyle Determines the default system style for tool buttons that uses Qt::ToolButtonFollowStyle. |
| 1959 | |
| 1960 | \value SH_RequestSoftwareInputPanel Determines when a software input panel should |
| 1961 | be requested by input widgets. Returns an enum of type QStyle::RequestSoftwareInputPanel. |
| 1962 | |
| 1963 | \value SH_ScrollBar_Transient Determines if the style supports transient scroll bars. Transient |
| 1964 | scroll bars appear when the content is scrolled and disappear when they are no longer needed. |
| 1965 | |
| 1966 | \value SH_Menu_SupportsSections Determines if the style displays sections in menus or treat them as |
| 1967 | plain separators. Sections are separators with a text and icon hint. |
| 1968 | |
| 1969 | \value SH_ToolTip_WakeUpDelay Determines the delay before a tooltip is shown, in milliseconds. |
| 1970 | |
| 1971 | \value SH_ToolTip_FallAsleepDelay Determines the delay (in milliseconds) before a new wake time is needed when |
| 1972 | a tooltip is shown (notice: shown, not hidden). When a new wake isn't needed, a user-requested tooltip |
| 1973 | will be shown nearly instantly. |
| 1974 | |
| 1975 | \value SH_Widget_Animate Deprecated. Use \l{SH_Widget_Animation_Duration} instead. |
| 1976 | |
| 1977 | \value SH_Splitter_OpaqueResize Determines if widgets are resized dynamically (opaquely) while |
| 1978 | interactively moving the splitter. This enum value was introduced in Qt 5.2. |
| 1979 | |
| 1980 | \value SH_TabBar_ChangeCurrentDelay Determines the delay before the current |
| 1981 | tab is changed while dragging over the tabbar, in milliseconds. This |
| 1982 | enum value has been introduced in Qt 5.4 |
| 1983 | |
| 1984 | \value SH_ItemView_ScrollMode The default vertical and horizontal scroll mode as specified |
| 1985 | by the style. Can be overridden with QAbstractItemView::setVerticalScrollMode() and |
| 1986 | QAbstractItemView::setHorizontalScrollMode(). This enum value has been introduced in Qt 5.7. |
| 1987 | |
| 1988 | \value SH_TitleBar_ShowToolTipsOnButtons |
| 1989 | Determines if tool tips are shown on window title bar buttons. |
| 1990 | The Mac style, for example, sets this to false. |
| 1991 | This enum value has been introduced in Qt 5.10. |
| 1992 | |
| 1993 | \value SH_Widget_Animation_Duration |
| 1994 | Determines how much an animation should last (in ms). |
| 1995 | A value equal to zero means that the animations will be disabled. |
| 1996 | This enum value has been introduced in Qt 5.10. |
| 1997 | |
| 1998 | \value SH_ComboBox_AllowWheelScrolling |
| 1999 | Determines if the mouse wheel can be used to scroll inside a QComboBox. |
| 2000 | This is on by default in all styles except the Mac style. |
| 2001 | This enum value has been introduced in Qt 5.10. |
| 2002 | |
| 2003 | \value SH_SpinBox_ButtonsInsideFrame |
| 2004 | Determines if the spin box buttons are inside the line edit frame. |
| 2005 | This enum value has been introduced in Qt 5.11. |
| 2006 | |
| 2007 | \value SH_SpinBox_StepModifier |
| 2008 | Determines which Qt::KeyboardModifier increases the step rate of |
| 2009 | QAbstractSpinBox. Possible values are Qt::NoModifier, |
| 2010 | Qt::ControlModifier (default) or Qt::ShiftModifier. Qt::NoModifier |
| 2011 | disables this feature. |
| 2012 | This enum value has been introduced in Qt 5.12. |
| 2013 | |
| 2014 | \sa styleHint() |
| 2015 | */ |
| 2016 | |
| 2017 | /*! |
| 2018 | \fn int QStyle::styleHint(StyleHint hint, const QStyleOption *option, const QWidget *widget, QStyleHintReturn *returnData) const |
| 2019 | |
| 2020 | Returns an integer representing the specified style \a hint for |
| 2021 | the given \a widget described by the provided style \a option. |
| 2022 | |
| 2023 | \a returnData is used when the querying widget needs more detailed data than |
| 2024 | the integer that styleHint() returns. See the QStyleHintReturn class |
| 2025 | description for details. |
| 2026 | */ |
| 2027 | |
| 2028 | /*! |
| 2029 | \enum QStyle::StandardPixmap |
| 2030 | |
| 2031 | This enum describes the available standard pixmaps. A standard pixmap is a pixmap that |
| 2032 | can follow some existing GUI style or guideline. |
| 2033 | |
| 2034 | \value SP_TitleBarMinButton Minimize button on title bars (e.g., |
| 2035 | in QMdiSubWindow). |
| 2036 | \value SP_TitleBarMenuButton Menu button on a title bar. |
| 2037 | \value SP_TitleBarMaxButton Maximize button on title bars. |
| 2038 | \value SP_TitleBarCloseButton Close button on title bars. |
| 2039 | \value SP_TitleBarNormalButton Normal (restore) button on title bars. |
| 2040 | \value SP_TitleBarShadeButton Shade button on title bars. |
| 2041 | \value SP_TitleBarUnshadeButton Unshade button on title bars. |
| 2042 | \value SP_TitleBarContextHelpButton The Context help button on title bars. |
| 2043 | \value SP_MessageBoxInformation The "information" icon. |
| 2044 | \value SP_MessageBoxWarning The "warning" icon. |
| 2045 | \value SP_MessageBoxCritical The "critical" icon. |
| 2046 | \value SP_MessageBoxQuestion The "question" icon. |
| 2047 | \value SP_DesktopIcon The "desktop" icon. |
| 2048 | \value SP_TrashIcon The "trash" icon. |
| 2049 | \value SP_ComputerIcon The "My computer" icon. |
| 2050 | \value SP_DriveFDIcon The floppy icon. |
| 2051 | \value SP_DriveHDIcon The harddrive icon. |
| 2052 | \value SP_DriveCDIcon The CD icon. |
| 2053 | \value SP_DriveDVDIcon The DVD icon. |
| 2054 | \value SP_DriveNetIcon The network icon. |
| 2055 | \value SP_DirHomeIcon The home directory icon. |
| 2056 | \value SP_DirOpenIcon The open directory icon. |
| 2057 | \value SP_DirClosedIcon The closed directory icon. |
| 2058 | \value SP_DirIcon The directory icon. |
| 2059 | \value SP_DirLinkIcon The link to directory icon. |
| 2060 | \value SP_DirLinkOpenIcon The link to open directory icon. |
| 2061 | \value SP_FileIcon The file icon. |
| 2062 | \value SP_FileLinkIcon The link to file icon. |
| 2063 | \value SP_FileDialogStart The "start" icon in a file dialog. |
| 2064 | \value SP_FileDialogEnd The "end" icon in a file dialog. |
| 2065 | \value SP_FileDialogToParent The "parent directory" icon in a file dialog. |
| 2066 | \value SP_FileDialogNewFolder The "create new folder" icon in a file dialog. |
| 2067 | \value SP_FileDialogDetailedView The detailed view icon in a file dialog. |
| 2068 | \value SP_FileDialogInfoView The file info icon in a file dialog. |
| 2069 | \value SP_FileDialogContentsView The contents view icon in a file dialog. |
| 2070 | \value SP_FileDialogListView The list view icon in a file dialog. |
| 2071 | \value SP_FileDialogBack The back arrow in a file dialog. |
| 2072 | \value SP_DockWidgetCloseButton Close button on dock windows (see also QDockWidget). |
| 2073 | \value SP_ToolBarHorizontalExtensionButton Extension button for horizontal toolbars. |
| 2074 | \value SP_ToolBarVerticalExtensionButton Extension button for vertical toolbars. |
| 2075 | \value SP_DialogOkButton Icon for a standard OK button in a QDialogButtonBox. |
| 2076 | \value SP_DialogCancelButton Icon for a standard Cancel button in a QDialogButtonBox. |
| 2077 | \value SP_DialogHelpButton Icon for a standard Help button in a QDialogButtonBox. |
| 2078 | \value SP_DialogOpenButton Icon for a standard Open button in a QDialogButtonBox. |
| 2079 | \value SP_DialogSaveButton Icon for a standard Save button in a QDialogButtonBox. |
| 2080 | \value SP_DialogCloseButton Icon for a standard Close button in a QDialogButtonBox. |
| 2081 | \value SP_DialogApplyButton Icon for a standard Apply button in a QDialogButtonBox. |
| 2082 | \value SP_DialogResetButton Icon for a standard Reset button in a QDialogButtonBox. |
| 2083 | \value SP_DialogDiscardButton Icon for a standard Discard button in a QDialogButtonBox. |
| 2084 | \value SP_DialogYesButton Icon for a standard Yes button in a QDialogButtonBox. |
| 2085 | \value SP_DialogNoButton Icon for a standard No button in a QDialogButtonBox. |
| 2086 | \value SP_ArrowUp Icon arrow pointing up. |
| 2087 | \value SP_ArrowDown Icon arrow pointing down. |
| 2088 | \value SP_ArrowLeft Icon arrow pointing left. |
| 2089 | \value SP_ArrowRight Icon arrow pointing right. |
| 2090 | \value SP_ArrowBack Equivalent to SP_ArrowLeft when the current layout direction is Qt::LeftToRight, otherwise SP_ArrowRight. |
| 2091 | \value SP_ArrowForward Equivalent to SP_ArrowRight when the current layout direction is Qt::LeftToRight, otherwise SP_ArrowLeft. |
| 2092 | \value SP_CommandLink Icon used to indicate a Vista style command link glyph. |
| 2093 | \value SP_VistaShield Icon used to indicate UAC prompts on Windows Vista. This will return a null pixmap or icon on all other platforms. |
| 2094 | \value SP_BrowserReload Icon indicating that the current page should be reloaded. |
| 2095 | \value SP_BrowserStop Icon indicating that the page loading should stop. |
| 2096 | \value SP_MediaPlay Icon indicating that media should begin playback. |
| 2097 | \value SP_MediaStop Icon indicating that media should stop playback. |
| 2098 | \value SP_MediaPause Icon indicating that media should pause playback. |
| 2099 | \value SP_MediaSkipForward Icon indicating that media should skip forward. |
| 2100 | \value SP_MediaSkipBackward Icon indicating that media should skip backward. |
| 2101 | \value SP_MediaSeekForward Icon indicating that media should seek forward. |
| 2102 | \value SP_MediaSeekBackward Icon indicating that media should seek backward. |
| 2103 | \value SP_MediaVolume Icon indicating a volume control. |
| 2104 | \value SP_MediaVolumeMuted Icon indicating a muted volume control. |
| 2105 | \value SP_LineEditClearButton Icon for a standard clear button in a QLineEdit. This enum value was added in Qt 5.2. |
| 2106 | \value SP_DialogYesToAllButton Icon for a standard YesToAll button in a QDialogButtonBox. |
| 2107 | This enum value was added in Qt 5.14. |
| 2108 | \value SP_DialogNoToAllButton Icon for a standard NoToAll button in a QDialogButtonBox. |
| 2109 | This enum value was added in Qt 5.14. |
| 2110 | \value SP_DialogSaveAllButton Icon for a standard SaveAll button in a QDialogButtonBox. |
| 2111 | This enum value was added in Qt 5.14. |
| 2112 | \value SP_DialogAbortButton Icon for a standard Abort button in a QDialogButtonBox. |
| 2113 | This enum value was added in Qt 5.14. |
| 2114 | \value SP_DialogRetryButton Icon for a standard Retry button in a QDialogButtonBox. |
| 2115 | This enum value was added in Qt 5.14. |
| 2116 | \value SP_DialogIgnoreButton Icon for a standard Ignore button in a QDialogButtonBox. |
| 2117 | This enum value was added in Qt 5.14. |
| 2118 | \value SP_RestoreDefaultsButton Icon for a standard RestoreDefaults button in a QDialogButtonBox. |
| 2119 | This enum value was added in Qt 5.14. |
| 2120 | \value SP_CustomBase Base value for custom standard pixmaps; |
| 2121 | custom values must be greater than this value. |
| 2122 | |
| 2123 | \sa standardIcon() |
| 2124 | */ |
| 2125 | |
| 2126 | /*! |
| 2127 | \fn QPixmap QStyle::generatedIconPixmap(QIcon::Mode iconMode, |
| 2128 | const QPixmap &pixmap, const QStyleOption *option) const |
| 2129 | |
| 2130 | Returns a copy of the given \a pixmap, styled to conform to the |
| 2131 | specified \a iconMode and taking into account the palette |
| 2132 | specified by \a option. |
| 2133 | |
| 2134 | The \a option parameter can pass extra information, but |
| 2135 | it must contain a palette. |
| 2136 | |
| 2137 | Note that not all pixmaps will conform, in which case the returned |
| 2138 | pixmap is a plain copy. |
| 2139 | |
| 2140 | \sa QIcon |
| 2141 | */ |
| 2142 | |
| 2143 | /*! |
| 2144 | \fn QPixmap QStyle::standardPixmap(StandardPixmap standardPixmap, const QStyleOption *option, const QWidget *widget) const |
| 2145 | |
| 2146 | \obsolete |
| 2147 | Returns a pixmap for the given \a standardPixmap. |
| 2148 | |
| 2149 | A standard pixmap is a pixmap that can follow some existing GUI |
| 2150 | style or guideline. The \a option argument can be used to pass |
| 2151 | extra information required when defining the appropriate |
| 2152 | pixmap. The \a widget argument is optional and can also be used to |
| 2153 | aid the determination of the pixmap. |
| 2154 | |
| 2155 | Developers calling standardPixmap() should instead call standardIcon() |
| 2156 | Developers who re-implemented standardPixmap() should instead re-implement |
| 2157 | standardIcon(). |
| 2158 | |
| 2159 | \sa standardIcon() |
| 2160 | */ |
| 2161 | |
| 2162 | |
| 2163 | /*! |
| 2164 | \fn QRect QStyle::visualRect(Qt::LayoutDirection direction, const QRect &boundingRectangle, const QRect &logicalRectangle) |
| 2165 | |
| 2166 | Returns the given \a logicalRectangle converted to screen |
| 2167 | coordinates based on the specified \a direction. The \a |
| 2168 | boundingRectangle is used when performing the translation. |
| 2169 | |
| 2170 | This function is provided to support right-to-left desktops, and |
| 2171 | is typically used in implementations of the subControlRect() |
| 2172 | function. |
| 2173 | |
| 2174 | \sa QWidget::layoutDirection |
| 2175 | */ |
| 2176 | QRect QStyle::visualRect(Qt::LayoutDirection direction, const QRect &boundingRect, const QRect &logicalRect) |
| 2177 | { |
| 2178 | if (direction == Qt::LeftToRight) |
| 2179 | return logicalRect; |
| 2180 | QRect rect = logicalRect; |
| 2181 | rect.translate(dx: 2 * (boundingRect.right() - logicalRect.right()) + |
| 2182 | logicalRect.width() - boundingRect.width(), dy: 0); |
| 2183 | return rect; |
| 2184 | } |
| 2185 | |
| 2186 | /*! |
| 2187 | \fn QPoint QStyle::visualPos(Qt::LayoutDirection direction, const QRect &boundingRectangle, const QPoint &logicalPosition) |
| 2188 | |
| 2189 | Returns the given \a logicalPosition converted to screen |
| 2190 | coordinates based on the specified \a direction. The \a |
| 2191 | boundingRectangle is used when performing the translation. |
| 2192 | |
| 2193 | \sa QWidget::layoutDirection |
| 2194 | */ |
| 2195 | QPoint QStyle::visualPos(Qt::LayoutDirection direction, const QRect &boundingRect, const QPoint &logicalPos) |
| 2196 | { |
| 2197 | if (direction == Qt::LeftToRight) |
| 2198 | return logicalPos; |
| 2199 | return QPoint(boundingRect.right() - logicalPos.x(), logicalPos.y()); |
| 2200 | } |
| 2201 | |
| 2202 | /*! |
| 2203 | Returns a new rectangle of the specified \a size that is aligned to the given \a |
| 2204 | rectangle according to the specified \a alignment and \a direction. |
| 2205 | */ |
| 2206 | QRect QStyle::alignedRect(Qt::LayoutDirection direction, Qt::Alignment alignment, const QSize &size, const QRect &rectangle) |
| 2207 | { |
| 2208 | alignment = visualAlignment(direction, alignment); |
| 2209 | int x = rectangle.x(); |
| 2210 | int y = rectangle.y(); |
| 2211 | int w = size.width(); |
| 2212 | int h = size.height(); |
| 2213 | if ((alignment & Qt::AlignVCenter) == Qt::AlignVCenter) |
| 2214 | y += rectangle.size().height()/2 - h/2; |
| 2215 | else if ((alignment & Qt::AlignBottom) == Qt::AlignBottom) |
| 2216 | y += rectangle.size().height() - h; |
| 2217 | if ((alignment & Qt::AlignRight) == Qt::AlignRight) |
| 2218 | x += rectangle.size().width() - w; |
| 2219 | else if ((alignment & Qt::AlignHCenter) == Qt::AlignHCenter) |
| 2220 | x += rectangle.size().width()/2 - w/2; |
| 2221 | return QRect(x, y, w, h); |
| 2222 | } |
| 2223 | |
| 2224 | /*! |
| 2225 | Transforms an \a alignment of Qt::AlignLeft or Qt::AlignRight |
| 2226 | without Qt::AlignAbsolute into Qt::AlignLeft or Qt::AlignRight with |
| 2227 | Qt::AlignAbsolute according to the layout \a direction. The other |
| 2228 | alignment flags are left untouched. |
| 2229 | |
| 2230 | If no horizontal alignment was specified, the function returns the |
| 2231 | default alignment for the given layout \a direction. |
| 2232 | |
| 2233 | QWidget::layoutDirection |
| 2234 | */ |
| 2235 | Qt::Alignment QStyle::visualAlignment(Qt::LayoutDirection direction, Qt::Alignment alignment) |
| 2236 | { |
| 2237 | return QGuiApplicationPrivate::visualAlignment(direction, alignment); |
| 2238 | } |
| 2239 | |
| 2240 | /*! |
| 2241 | Converts the given \a logicalValue to a pixel position. The \a min |
| 2242 | parameter maps to 0, \a max maps to \a span and other values are |
| 2243 | distributed evenly in-between. |
| 2244 | |
| 2245 | This function can handle the entire integer range without |
| 2246 | overflow, providing that \a span is less than 4096. |
| 2247 | |
| 2248 | By default, this function assumes that the maximum value is on the |
| 2249 | right for horizontal items and on the bottom for vertical items. |
| 2250 | Set the \a upsideDown parameter to true to reverse this behavior. |
| 2251 | |
| 2252 | \sa sliderValueFromPosition() |
| 2253 | */ |
| 2254 | |
| 2255 | int QStyle::sliderPositionFromValue(int min, int max, int logicalValue, int span, bool upsideDown) |
| 2256 | { |
| 2257 | if (span <= 0 || logicalValue < min || max <= min) |
| 2258 | return 0; |
| 2259 | if (logicalValue > max) |
| 2260 | return upsideDown ? span : min; |
| 2261 | |
| 2262 | uint range = max - min; |
| 2263 | uint p = upsideDown ? max - logicalValue : logicalValue - min; |
| 2264 | |
| 2265 | if (range > (uint)INT_MAX/4096) { |
| 2266 | double dpos = (double(p))/(double(range)/span); |
| 2267 | return int(dpos); |
| 2268 | } else if (range > (uint)span) { |
| 2269 | return (2 * p * span + range) / (2*range); |
| 2270 | } else { |
| 2271 | uint div = span / range; |
| 2272 | uint mod = span % range; |
| 2273 | return p * div + (2 * p * mod + range) / (2 * range); |
| 2274 | } |
| 2275 | // equiv. to (p * span) / range + 0.5 |
| 2276 | // no overflow because of this implicit assumption: |
| 2277 | // span <= 4096 |
| 2278 | } |
| 2279 | |
| 2280 | /*! |
| 2281 | \fn int QStyle::sliderValueFromPosition(int min, int max, int position, int span, bool upsideDown) |
| 2282 | |
| 2283 | Converts the given pixel \a position to a logical value. 0 maps to |
| 2284 | the \a min parameter, \a span maps to \a max and other values are |
| 2285 | distributed evenly in-between. |
| 2286 | |
| 2287 | This function can handle the entire integer range without |
| 2288 | overflow. |
| 2289 | |
| 2290 | By default, this function assumes that the maximum value is on the |
| 2291 | right for horizontal items and on the bottom for vertical |
| 2292 | items. Set the \a upsideDown parameter to true to reverse this |
| 2293 | behavior. |
| 2294 | |
| 2295 | \sa sliderPositionFromValue() |
| 2296 | */ |
| 2297 | |
| 2298 | int QStyle::sliderValueFromPosition(int min, int max, int pos, int span, bool upsideDown) |
| 2299 | { |
| 2300 | if (span <= 0 || pos <= 0) |
| 2301 | return upsideDown ? max : min; |
| 2302 | if (pos >= span) |
| 2303 | return upsideDown ? min : max; |
| 2304 | |
| 2305 | uint range = max - min; |
| 2306 | |
| 2307 | if ((uint)span > range) { |
| 2308 | int tmp = (2 * pos * range + span) / (2 * span); |
| 2309 | return upsideDown ? max - tmp : tmp + min; |
| 2310 | } else { |
| 2311 | uint div = range / span; |
| 2312 | uint mod = range % span; |
| 2313 | int tmp = pos * div + (2 * pos * mod + span) / (2 * span); |
| 2314 | return upsideDown ? max - tmp : tmp + min; |
| 2315 | } |
| 2316 | // equiv. to min + (pos*range)/span + 0.5 |
| 2317 | // no overflow because of this implicit assumption: |
| 2318 | // pos <= span < sqrt(INT_MAX+0.0625)+0.25 ~ sqrt(INT_MAX) |
| 2319 | } |
| 2320 | |
| 2321 | /*! |
| 2322 | Returns the style's standard palette. |
| 2323 | |
| 2324 | Note that on systems that support system colors, the style's |
| 2325 | standard palette is not used. In particular, the Windows |
| 2326 | Vista and Mac styles do not use the standard palette, but make |
| 2327 | use of native theme engines. With these styles, you should not set |
| 2328 | the palette with QApplication::setPalette(). |
| 2329 | |
| 2330 | \sa QApplication::setPalette() |
| 2331 | */ |
| 2332 | QPalette QStyle::standardPalette() const |
| 2333 | { |
| 2334 | QColor background = QColor(0xd4, 0xd0, 0xc8); // win 2000 grey |
| 2335 | |
| 2336 | QColor light(background.lighter()); |
| 2337 | QColor dark(background.darker()); |
| 2338 | QColor mid(Qt::gray); |
| 2339 | QPalette palette(Qt::black, background, light, dark, mid, Qt::black, Qt::white); |
| 2340 | palette.setBrush(cg: QPalette::Disabled, cr: QPalette::WindowText, brush: dark); |
| 2341 | palette.setBrush(cg: QPalette::Disabled, cr: QPalette::Text, brush: dark); |
| 2342 | palette.setBrush(cg: QPalette::Disabled, cr: QPalette::ButtonText, brush: dark); |
| 2343 | palette.setBrush(cg: QPalette::Disabled, cr: QPalette::Base, brush: background); |
| 2344 | return palette; |
| 2345 | } |
| 2346 | |
| 2347 | /*! |
| 2348 | \since 4.1 |
| 2349 | |
| 2350 | \fn QIcon QStyle::standardIcon(StandardPixmap standardIcon, const QStyleOption *option = 0, |
| 2351 | const QWidget *widget = 0) const = 0; |
| 2352 | |
| 2353 | Returns an icon for the given \a standardIcon. |
| 2354 | |
| 2355 | The \a standardIcon is a standard pixmap which can follow some |
| 2356 | existing GUI style or guideline. The \a option argument can be |
| 2357 | used to pass extra information required when defining the |
| 2358 | appropriate icon. The \a widget argument is optional and can also |
| 2359 | be used to aid the determination of the icon. |
| 2360 | */ |
| 2361 | |
| 2362 | /*! |
| 2363 | \since 4.3 |
| 2364 | |
| 2365 | \fn int QStyle::layoutSpacing(QSizePolicy::ControlType control1, |
| 2366 | QSizePolicy::ControlType control2, Qt::Orientation orientation, |
| 2367 | const QStyleOption *option = nullptr, const QWidget *widget = nullptr) const |
| 2368 | |
| 2369 | Returns the spacing that should be used between \a control1 and |
| 2370 | \a control2 in a layout. \a orientation specifies whether the |
| 2371 | controls are laid out side by side or stacked vertically. The \a |
| 2372 | option parameter can be used to pass extra information about the |
| 2373 | parent widget. The \a widget parameter is optional and can also |
| 2374 | be used if \a option is \nullptr. |
| 2375 | |
| 2376 | This function is called by the layout system. It is used only if |
| 2377 | PM_LayoutHorizontalSpacing or PM_LayoutVerticalSpacing returns a |
| 2378 | negative value. |
| 2379 | |
| 2380 | \sa combinedLayoutSpacing() |
| 2381 | */ |
| 2382 | |
| 2383 | /*! |
| 2384 | \since 4.3 |
| 2385 | |
| 2386 | Returns the spacing that should be used between \a controls1 and |
| 2387 | \a controls2 in a layout. \a orientation specifies whether the |
| 2388 | controls are laid out side by side or stacked vertically. The \a |
| 2389 | option parameter can be used to pass extra information about the |
| 2390 | parent widget. The \a widget parameter is optional and can also |
| 2391 | be used if \a option is \nullptr. |
| 2392 | |
| 2393 | \a controls1 and \a controls2 are OR-combination of zero or more |
| 2394 | \l{QSizePolicy::ControlTypes}{control types}. |
| 2395 | |
| 2396 | This function is called by the layout system. It is used only if |
| 2397 | PM_LayoutHorizontalSpacing or PM_LayoutVerticalSpacing returns a |
| 2398 | negative value. |
| 2399 | |
| 2400 | \sa layoutSpacing() |
| 2401 | */ |
| 2402 | int QStyle::combinedLayoutSpacing(QSizePolicy::ControlTypes controls1, |
| 2403 | QSizePolicy::ControlTypes controls2, Qt::Orientation orientation, |
| 2404 | QStyleOption *option, QWidget *widget) const |
| 2405 | { |
| 2406 | QSizePolicy::ControlType array1[MaxBits]; |
| 2407 | QSizePolicy::ControlType array2[MaxBits]; |
| 2408 | int count1 = unpackControlTypes(controls: controls1, array: array1); |
| 2409 | int count2 = unpackControlTypes(controls: controls2, array: array2); |
| 2410 | int result = -1; |
| 2411 | |
| 2412 | for (int i = 0; i < count1; ++i) { |
| 2413 | for (int j = 0; j < count2; ++j) { |
| 2414 | int spacing = layoutSpacing(control1: array1[i], control2: array2[j], orientation, option, widget); |
| 2415 | result = qMax(a: spacing, b: result); |
| 2416 | } |
| 2417 | } |
| 2418 | return result; |
| 2419 | } |
| 2420 | |
| 2421 | // ### Qt 6: Remove in favor of template<class T> QDebug operator<<(QDebug, const QFlags<T> &). |
| 2422 | #if QT_VERSION < QT_VERSION_CHECK(6,0,0) |
| 2423 | QT_BEGIN_INCLUDE_NAMESPACE |
| 2424 | # include <QDebug> |
| 2425 | QT_END_INCLUDE_NAMESPACE |
| 2426 | |
| 2427 | # if !defined(QT_NO_DEBUG_STREAM) |
| 2428 | QDebug operator<<(QDebug debug, QStyle::State state) |
| 2429 | { |
| 2430 | # if !defined(QT_NO_DEBUG) |
| 2431 | return operator<< <QStyle::StateFlag>(debug, flags: state); |
| 2432 | # else |
| 2433 | Q_UNUSED(state); |
| 2434 | return debug; |
| 2435 | # endif |
| 2436 | } |
| 2437 | # endif // !QT_NO_DEBUG_STREAM |
| 2438 | #endif // QT_VERSION < QT_VERSION_CHECK(6,0,0) |
| 2439 | |
| 2440 | /*! |
| 2441 | \since 4.6 |
| 2442 | |
| 2443 | \fn const QStyle *QStyle::proxy() const |
| 2444 | |
| 2445 | This function returns the current proxy for this style. |
| 2446 | By default most styles will return themselves. However |
| 2447 | when a proxy style is in use, it will allow the style to |
| 2448 | call back into its proxy. |
| 2449 | */ |
| 2450 | const QStyle * QStyle::proxy() const |
| 2451 | { |
| 2452 | Q_D(const QStyle); |
| 2453 | return d->proxyStyle == this ? this : d->proxyStyle->proxy(); |
| 2454 | } |
| 2455 | |
| 2456 | /* \internal |
| 2457 | |
| 2458 | This function sets the base style that style calls will be |
| 2459 | redirected to. Note that ownership is not transferred. \a style |
| 2460 | must be a valid pointer (not nullptr). |
| 2461 | */ |
| 2462 | void QStyle::setProxy(QStyle *style) |
| 2463 | { |
| 2464 | Q_D(QStyle); |
| 2465 | Q_ASSERT(style); |
| 2466 | d->proxyStyle = style; |
| 2467 | } |
| 2468 | |
| 2469 | //Windows and KDE allow menus to cover the taskbar, while GNOME and macOS don't |
| 2470 | bool QStylePrivate::() |
| 2471 | { |
| 2472 | auto theme = QGuiApplicationPrivate::platformTheme(); |
| 2473 | return theme && theme->themeHint(hint: QPlatformTheme::UseFullScreenForPopupMenu).toBool(); |
| 2474 | } |
| 2475 | |
| 2476 | QT_END_NAMESPACE |
| 2477 | |
| 2478 | #include "moc_qstyle.cpp" |
| 2479 | |