Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qnamespace.qdoc
Go to the documentation of this file.
1// Copyright (C) 2022 The Qt Company Ltd.
2// Copyright (C) 2020 Klaralvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
3// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
4
5/*!
6 \namespace Qt
7 \inmodule QtCore
8 \keyword Qt Namespace
9
10 \brief The Qt namespace contains miscellaneous identifiers
11 used throughout the Qt library.
12*/
13
14/*!
15 \enum Qt::Orientation
16
17 This type is used to signify an object's orientation.
18
19 \value Horizontal
20 \value Vertical
21
22 Orientation is used with QScrollBar for example.
23*/
24
25/*!
26 \enum Qt::AlignmentFlag
27
28 This enum type is used to describe alignment. It contains
29 horizontal and vertical flags that can be combined to produce
30 the required effect.
31
32 The \l{TextElideMode} enum can also be used in many situations
33 to fine-tune the appearance of aligned text.
34
35 The horizontal flags are:
36
37 \value AlignLeft Aligns with the left edge.
38 \value AlignRight Aligns with the right edge.
39 \value AlignHCenter Centers horizontally in the available space.
40 \value AlignJustify Justifies the text in the available space.
41
42 The vertical flags are:
43
44 \value AlignTop Aligns with the top.
45 \value AlignBottom Aligns with the bottom.
46 \value AlignVCenter Centers vertically in the available space.
47 \value AlignBaseline Aligns with the baseline.
48
49 You can use only one of the horizontal flags at a time. There is
50 one two-dimensional flag:
51
52 \value AlignCenter Centers in both dimensions.
53
54 You can use at most one horizontal and one vertical flag at a
55 time. Qt::AlignCenter counts as both horizontal and vertical.
56
57 Three enum values are useful in applications that can be run in
58 right-to-left mode:
59
60 \value AlignAbsolute If the widget's layout direction is
61 Qt::RightToLeft (instead of Qt::LeftToRight, the default),
62 Qt::AlignLeft refers to the \e right edge and Qt::AlignRight
63 to the \e left edge. This is normally the desired behavior.
64 If you want Qt::AlignLeft to always mean "left" and
65 Qt::AlignRight to always mean "right", combine the flag with
66 Qt::AlignAbsolute.
67 \value AlignLeading Synonym for Qt::AlignLeft.
68 \value AlignTrailing Synonym for Qt::AlignRight.
69
70 Masks:
71
72 \value AlignHorizontal_Mask
73 \value AlignVertical_Mask
74
75 Conflicting combinations of flags have undefined meanings.
76*/
77
78/*!
79 \enum Qt::ApplicationAttribute
80
81 This enum describes attributes that change the behavior of
82 application-wide features. These are enabled and disabled using
83 QCoreApplication::setAttribute(), and can be tested for with
84 QCoreApplication::testAttribute().
85
86
87 \value [since 6.7] AA_QtQuickUseDefaultSizePolicy Qt Quick Layouts use the built-in size
88 policy of \l Item. For example, when this is set, \l Button fills the available
89 width, but has a fixed height. When this is not set, it will use the default
90 sizing behavior of the layout it's in, which is to use its implicit size as the
91 preferred size. This is explained in detail in \l {Specifying preferred size} and
92 \l {Size constraints}. When this is set, the default size policy of the item
93 with the layout can be overridden by explicitly setting
94 \l{Layout::fillWidth}{Layout.fillWidth} or
95 \l{Layout::fillHeight}{Layout.fillHeight}.
96
97 \value AA_DontShowIconsInMenus Actions with the Icon property won't be
98 shown in any menus unless specifically set by the
99 QAction::iconVisibleInMenu property. The default value of this
100 attribute depends on the platform. To override the default
101 behavior, set the attribute after QGuiApplication has been
102 instantiated.
103 Menus that are currently open or menus already created in the native
104 \macos menubar \e{may not} pick up a change in this attribute. Changes
105 in the QAction::iconVisibleInMenu property will always be picked up.
106
107 \value AA_DontShowShortcutsInContextMenus Actions with the Shortcut property
108 won't be shown in any shortcut menus unless specifically set by the
109 QAction::shortcutVisibleInContextMenu property. This value was added
110 in Qt 5.10, and is by default based on the value reported by
111 QStyleHints::showShortcutsInContextMenus(). To override the default
112 behavior, set the style hint before QCoreApplication has been
113 instantiated, or set this attribute after QCoreApplication has
114 been instantiated.
115
116 \value AA_NativeWindows Ensures that widgets have native windows.
117
118 \value AA_DontCreateNativeWidgetSiblings Ensures that siblings of native
119 widgets stay non-native unless specifically set by the
120 Qt::WA_NativeWindow attribute.
121
122 \value AA_PluginApplication Indicates that Qt is used to author a plugin. Depending
123 on the operating system, it suppresses specific initializations that do not
124 necessarily make sense in the plugin case.
125 For example on \macos, this includes avoiding loading our nib for the main
126 menu and not taking possession of the native menu bar. Setting this
127 attribute to true will also set the AA_DontUseNativeMenuBar attribute
128 to true. It also disables native event filters.
129 This attribute must be set before QGuiApplication constructed.
130 This value was added in Qt 5.7.
131
132 \value AA_DontUseNativeMenuBar All menubars created while this attribute is
133 set to true won't be used as a native menubar (e.g, the menubar at
134 the top of the main screen on \macos).
135
136 \value AA_MacDontSwapCtrlAndMeta Keyboard shortcuts on Apple platforms are typically
137 based on the Command (or Cmd) keyboard modifier, represented by
138 the ⌘ symbol. For example, the 'Copy' action is Command+C (⌘+C).
139 To ease cross platform development Qt will by default remap Command
140 to the Qt::ControlModifier, to align with other platforms. This
141 allows creating keyboard shortcuts such as "Ctrl+J", which on
142 \macos will then map to Command+J, as expected by \macos users. The
143 actual Control (or Ctrl) modifier on Apple platforms, represented by ⌃,
144 is mapped to Qt::MetaModifier.
145
146 When this attribute is true Qt will not do the remapping, and pressing
147 the Command modifier will result in Qt::MetaModifier, while pressing
148 the Control modifier will result in Qt::ControlModifier.
149
150 Note that the \l QKeySequence::StandardKey sequences will always be
151 based on the same modifier (i.e., QKeySequence::Copy will be
152 Command+C regardless of the value set), but what is output for
153 QKeySequence::toString() will be different.
154
155 \value AA_Use96Dpi Assume the screen has a resolution of 96 DPI rather
156 than using the OS-provided resolution. This will cause font rendering
157 to be consistent in pixels-per-point across devices rather than
158 defining 1 point as 1/72 inch.
159
160 \value AA_SynthesizeTouchForUnhandledMouseEvents All mouse events
161 that are not accepted by the application will be translated
162 to touch events instead.
163
164 \value AA_SynthesizeMouseForUnhandledTouchEvents All touch events
165 that are not accepted by the application will be translated
166 to left button mouse events instead. This attribute is enabled
167 by default.
168
169 \value AA_ForceRasterWidgets Make top-level widgets use pure raster surfaces,
170 and do not support non-native GL-based child widgets.
171
172 \value AA_UseDesktopOpenGL Forces the usage of desktop OpenGL (for example,
173 \e opengl32.dll or \e libGL.so) on platforms that use dynamic loading
174 of the OpenGL implementation. This attribute must be set before
175 QGuiApplication is constructed.
176 This value was added in Qt 5.3.
177
178 \value AA_UseOpenGLES Forces the usage of OpenGL ES 2.0 or higher on
179 platforms that use dynamic loading of the OpenGL implementation.
180 This attribute must be set before QGuiApplication is constructed.
181 This value was added in Qt 5.3.
182
183 \value AA_UseSoftwareOpenGL Forces the usage of a software based OpenGL
184 implementation on platforms that use dynamic loading of the OpenGL
185 implementation. This will typically be a patched build of
186 \l{http://www.mesa3d.org/llvmpipe.html}{Mesa llvmpipe}, providing
187 OpenGL 2.1. The value may have no effect if no such OpenGL
188 implementation is available. The default name of this library is
189 \c opengl32sw.dll and can be overridden by setting the environment
190 variable \e QT_OPENGL_DLL. See the platform-specific pages, for
191 instance \l{Qt for Windows}, for more information. This attribute
192 must be set before QGuiApplication is constructed.
193 This value was added in Qt 5.4.
194
195 \value AA_ShareOpenGLContexts Enables resource sharing between the OpenGL
196 contexts used by classes like QOpenGLWidget and QQuickWidget. This
197 allows sharing OpenGL resources, like textures, between QOpenGLWidget
198 instances that belong to different top-level windows.
199 This value was added in Qt 5.4.
200
201 \value AA_SetPalette Indicates whether a palette was explicitly set on the
202 QGuiApplication. This value was added in Qt 5.5.
203
204 \value AA_UseStyleSheetPropagationInWidgetStyles By default, Qt Style Sheets
205 disable regular QWidget palette and font propagation. When this flag
206 is enabled, font and palette changes done from a style sheet will propagate
207 a single time, when the style sheet is set.
208 See \l{The Style Sheet Syntax#Inheritance}{The Style Sheet Syntax - Inheritance}
209 for more details.
210 This value was added in Qt 5.7.
211
212 \value AA_DontUseNativeDialogs All dialogs created while this attribute is
213 set to true won't use the native dialogs provided by the platform.
214 This value was added in Qt 5.7.
215
216 \value AA_SynthesizeMouseForUnhandledTabletEvents All tablet events
217 that are not accepted by the application will be translated
218 to mouse events instead. This attribute is enabled
219 by default.
220 This value was added in Qt 5.7.
221
222 \value AA_CompressHighFrequencyEvents Enables compression of certain frequent events.
223 On the X11 windowing system, the default value is true, which means that
224 QEvent::MouseMove, QEvent::TouchUpdate, and changes in window size and
225 position will be combined whenever they occur more frequently than the
226 application handles them, so that they don't accumulate and overwhelm the
227 application later.
228 On Windows 8 and above the default value is also true, but it only applies
229 to touch events. Mouse and window events remain unaffected by this flag.
230 On Wayland the default value is also true, but it only applies to mouse events.
231 On other platforms, the default is false.
232 (In the future, the compression feature may be implemented across platforms.)
233 You can test the attribute to see whether compression is enabled.
234 If your application needs to handle all events with no compression,
235 you can unset this attribute. Notice that input events from tablet devices
236 will not be compressed. See AA_CompressTabletEvents if you want these to be
237 compressed as well.
238 This value was added in Qt 5.7.
239
240 \value AA_CompressTabletEvents Enables compression of input events from tablet devices.
241 Notice that AA_CompressHighFrequencyEvents must be true for events compression
242 to be enabled, and that this flag extends the former to tablet events.
243 Currently supported on the X11 windowing system, Windows 8 and above.
244 The default value is false.
245 This value was added in Qt 5.10.
246
247 \value AA_DontCheckOpenGLContextThreadAffinity When making a context
248 current using QOpenGLContext, do not check that the
249 \l{QObject#Thread Affinity}{QObject thread affinity}
250 of the QOpenGLContext object is the same thread calling
251 \l{QOpenGLContext::makeCurrent}{makeCurrent()}.
252 This value was added in Qt 5.8.
253
254 \value AA_DisableShaderDiskCache Disables caching of shader program binaries
255 on disk. By default Qt Quick, QPainter's OpenGL backend, and any
256 application using QOpenGLShaderProgram with one of its
257 \e addCacheableShaderFromSource overloads will employ a disk-based
258 program binary cache in either the shared or per-process cache storage
259 location, on systems that support \e glProgramBinary(). In the unlikely
260 event of this being problematic, set this attribute to disable all
261 disk-based caching of shaders.
262
263 \value AA_DisableSessionManager Disables the QSessionManager.
264 By default Qt will connect to a running session manager for a GUI
265 application on supported platforms, use of a session manager may be
266 redundant for system services.
267 This attribute must be set before QGuiApplication is constructed.
268 This value was added in 5.14
269
270 \value AA_DisableNativeVirtualKeyboard When this attribute is set, the native
271 on-screen virtual keyboard will not be shown automatically when a
272 text input widget gains focus on a system without a physical keyboard.
273 Currently supported on the Windows platform only.
274 This value was added in 5.15
275
276 \value AA_DontUseNativeMenuWindows Menu popup windows (e.g. context menus,
277 combo box menus, and non-native menubar menus) created while this
278 attribute is set to true will not be represented as native top
279 level windows, unless required by the implementation.
280 This value was added in Qt 6.8.
281
282 \omitvalue AA_AttributeCount
283 \omitvalue AA_EnableHighDpiScaling
284 \omitvalue AA_UseHighDpiPixmaps
285 \omitvalue AA_DisableHighDpiScaling
286*/
287
288/*!
289 \enum Qt::MouseButton
290
291 This enum type describes the different mouse buttons.
292
293 \value NoButton The button state does not refer to any
294 button (see QMouseEvent::button()).
295
296 \value AllButtons This value corresponds to a mask of all
297 possible mouse buttons. Use to set the 'acceptedButtons'
298 property of a MouseArea to accept ALL mouse buttons.
299
300 \value LeftButton The left button is pressed, or an event refers
301 to the left button. (The left button may be the right button on
302 left-handed mice.)
303 \value RightButton The right button.
304 \value MiddleButton The middle button.
305
306 \value BackButton The 'Back' button. (Typically present on
307 the 'thumb' side of a mouse with extra buttons. This is NOT
308 the tilt wheel.)
309 \value XButton1 The 'Back' Button.
310 \value ExtraButton1 The 'Back' Button.
311
312 \value ForwardButton The 'Forward' Button. (Typically present
313 beside the 'Back' button, and also pressed by the thumb.)
314 \value XButton2 The 'Forward Button.
315 \value ExtraButton2 The 'Forward' Button.
316
317 \value TaskButton The 'Task' Button.
318 \value ExtraButton3 The 'Task' Button.
319
320 \value ExtraButton4 The 7th non-wheel Mouse Button.
321 \value ExtraButton5 The 8th non-wheel Mouse Button.
322 \value ExtraButton6 The 9th non-wheel Mouse Button.
323 \value ExtraButton7 The 10th non-wheel Mouse Button.
324 \value ExtraButton8 The 11th non-wheel Mouse Button.
325 \value ExtraButton9 The 12th non-wheel Mouse Button.
326 \value ExtraButton10 The 13th non-wheel Mouse Button.
327 \value ExtraButton11 The 14th non-wheel Mouse Button.
328 \value ExtraButton12 The 15th non-wheel Mouse Button.
329 \value ExtraButton13 The 16th non-wheel Mouse Button.
330 \value ExtraButton14 The 17th non-wheel Mouse Button.
331 \value ExtraButton15 The 18th non-wheel Mouse Button.
332 \value ExtraButton16 The 19th non-wheel Mouse Button.
333 \value ExtraButton17 The 20th non-wheel Mouse Button.
334 \value ExtraButton18 The 21st non-wheel Mouse Button.
335 \value ExtraButton19 The 22nd non-wheel Mouse Button.
336 \value ExtraButton20 The 23rd non-wheel Mouse Button.
337 \value ExtraButton21 The 24th non-wheel Mouse Button.
338 \value ExtraButton22 The 25th non-wheel Mouse Button.
339 \value ExtraButton23 The 26th non-wheel Mouse Button.
340 \value ExtraButton24 The 27th non-wheel Mouse Button.
341
342 \omitvalue MaxMouseButton
343 \omitvalue MouseButtonMask
344
345 \note Some models of multi-button mice are pre-configured with
346 high-numbered Buttons emulating keyboard sequences, for use in
347 specific games. In order for these Buttons to be seen as
348 actual 'Mouse Buttons', the device must be re-configured (using
349 the vendor's configuration tool).
350
351 \sa KeyboardModifier, Modifier
352*/
353
354/*!
355 \enum Qt::KeyboardModifier
356
357 This enum describes the modifier keys.
358
359 \value NoModifier No modifier key is pressed.
360 \value ShiftModifier A Shift key on the keyboard is pressed.
361 \value ControlModifier A Ctrl key on the keyboard is pressed.
362 \value AltModifier An Alt key on the keyboard is pressed.
363 \value MetaModifier A Meta key on the keyboard is pressed.
364 \value KeypadModifier A keypad button is pressed.
365 \value GroupSwitchModifier X11 only (unless activated on Windows by a command line argument).
366 A Mode_switch key on the keyboard is pressed.
367
368 \omitvalue KeyboardModifierMask
369
370 \note On \macos, the \c ControlModifier value corresponds to
371 the Command keys on the keyboard, and the \c MetaModifier value
372 corresponds to the Control keys. The \c KeypadModifier value will also be set
373 when an arrow key is pressed as the arrow keys are considered part of the
374 keypad.
375
376 \note On Windows Keyboards, Qt::MetaModifier and Qt::Key_Meta are mapped
377 to the Windows key.
378
379 \sa MouseButton, Modifier
380*/
381
382/*!
383 \enum Qt::Modifier
384
385 This enum provides shorter names for the keyboard modifier keys
386 supported by Qt.
387
388 \note On \macos, the \c CTRL value corresponds to
389 the Command keys on the keyboard, and the \c META value
390 corresponds to the Control keys.
391
392 \value SHIFT The Shift keys provided on all standard keyboards.
393 \value META The Meta keys.
394 \value CTRL The Ctrl keys.
395 \value ALT The normal Alt keys, but not keys like AltGr.
396 \omitvalue MODIFIER_MASK
397
398 \sa KeyboardModifier, MouseButton
399*/
400
401/*!
402 \enum Qt::GlobalColor
403
404 Qt's predefined QColor objects:
405
406 \value white \span {id="color-white"} {White (#ffffff) }
407 \value black \span {id="color-black"} {Black (#000000) }
408 \value red \span {id="color-red"} {Red (#ff0000) }
409 \value darkRed \span {id="color-darkRed"} {Dark red (#800000) }
410 \value green \span {id="color-green"} {Green (#00ff00) }
411 \value darkGreen \span {id="color-darkGreen"} {Dark green (#008000) }
412 \value blue \span {id="color-blue"} {Blue (#0000ff) }
413 \value darkBlue \span {id="color-darkBlue"} {Dark blue (#000080) }
414 \value cyan \span {id="color-cyan"} {Cyan (#00ffff) }
415 \value darkCyan \span {id="color-darkCyan"} {Dark cyan (#008080) }
416 \value magenta \span {id="color-magenta"} {Magenta (#ff00ff) }
417 \value darkMagenta \span {id="color-darkMagenta"} {Dark magenta (#800080) }
418 \value yellow \span {id="color-yellow"} {Yellow (#ffff00) }
419 \value darkYellow \span {id="color-darkYellow"} {Dark yellow (#808000) }
420 \value gray \span {id="color-gray"} {Gray (#a0a0a4) }
421 \value darkGray \span {id="color-darkGray"} {Dark gray (#808080) }
422 \value lightGray \span {id="color-lightGray"} {Light gray (#c0c0c0) }
423 \value transparent a transparent black value (i.e., QColor(0, 0, 0, 0))
424 \value color0 0 pixel value (for bitmaps)
425 \value color1 1 pixel value (for bitmaps)
426
427 \sa QColor
428
429*/
430
431/*!
432 \enum Qt::PenStyle
433
434 This enum type defines the pen styles that can be drawn using
435 QPainter. The styles are:
436
437 \table
438 \row
439 \li \inlineimage qpen-solid.png {Solid line}
440 \li \inlineimage qpen-dash.png {Dashed line}
441 \li \inlineimage qpen-dot.png {Dotted line}
442 \row
443 \li Qt::SolidLine
444 \li Qt::DashLine
445 \li Qt::DotLine
446 \row
447 \li \inlineimage qpen-dashdot.png {Dash-dot line}
448 \li \inlineimage qpen-dashdotdot.png {Dash-dot-dot line}
449 \li \inlineimage qpen-custom.png {Custom dash line}
450 \row
451 \li Qt::DashDotLine
452 \li Qt::DashDotDotLine
453 \li Qt::CustomDashLine
454 \endtable
455
456 \value NoPen no line at all. For example, QPainter::drawRect()
457 fills but does not draw any boundary line.
458
459 \value SolidLine A plain line.
460 \value DashLine Dashes separated by a few pixels.
461 \value DotLine Dots separated by a few pixels.
462 \value DashDotLine Alternate dots and dashes.
463 \value DashDotDotLine One dash, two dots, one dash, two dots.
464 \value CustomDashLine A custom pattern defined using
465 QPainterPathStroker::setDashPattern().
466
467 \omitvalue MPenStyle
468
469 \sa QPen
470*/
471
472/*!
473 \enum Qt::PenCapStyle
474
475 This enum type defines the pen cap styles supported by Qt, i.e.
476 the line end caps that can be drawn using QPainter.
477
478 \table
479 \row
480 \li \inlineimage qpen-square.png {Square cap extending past endpoint}
481 \li \inlineimage qpen-flat.png {Flat cap ending at endpoint}
482 \li \inlineimage qpen-roundcap.png {Rounded cap}
483 \row
484 \li Qt::SquareCap
485 \li Qt::FlatCap
486 \li Qt::RoundCap
487 \endtable
488
489 \value FlatCap a square line end that does not cover the end
490 point of the line.
491 \value SquareCap a square line end that covers the end point and
492 extends beyond it by half the line width.
493 \value RoundCap a rounded line end.
494 \omitvalue MPenCapStyle
495
496 \sa QPen
497*/
498
499/*!
500 \enum Qt::PenJoinStyle
501
502 This enum type defines the pen join styles supported by Qt, i.e.
503 which joins between two connected lines can be drawn using
504 QPainter.
505
506 \table
507 \row
508 \li \inlineimage qpen-bevel.png {Beveled corner join}
509 \li \inlineimage qpen-miter.png {Pointed miter join}
510 \li \inlineimage qpen-roundjoin.png {Rounded corner join}
511 \row
512 \li Qt::BevelJoin
513 \li Qt::MiterJoin
514 \li Qt::RoundJoin
515 \endtable
516
517 \value MiterJoin The outer edges of the lines are extended to
518 meet at an angle, and this area is filled.
519 \value BevelJoin The triangular notch between the two lines is filled.
520 \value RoundJoin A circular arc between the two lines is filled.
521 \value SvgMiterJoin A miter join corresponding to the definition of
522 a miter join in the \l{http://www.w3.org/TR/SVGMobile12/}{SVG 1.2 Tiny} specification.
523 \omitvalue MPenJoinStyle
524
525 \sa QPen
526*/
527
528/*!
529 \enum Qt::BrushStyle
530
531 This enum type defines the brush styles supported by Qt, i.e. the
532 fill pattern of shapes drawn using QPainter.
533
534 \image brush-styles.png Brush Styles
535
536 \value NoBrush No brush pattern.
537 \value SolidPattern Uniform color.
538 \value Dense1Pattern Extremely dense brush pattern.
539 \value Dense2Pattern Very dense brush pattern.
540 \value Dense3Pattern Somewhat dense brush pattern.
541 \value Dense4Pattern Half dense brush pattern.
542 \value Dense5Pattern Somewhat sparse brush pattern.
543 \value Dense6Pattern Very sparse brush pattern.
544 \value Dense7Pattern Extremely sparse brush pattern.
545 \value HorPattern Horizontal lines.
546 \value VerPattern Vertical lines.
547 \value CrossPattern Crossing horizontal and vertical lines.
548 \value BDiagPattern Backward diagonal lines.
549 \value FDiagPattern Forward diagonal lines.
550 \value DiagCrossPattern Crossing diagonal lines.
551 \value LinearGradientPattern Linear gradient (set using a dedicated QBrush constructor).
552 \value ConicalGradientPattern Conical gradient (set using a dedicated QBrush constructor).
553 \value RadialGradientPattern Radial gradient (set using a dedicated QBrush constructor).
554 \value TexturePattern Custom pattern (see QBrush::setTexture()).
555
556 \sa QBrush
557*/
558
559/*!
560 \enum Qt::TextFlag
561
562 This enum type is used to define some modifier flags. Some of
563 these flags only make sense in the context of printing:
564
565 \value TextSingleLine Treats all whitespace as spaces and prints just
566 one line.
567 \value TextDontClip If it's impossible to stay within the given bounds,
568 it prints outside.
569 \value TextExpandTabs Makes the U+0009 (ASCII tab) character move to
570 the next tab stop.
571 \value TextShowMnemonic Displays the string "\&P" as \underline{P}
572 For an ampersand, use "\&\&".
573 \value TextWordWrap Breaks lines at appropriate points, e.g. at word
574 boundaries.
575 \value TextWrapAnywhere Breaks lines anywhere, even within words.
576 \value TextHideMnemonic Same as Qt::TextShowMnemonic but doesn't draw
577 the underlines.
578 \value TextDontPrint Treat this text as "hidden" and don't print it.
579 \value TextIncludeTrailingSpaces When this option is set,
580 QTextLine::naturalTextWidth() and QTextLine::naturalTextRect() will
581 return a value that includes the width of trailing spaces in the
582 text; otherwise this width is excluded.
583 \value TextJustificationForced Ensures that text lines are justified.
584
585 \omitvalue TextLongestVariant
586 \omitvalue TextForceLeftToRight
587 \omitvalue TextForceRightToLeft
588
589 You can use as many modifier flags as you want, except that
590 Qt::TextSingleLine and Qt::TextWordWrap cannot be combined.
591
592 Flags that are inappropriate for a given use are generally
593 ignored.
594*/
595
596/*!
597 \enum Qt::BGMode
598
599 Background mode:
600
601 \value TransparentMode
602 \value OpaqueMode
603*/
604
605/*!
606 \enum Qt::ConnectionType
607
608 This enum describes the types of connection that can be used
609 between signals and slots. In particular, it determines whether a
610 particular signal is delivered to a slot immediately or queued for
611 delivery at a later time.
612
613 \value AutoConnection
614 \b (Default) If the receiver \l{QObject#Thread Affinity}{lives in} the
615 thread that emits the signal, Qt::DirectConnection is used. Otherwise,
616 Qt::QueuedConnection is used. The connection type is
617 determined when the signal is emitted.
618
619 \value DirectConnection
620 The slot is invoked immediately when the signal is
621 emitted. The slot is executed in the signalling thread.
622
623 \value QueuedConnection
624 The slot is invoked when control returns to the event loop
625 of the receiver's thread. The slot is executed in the
626 receiver's thread.
627
628 \value BlockingQueuedConnection
629 Same as Qt::QueuedConnection, except that the signalling thread blocks
630 until the slot returns. This connection must \e not be used if the
631 receiver lives in the signalling thread, or else the application
632 will deadlock.
633
634 \value UniqueConnection
635 This is a flag that can be combined with any one of the above
636 connection types, using a bitwise OR. When Qt::UniqueConnection is
637 set, QObject::connect() will fail if the connection already exists
638 (i.e. if the same signal is already connected to the same slot
639 for the same pair of objects).
640
641 \value SingleShotConnection
642 This is a flag that can be combined with any one of the above
643 connection types, using a bitwise OR. When Qt::SingleShotConnection
644 is set, the slot is going to be called only once; the connection
645 will be automatically broken when the signal is emitted.
646 This flag was introduced in Qt 6.0.
647
648 With queued connections, the parameters must be of types that are
649 known to Qt's meta-object system, because Qt needs to copy the
650 arguments to store them in an event behind the scenes. If you try
651 to use a queued connection and get the error message:
652
653 \snippet code/doc_src_qnamespace.qdoc 0
654
655 Call qRegisterMetaType() to register the data type before you
656 establish the connection.
657
658 When using signals and slots with multiple threads, see \l{Signals and Slots Across Threads}.
659
660 \sa {Multi-threading in Qt}, QObject::connect(), qRegisterMetaType(), Q_DECLARE_METATYPE()
661*/
662
663/*!
664 \enum Qt::DateFormat
665
666 \value TextDate The default Qt format, which includes the day and month
667 name, the day number in the month, and the year in full. The day and month
668 names will be short names in English (C locale). This effectively uses, for
669 a date, format \c{ddd MMM d yyyy}, for a time \c{HH:mm:ss} and combines
670 these as \c{ddd MMM d HH:mm:ss yyyy} for a date-time, with an optional
671 zone-offset suffix, where relevant. When reading from a string, a
672 fractional part is also recognized on the seconds of a time part, as
673 \c{HH:mm:ss.zzz}, and some minor variants on the format may be recognized,
674 for compatibility with earlier versions of Qt and with changes to the format
675 planned for the future. In particular, the zone-offset suffix presently uses
676 \c{GMT[±tzoff]} with a \c{tzoff} in \c{HH[[:]mm]} format (two-digit hour and
677 optional two-digit minutes, with optional colon separator); this shall
678 change to use \c{UTC} in place of \c{GMT} in a future release of Qt, so the
679 planned \c{UTC} format is recognized.
680
681 \value ISODateWithMs \l{ISO 8601} extended format: uses \c{yyyy-MM-dd} for
682 dates, \c{HH:mm:ss.zzz} for times or \c{yyyy-MM-ddTHH:mm:ss.zzz}
683 (e.g. 2017-07-24T15:46:29.739) for combined dates and times, optionally with
684 a time-zone suffix (Z for UTC otherwise an offset as ±HH:mm) where
685 appropriate. When parsed, a single space, \c{' '}, may be used in place of
686 the \c{'T'} separator between date and time; no other spacing characters are
687 permitted. This format also accepts \c{HH:mm} and plain \c{HH} formats for
688 the time part, either of which may include a fractional part, \c{HH:mm.zzz}
689 or \c{HH.zzz}, applied to the last field present (hour or minute).
690
691 \value ISODate \l{ISO 8601} extended format, as for \c ISODateWithMs, but
692 omitting the milliseconds (\c{.zzz}) part when converting to a string. There
693 is no difference when reading from a string: if a fractional part is present
694 on the last time field, either format will accept it.
695
696 \value RFC2822Date \l{RFC 2822}, \l{RFC 850} and \l{RFC 1036} format: when
697 converting dates to string form, format \c{dd MMM yyyy} is used, for times
698 the format is \c{HH:mm:ss}. For combined date and time, these are combined
699 as \c{dd MMM yyyy HH:mm:ss ±tzoff} (omitting the optional leading day of the
700 week from the first format recognized). When reading from a string either
701 \c{[ddd,] dd MMM yyyy [HH:mm[:ss]][ ±tzoff]} or \c{ddd MMM dd[ HH:mm:ss]
702 yyyy[ ±tzoff]} will be recognized for combined dates and times, where
703 \c{tzoff} is a timezone offset in \c{HHmm} format. Arbitrary spacing may
704 appear before or after the text and any non-empty spacing may replace the
705 spaces in this format. For dates and times separately, the same formats are
706 matched and the unwanted parts are ignored. In particular, note that a time
707 is not recognized without an accompanying date.
708
709 For \c ISODate formats, each \c y, \c M and \c d represents a single digit
710 of the year, month, and day used to specify the date. Each \c H, \c m, and
711 \c s represents a single digit of the hour (up to 24), minute and second
712 used to specify the time. An hour of 24, with zero for all other time
713 fields, is understood as the start of the next day. A \c{.zzz} stands for a
714 fractional part suffix on the preceding field, which may be separated from
715 that field either by a comma \c{','} or the dot \c{'.'} shown. Precision
716 beyond milliseconds is accepted but discarded, rounding to the nearest
717 representable millisecond. The presence of a literal \c T character is used
718 to separate the date and time when both are specified. For the \c TextDate
719 and \c RFC2822Date formats, \c{ddd} stands for the first three letters of
720 the name of the day of the week and \c{MMM} stands for the first three
721 letters of the month name. The names of days and months are always in
722 English (C locale) regardless of user preferences or system settings. The
723 other format characters have the same meaning as for the ISODate format,
724 except that 24 is not accepted as an hour. Parts of a format enclosed in
725 square brackets \c{[...]} are optional; the square brackets do not form part
726 of the format. The plus-or-minus character \c{'±'} here stands for either
727 sign character, \c{'-'} for minus or \c{'+'} for plus.
728
729 \note Zone offsets are measured positive to the east of Greenwich, negative
730 to the west, as is usual for UTC-based offset notations (conflicting with
731 some GMT-based zones-names, such as \c{Etc/GMT+3}, which use the opposite
732 convention).
733
734 \note Qt::ISODate: the parser is lenient about the date-field separators:
735 any punctuation character is accepted in place of the '-' that ISO 8601
736 requires, so "2024/01/02" and "2024.01.02" are also allowed.
737
738 \sa QDate::toString(), QTime::toString(), QDateTime::toString(),
739 QDate::fromString(), QTime::fromString(), QDateTime::fromString()
740*/
741
742/*!
743 \enum Qt::TimeSpec
744
745 \value LocalTime Local time, controlled by a system time-zone setting.
746 \value UTC Coordinated Universal Time.
747 \value OffsetFromUTC An offset in seconds from Coordinated Universal Time.
748 \value TimeZone A named time zone.
749
750 Both LocalTime and TimeZone will take care of transitions, such as
751 the start and end of daylight-saving time. UTC is the standard
752 time relative to which time-zones are usually specified: Greenwich
753 Mean Time has zero offset from it. Neither UTC nor OffsetFromUTC
754 has any transitions.
755
756 When specifying a datetime using OffsetFromUTC, the offset from UTC must
757 also be supplied (it is measured in seconds). To specify a datetime using
758 TimeZone, a QTimeZone must be supplied. From Qt 6.5, a QTimeZone can now
759 package a timespec with, where needed, an offset as a lightweight time
760 description, so that passing a QTimeZone now provides a uniform way to use
761 datetime APIs, saving the need to call them differently for different
762 timespecs.
763
764 \note After a change to the system time-zone setting, the behavior
765 of LocalTime-based QDateTime objects created before the change is
766 undefined: QDateTime may have cached data that the change
767 invalidates. (This is not triggered by \e transitions of the system
768 time-zone.) In long-running processes, updates to the system's
769 time-zone data (e.g. when politicians change the rules for a zone)
770 may likewise lead to conflicts between the updated time-zone
771 information and data cached by QDateTime objects created before
772 the update, using either LocalTime or TimeZone.
773
774 \sa QTimeZone, QDateTime
775*/
776
777/*!
778 \enum Qt::DayOfWeek
779
780 \value Monday
781 \value Tuesday
782 \value Wednesday
783 \value Thursday
784 \value Friday
785 \value Saturday
786 \value Sunday
787*/
788
789/*!
790 \enum Qt::CaseSensitivity
791
792 \value CaseInsensitive
793 \value CaseSensitive
794*/
795
796/*!
797 \enum Qt::ToolBarArea
798
799 Represents the areas a QToolBar can be placed in.
800
801 \value LeftToolBarArea The left toolbar area of a QMainWindow.
802 \value RightToolBarArea The right toolbar area of a QMainWindow.
803 \value TopToolBarArea The top toolbar area of a QMainWindow.
804 \value BottomToolBarArea The bottom toolbar area of a QMainWindow.
805 \value AllToolBarAreas All toolbar areas. This is the default value of
806 QToolBar::allowedAreas.
807 \value NoToolBarArea No toolbar area.
808
809 \omitvalue ToolBarArea_Mask
810 \sa QToolBar::setAllowedAreas, QToolBar::isAreaAllowed
811*/
812
813/*!
814 \enum Qt::DockWidgetArea
815
816 Represents the areas a QDockWidget can be plugged to.
817 \note A floating dock widget with tabs can be docked anywhere.
818
819 \value LeftDockWidgetArea The left dock area of a QMainWindow.
820 \value RightDockWidgetArea The right dock area of a QMainWindow.
821 \value TopDockWidgetArea The top dock area of a QMainWindow.
822 \value BottomDockWidgetArea The bottom dock area of a QMainWindow.
823 \value AllDockWidgetAreas All dock widget areas. This is the default
824 value of QDockWidget::allowedAreas.
825 \value NoDockWidgetArea No dock widget areas.
826
827 \omitvalue DockWidgetArea_Mask
828 \sa QDockWidget::setAllowedAreas, QDockWidget::isAreaAllowed
829*/
830
831/*!
832 \enum Qt::ColorScheme
833
834 Represents the appearance of an application's theme,
835 defined by QGuiApplication::palette().
836
837 \value Unknown The appearance is unknown.
838 \value Light The background colors are lighter than the text color, i.e. the theme is light.
839 \value Dark The background colors are darker than the text color, i.e. the theme is dark.
840*/
841
842/*!
843 \enum Qt::ContrastPreference
844 \since 6.10
845
846 Represents the user's preferred contrast setting.
847 Styles can honor this setting by increasing the contrast of foreground and background colors,
848 as well as giving widgets and controls thicker borders.
849
850 \value NoPreference No specific preferences.
851 \value HighContrast The user prefers the application to be in high contrast.
852*/
853
854/*!
855 \enum Qt::MotionPreference
856 \since 6.12
857
858 Represents the user's preferred setting for animations and motions.
859 Controls, styles and applications can honor this setting by limiting the amount of animations depending
860 on the enum value.
861
862 \value NoPreference No specific preferences.
863 \value ReducedMotion The user prefers fewer animations in their UI.
864*/
865
866/*!
867 \enum Qt::ImageConversionFlag
868
869 The options marked "(default)" are set if no other values from
870 the list are included (since the defaults are zero):
871
872 Color/Mono preference (ignored for QBitmap):
873
874 \value AutoColor (default) - If the image has \l{QImage::depth()}{depth} 1 and contains only
875 black and white pixels, the pixmap becomes monochrome.
876 \value ColorOnly The pixmap is dithered/converted to the
877 \l{QPixmap::defaultDepth()}{native display depth}.
878 \value MonoOnly The pixmap becomes monochrome. If necessary,
879 it is dithered using the chosen dithering algorithm.
880
881 Dithering mode preference:
882
883 \value DiffuseDither (default) - A high-quality dither using error diffusion.
884 \value OrderedDither A faster, ordered dither.
885 \value ThresholdDither No dithering; closest color is used.
886
887 Dithering mode preference for 1-bit alpha masks:
888
889 \value ThresholdAlphaDither (default) - No dithering.
890 \value OrderedAlphaDither A faster, ordered dither.
891 \value DiffuseAlphaDither A high-quality dither using error diffusion.
892 \omitvalue NoAlpha
893
894 Color matching versus dithering preference:
895
896 \value PreferDither Always dither images when converting to smaller color-spaces.
897 \value AvoidDither Only dither to indexed formats if the source image uses more
898 different colors than the size of the color table of the destination format.
899 \value AutoDither (default) - Only dither when down-converting to 1 or 8-bit indexed formats.
900
901 \value NoOpaqueDetection Do not check whether the image contains non-opaque
902 pixels. Use this if you know that the image is semi-transparent and
903 you want to avoid the overhead of checking the pixels in the image
904 until a non-opaque pixel is found, or if you want the pixmap to
905 retain an alpha channel for some other reason. If the image has no
906 alpha channel this flag has no effect.
907
908 \value NoFormatConversion Don't do any format conversions on the image.
909 Can be useful when converting a QImage to a QPixmap for a one-time
910 rendering operation for example. Note that a QPixmap not in the
911 preferred format will be much slower as a paint device.
912
913 \omitvalue ColorMode_Mask
914 \omitvalue Dither_Mask
915 \omitvalue AlphaDither_Mask
916 \omitvalue DitherMode_Mask
917*/
918
919/*!
920 \enum Qt::UIEffect
921
922 This enum describes the available UI effects.
923
924 By default, Qt will try to use the platform specific desktop
925 settings for each effect. Use the
926 QApplication::setDesktopSettingsAware() function (passing \c false
927 as argument) to prevent this, and the
928 QApplication::setEffectEnabled() to enable or disable a particular
929 effect.
930
931 Note that all effects are disabled on screens running at less than
932 16-bit color depth.
933
934 \omitvalue UI_General
935
936 \value UI_AnimateMenu Show animated menus.
937 \value UI_FadeMenu Show faded menus.
938 \value UI_AnimateCombo Show animated comboboxes.
939 \value UI_AnimateTooltip Show tooltip animations.
940 \value UI_FadeTooltip Show tooltip fading effects.
941 \value UI_AnimateToolBox Reserved
942
943 \sa QApplication::setEffectEnabled(), QGuiApplication::setDesktopSettingsAware()
944*/
945
946/*! \enum Qt::AspectRatioMode
947
948 This enum type defines what happens to the aspect ratio when
949 scaling an rectangle.
950
951 \image qimage-scaling.png {Illustration showing three different
952 ways to scale images with Aspect Ratio Mode}
953
954 \value IgnoreAspectRatio The size is scaled freely. The aspect
955 ratio is not preserved.
956 \value KeepAspectRatio The size is scaled to a rectangle as
957 large as possible inside a given
958 rectangle, preserving the aspect ratio.
959 \value KeepAspectRatioByExpanding The size is scaled to a
960 rectangle as small as possible
961 outside a given rectangle,
962 preserving the aspect ratio.
963
964 \sa QSize::scale(), QImage::scaled()
965*/
966
967/*! \enum Qt::TransformationMode
968
969 This enum type defines whether image transformations (e.g.,
970 scaling) should be smooth or not.
971
972 \value FastTransformation The transformation is performed
973 quickly, with no smoothing.
974 \value SmoothTransformation The resulting image is transformed
975 using bilinear filtering.
976
977 \sa QImage::scaled()
978*/
979
980/*! \enum Qt::Axis
981
982 This enum type defines three values to represent the three
983 axes in the cartesian coordinate system.
984
985 \value XAxis The X axis.
986 \value YAxis The Y axis.
987 \value ZAxis The Z axis.
988
989 \sa QTransform::rotate(), QTransform::rotateRadians()
990 */
991
992/*!
993 \enum Qt::WidgetAttribute
994
995 \keyword widget attributes
996
997 This enum type is used to specify various widget attributes.
998 Attributes are set and cleared with QWidget::setAttribute(), and
999 queried with QWidget::testAttribute(), although some have special
1000 convenience functions which are mentioned below.
1001
1002 \value WA_AcceptDrops Allows data from drag and drop operations
1003 to be dropped onto the widget (see QWidget::setAcceptDrops()).
1004
1005 \value WA_AlwaysShowToolTips Enables tooltips for inactive windows.
1006
1007 \value WA_CustomWhatsThis Indicates that the widget wants to
1008 continue operating normally in "What's This?" mode. This is set by the
1009 widget's author.
1010
1011 \value WA_DeleteOnClose Makes Qt delete this widget when the
1012 widget has accepted the close event (see QWidget::closeEvent()).
1013
1014 \value WA_Disabled Indicates that the widget is disabled, i.e.
1015 it does not receive any mouse or keyboard events. There is also a
1016 getter functions QWidget::isEnabled(). This is set/cleared by the
1017 Qt kernel.
1018
1019 \value WA_DontShowOnScreen Indicates that the widget is hidden or is
1020 not a part of the viewable Desktop.
1021
1022 \value WA_ForceDisabled Indicates that the widget is
1023 explicitly disabled, i.e. it will remain disabled even when all
1024 its ancestors are set to the enabled state. This implies
1025 WA_Disabled. This is set/cleared by QWidget::setEnabled() and
1026 QWidget::setDisabled().
1027
1028 \value WA_ForceUpdatesDisabled Indicates that updates are
1029 explicitly disabled for the widget; i.e. it will remain disabled
1030 even when all its ancestors are set to the updates-enabled state.
1031 This implies WA_UpdatesDisabled. This is set/cleared by
1032 QWidget::setUpdatesEnabled().
1033
1034 \value WA_Hover Forces Qt to generate paint events when the mouse
1035 enters or leaves the widget. This feature is typically used when
1036 implementing custom styles.
1037
1038 \value WA_InputMethodEnabled Enables input methods for Asian languages.
1039 Must be set when creating custom text editing widgets.
1040
1041 \value WA_KeyboardFocusChange Set on a toplevel window when
1042 the users changes focus with the keyboard (tab, backtab, or shortcut).
1043
1044 \value WA_KeyCompression Enables key event compression if set,
1045 and disables it if not set. By default key compression is off, so
1046 widgets receive one key press event for each key press (or more,
1047 since autorepeat is usually on). If you turn it on and your
1048 program doesn't keep up with key input, Qt may try to compress key
1049 events so that more than one character can be processed in each
1050 event.
1051 For example, a word processor widget might receive 2, 3 or more
1052 characters in each QKeyEvent::text(), if the layout recalculation
1053 takes too long for the CPU.
1054 If a widget supports multiple character unicode input, it is
1055 always safe to turn the compression on.
1056 Qt performs key event compression only for printable characters.
1057 Qt::Modifier keys, cursor movement keys, function keys and
1058 miscellaneous action keys (e.g. Escape, Enter, Backspace,
1059 PrintScreen) will stop key event compression, even if there are
1060 more compressible key events available.
1061 Platforms other than Mac and X11 do not support this compression,
1062 in which case turning it on will have no effect.
1063 This is set/cleared by the widget's author.
1064
1065 \value WA_LayoutOnEntireRect Indicates that the widget
1066 wants QLayout to operate on the entire QWidget::rect(), not only
1067 on QWidget::contentsRect(). This is set by the widget's author.
1068
1069 \value WA_LayoutUsesWidgetRect Ignore the layout item rect from the style
1070 when laying out this widget with QLayout.
1071
1072 \value WA_MacOpaqueSizeGrip Indicates that the native size grip
1073 should be opaque instead of transparent (the default). This attribute
1074 is only applicable to \macos and is set by the widget's author.
1075
1076 \value WA_MacShowFocusRect Indicates that this widget should get a
1077 QFocusFrame around it. Some widgets draw their own focus halo
1078 regardless of this attribute. Not that the QWidget::focusPolicy
1079 also plays the main role in whether something is given focus or
1080 not, this only controls whether or not this gets the focus
1081 frame. This attribute is only applicable to \macos.
1082
1083 \value WA_MacNormalSize Indicates the widget should have the
1084 normal size for widgets in \macos. This attribute is only
1085 applicable to \macos.
1086
1087 \value WA_MacSmallSize Indicates the widget should have the small
1088 size for widgets in \macos. This attribute is only applicable to
1089 \macos.
1090
1091 \value WA_MacMiniSize Indicates the widget should have the mini
1092 size for widgets in \macos. This attribute is only applicable to
1093 \macos.
1094
1095 \value WA_Mapped Indicates that the widget is mapped on screen.
1096 This is set/cleared by the Qt kernel.
1097
1098 \value WA_MouseNoMask Makes the widget receive mouse events for
1099 the entire widget regardless of the currently set mask,
1100 overriding QWidget::setMask(). This is not applicable for
1101 top-level windows.
1102
1103 \value WA_MouseTracking Indicates that the widget has mouse
1104 tracking enabled. See QWidget::mouseTracking.
1105
1106 \value WA_Moved Indicates that the widget has an explicit
1107 position. This is set/cleared by QWidget::move() and
1108 by QWidget::setGeometry().
1109
1110 \value WA_NoChildEventsForParent Indicates that the widget does
1111 not want \l{QEvent::}{ChildAdded} or \l{QEvent::}{ChildRemoved} events sent to its
1112 parent. This is rarely necessary but can help to avoid automatic
1113 insertion widgets like splitters and layouts. This is set by a
1114 widget's author.
1115
1116 \value WA_NoChildEventsFromChildren Indicates that the widget does
1117 not want to receive \l{QEvent::}{ChildAdded} or \l{QEvent::}{ChildRemoved} events sent from its
1118 children. This is set by a widget's author.
1119
1120 \value WA_NoMouseReplay Used for pop-up widgets. Indicates that the most
1121 recent mouse press event should not be replayed when the pop-up widget
1122 closes. The flag is set by the widget's author and cleared by the Qt kernel
1123 every time the widget receives a new mouse event.
1124
1125 \value WA_NoMousePropagation Prohibits mouse events from being propagated
1126 to the widget's parent. This attribute is disabled by default.
1127
1128 \value WA_TransparentForMouseEvents When enabled, this attribute disables
1129 the delivery of mouse events to the widget and its children. Mouse events
1130 are delivered to other widgets as if the widget and its children were not
1131 present in the widget hierarchy; mouse clicks and other events effectively
1132 "pass through" them. This attribute is disabled by default.
1133
1134 \value WA_NoSystemBackground Indicates that the widget has no background,
1135 i.e. when the widget receives paint events, the background is not
1136 automatically repainted. \b Note: Unlike WA_OpaquePaintEvent, newly exposed
1137 areas are \b never filled with the background (e.g., after showing a
1138 window for the first time the user can see "through" it until the
1139 application processes the paint events). This flag is set or cleared by the
1140 widget's author.
1141
1142 \value WA_OpaquePaintEvent Indicates that the widget paints all its pixels
1143 when it receives a paint event. Thus, it is not required for operations
1144 like updating, resizing, scrolling and focus changes to erase the widget
1145 before generating paint events. The use of WA_OpaquePaintEvent provides a
1146 small optimization by helping to reduce flicker on systems that do not
1147 support double buffering and avoiding computational cycles necessary to
1148 erase the background prior to painting. \b Note: Unlike
1149 WA_NoSystemBackground, WA_OpaquePaintEvent makes an effort to avoid
1150 transparent window backgrounds. This flag is set or cleared by the widget's
1151 author.
1152
1153 \value WA_OutsideWSRange Indicates that the widget is outside
1154 the valid range of the window system's coordinate system. A widget
1155 outside the valid range cannot be mapped on screen. This is
1156 set/cleared by the Qt kernel.
1157
1158 \value WA_PaintOnScreen Indicates that the widget wants to draw directly
1159 onto the screen. Widgets with this attribute set do not participate in
1160 composition management, i.e. they cannot be semi-transparent or shine
1161 through semi-transparent overlapping widgets. \b Note: This flag is only
1162 supported on X11 and it disables double buffering. On Qt for Embedded
1163 Linux, the flag only works when set on a top-level widget and it relies on
1164 support from the active screen driver. This flag is set or cleared by the
1165 widget's author. To render outside of Qt's paint system, e.g., if you
1166 require native painting primitives, you need to reimplement
1167 QWidget::paintEngine() to return 0 and set this flag.
1168
1169 \value WA_PaintUnclipped Makes all painters operating on this widget
1170 unclipped. Children of this widget or other widgets in front of it do not
1171 clip the area the painter can paint on. This flag is only supported for
1172 widgets with the WA_PaintOnScreen flag set. The preferred way to do this in
1173 a cross platform way is to create a transparent widget that lies in front
1174 of the other widgets.
1175
1176 \value WA_PendingMoveEvent Indicates that a move event is pending, e.g.,
1177 when a hidden widget was moved. This flag is set or cleared by the Qt
1178 kernel.
1179
1180 \value WA_PendingResizeEvent Indicates that a resize event is pending,
1181 e.g., when a hidden widget was resized. This flag is set or cleared by the
1182 Qt kernel.
1183
1184 \value WA_QuitOnClose Indicates that the widget should be taken into account
1185 when deciding whether to quit the application when the last window is closed.
1186 This behavior can be modified with the QGuiApplication::quitOnLastWindowClosed
1187 property. By default this attribute is set for all widgets of type Qt::Window.
1188
1189 \value WA_Resized Indicates that the widget has an explicit size. This flag
1190 is set or cleared by QWidget::resize() and QWidget::setGeometry().
1191
1192 \value WA_RightToLeft Indicates that the layout direction for the widget
1193 is right to left.
1194
1195 \value WA_SetCursor Indicates that the widget has a cursor of its own. This
1196 flag is set or cleared by QWidget::setCursor() and QWidget::unsetCursor().
1197
1198 \value WA_SetFont Indicates that the widget has a font of its own. This
1199 flag is set or cleared by QWidget::setFont().
1200
1201 \value WA_SetPalette Indicates that the widget has a palette of its own.
1202 This flag is set or cleared by QWidget::setPalette().
1203
1204 \value WA_SetStyle Indicates that the widget has a style of its own. This
1205 flag is set or cleared by QWidget::setStyle().
1206
1207 \value WA_ShowModal \e{This attribute has been deprecated.} Use
1208 QWidget::windowModality instead.
1209
1210 \value WA_StaticContents Indicates that the widget contents are north-west
1211 aligned and static. On resize, such a widget will receive paint events only
1212 for parts of itself that are newly visible. This flag is set or cleared by
1213 the widget's author.
1214
1215 \value WA_StyleSheet Indicates that the widget is styled using a
1216 \l{Qt Style Sheets}{style sheet}. WA_StyleSheet is set whenever a widget
1217 is subject to a style sheet, even if the style sheet did not affect the
1218 widget appearance.
1219
1220 \value WA_StyleSheetTarget Indicates that the widget appearance was modified
1221 by a \l{Qt Style Sheets}{style sheet}. WA_StyleSheet will also be set.
1222 This value was introduced in Qt 5.12.
1223
1224 \value WA_TabletTracking Indicates that the widget has tablet
1225 tracking enabled. See QWidget::tabletTracking.
1226
1227 \value WA_TranslucentBackground Indicates that the widget should have a
1228 translucent background, i.e., any non-opaque regions of the widgets will be
1229 translucent because the widget will have an alpha channel. Setting this
1230 flag causes WA_NoSystemBackground to be set. On Windows the widget also
1231 needs the Qt::FramelessWindowHint window flag to be set. This flag is set
1232 or cleared by the widget's author. As of Qt 5.0, toggling this attribute
1233 after the widget has been shown is not uniformly supported across
1234 platforms. When translucent background is desired, set the attribute early
1235 when creating the widget, and avoid altering it afterwards.
1236
1237 \value WA_UnderMouse Indicates that the widget is under the mouse cursor.
1238 The value is not updated correctly during drag and drop operations. There
1239 is also a getter function, QWidget::underMouse(). This flag is set or
1240 cleared by the Qt kernel.
1241
1242 \value WA_UpdatesDisabled Indicates that updates are blocked (including the
1243 system background). This flag is set or cleared by the Qt kernel.
1244 \b Warning: This flag must \e never be set or cleared by the widget's author.
1245
1246 \value WA_WindowModified Indicates that the window is marked as modified.
1247 On some platforms this flag will do nothing, on others (including \macos
1248 and Windows) the window will take a modified appearance. This flag is set
1249 or cleared by QWidget::setWindowModified().
1250
1251 \value WA_WindowPropagation Makes a toplevel window inherit font, palette
1252 and locale from its parent.
1253
1254 \value WA_MacAlwaysShowToolWindow On \macos, show the tool window even
1255 when the application is not active. By default, all tool windows are
1256 hidden when the application is inactive.
1257
1258 \value WA_SetLocale Indicates the locale should be taken into consideration
1259 in the widget.
1260
1261 \value WA_StyledBackground Indicates the widget should be drawn using a
1262 styled background.
1263
1264 \value WA_ShowWithoutActivating Show the widget without making it active.
1265
1266 \value WA_NativeWindow Indicates that a native window is created for the
1267 widget. Enabling this flag will also force a native window for the widget's
1268 ancestors unless Qt::WA_DontCreateNativeAncestors is set.
1269
1270 \value WA_DontCreateNativeAncestors Indicates that the widget's ancestors
1271 are kept non-native even though the widget itself is native.
1272
1273 \value WA_X11NetWmWindowTypeDesktop Adds _NET_WM_WINDOW_TYPE_DESKTOP to the
1274 window's _NET_WM_WINDOW_TYPE X11 window property. See
1275 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1276 has no effect on non-X11 platforms.
1277
1278 \value WA_X11NetWmWindowTypeDock Adds _NET_WM_WINDOW_TYPE_DOCK to the
1279 window's _NET_WM_WINDOW_TYPE X11 window property. See
1280 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1281 has no effect on non-X11 platforms.
1282
1283 \value WA_X11NetWmWindowTypeToolBar Adds _NET_WM_WINDOW_TYPE_TOOLBAR to the
1284 window's _NET_WM_WINDOW_TYPE X11 window property. See
1285 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1286 has no effect on non-X11 platforms. \b Note: Qt automatically sets this
1287 attribute for QToolBar.
1288
1289 \value WA_X11NetWmWindowTypeMenu Adds _NET_WM_WINDOW_TYPE_MENU to the
1290 window's _NET_WM_WINDOW_TYPE X11 window property. See
1291 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1292 has no effect on non-X11 platforms. \b Note: Qt automatically sets this
1293 attribute for QMenu when torn-off.
1294
1295 \value WA_X11NetWmWindowTypeUtility Adds _NET_WM_WINDOW_TYPE_UTILITY to the
1296 window's _NET_WM_WINDOW_TYPE X11 window property. See
1297 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1298 has no effect on non-X11 platforms. \b Note: Qt automatically sets this
1299 attribute for the Qt::Tool window type.
1300
1301 \value WA_X11NetWmWindowTypeSplash Adds _NET_WM_WINDOW_TYPE_SPLASH to the
1302 window's _NET_WM_WINDOW_TYPE X11 window property. See
1303 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1304 has no effect on non-X11 platforms. \b Note: Qt automatically sets this
1305 attribute for the Qt::SplashScreen window type.
1306
1307 \value WA_X11NetWmWindowTypeDialog Adds _NET_WM_WINDOW_TYPE_DIALOG
1308 to the window's _NET_WM_WINDOW_TYPE X11 window property. See
1309 http://standards.freedesktop.org/wm-spec/ for more details. This
1310 attribute has no effect on non-X11 platforms. \b Note: Qt automatically sets
1311 this attribute for the Qt::Dialog and Qt::Sheet window types.
1312
1313 \value WA_X11NetWmWindowTypeDropDownMenu Adds
1314 _NET_WM_WINDOW_TYPE_DROPDOWN_MENU to the window's
1315 _NET_WM_WINDOW_TYPE X11 window property. See
1316 http://standards.freedesktop.org/wm-spec/ for more details. This
1317 attribute has no effect on non-X11 platforms. \b Note: Qt
1318 automatically sets this attribute for QMenu objects added to a QMenuBar.
1319
1320 \value WA_X11NetWmWindowTypePopupMenu Adds _NET_WM_WINDOW_TYPE_POPUP_MENU
1321 to the window's _NET_WM_WINDOW_TYPE X11 window property. See
1322 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1323 has no effect on non-X11 platforms. \b Note: Qt automatically sets this
1324 attribute for QMenu.
1325
1326 \value WA_X11NetWmWindowTypeToolTip Adds _NET_WM_WINDOW_TYPE_TOOLTIP to the
1327 window's _NET_WM_WINDOW_TYPE X11 window property. See
1328 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1329 has no effect on non-X11 platforms. \b Note: Qt automatically sets this
1330 attribute for the Qt::ToolTip window type.
1331
1332 \value WA_X11NetWmWindowTypeNotification Adds
1333 _NET_WM_WINDOW_TYPE_NOTIFICATION to the window's _NET_WM_WINDOW_TYPE X11
1334 window property. See http://standards.freedesktop.org/wm-spec/ for more
1335 details. This attribute has no effect on non-X11 platforms.
1336
1337 \value WA_X11NetWmWindowTypeCombo Adds _NET_WM_WINDOW_TYPE_COMBO
1338 to the window's _NET_WM_WINDOW_TYPE X11 window property. See
1339 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1340 has no effect on non-X11 platforms. \b Note: Qt automatically sets this
1341 attribute for the QComboBox pop-up.
1342
1343 \value WA_X11NetWmWindowTypeDND Adds _NET_WM_WINDOW_TYPE_DND to
1344 the window's _NET_WM_WINDOW_TYPE X11 window property. See
1345 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1346 has no effect on non-X11 platforms. \b Note: Qt automatically sets this
1347 attribute on the feedback widget used during a drag.
1348
1349 \value WA_AcceptTouchEvents Allows touch events (see QTouchEvent)
1350 to be sent to the widget. Must be set on all widgets that can
1351 handle touch events. Without this attribute set, events from a
1352 touch device will be sent as mouse events.
1353
1354 \value WA_TouchPadAcceptSingleTouchEvents Allows touchpad single
1355 touch events to be sent to the widget.
1356
1357 \value WA_X11DoNotAcceptFocus Asks the window manager to not give focus
1358 to this top level window. This attribute has no effect on non-X11
1359 platforms.
1360
1361 \value [since 5.4] WA_AlwaysStackOnTop Forces QOpenGLWidget and
1362 QQuickWidget to be drawn last, on top of other widgets. Ignored for other
1363 type of widgets. Setting this attribute breaks the stacking order, but
1364 allows having a semi-transparent OpenGL widget with other widgets visible
1365 underneath. It is strongly recommended to call \l{QWidget::}{update()} on the widget's
1366 top-level window after enabling or disabling this attribute.
1367
1368 \value WA_ContentsMarginsRespectsSafeArea A QWidget respects the safe
1369 area margins of a window by incorporating the margins into its contents'
1370 margins by default. This means, that a QLayout will use the content area
1371 of a widget for its layout, unless the Qt::WA_LayoutOnEntireRect attribute
1372 is set. This along with a contents margin of 0 can be used on the actual
1373 layout, to allow for example a background image to underlay the status bar and other
1374 system areas on an iOS device, while still allowing child widgets of
1375 that background to be inset based on the safe area.
1376
1377 \omitvalue WA_LaidOut
1378 \omitvalue WA_WState_Visible
1379 \omitvalue WA_WState_Hidden
1380 \omitvalue WA_PendingUpdate
1381 \omitvalue WA_InvalidSize
1382 \omitvalue WA_GrabbedShortcut
1383 \omitvalue WA_SetWindowIcon
1384 \omitvalue WA_SetLayoutDirection
1385 \omitvalue WA_ForceUpdatesDisabled
1386 \omitvalue WA_WState_Created
1387 \omitvalue WA_WState_CompressKeys
1388 \omitvalue WA_WState_InPaintEvent
1389 \omitvalue WA_WState_Reparented
1390 \omitvalue WA_WState_ConfigPending
1391 \omitvalue WA_WState_Polished
1392 \omitvalue WA_WState_OwnSizePolicy
1393 \omitvalue WA_WState_ExplicitShowHide
1394 \omitvalue WA_InputMethodTransparent
1395 \omitvalue WA_DropSiteRegistered
1396 \omitvalue WA_NoX11EventCompression
1397 \omitvalue WA_TintedBackground
1398 \omitvalue WA_X11OpenGLOverlay
1399 \omitvalue WA_CanHostQMdiSubWindowTitleBar
1400 \omitvalue WA_X11BypassTransientForHint
1401 \omitvalue WA_DontShowOnScreen
1402 \omitvalue WA_SetWindowModality
1403 \omitvalue WA_WState_WindowOpacitySet
1404 \omitvalue WA_WState_AcceptedTouchBeginEvent
1405 \omitvalue WA_StyleSheet
1406 \omitvalue WA_AttributeCount
1407*/
1408
1409/*! \typedef Qt::HANDLE
1410
1411 A handle type for system objects, defined as \c{void *}
1412 on all platforms.
1413*/
1414
1415/*!
1416 \enum Qt::Key
1417
1418 The key names used by Qt.
1419
1420 \value Key_Escape
1421 \value Key_Tab
1422 \value Key_Backtab
1423 \value Key_Backspace
1424 \value Key_Return
1425 \value Key_Enter Typically located on the keypad.
1426 \value Key_Insert
1427 \value Key_Delete
1428 \value Key_Pause The Pause/Break key (\b Note: Not related to pausing media)
1429 \value Key_Print
1430 \value Key_SysReq
1431 \value Key_Clear Corresponds to the \b Clear key on selected Apple
1432 keyboard models. On other systems it is commonly mapped
1433 to the numeric keypad key \b 5, when \b {Num Lock} is
1434 \c off.
1435 \value Key_Home
1436 \value Key_End
1437 \value Key_Left
1438 \value Key_Up
1439 \value Key_Right
1440 \value Key_Down
1441 \value Key_PageUp
1442 \value Key_PageDown
1443 \value Key_Shift
1444 \value Key_Control On \macos, this corresponds to the Command keys.
1445 \value Key_Meta On \macos, this corresponds to the Control keys.
1446 On Windows keyboards, this key is mapped to the
1447 Windows key.
1448 \value Key_Alt
1449 \value Key_AltGr On Windows, when the \c KeyDown event for this key is
1450 sent, the Ctrl+Alt modifiers are also set.
1451 \value Key_CapsLock
1452 \value Key_NumLock
1453 \value Key_ScrollLock
1454 \value Key_F1
1455 \value Key_F2
1456 \value Key_F3
1457 \value Key_F4
1458 \value Key_F5
1459 \value Key_F6
1460 \value Key_F7
1461 \value Key_F8
1462 \value Key_F9
1463 \value Key_F10
1464 \value Key_F11
1465 \value Key_F12
1466 \value Key_F13
1467 \value Key_F14
1468 \value Key_F15
1469 \value Key_F16
1470 \value Key_F17
1471 \value Key_F18
1472 \value Key_F19
1473 \value Key_F20
1474 \value Key_F21
1475 \value Key_F22
1476 \value Key_F23
1477 \value Key_F24
1478 \value Key_F25
1479 \value Key_F26
1480 \value Key_F27
1481 \value Key_F28
1482 \value Key_F29
1483 \value Key_F30
1484 \value Key_F31
1485 \value Key_F32
1486 \value Key_F33
1487 \value Key_F34
1488 \value Key_F35
1489 \value Key_Super_L
1490 \value Key_Super_R
1491 \value Key_Menu
1492 \value Key_Hyper_L
1493 \value Key_Hyper_R
1494 \value Key_Help
1495 \value Key_Direction_L
1496 \value Key_Direction_R
1497
1498 \value Key_Space
1499 \value Key_Any
1500 \value Key_Exclam
1501 \value Key_QuoteDbl
1502 \value Key_NumberSign
1503 \value Key_Dollar
1504 \value Key_Percent
1505 \value Key_Ampersand
1506 \value Key_Apostrophe
1507 \value Key_ParenLeft
1508 \value Key_ParenRight
1509 \value Key_Asterisk
1510 \value Key_Plus
1511 \value Key_Comma
1512 \value Key_Minus
1513 \value Key_Period
1514 \value Key_Slash
1515 \value Key_0
1516 \value Key_1
1517 \value Key_2
1518 \value Key_3
1519 \value Key_4
1520 \value Key_5
1521 \value Key_6
1522 \value Key_7
1523 \value Key_8
1524 \value Key_9
1525 \value Key_Colon
1526 \value Key_Semicolon
1527 \value Key_Less
1528 \value Key_Equal
1529 \value Key_Greater
1530 \value Key_Question
1531 \value Key_At
1532 \value Key_A
1533 \value Key_B
1534 \value Key_C
1535 \value Key_D
1536 \value Key_E
1537 \value Key_F
1538 \value Key_G
1539 \value Key_H
1540 \value Key_I
1541 \value Key_J
1542 \value Key_K
1543 \value Key_L
1544 \value Key_M
1545 \value Key_N
1546 \value Key_O
1547 \value Key_P
1548 \value Key_Q
1549 \value Key_R
1550 \value Key_S
1551 \value Key_T
1552 \value Key_U
1553 \value Key_V
1554 \value Key_W
1555 \value Key_X
1556 \value Key_Y
1557 \value Key_Z
1558 \value Key_BracketLeft
1559 \value Key_Backslash
1560 \value Key_BracketRight
1561 \value Key_AsciiCircum
1562 \value Key_Underscore
1563 \value Key_QuoteLeft
1564 \value Key_BraceLeft
1565 \value Key_Bar
1566 \value Key_BraceRight
1567 \value Key_AsciiTilde
1568 \value Key_nobreakspace
1569 \value Key_exclamdown
1570 \value Key_cent
1571 \value Key_sterling
1572 \value Key_currency
1573 \value Key_yen
1574 \value Key_brokenbar
1575 \value Key_section
1576 \value Key_diaeresis
1577 \value Key_copyright
1578 \value Key_ordfeminine
1579 \value Key_guillemotleft
1580 \value Key_notsign
1581 \value Key_hyphen
1582 \value Key_registered
1583 \value Key_macron
1584 \value Key_degree
1585 \value Key_plusminus
1586 \value Key_twosuperior
1587 \value Key_threesuperior
1588 \value Key_acute
1589 \value [since 6.7] Key_micro
1590 \value Key_mu Deprecated alias for Key_micro
1591 \value Key_paragraph
1592 \value Key_periodcentered
1593 \value Key_cedilla
1594 \value Key_onesuperior
1595 \value Key_masculine
1596 \value Key_guillemotright
1597 \value Key_onequarter
1598 \value Key_onehalf
1599 \value Key_threequarters
1600 \value Key_questiondown
1601 \value Key_Agrave
1602 \value Key_Aacute
1603 \value Key_Acircumflex
1604 \value Key_Atilde
1605 \value Key_Adiaeresis
1606 \value Key_Aring
1607 \value Key_AE
1608 \value Key_Ccedilla
1609 \value Key_Egrave
1610 \value Key_Eacute
1611 \value Key_Ecircumflex
1612 \value Key_Ediaeresis
1613 \value Key_Igrave
1614 \value Key_Iacute
1615 \value Key_Icircumflex
1616 \value Key_Idiaeresis
1617 \value Key_ETH
1618 \value Key_Ntilde
1619 \value Key_Ograve
1620 \value Key_Oacute
1621 \value Key_Ocircumflex
1622 \value Key_Otilde
1623 \value Key_Odiaeresis
1624 \value Key_multiply
1625 \value Key_Ooblique
1626 \value Key_Ugrave
1627 \value Key_Uacute
1628 \value Key_Ucircumflex
1629 \value Key_Udiaeresis
1630 \value Key_Yacute
1631 \value Key_THORN
1632 \value Key_ssharp
1633 \value Key_division
1634 \value Key_ydiaeresis
1635
1636 \value Key_Multi_key
1637 \value Key_Codeinput
1638 \value Key_SingleCandidate
1639 \value Key_MultipleCandidate
1640 \value Key_PreviousCandidate
1641 \value Key_Mode_switch
1642 \value Key_Kanji
1643 \value Key_Muhenkan
1644 \value Key_Henkan
1645 \value Key_Romaji
1646 \value Key_Hiragana
1647 \value Key_Katakana
1648 \value Key_Hiragana_Katakana
1649 \value Key_Zenkaku
1650 \value Key_Hankaku
1651 \value Key_Zenkaku_Hankaku
1652 \value Key_Touroku
1653 \value Key_Massyo
1654 \value Key_Kana_Lock
1655 \value Key_Kana_Shift
1656 \value Key_Eisu_Shift
1657 \value Key_Eisu_toggle
1658 \value Key_Hangul
1659 \value Key_Hangul_Start
1660 \value Key_Hangul_End
1661 \value Key_Hangul_Hanja
1662 \value Key_Hangul_Jamo
1663 \value Key_Hangul_Romaja
1664 \value Key_Hangul_Jeonja
1665 \value Key_Hangul_Banja
1666 \value Key_Hangul_PreHanja
1667 \value Key_Hangul_PostHanja
1668 \value Key_Hangul_Special
1669 \value Key_Dead_Grave
1670 \value Key_Dead_Acute
1671 \value Key_Dead_Circumflex
1672 \value Key_Dead_Tilde
1673 \value Key_Dead_Macron
1674 \value Key_Dead_Breve
1675 \value Key_Dead_Abovedot
1676 \value Key_Dead_Diaeresis
1677 \value Key_Dead_Abovering
1678 \value Key_Dead_Doubleacute
1679 \value Key_Dead_Caron
1680 \value Key_Dead_Cedilla
1681 \value Key_Dead_Ogonek
1682 \value Key_Dead_Iota
1683 \value Key_Dead_Voiced_Sound
1684 \value Key_Dead_Semivoiced_Sound
1685 \value Key_Dead_Belowdot
1686 \value Key_Dead_Hook
1687 \value Key_Dead_Horn
1688 \value Key_Dead_Stroke
1689 \value Key_Dead_Abovecomma
1690 \value Key_Dead_Abovereversedcomma
1691 \value Key_Dead_Doublegrave
1692 \value Key_Dead_Belowring
1693 \value Key_Dead_Belowmacron
1694 \value Key_Dead_Belowcircumflex
1695 \value Key_Dead_Belowtilde
1696 \value Key_Dead_Belowbreve
1697 \value Key_Dead_Belowdiaeresis
1698 \value Key_Dead_Invertedbreve
1699 \value Key_Dead_Belowcomma
1700 \value Key_Dead_Currency
1701 \value Key_Dead_a
1702 \value Key_Dead_A
1703 \value Key_Dead_e
1704 \value Key_Dead_E
1705 \value Key_Dead_i
1706 \value Key_Dead_I
1707 \value Key_Dead_o
1708 \value Key_Dead_O
1709 \value Key_Dead_u
1710 \value Key_Dead_U
1711 \value Key_Dead_Small_Schwa
1712 \value Key_Dead_Capital_Schwa
1713 \value Key_Dead_Greek
1714 \value Key_Dead_Lowline
1715 \value Key_Dead_Aboveverticalline
1716 \value Key_Dead_Belowverticalline
1717 \value Key_Dead_Longsolidusoverlay
1718 \value Key_Back
1719 \value Key_Forward
1720 \value Key_Stop
1721 \value Key_Refresh
1722 \value Key_VolumeDown
1723 \value Key_VolumeMute
1724 \value Key_VolumeUp
1725 \value Key_BassBoost
1726 \value Key_BassUp
1727 \value Key_BassDown
1728 \value Key_TrebleUp
1729 \value Key_TrebleDown
1730 \value Key_MediaPlay A key setting the state of the media player to play
1731 \value Key_MediaStop A key setting the state of the media player to stop
1732 \value Key_MediaPrevious
1733 \value Key_MediaNext
1734 \value Key_MediaRecord
1735 \value Key_MediaPause A key setting the state of the media player to pause (\b Note: not the pause/break key)
1736 \value Key_MediaTogglePlayPause A key to toggle the play/pause state in the media player (rather than setting an absolute state)
1737 \value Key_HomePage
1738 \value Key_Favorites
1739 \value Key_Search
1740 \value Key_Standby
1741 \value Key_OpenUrl
1742 \value Key_LaunchMail
1743 \value Key_LaunchMedia
1744 \value Key_Launch0
1745 \value Key_Launch1
1746 \value Key_Launch2
1747 \value Key_Launch3
1748 \value Key_Launch4
1749 \value Key_Launch5
1750 \value Key_Launch6
1751 \value Key_Launch7
1752 \value Key_Launch8
1753 \value Key_Launch9
1754 \value Key_LaunchA
1755 \value Key_LaunchB
1756 \value Key_LaunchC
1757 \value Key_LaunchD
1758 \value Key_LaunchE
1759 \value Key_LaunchF
1760 \value Key_LaunchG
1761 \value Key_LaunchH
1762 \value Key_MonBrightnessUp
1763 \value Key_MonBrightnessDown
1764 \value Key_KeyboardLightOnOff
1765 \value Key_KeyboardBrightnessUp
1766 \value Key_KeyboardBrightnessDown
1767 \value Key_PowerOff
1768 \value Key_WakeUp
1769 \value Key_Eject
1770 \value Key_ScreenSaver
1771 \value Key_WWW
1772 \value Key_Memo
1773 \value Key_LightBulb
1774 \value Key_Shop
1775 \value Key_History
1776 \value Key_AddFavorite
1777 \value Key_HotLinks
1778 \value Key_BrightnessAdjust
1779 \value Key_Finance
1780 \value Key_Community
1781 \value Key_AudioRewind
1782 \value Key_BackForward
1783 \value Key_ApplicationLeft
1784 \value Key_ApplicationRight
1785 \value Key_Book
1786 \value Key_CD
1787 \value Key_Calculator
1788 \value Key_ToDoList
1789 \value Key_ClearGrab
1790 \value Key_Close
1791 \value Key_Copy
1792 \value Key_Cut
1793 \value Key_Display
1794 \value Key_DOS
1795 \value Key_Documents
1796 \value Key_Excel
1797 \value Key_Explorer
1798 \value Key_Game
1799 \value Key_Go
1800 \value Key_iTouch
1801 \value Key_LogOff
1802 \value Key_Market
1803 \value Key_Meeting
1804 \value Key_MenuKB
1805 \value Key_MenuPB
1806 \value Key_MySites
1807 \value Key_News
1808 \value Key_OfficeHome
1809 \value Key_Option
1810 \value Key_Paste
1811 \value Key_Phone
1812 \value Key_Calendar
1813 \value Key_Reply
1814 \value Key_Reload
1815 \value Key_RotateWindows
1816 \value Key_RotationPB
1817 \value Key_RotationKB
1818 \value Key_Save
1819 \value Key_Send
1820 \value Key_Spell
1821 \value Key_SplitScreen
1822 \value Key_Support
1823 \value Key_TaskPane
1824 \value Key_Terminal
1825 \value Key_Tools
1826 \value Key_Travel
1827 \value Key_Video
1828 \value Key_Word
1829 \value Key_Xfer
1830 \value Key_ZoomIn
1831 \value Key_ZoomOut
1832 \value Key_Away
1833 \value Key_Messenger
1834 \value Key_WebCam
1835 \value Key_MailForward
1836 \value Key_Pictures
1837 \value Key_Music
1838 \value Key_Battery
1839 \value Key_Bluetooth
1840 \value Key_WLAN
1841 \value Key_UWB
1842 \value Key_AudioForward
1843 \value Key_AudioRepeat
1844 \value Key_AudioRandomPlay
1845 \value Key_Subtitle
1846 \value Key_AudioCycleTrack
1847 \value Key_Time
1848 \value Key_Hibernate
1849 \value Key_View
1850 \value Key_TopMenu
1851 \value Key_PowerDown
1852 \value Key_Suspend
1853 \value Key_ContrastAdjust
1854 \value Key_TouchpadToggle
1855 \value Key_TouchpadOn
1856 \value Key_TouchpadOff
1857 \value Key_MicMute
1858 \value Key_Red
1859 \value Key_Green
1860 \value Key_Yellow
1861 \value Key_Blue
1862 \value Key_ChannelUp
1863 \value Key_ChannelDown
1864 \value Key_Guide
1865 \value Key_Info
1866 \value Key_Settings
1867 \value Key_MicVolumeUp
1868 \value Key_MicVolumeDown
1869 \value Key_Keyboard
1870 \value Key_New
1871 \value Key_Open
1872 \value Key_Find
1873 \value Key_Undo
1874 \value Key_Redo
1875 \value [since 6.13] Key_Assistant A key to invoke a voice assistant.
1876 \value [since 6.13] Key_SelectiveScreenshot A key to take a screenshot of a
1877 user-selected part of the screen.
1878 \value [since 6.13] Key_PerformanceMode A key to switch the performance mode
1879 of the device.
1880 \value Key_MediaLast
1881 \value Key_unknown
1882
1883 \value Key_Call A key to answer or initiate a call (see Qt::Key_ToggleCallHangup for a key to toggle current call state)
1884 \value Key_Camera A key to activate the camera shutter. On Windows Runtime, the environment variable QT_QPA_ENABLE_CAMERA_KEYS must be set to receive the event.
1885 \value Key_CameraFocus A key to focus the camera. On Windows Runtime, the environment variable QT_QPA_ENABLE_CAMERA_KEYS must be set to receive the event.
1886 \value Key_Context1
1887 \value Key_Context2
1888 \value Key_Context3
1889 \value Key_Context4
1890 \value Key_Flip
1891 \value Key_Hangup A key to end an ongoing call (see Qt::Key_ToggleCallHangup for a key to toggle current call state)
1892 \value Key_No
1893 \value Key_Select
1894 \value Key_Yes
1895 \value Key_ToggleCallHangup A key to toggle the current call state (ie. either answer, or hangup) depending on current call state
1896 \value Key_VoiceDial
1897 \value Key_LastNumberRedial
1898
1899 \value Key_Execute
1900 \value Key_Printer
1901 \value Key_Play
1902 \value Key_Sleep
1903 \value Key_Zoom
1904 \value Key_Exit
1905 \value Key_Cancel
1906
1907 \sa QKeyEvent::key()
1908*/
1909
1910/*!
1911 \enum Qt::HitTestAccuracy
1912
1913 This enum contains the types of accuracy that can be used by the
1914 QTextDocument class when testing for mouse clicks on text documents.
1915
1916 \value ExactHit The point at which input occurred must coincide
1917 exactly with input-sensitive parts of the document.
1918 \value FuzzyHit The point at which input occurred can lie close to
1919 input-sensitive parts of the document.
1920*/
1921
1922/*!
1923 \enum Qt::WhiteSpaceMode
1924
1925 This enum describes the types of whitespace mode that are used by
1926 the QTextDocument class to meet the requirements of different kinds
1927 of textual information.
1928
1929 \value WhiteSpaceNormal The whitespace mode used to display
1930 normal word wrapped text in paragraphs.
1931 \value WhiteSpacePre A preformatted text mode in which
1932 whitespace is reproduced exactly.
1933 \value WhiteSpaceNoWrap
1934
1935 \omitvalue WhiteSpaceModeUndefined
1936*/
1937
1938/*!
1939 \enum Qt::CheckState
1940
1941 This enum describes the state of checkable items, controls, and widgets.
1942
1943 \value Unchecked The item is unchecked.
1944 \value PartiallyChecked The item is partially checked. Items in hierarchical models
1945 may be partially checked if some, but not all, of their
1946 children are checked.
1947 \value Checked The item is checked.
1948
1949 \sa QCheckBox, Qt::ItemFlags, Qt::ItemDataRole
1950*/
1951
1952
1953/*!
1954 \enum Qt::ToolButtonStyle
1955
1956 The style of the tool button, describing how the button's text and
1957 icon should be displayed.
1958
1959 \value ToolButtonIconOnly Only display the icon.
1960 \value ToolButtonTextOnly Only display the text.
1961 \value ToolButtonTextBesideIcon The text appears beside the icon.
1962 \value ToolButtonTextUnderIcon The text appears under the icon.
1963 \value ToolButtonFollowStyle Follow the \l{QStyle::SH_ToolButtonStyle}{style}.
1964*/
1965
1966/*!
1967 \enum Qt::Corner
1968
1969 This enum type specifies a corner in a rectangle:
1970
1971 \value TopLeftCorner The top-left corner of the rectangle.
1972 \value TopRightCorner The top-right corner of the rectangle.
1973 \value BottomLeftCorner The bottom-left corner of the rectangle.
1974 \value BottomRightCorner The bottom-right corner of the rectangle.
1975*/
1976
1977/*!
1978 \enum Qt::Edge
1979
1980 This enum type specifies an edge in a rectangle:
1981
1982 \value TopEdge The top edge of the rectangle.
1983 \value LeftEdge The left edge of the rectangle.
1984 \value RightEdge The right edge of the rectangle.
1985 \value BottomEdge The bottom edge of the rectangle.
1986
1987 \since 5.1
1988*/
1989
1990/*!
1991 \enum Qt::ScrollBarPolicy
1992
1993 This enum type describes the various modes of QAbstractScrollArea's scroll
1994 bars.
1995
1996 \value ScrollBarAsNeeded QAbstractScrollArea shows a scroll bar when the
1997 content is too large to fit and not otherwise. This is the
1998 default.
1999
2000 \value ScrollBarAlwaysOff QAbstractScrollArea never shows a scroll bar.
2001
2002 \value ScrollBarAlwaysOn QAbstractScrollArea always shows a scroll bar. This
2003 property is ignored on systems with transient scroll bars (e.g., on Mac from
2004 version 10.7).
2005
2006 (The modes for the horizontal and vertical scroll bars are
2007 independent.)
2008*/
2009
2010/*!
2011 \enum Qt::ArrowType
2012
2013 \value NoArrow
2014 \value UpArrow
2015 \value DownArrow
2016 \value LeftArrow
2017 \value RightArrow
2018*/
2019
2020/*!
2021 \enum Qt::FocusReason
2022
2023 This enum specifies why the focus changed. It will be passed
2024 through QWidget::setFocus and can be retrieved in the QFocusEvent
2025 sent to the widget upon focus change.
2026
2027 \value MouseFocusReason A mouse action occurred.
2028 \value TabFocusReason The Tab key was pressed.
2029 \value BacktabFocusReason A Backtab occurred. The input for this may
2030 include the Shift or Control keys;
2031 e.g. Shift+Tab.
2032 \value ActiveWindowFocusReason The window system made this window either
2033 active or inactive.
2034 \value PopupFocusReason The application opened/closed a pop-up that
2035 grabbed/released the keyboard focus.
2036 \value ShortcutFocusReason The user typed a label's buddy shortcut
2037 \value MenuBarFocusReason The menu bar took focus.
2038 \value OtherFocusReason Another reason, usually application-specific.
2039
2040 \omitvalue NoFocusReason
2041
2042 \sa {Keyboard Focus in Widgets}
2043*/
2044
2045/*!
2046 \enum Qt::WindowState
2047
2048 \keyword window state
2049
2050 This enum type is used to specify the current state of a top-level
2051 window.
2052
2053 The states are
2054
2055 \value WindowNoState The window has no state set (in normal state).
2056 \value WindowMinimized The window is minimized (i.e. iconified).
2057 \value WindowMaximized The window is maximized with a frame around it.
2058 \value WindowFullScreen The window fills the entire screen without any frame around it.
2059 \value WindowActive The window is the active window, i.e. it has keyboard focus.
2060
2061*/
2062
2063/*!
2064 \enum Qt::ApplicationState
2065
2066 \keyword application state
2067
2068 This enum type is used to specify the current state of the application.
2069
2070 The states are
2071
2072 \value ApplicationSuspended The application is about to suspend. When entering this state, the
2073 application should save its state, cease all activities, and be
2074 prepared for code execution to stop. While suspended, the
2075 application can be killed at any time without further warnings
2076 (e.g. when low memory forces the OS to purge suspended applications).
2077 \value ApplicationHidden The application is hidden and runs in the background. This
2078 is the normal state for applications that need to do background
2079 processing, like playing music, while the user interacts with
2080 other applications. The application should free up all graphical
2081 resources when entering this state.
2082 \value ApplicationInactive The application is visible, but not selected to be in front.
2083 On desktop platforms, this typically means that the user
2084 activated another application. On mobile platforms, it is
2085 more common to enter this state when the OS is interrupting
2086 the user with e.g. incoming calls or SMS-messages.
2087 While in this state, consider reducing CPU-intensive tasks.
2088 \value ApplicationActive The application is visible and selected to be in front.
2089
2090 \since 5.1
2091*/
2092
2093/*!
2094 \enum Qt::ScreenOrientation
2095
2096 This enum type specifies the various orientations a screen might have.
2097
2098 \value PrimaryOrientation The display's primary orientation.
2099 \value LandscapeOrientation Landscape orientation, display width is greater than display height.
2100 \value PortraitOrientation Portrait orientation, display height is greater than display width,
2101 rotated 90 degree clockwise relative to landscape.
2102 \value InvertedLandscapeOrientation Inverted landscape orientation, rotated 180 degrees relative to landscape.
2103 \value InvertedPortraitOrientation Inverted portrait orientation, rotated 180 degrees relative to portrait.
2104*/
2105
2106/*!
2107 \enum Qt::ContextMenuPolicy
2108
2109 This enum type defines the various policies a widget can have with
2110 respect to showing a context menu.
2111
2112 \value NoContextMenu the widget does not feature a context menu,
2113 context menu handling is deferred to the widget's parent.
2114 \value PreventContextMenu the widget does not feature a context
2115 menu, and in contrast to \c NoContextMenu, the handling is \e not
2116 deferred to the widget's parent. This means that all right mouse
2117 button events are guaranteed to be delivered to the widget itself
2118 through QWidget::mousePressEvent(), and QWidget::mouseReleaseEvent().
2119 \value DefaultContextMenu the widget's QWidget::contextMenuEvent() handler is called.
2120 \value ActionsContextMenu the widget displays its QWidget::actions() as context menu.
2121 \value CustomContextMenu the widget emits the QWidget::customContextMenuRequested() signal.
2122*/
2123
2124/*!
2125 \enum Qt::ContextMenuTrigger
2126 \since 6.8
2127
2128 This enum type defines the mouse event used to trigger a context menu event.
2129
2130 \value Press context menu on mouse press event, default on UNIX systems.
2131 \value Release context menu on mouse release event, default on Windows.
2132
2133 \sa QStyleHints::contextMenuTrigger
2134*/
2135
2136/*!
2137 \enum Qt::FocusPolicy
2138
2139 This enum type defines the various policies a widget can have with
2140 respect to acquiring keyboard focus.
2141
2142 \value TabFocus the widget accepts focus by tabbing.
2143 \value ClickFocus the widget accepts focus by clicking.
2144 \value StrongFocus the widget accepts focus by both tabbing
2145 and clicking. On \macos this will also
2146 be indicate that the widget accepts tab focus
2147 when in 'Text/List focus mode'.
2148 \value WheelFocus like Qt::StrongFocus plus the widget accepts
2149 focus by using the mouse wheel.
2150 \value NoFocus the widget does not accept focus.
2151
2152*/
2153
2154/*!
2155 \enum Qt::TabFocusBehavior
2156 \since 5.5
2157
2158 This enum type provides different focus behaviors for tab navigation.
2159
2160 \value NoTabFocus iterate nothing.
2161 \value TabFocusTextControls iterate text controls and widgets.
2162 \value TabFocusListControls iterate list controls and widgets.
2163 \value TabFocusAllControls iterate all controls and widgets.
2164
2165*/
2166
2167/*!
2168 \enum Qt::ShortcutContext
2169
2170 For a QEvent::Shortcut event to occur, the shortcut's key sequence
2171 must be entered by the user in a context where the shortcut is
2172 active. The possible contexts are these:
2173
2174 \value WidgetShortcut The shortcut is active when its
2175 parent widget has focus.
2176 \value WidgetWithChildrenShortcut The shortcut is active
2177 when its parent widget, or any of its children has focus.
2178 Children which are top-level widgets, except pop-ups, are
2179 not affected by this shortcut context.
2180 \value WindowShortcut The shortcut is active when its
2181 parent widget is a logical subwidget of the
2182 active top-level window.
2183 \value ApplicationShortcut The shortcut is active when one of
2184 the applications windows are active.
2185*/
2186
2187/*!
2188 \enum Qt::WindowType
2189
2190 \keyword window flag
2191
2192 This enum type is used to specify various window-system properties
2193 for the widget. They are fairly unusual but necessary in a few
2194 cases. Some of these flags depend on whether the underlying window
2195 manager supports them.
2196
2197 The main types are
2198
2199 \value Widget This is the default type for QWidget. Widgets of
2200 this type are child widgets if they have a parent,
2201 and independent windows if they have no parent.
2202 See also Qt::Window and Qt::SubWindow.
2203
2204 \value Window Indicates that the widget is a window, usually
2205 with a window system frame and a title bar,
2206 irrespective of whether the widget has a parent or
2207 not. Note that it is not possible to unset this
2208 flag if the widget does not have a parent.
2209
2210 \value Dialog Indicates that the widget is a window that should
2211 be decorated as a dialog (i.e., typically no
2212 maximize or minimize buttons in the title bar).
2213 This is the default type for QDialog. If you want
2214 to use it as a modal dialog, it should be launched
2215 from another window, or have a parent and used
2216 with the QWidget::windowModality property. If you make
2217 it modal, the dialog will prevent other top-level
2218 windows in the application from getting any input.
2219 We refer to a top-level window that has a parent
2220 as a \e secondary window.
2221
2222 \value Sheet Indicates that the window is a sheet on \macos. Since
2223 using a sheet implies window modality, the recommended
2224 way is to use QWidget::setWindowModality(), or
2225 QDialog::open(), instead.
2226
2227 \value Drawer Indicates that the widget is a drawer on \macos.
2228 This feature is obsolete. Setting the flag
2229 has no effect.
2230
2231 \value Popup Indicates that the widget is a pop-up top-level
2232 window, i.e. that it is modal, but has a window
2233 system frame appropriate for pop-up menus.
2234
2235 \value Tool Indicates that the widget is a tool window. A tool
2236 window is often a small window with a smaller than
2237 usual title bar and decoration, typically used for
2238 collections of tool buttons. If there is a parent,
2239 the tool window will always be kept on top of it.
2240 If there isn't a parent, you may consider using
2241 Qt::WindowStaysOnTopHint as well. If the window
2242 system supports it, a tool window can be decorated
2243 with a somewhat lighter frame. It can also be
2244 combined with Qt::FramelessWindowHint.
2245 On \macos, tool windows correspond to the
2246 \l{https://developer.apple.com/documentation/appkit/nspanel}{NSPanel}
2247 class of windows. This means that the window lives on a
2248 level above normal windows making it impossible to put a normal
2249 window on top of it. By default, tool windows will disappear
2250 when the application is inactive. This can be controlled by
2251 the Qt::WA_MacAlwaysShowToolWindow attribute.
2252
2253 \value ToolTip Indicates that the widget is a tooltip. This is
2254 used internally to implement
2255 \l{QWidget::toolTip}{tooltips}.
2256
2257 \value SplashScreen Indicates that the window is a splash screen.
2258 This is the default type for QSplashScreen.
2259
2260 \omitvalue Desktop Indicates that this widget is the desktop.
2261
2262 \value SubWindow Indicates that this widget is a sub-window, such
2263 as a QMdiSubWindow widget.
2264
2265 \value ForeignWindow Indicates that this window object is a handle
2266 representing a native platform window created by
2267 another process or by manually using native code.
2268
2269 \value CoverWindow Indicates that the window represents a cover window,
2270 which is shown when the application is minimized on
2271 some platforms.
2272
2273 There are also a number of flags which you can use to customize
2274 the appearance of top-level windows. These have no effect on other
2275 windows:
2276
2277 \value MSWindowsFixedSizeDialogHint Gives the window a thin dialog border on Windows.
2278 This style is traditionally used for fixed-size dialogs.
2279
2280 \note The use of this flag is not recommended in multi-monitor
2281 environments. This is because the system will enforce that the window
2282 maintains its native size when moving it across screens. This is
2283 particularly undesirable when using monitors with different
2284 resolutions.
2285
2286 \value MSWindowsOwnDC Gives the window its own display
2287 context on Windows.
2288
2289 \value BypassWindowManagerHint This flag can be used to indicate to the platform plugin
2290 that "all" window manager protocols should be disabled. This flag will behave
2291 different depending on what operating system the application is running on and
2292 what window manager is running. The flag can be used to get a native window
2293 with no configuration set.
2294
2295 \value X11BypassWindowManagerHint Bypass the window
2296 manager completely. This results in a borderless window
2297 that is not managed at all (i.e., no keyboard input unless
2298 you call QWidget::activateWindow() manually).
2299
2300 \value FramelessWindowHint Produces a borderless window.
2301
2302 On X11, the result of the flag is dependent on the window manager and its
2303 ability to understand Motif and/or NETWM hints. Most existing
2304 modern window managers can handle this.
2305
2306 \note If the window manager relies on the frame to interactively manipulate
2307 the window, the user can no longer move or resize the window via the window
2308 system, but this side effect should not be relied on. To produce a fixed
2309 size window that can not be resized, please set QWindow::setMinimumSize()
2310 and QWindow::setMaximumSize() to the same size.
2311
2312 \value NoDropShadowWindowHint Disables window drop shadow on supporting platforms.
2313
2314 The \c CustomizeWindowHint flag is used to enable customization of
2315 the window controls. This flag must be set to allow the \c
2316 WindowTitleHint, \c WindowSystemMenuHint, \c
2317 WindowMinimizeButtonHint, \c WindowMaximizeButtonHint and \c
2318 WindowCloseButtonHint flags to be changed.
2319
2320 \value CustomizeWindowHint Turns off the default window title hints.
2321
2322 \value WindowTitleHint Gives the window a title bar.
2323
2324 \value WindowSystemMenuHint Adds a window system menu, and
2325 possibly a close button (for example on Mac). If you need to hide
2326 or show a close button, it is more portable to use \c
2327 WindowCloseButtonHint.
2328
2329 \value WindowMinimizeButtonHint Adds a minimize button. On
2330 some platforms this implies Qt::WindowSystemMenuHint for it to work.
2331
2332 \note On many Wayland-based systems, button hints are not supported for
2333 server-side decorations.
2334
2335 \value WindowMaximizeButtonHint Adds a maximize button. On
2336 some platforms this implies Qt::WindowSystemMenuHint for it to work.
2337
2338 \note On many Wayland-based systems, button hints are not supported for
2339 server-side decorations.
2340
2341 \value WindowMinMaxButtonsHint Adds a minimize and a maximize
2342 button. On some platforms this implies Qt::WindowSystemMenuHint for it to work.
2343
2344 \note On many Wayland-based systems, button hints are not supported for
2345 server-side decorations.
2346
2347 \value WindowCloseButtonHint Adds a close button. On
2348 some platforms this implies Qt::WindowSystemMenuHint for it
2349 to work.
2350
2351 \note On many Wayland-based systems, button hints are not supported for
2352 server-side decorations.
2353
2354 \value WindowContextHelpButtonHint Adds a context help button to dialogs.
2355 On some platforms this implies Qt::WindowSystemMenuHint for it to work.
2356
2357 \omitvalue MacWindowToolBarButtonHint
2358
2359 \value WindowFullscreenButtonHint On \macos adds a fullscreen button.
2360
2361 \value BypassGraphicsProxyWidget Prevents the window and its children from
2362 automatically embedding themselves into a QGraphicsProxyWidget if the
2363 parent widget is already embedded. You can set this flag if you
2364 want your widget to always be a toplevel widget on the desktop,
2365 regardless of whether the parent widget is embedded in a scene or
2366 not.
2367
2368 \value WindowShadeButtonHint Adds a shade button in place of the minimize
2369 button if the underlying window manager supports it.
2370
2371 \value WindowStaysOnTopHint Informs the window system that the
2372 window should stay on top of all other windows. Note that
2373 on some window managers on X11 you also have to pass
2374 Qt::X11BypassWindowManagerHint for this flag to work
2375 correctly.
2376
2377 \value WindowStaysOnBottomHint Informs the window system that the
2378 window should stay on bottom of all other windows.
2379
2380 \note On X11, this hint will work only in window managers
2381 that support _NET_WM_STATE_BELOW atom. If a window always
2382 on the bottom has a parent, the parent will also be left on
2383 the bottom. This window hint is currently not implemented
2384 for \macos.
2385
2386 \note On Windows, this will work only for frameless or
2387 full-screen windows.
2388
2389 \value WindowTransparentForInput Informs the window system that this window
2390 is used only for output (displaying something) and does not take input.
2391 Therefore input events should pass through as if it wasn't there.
2392
2393 \value WindowOverridesSystemGestures Informs the window system that this window
2394 implements its own set of gestures and that system level gestures, like for
2395 instance three-finger desktop switching, should be disabled.
2396
2397 \value WindowDoesNotAcceptFocus Informs the window system that this window should
2398 not receive the input focus.
2399
2400 \note On Windows, this prevents the window from appearing in the taskbar.
2401
2402 \value MaximizeUsingFullscreenGeometryHint Deprecated alias for Qt::ExpandedClientAreaHint
2403
2404 \value [since 6.9] ExpandedClientAreaHint Requests that the window's client area is
2405 expanded to areas where it might be obscured by, or conflicting with other UI
2406 elements, such as the window's titlebar controls or other system UIs. The
2407 window's \l{QWindow::safeAreaMargins()}{safe area margins} will reflect any
2408 areas that may have conflicting UI elements.
2409
2410 \value [since 6.9] NoTitleBarBackgroundHint Requests that the window's title bar is drawn
2411 without a background color. This flag is useful in combination with
2412 Qt::ExpandedClientAreaHint, to give the perception that the window's
2413 client area seamlessly blends with the titlebar area and controls.
2414
2415 \value WindowType_Mask A mask for extracting the window type
2416 part of the window flags.
2417
2418 \sa QWidget::windowFlags, {Window Flags Example}
2419*/
2420
2421/*!
2422 \enum Qt::FindChildOption
2423
2424 \value FindDirectChildrenOnly Looks only at the direct children of the object.
2425 \value FindChildrenRecursively Looks at all children of the object (recursive search).
2426*/
2427
2428/*!
2429 \enum Qt::DropAction
2430
2431 \value CopyAction Copy the data to the target.
2432 \value MoveAction Move the data from the source to the target.
2433 \value LinkAction Create a link from the source to the target.
2434 \value ActionMask
2435 \value IgnoreAction Ignore the action (do nothing with the data).
2436 \value TargetMoveAction On Windows, this value is used when the ownership of the D&D data
2437 should be taken over by the target application,
2438 i.e., the source application should not delete
2439 the data.
2440 On X11 this value is used to do a move.
2441 TargetMoveAction is not used on the Mac.
2442*/
2443
2444/*!
2445 \enum Qt::SortOrder
2446
2447 This enum describes how the items in a widget are sorted.
2448
2449 \value AscendingOrder The items are sorted ascending e.g. starts with
2450 'AAA' ends with 'ZZZ' in Latin-1 locales
2451
2452 \value DescendingOrder The items are sorted descending e.g. starts with
2453 'ZZZ' ends with 'AAA' in Latin-1 locales
2454*/
2455
2456/*!
2457 \enum Qt::SplitBehaviorFlags
2458 \since 5.14
2459
2460 This enum specifies how the QString::split() functions should behave with
2461 respect to empty strings.
2462
2463 \value KeepEmptyParts If a field is empty, keep it in the result.
2464 \value SkipEmptyParts If a field is empty, don't include it in the result.
2465
2466 \sa QString::split()
2467*/
2468
2469/*!
2470 \enum Qt::ClipOperation
2471
2472 \value NoClip This operation turns clipping off.
2473
2474 \value ReplaceClip Replaces the current clip path/rect/region with
2475 the one supplied in the function call.
2476
2477 \value IntersectClip Intersects the current clip path/rect/region
2478 with the one supplied in the function call.
2479*/
2480
2481/*!
2482 \enum Qt::ItemSelectionMode
2483
2484 This enum is used in QGraphicsItem, QGraphicsScene and QGraphicsView to
2485 specify how items are selected, or how to determine if shapes and items
2486 collide.
2487
2488 \value ContainsItemShape The output list contains only items whose
2489 \l{QGraphicsItem::shape()}{shape} is fully contained inside the
2490 selection area. Items that intersect with the area's outline are
2491 not included.
2492
2493 \value IntersectsItemShape The output list contains both items whose
2494 \l{QGraphicsItem::shape()}{shape} is fully contained inside the
2495 selection area, and items that intersect with the area's
2496 outline. This is a common mode for rubber band selection.
2497
2498 \value ContainsItemBoundingRect The output list contains only items whose
2499 \l{QGraphicsItem::boundingRect()}{bounding rectangle} is fully
2500 contained inside the selection area. Items that intersect with the
2501 area's outline are not included.
2502
2503 \value IntersectsItemBoundingRect The output list contains both items
2504 whose \l{QGraphicsItem::boundingRect()}{bounding rectangle} is
2505 fully contained inside the selection area, and items that intersect
2506 with the area's outline. This method is commonly used for
2507 determining areas that need redrawing.
2508
2509 \sa QGraphicsScene::items(), QGraphicsScene::collidingItems(),
2510 QGraphicsView::items(), QGraphicsItem::collidesWithItem(),
2511 QGraphicsItem::collidesWithPath()
2512*/
2513
2514/*!
2515 \enum Qt::ItemSelectionOperation
2516
2517 This enum is used in QGraphicsScene to specify what to do with currently selected
2518 items when setting a selection area.
2519
2520 \value ReplaceSelection The currently selected items are replaced by items
2521 in the selection area.
2522
2523 \value AddToSelection The items in the selection area are added to the currently
2524 selected items.
2525
2526 \sa QGraphicsScene::setSelectionArea()
2527*/
2528
2529/*!
2530 \enum Qt::FillRule
2531
2532 Specifies which method should be used to fill the paths and polygons.
2533
2534 \value OddEvenFill Specifies that the region is filled using the
2535 odd even fill rule. With this rule, we determine whether a point
2536 is inside the shape by using the following method.
2537 Draw a horizontal line from the point to a location outside the shape,
2538 and count the number of intersections. If the number of intersections
2539 is an odd number, the point is inside the shape. This mode is the
2540 default.
2541
2542 \value WindingFill Specifies that the region is filled using the
2543 non zero winding rule. With this rule, we determine whether a
2544 point is inside the shape by using the following method.
2545 Draw a horizontal line from the point to a location outside the shape.
2546 Determine whether the direction of the line at each intersection point
2547 is up or down. The winding number is determined by summing the
2548 direction of each intersection. If the number is non zero, the point
2549 is inside the shape. This fill mode can also in most cases be considered
2550 as the intersection of closed shapes.
2551*/
2552
2553/*!
2554 \enum Qt::TextFormat
2555
2556 This enum is used in widgets that can display both plain text and
2557 rich text, for example QLabel. It is used for deciding whether a text
2558 string should be interpreted as one or the other. This is normally
2559 done by passing one of the enum values to a QStaticText::setTextFormat()
2560 function.
2561
2562 \value PlainText The text string is interpreted as a plain text
2563 string.
2564
2565 \value RichText The text string is interpreted as a rich text
2566 string. See \l {Supported HTML Subset} for the definition
2567 of rich text.
2568
2569 \value AutoText The text string is interpreted as for
2570 Qt::RichText if Qt::mightBeRichText() returns \c true, otherwise
2571 as Qt::PlainText.
2572
2573 \value MarkdownText The text string is interpreted as Markdown-formatted text.
2574 This enum value was added in Qt 5.14.
2575*/
2576
2577/*!
2578 \enum Qt::CursorShape
2579
2580 This enum type defines the various cursors that can be used.
2581
2582 The standard arrow cursor is the default for widgets in a normal state.
2583
2584 \value ArrowCursor \inlineimage cursor-arrow.png {Arrow cursor}
2585 The standard arrow cursor.
2586 \value UpArrowCursor \inlineimage cursor-uparrow.png {Up arrow cursor}
2587 An arrow pointing upwards toward the top of the screen.
2588 \value CrossCursor \inlineimage cursor-cross.png {Cross cursor}
2589 A crosshair cursor, typically used to help the
2590 user accurately select a point on the screen.
2591 \value WaitCursor \inlineimage cursor-wait.png {Wait cursor}
2592 An hourglass or watch cursor, usually shown during
2593 operations that prevent the user from interacting with
2594 the application.
2595 \value IBeamCursor \inlineimage cursor-ibeam.png {I-beam cursor}
2596 A caret or ibeam cursor, indicating that a widget can
2597 accept and display text input.
2598 \value SizeVerCursor \inlineimage cursor-sizev.png {Vertical resize cursor}
2599 A cursor used for elements that are used to vertically
2600 resize top-level windows.
2601 \value SizeHorCursor \inlineimage cursor-sizeh.png {Horizontal resize cursor}
2602 A cursor used for elements that are used to horizontally
2603 resize top-level windows.
2604 \value SizeBDiagCursor \inlineimage cursor-sizeb.png {Diagonal resize cursor}
2605 A cursor used for elements that are used to diagonally
2606 resize top-level windows at their top-right and
2607 bottom-left corners.
2608 \value SizeFDiagCursor \inlineimage cursor-sizef.png {Diagonal resize cursor}
2609 A cursor used for elements that are used to diagonally
2610 resize top-level windows at their top-left and
2611 bottom-right corners.
2612 \value SizeAllCursor \inlineimage cursor-sizeall.png {Move cursor}
2613 A cursor used for elements that are used to resize
2614 top-level windows in any direction.
2615 \value BlankCursor A blank/invisible cursor, typically used when the cursor
2616 shape needs to be hidden.
2617 \value SplitVCursor \inlineimage cursor-vsplit.png {Vertical split cursor}
2618 A cursor used for vertical splitters, indicating that
2619 a handle can be dragged horizontally to adjust the use
2620 of available space.
2621 \value SplitHCursor \inlineimage cursor-hsplit.png {Horizontal split cursor}
2622 A cursor used for horizontal splitters, indicating that
2623 a handle can be dragged vertically to adjust the use
2624 of available space.
2625 \value PointingHandCursor \inlineimage cursor-hand.png {Pointing hand cursor}
2626 A pointing hand cursor that is typically used for
2627 clickable elements such as hyperlinks.
2628 \value ForbiddenCursor \inlineimage cursor-forbidden.png {Forbidden cursor}
2629 A slashed circle cursor, typically used during drag
2630 and drop operations to indicate that dragged content
2631 cannot be dropped on particular widgets or inside
2632 certain regions.
2633 \value OpenHandCursor \inlineimage cursor-openhand.png {Open hand cursor}
2634 A cursor representing an open hand, typically used to
2635 indicate that the area under the cursor is the visible
2636 part of a canvas that the user can click and drag in
2637 order to scroll around.
2638 \value ClosedHandCursor \inlineimage cursor-closedhand.png {Closed hand cursor}
2639 A cursor representing a closed hand, typically used to
2640 indicate that a dragging operation is in progress that
2641 involves scrolling.
2642 \value WhatsThisCursor \inlineimage cursor-whatsthis.png {What's this cursor}
2643 An arrow with a question mark, typically used to indicate
2644 the presence of What's This? help for a widget.
2645 \value BusyCursor \inlineimage cursor-busy.png {Busy cursor}
2646 An hourglass or watch cursor, usually shown during
2647 operations that allow the user to interact with
2648 the application while they are performed in the
2649 background.
2650 \value DragMoveCursor
2651 A cursor that is usually used when dragging an item.
2652 \value DragCopyCursor
2653 A cursor that is usually used when dragging an item
2654 to copy it.
2655 \value DragLinkCursor
2656 A cursor that is usually used when dragging an item
2657 to make a link to it.
2658
2659 \value BitmapCursor
2660 \omitvalue LastCursor
2661 \omitvalue CustomCursor
2662*/
2663
2664/*!
2665 \enum Qt::LayoutDirection
2666
2667 Specifies the direction of Qt's layouts and text handling.
2668
2669 \value LeftToRight Left-to-right layout.
2670 \value RightToLeft Right-to-left layout.
2671 \value LayoutDirectionAuto Automatic layout.
2672
2673 Right-to-left layouts are necessary for certain languages,
2674 notably Arabic and Hebrew.
2675
2676 LayoutDirectionAuto serves two purposes. When used in conjunction with widgets and layouts, it
2677 will imply to use the layout direction set on the parent widget or QApplication. This
2678 has the same effect as QWidget::unsetLayoutDirection().
2679
2680 When LayoutDirectionAuto is used in conjunction with text layouting, it will imply that the text
2681 directionality is determined from the content of the string to be layouted.
2682
2683 \sa QGuiApplication::setLayoutDirection(), QWidget::setLayoutDirection(), QTextOption::setTextDirection(), QString::isRightToLeft()
2684*/
2685
2686/*!
2687 \enum Qt::AnchorPoint
2688
2689 Specifies a side of a layout item that can be anchored. This is used by
2690 QGraphicsAnchorLayout.
2691
2692 \value AnchorLeft The left side of a layout item.
2693 \value AnchorHorizontalCenter A "virtual" side that is centered between the left and the
2694 right side of a layout item.
2695 \value AnchorRight The right side of a layout item.
2696 \value AnchorTop The top side of a layout item.
2697 \value AnchorVerticalCenter A "virtual" side that is centered between the top and the
2698 bottom side of a layout item.
2699 \value AnchorBottom The bottom side of a layout item.
2700
2701 \sa QGraphicsAnchorLayout
2702*/
2703
2704/*!
2705 \enum Qt::InputMethodHint
2706
2707 \value ImhNone No hints.
2708
2709 Flags that alter the behavior:
2710
2711 \value ImhHiddenText The input method should not show the characters while typing.
2712 This is automatically set when setting QLineEdit::echoMode to \c Password.
2713 Note that setting \c ImhHiddenText does not change the echo mode.
2714
2715 Note that Android IMEs deliberately only
2716 allow Latin/ASCII character input for password fields.
2717 \value ImhSensitiveData Typed text should not be stored by the active input method
2718 in any persistent storage like predictive user dictionary.
2719
2720 Note that the Qt Framework treats this as a visible password
2721 and in this case Android IMEs deliberately only
2722 allow Latin/ASCII character input.
2723 \value ImhNoAutoUppercase The input method should not try to automatically switch to upper case
2724 when a sentence ends.
2725 \value ImhPreferNumbers Numbers are preferred (but not required).
2726 \value ImhPreferUppercase Upper case letters are preferred (but not required).
2727 \value ImhPreferLowercase Lower case letters are preferred (but not required).
2728 \value ImhNoPredictiveText Do not use predictive text (i.e. dictionary lookup) while typing.
2729
2730 \value ImhDate The text editor functions as a date field.
2731 \value ImhTime The text editor functions as a time field.
2732 \value ImhPreferLatin Latin characters are preferred (but not required).
2733
2734 \value ImhMultiLine Multiple lines can be entered into the text field.
2735
2736 \value ImhNoEditMenu Do not use built-in edit menu. This flag was introduced in Qt 5.11.
2737 \value ImhNoTextHandles Do not use built-in text cursor and selection handles. This flag was introduced in Qt 5.11.
2738 \value [since 6.12] ImhNoFullscreen Do not use fullscreen input method.
2739
2740 Flags that restrict input (exclusive flags):
2741
2742 \value ImhDigitsOnly Only digits are allowed.
2743 \value [since 6.12] ImhDecimalNumbersOnly Only number input is allowed. This includes decimal point, but not negative numbers.
2744 \value ImhFormattedNumbersOnly Only number input is allowed. This includes decimal point and minus sign.
2745 \value ImhUppercaseOnly Only upper case letter input is allowed.
2746 \value ImhLowercaseOnly Only lower case letter input is allowed.
2747 \value ImhDialableCharactersOnly Only characters suitable for phone dialing are allowed.
2748 \value ImhEmailCharactersOnly Only characters suitable for email addresses are allowed.
2749 \value ImhUrlCharactersOnly Only characters suitable for URLs are allowed.
2750 \value ImhLatinOnly Only latin based input is allowed.
2751
2752 Masks:
2753
2754 \value ImhExclusiveInputMask This mask yields nonzero if any of the exclusive flags are used.
2755
2756 \note If several exclusive flags are OR-ed together, the resulting character set will
2757 consist of the union of the specified sets. For instance specifying \c ImhNumbersOnly and
2758 \c ImhUppercaseOnly would yield a set consisting of numbers and uppercase letters.
2759
2760 \sa QGraphicsItem::inputMethodHints()
2761*/
2762
2763/*!
2764 \enum Qt::InputMethodQuery
2765
2766 \value ImEnabled The widget accepts input method input.
2767 \value ImCursorRectangle The rectangle covering the area of the input cursor in widget coordinates.
2768 \value ImFont The currently used font for text input.
2769 \value ImCursorPosition The logical position of the cursor within the text surrounding the input area
2770 (see \c ImSurroundingText). The position does not incorporate the offset of
2771 the cursor within the preedit area, as controlled by QInputMethodEvent::Cursor.
2772 \value ImSurroundingText The plain text around the input area, for example the current paragraph.
2773 \value ImCurrentSelection The currently selected text.
2774 \value ImMaximumTextLength The maximum number of characters that the widget can hold. If there is no limit,
2775 QVariant::QVariant() is returned.
2776 \value ImAnchorPosition The position of the selection anchor. This may be less or greater than
2777 \c ImCursorPosition, depending on which side of selection the cursor is.
2778 If there is no selection, it returns the same as \c ImCursorPosition.
2779 \value ImHints The hints for input method on expected input. (See Qt::InputMethodHints)
2780 \value ImPreferredLanguage The preferred input language.
2781 \value ImPlatformData Platform specific data for input method.
2782 \value ImAbsolutePosition The logical position of the cursor within the entire document. The position does
2783 not incorporate the offset of the cursor within the preedit area, as controlled
2784 by QInputMethodEvent::Cursor.
2785 \value ImTextBeforeCursor The plain text before the cursor. The widget can decide how much text to return,
2786 but \b{must} not return an empty string unless the cursor is at the start of the document.
2787 \value ImTextAfterCursor The plain text after the cursor. The widget can decide how much text to return,
2788 but \b{must} not return an empty string unless the cursor is at the end of the document.
2789 \value ImEnterKeyType The Enter key type.
2790 \value ImAnchorRectangle The bounding rectangle of the selection anchor.
2791 This value was added in Qt 5.7.
2792 \value ImInputItemClipRectangle The actual exposed input item rectangle. Parts of the input item might be
2793 clipped. This value will take clipping into consideration and return the actual painted
2794 item rectangle. The rectangle is in widget coordinates.
2795 \value ImReadOnly The widget is read only. This value was added in Qt 6.2.
2796
2797 Masks:
2798
2799 \value ImQueryInput Commonly changed properties on input.
2800 \value ImQueryAll Query for all input method properties.
2801
2802 \sa QInputMethodQueryEvent
2803*/
2804
2805/*!
2806 \enum Qt::EnterKeyType
2807
2808 This can be used to alter the appearance of the Return key on an on-screen keyboard.
2809
2810 \note Not all of these values are supported on all platforms.
2811 For unsupported values the default key will be used instead.
2812
2813 \value EnterKeyDefault The default Enter key.
2814 This can either be a button closing the keyboard, or a Return button
2815 causing a new line in case of a multi-line input field.
2816 \value EnterKeyReturn Show a Return button that inserts a new line.
2817 The keyboard will not close when this button is pressed.
2818 \value EnterKeyDone Show a "Done" button.
2819 The keyboard will close when this button is pressed.
2820 \value EnterKeyGo Show a "Go" button.
2821 Typically used in an address bar when entering a URL; the keyboard
2822 will close when this button is pressed.
2823 \value EnterKeySend Show a "Send" button.
2824 The keyboard will close when this button is pressed.
2825 \value EnterKeySearch Show a "Search" button.
2826 The keyboard will close when this button is pressed.
2827 \value EnterKeyNext Show a "Next" button.
2828 Typically used in a form to allow navigating to the next input field;
2829 the keyboard will not close when this button is pressed.
2830 \value EnterKeyPrevious Show a "Previous" button.
2831 The keyboard will not close when this button is pressed.
2832
2833 \since 5.6
2834*/
2835
2836/*!
2837 \enum Qt::ItemDataRole
2838
2839 Each item in the model has a set of data elements associated with
2840 it, each with its own role. The roles are used by the view to indicate
2841 to the model which type of data it needs. Custom models should return
2842 data in these types.
2843
2844 The general purpose roles (and the associated types) are:
2845
2846 \value DisplayRole The key data to be rendered in the form of text. (QString)
2847 \value DecorationRole The data to be rendered as a decoration in the form
2848 of an icon. (QColor, QIcon or QPixmap)
2849 \value EditRole The data in a form suitable for editing in an
2850 editor. (QString)
2851 \value ToolTipRole The data displayed in the item's tooltip. (QString)
2852 \value StatusTipRole The data displayed in the status bar. (QString)
2853 \value WhatsThisRole The data displayed for the item in "What's This?"
2854 mode. (QString)
2855 \value SizeHintRole The size hint for the item that will be supplied
2856 to views. (QSize)
2857
2858 Roles describing appearance and meta data (with associated types):
2859
2860 \value FontRole The font used for items rendered with the default
2861 delegate. (QFont)
2862 \value TextAlignmentRole The alignment of the text for items rendered with the
2863 default delegate. (Qt::Alignment)
2864 \value BackgroundRole The background brush used for items rendered with
2865 the default delegate. (QBrush)
2866 \value ForegroundRole The foreground brush (text color, typically)
2867 used for items rendered with the default delegate.
2868 (QBrush)
2869 \value CheckStateRole This role is used to obtain the checked state of
2870 an item. (Qt::CheckState)
2871 \value InitialSortOrderRole This role is used to obtain the initial sort order
2872 of a header view section. (Qt::SortOrder).
2873
2874 Accessibility roles (with associated types):
2875
2876 \value AccessibleTextRole The text to be used by accessibility
2877 extensions and plugins, such as screen
2878 readers. (QString)
2879 \value AccessibleDescriptionRole A description of the item for accessibility
2880 purposes. (QString)
2881
2882 User roles:
2883
2884 \value UserRole The first role that can be used for application-specific purposes.
2885
2886 \omitvalue DisplayPropertyRole
2887 \omitvalue DecorationPropertyRole
2888 \omitvalue ToolTipPropertyRole
2889 \omitvalue StatusTipPropertyRole
2890 \omitvalue WhatsThisPropertyRole
2891 \omitvalue RangeModelDataRole
2892 \omitvalue RangeModelAdapterRole
2893 \omitvalue StandardItemFlagsRole
2894 \omitvalue FileInfoRole
2895 \omitvalue RemoteObjectsCacheRole
2896
2897 For user roles, it is up to the developer to decide which types to use and ensure that
2898 components use the correct types when accessing and setting data.
2899*/
2900
2901/*!
2902 \enum Qt::ItemFlag
2903
2904 This enum describes the properties of an item:
2905
2906 \value NoItemFlags It does not have any properties set.
2907 \value ItemIsSelectable It can be selected.
2908 \value ItemIsEditable It can be edited.
2909 \value ItemIsDragEnabled It can be dragged.
2910 \value ItemIsDropEnabled It can be used as a drop target.
2911 \value ItemIsUserCheckable It can be checked or unchecked by the user.
2912 \value ItemIsEnabled The user can interact with the item.
2913 \value ItemIsAutoTristate The item's state depends on the state of its children.
2914 This enables automatic management of the state of parent items in QTreeWidget
2915 (checked if all children are checked, unchecked if all children are unchecked,
2916 or partially checked if only some children are checked).
2917 \value ItemNeverHasChildren The item never has child items.
2918 This is used for optimization purposes only.
2919 \value ItemIsUserTristate The user can cycle through three separate states.
2920 This value was added in Qt 5.5.
2921
2922 Note that checkable items need to be given both a suitable set of flags
2923 and an initial state, indicating whether the item is checked or not.
2924 This is handled automatically for model/view components, but needs
2925 to be explicitly set for instances of QListWidgetItem, QTableWidgetItem,
2926 and QTreeWidgetItem.
2927
2928 Note that it is undefined behavior to reimplement QAbstractItemModel::hasChildren
2929 to return true for an index if that index has the Qt::ItemNeverHasChildren flag set.
2930
2931 \sa QAbstractItemModel
2932*/
2933
2934/*!
2935 \enum Qt::MatchFlag
2936
2937 This enum describes the type of matches that can be used when searching
2938 for items in a model.
2939
2940 \value MatchExactly Performs QVariant-based matching.
2941 \value MatchFixedString Performs string-based matching.
2942 String-based comparisons are case-insensitive unless the
2943 \c MatchCaseSensitive flag is also specified.
2944 \value MatchContains The search term is contained in the item.
2945 \value MatchStartsWith The search term matches the start of the item.
2946 \value MatchEndsWith The search term matches the end of the item.
2947 \value MatchCaseSensitive The search is case sensitive.
2948 \value MatchRegularExpression Performs string-based matching using a regular
2949 expression as the search term. Uses QRegularExpression.
2950 When using this flag, a QRegularExpression object can be passed as
2951 parameter and will directly be used to perform the search. The case
2952 sensitivity flag will be ignored as the QRegularExpression object is
2953 expected to be fully configured.
2954 This enum value was added in Qt 5.15.
2955 \value MatchWildcard Performs string-based matching using a string with
2956 wildcards as the search term.
2957 \value MatchWrap Perform a search that wraps around, so that when
2958 the search reaches the last item in the model, it begins again at
2959 the first item and continues until all items have been examined.
2960 \value MatchRecursive Searches the entire hierarchy.
2961 \omitvalue MatchTypeMask
2962
2963 \note Qt::MatchExactly, Qt::MatchContains, Qt::MatchStartsWith,
2964 Qt::MatchEndsWith, Qt::MatchRegularExpression, Qt::MatchWildcard, and
2965 Qt::MatchFixedString are mutually exclusive. The behavior achieved by
2966 setting several of them in a Qt::MatchFlags argument is undefined.
2967
2968 \sa QString::compare(), QRegularExpression
2969*/
2970
2971/*!
2972 \enum Qt::TextElideMode
2973
2974 This enum specifies where the ellipsis should appear when
2975 displaying texts that don't fit:
2976
2977 \value ElideLeft The ellipsis should appear at the beginning of the text.
2978 \value ElideRight The ellipsis should appear at the end of the text.
2979 \value ElideMiddle The ellipsis should appear in the middle of the text.
2980 \value ElideNone Ellipsis should NOT appear in the text. When passed to functions such as
2981 QFontMetrics::elidedText(), this will cause the full string to return unless
2982 the text contains multi-length variants. Elision in this case must be done
2983 by clipping to the component width.
2984
2985 Qt::ElideMiddle is normally the most appropriate choice for URLs (e.g.,
2986 "\l{http://bugreports.qt.io/browse/QTWEBSITE-13}{http://bugreports.qt.../QTWEBSITE-13/}"),
2987 whereas Qt::ElideRight is appropriate
2988 for other strings (e.g.,
2989 "\l{http://doc.qt.io/archives/qq/qq09-mac-deployment.html}{Deploying Applications on Ma...}").
2990
2991 \sa QAbstractItemView::textElideMode, QFontMetrics::elidedText(), AlignmentFlag, QTabBar::elideMode
2992*/
2993
2994/*!
2995 \enum Qt::WindowModality
2996
2997 \keyword modal
2998
2999 This enum specifies the behavior of a modal window. A modal window
3000 is one that blocks input to other windows. Note that windows that
3001 are children of a modal window are not blocked.
3002
3003 The values are:
3004 \value NonModal The window is not modal and does not block input to other windows.
3005 \value WindowModal The window is modal to a single window hierarchy and blocks input to its parent window, all grandparent windows, and all siblings of its parent and grandparent windows.
3006 \value ApplicationModal The window is modal to the application and blocks input to all windows.
3007
3008 \sa QWidget::windowModality, QDialog
3009*/
3010
3011/*!
3012 \enum Qt::TextInteractionFlag
3013
3014 This enum specifies how a text displaying widget reacts to user input.
3015
3016 \value NoTextInteraction No interaction with the text is possible.
3017 \value TextSelectableByMouse Text can be selected with the mouse and copied to the clipboard using
3018 a context menu or standard keyboard shortcuts.
3019 \value TextSelectableByKeyboard Text can be selected with the cursor keys on the keyboard. A text cursor is shown.
3020 \value LinksAccessibleByMouse Links can be highlighted and activated with the mouse.
3021 \value LinksAccessibleByKeyboard Links can be focused using tab and activated with enter.
3022 \value TextEditable The text is fully editable.
3023
3024 \value TextEditorInteraction The default for a text editor.
3025 \value TextBrowserInteraction The default for QTextBrowser.
3026*/
3027
3028/*!
3029 \enum Qt::MaskMode
3030
3031 This enum specifies the behavior of the
3032 QPixmap::createMaskFromColor() and QImage::createMaskFromColor()
3033 functions.
3034
3035 \value MaskInColor Creates a mask where all pixels matching the given color are opaque.
3036 \value MaskOutColor Creates a mask where all pixels matching the given color are transparent.
3037*/
3038
3039/*!
3040 \enum Qt::DockWidgetAreaSizes
3041 \internal
3042*/
3043
3044/*!
3045 \enum Qt::ToolBarAreaSizes
3046 \internal
3047*/
3048
3049/*!
3050 \enum Qt::EventPriority
3051
3052 This enum can be used to specify event priorities.
3053
3054 \value HighEventPriority Events with this priority are sent before
3055 events with NormalEventPriority or LowEventPriority.
3056
3057 \value NormalEventPriority Events with this priority are sent
3058 after events with HighEventPriority, but before events with
3059 LowEventPriority.
3060
3061 \value LowEventPriority Events with this priority are sent after
3062 events with HighEventPriority or NormalEventPriority.
3063
3064 Note that these values are provided purely for convenience, since
3065 event priorities can be any value between \c INT_MAX and \c
3066 INT_MIN, inclusive. For example, you can define custom priorities
3067 as being relative to each other:
3068
3069 \snippet code/doc_src_qnamespace.cpp 1
3070
3071 \sa QCoreApplication::postEvent()
3072*/
3073/*!
3074 \enum Qt::SizeHint
3075 \since 4.4
3076
3077 This enum is used by QGraphicsLayoutItem::sizeHint()
3078
3079 \value MinimumSize is used to specify the minimum size of a graphics layout item.
3080 \value PreferredSize is used to specify the preferred size of a graphics layout item.
3081 \value MaximumSize is used to specify the maximum size of a graphics layout item.
3082 \value MinimumDescent is used to specify the minimum descent of a text string in a graphics layout item.
3083 \omitvalue NSizeHints
3084
3085 \sa QGraphicsLayoutItem::sizeHint()
3086*/
3087
3088/*!
3089 \enum Qt::SizeMode
3090 \since 4.4
3091
3092 This enum is used by QPainter::drawRoundedRect() and QPainterPath::addRoundedRect()
3093 functions to specify the radii of rectangle corners with respect to the dimensions
3094 of the bounding rectangles specified.
3095
3096 \value AbsoluteSize Specifies the size using absolute measurements.
3097 \value RelativeSize Specifies the size relative to the bounding rectangle,
3098 typically using percentage measurements.
3099*/
3100
3101/*!
3102 \enum Qt::WindowFrameSection
3103 \since 4.4
3104
3105 This enum is used to describe parts of a window frame. It is returned by
3106 QGraphicsWidget::windowFrameSectionAt() to describe what section of the window
3107 frame is under the mouse.
3108
3109 \value NoSection
3110 \value LeftSection
3111 \value TopLeftSection
3112 \value TopSection
3113 \value TopRightSection
3114 \value RightSection
3115 \value BottomRightSection
3116 \value BottomSection
3117 \value BottomLeftSection
3118 \value TitleBarArea
3119
3120 \sa QGraphicsWidget::windowFrameEvent()
3121 \sa QGraphicsWidget::paintWindowFrame()
3122 \sa QGraphicsWidget::windowFrameSectionAt()
3123
3124*/
3125
3126/*!
3127 \enum Qt::TileRule
3128 \since 4.6
3129
3130 This enum describes how to repeat or stretch the parts of an image
3131 when drawing.
3132
3133 \value StretchTile Scale the image to fit to the available area.
3134
3135 \value RepeatTile Repeat the image until there is no more space. May
3136 crop the last image.
3137
3138 \value RoundTile Similar to Repeat, but scales the image down to
3139 ensure that the last tile is not cropped.
3140*/
3141
3142/*!
3143 \enum Qt::Initialization
3144 \internal
3145*/
3146
3147/*!
3148 \enum Qt::Disambiguated_t
3149 \internal
3150*/
3151
3152/*!
3153 \enum Qt::CoordinateSystem
3154 \since 4.6
3155
3156 This enum specifies the coordinate system.
3157
3158 \value DeviceCoordinates Coordinates are relative to the top-left corner
3159 of the object's paint device.
3160
3161 \value LogicalCoordinates Coordinates are relative to the top-left corner
3162 of the object.
3163*/
3164
3165/*! \enum Qt::TouchPointState
3166 \since 4.6
3167
3168 This enum represents the state of a touch point at the time a
3169 QTouchEvent occurred.
3170
3171 \value TouchPointUnknownState The state of the touch point is not known.
3172 \value TouchPointPressed The touch point is now pressed.
3173 \value TouchPointMoved The touch point moved.
3174 \value TouchPointStationary The touch point did not move.
3175 \value TouchPointReleased The touch point was released.
3176*/
3177
3178/*!
3179 \enum Qt::GestureState
3180 \since 4.6
3181
3182 This enum type describes the state of a gesture.
3183
3184 \value NoGesture No gesture has been detected.
3185 \value GestureStarted A continuous gesture has started.
3186 \value GestureUpdated A gesture continues.
3187 \value GestureFinished A gesture has finished.
3188 \value GestureCanceled A gesture was canceled.
3189
3190 \sa QGesture
3191*/
3192
3193/*!
3194 \enum Qt::GestureType
3195 \since 4.6
3196
3197 This enum type describes the standard gestures.
3198
3199 \value TapGesture A Tap gesture.
3200 \value TapAndHoldGesture A Tap-And-Hold (Long-Tap) gesture.
3201 \value PanGesture A Pan gesture.
3202 \value PinchGesture A Pinch gesture.
3203 \value SwipeGesture A Swipe gesture.
3204 \value CustomGesture A flag that can be used to test if the gesture is a
3205 user-defined gesture ID.
3206 \omitvalue LastGestureType
3207
3208 User-defined gestures are registered with the
3209 QGestureRecognizer::registerRecognizer() function which generates a custom
3210 gesture ID with the Qt::CustomGesture flag set.
3211
3212 \sa QGesture, QWidget::grabGesture(), QGraphicsObject::grabGesture()
3213*/
3214
3215/*!
3216 \enum Qt::GestureFlag
3217 \since 4.6
3218
3219 This enum type describes additional flags that can be used when subscribing
3220 to a gesture.
3221
3222 \value DontStartGestureOnChildren By default gestures can start on the
3223 widget or over any of its children. Use this flag to disable this and allow
3224 a gesture to start on the widget only.
3225
3226 \value ReceivePartialGestures Allows any ignored gesture events to be
3227 propagated to parent widgets which have specified this hint. By default
3228 only gestures that are in the Qt::GestureStarted state are propagated and
3229 the widget always gets the full gesture sequence starting with a gesture in
3230 the Qt::GestureStarted state and ending with a gesture in the
3231 Qt::GestureFinished or Qt::GestureCanceled states.
3232
3233 \value [since 4.7] IgnoredGesturesPropagateToParent Allows fine-tuning of
3234 gesture event propagation. By setting the flag when
3235 \l{QGraphicsObject::grabGesture()}{grabbing} a gesture all ignored partial
3236 gestures will propagate to their parent items.
3237
3238 \sa QWidget::grabGesture(), QGraphicsObject::grabGesture()
3239*/
3240
3241/*!
3242 \enum Qt::NativeGestureType
3243 \since 5.2
3244
3245 This enum returns the gesture type.
3246
3247 \value BeginNativeGesture Sent before gesture event stream.
3248 \value EndNativeGesture Sent after gesture event stream.
3249 \value PanNativeGesture Specifies the displacement delta in pixels.
3250 \value ZoomNativeGesture Specifies the magnification delta in percent.
3251 \value SmartZoomNativeGesture Boolean magnification state.
3252 \value RotateNativeGesture Specifies the rotation delta in degrees.
3253 \value SwipeNativeGesture Sent after a swipe movement.
3254
3255*/
3256
3257/*!
3258 \enum Qt::NavigationMode
3259 \deprecated [6.12]
3260 \since 4.6
3261
3262 This enum type describes the mode for moving focus.
3263
3264 \value NavigationModeNone Only the touch screen is used.
3265 \value NavigationModeKeypadTabOrder Qt::Key_Up and Qt::Key_Down are used to change focus.
3266 \value NavigationModeKeypadDirectional Qt::Key_Up, Qt::Key_Down, Qt::Key_Left and Qt::Key_Right are used to change focus.
3267 \value NavigationModeCursorAuto The mouse cursor is used to change focus,
3268 it is displayed only on non touchscreen devices.
3269 The keypad is used to implement a virtual cursor, unless
3270 the device has an analog mouse type of input device (e.g. touchpad).
3271 This is the recommended setting for an application such as a web browser that
3272 needs pointer control on both touch and non-touch devices.
3273 \value NavigationModeCursorForceVisible The mouse cursor is used to change focus,
3274 it is displayed regardless of device type.
3275 The keypad is used to implement a virtual cursor, unless
3276 the device has an analog mouse type of input device (e.g. touchpad)
3277
3278 \note The Qt API that used this enum (\c QApplication::setNavigationMode(), \c QApplication::navigationMode())
3279 was deprecated in Qt 5.14 and removed in Qt 6.12.
3280*/
3281
3282/*!
3283 \enum Qt::CursorMoveStyle
3284
3285 This enum describes the movement style available to text cursors. The options
3286 are:
3287
3288 \value LogicalMoveStyle Within a left-to-right text block, decrease cursor
3289 position when pressing left arrow key, increase cursor position when pressing
3290 the right arrow key. If the text block is right-to-left, the opposite behavior
3291 applies.
3292 \value VisualMoveStyle Pressing the left arrow key will always cause the cursor
3293 to move left, regardless of the text's writing direction. Pressing the right
3294 arrow key will always cause the cursor to move right.
3295*/
3296
3297/*!
3298 \enum Qt::TimerType
3299
3300 The timer type indicates how accurate a timer can be.
3301
3302 \value PreciseTimer Precise timers try to keep millisecond accuracy
3303 \value CoarseTimer Coarse timers try to keep accuracy within 5% of the desired interval
3304 \value VeryCoarseTimer Very coarse timers only keep full second accuracy
3305
3306 On UNIX (including Linux, \macos, and iOS), Qt will keep millisecond accuracy
3307 for Qt::PreciseTimer. For Qt::CoarseTimer, the interval will be adjusted up
3308 to 5% to align the timer with other timers that are expected to fire at or
3309 around the same time. The objective is to make most timers wake up at the
3310 same time, thereby reducing CPU wakeups and power consumption.
3311
3312 On Windows, Qt will use Windows's Multimedia timer facility (if available)
3313 for Qt::PreciseTimer and normal Windows timers for Qt::CoarseTimer and
3314 Qt::VeryCoarseTimer.
3315
3316 On all platforms, the interval for Qt::VeryCoarseTimer is rounded to the
3317 nearest full second (e.g. an interval of 23500ms will be rounded to
3318 24000ms, and 20300ms to 20000ms).
3319*/
3320
3321/*!
3322 \enum Qt::TimerId
3323 \since 6.8
3324 \relates QObject
3325 \relates QTimer
3326 \relates QChronoTimer
3327
3328 This is used to represent timer IDs (for example, QTimer and QChronoTimer).
3329 The underlying type is \c int. You can use \l qToUnderlying() to convert
3330 Qt::TimerId to \c int.
3331
3332 \value Invalid Represents a no-op timer ID; its usage depends on the
3333 context, for example, this is the value returned by QObject::startTimer()
3334 to indicate it failed to start a timer; whereas QChronoTimer::id() returns
3335 this value when the timer is inactive, that is, \c timer.isActive()
3336 returns \c false.
3337
3338 \sa QTimer::id(), QChronoTimer::id(), QObject::startTimer()
3339*/
3340
3341/*!
3342 \enum Qt::ScrollPhase
3343 \since 5.2
3344
3345 This enum describes the phase of scrolling.
3346
3347 \value NoScrollPhase The input device doesn't support scroll phase.
3348 This value was introduced in Qt 5.7.
3349
3350 \value ScrollBegin Scrolling is about to begin, but the scrolling
3351 distance did not yet change.
3352
3353 \value ScrollUpdate The scrolling distance has changed (default).
3354
3355 \value ScrollEnd Scrolling has ended, and the scrolling distance
3356 did not change anymore.
3357
3358 \value ScrollMomentum The user no longer touches the input device,
3359 but scrolling continues due to scroll momentum.
3360 This value was introduced in Qt 5.12.
3361*/
3362
3363/*!
3364 \enum Qt::MouseEventSource
3365 \since 5.3
3366
3367 This enum describes the source of a mouse event and can be useful
3368 to determine if the event is an artificial mouse event originating
3369 from another device such as a touchscreen.
3370
3371 \value MouseEventNotSynthesized The most common value. On
3372 platforms where such information is available this value indicates
3373 that the event was generated in response to a genuine mouse event
3374 in the system.
3375
3376 \value MouseEventSynthesizedBySystem Indicates that the mouse
3377 event was synthesized from a touch event by the platform.
3378
3379 \value MouseEventSynthesizedByQt Indicates that the mouse event was
3380 synthesized from an unhandled touch event by Qt.
3381
3382 \value MouseEventSynthesizedByApplication Indicates that the mouse
3383 event was synthesized by the application. This allows
3384 distinguishing application-generated mouse events from the ones
3385 that are coming from the system or are synthesized by Qt. This
3386 value was introduced in Qt 5.6
3387
3388 \sa Qt::AA_SynthesizeMouseForUnhandledTouchEvents
3389*/
3390
3391/*!
3392 \enum Qt::MouseEventFlag
3393 \since 5.3
3394
3395 This enum provides additional information concerning a QMouseEvent.
3396
3397 \value MouseEventCreatedDoubleClick Indicates that Qt has created a
3398 \l {QEvent::MouseButtonDblClick}{MouseButtonDblClick} event from this event. The flag is set in the causing
3399 \l {QEvent::MouseButtonPress}{MouseButtonPress}, and not in the resulting \l {QEvent::MouseButtonDblClick}{MouseButtonDblClick}.
3400
3401 \omitvalue NoMouseEventFlag
3402 \omitvalue MouseEventFlagMask
3403*/
3404
3405/*!
3406 \enum Qt::ChecksumType
3407 \since 5.9
3408
3409 This enum describes the possible standards used by qChecksum().
3410
3411 \value ChecksumIso3309 Checksum calculation based on ISO 3309.
3412
3413 \value ChecksumItuV41 Checksum calculation based on ITU-V.41.
3414*/
3415
3416/*!
3417 \enum Qt::HighDpiScaleFactorRoundingPolicy
3418 \since 5.14
3419
3420 This enum describes the possible High-DPI scale factor rounding policies, which
3421 decide how non-integer scale factors (such as Windows 150%) are handled.
3422
3423 The active policy is set by calling QGuiApplication::setHighDpiScaleFactorRoundingPolicy() before
3424 the application object is created.
3425
3426 \sa QGuiApplication::setHighDpiScaleFactorRoundingPolicy()
3427
3428 \omitvalue Unset
3429 \value Round Round up for .5 and above.
3430 \value Ceil Always round up.
3431 \value Floor Always round down.
3432 \value RoundPreferFloor Round up for .75 and above.
3433 \value PassThrough Don't round.
3434*/
3435
3436/*!
3437 \enum Qt::PermissionStatus
3438
3439 This enum describes the possible statuses of a permissions.
3440
3441 \value Undetermined
3442 The permission status is not yet known. Permission should be requested
3443 via QCoreApplication::requestPermission() to determine the actual status.
3444 This status will never be the result of requesting a permission.
3445
3446 \value Granted
3447 The user has explicitly granted the application the permission,
3448 or the permission is known to not require user authorization on
3449 the given platform.
3450
3451 \value Denied
3452 The user has explicitly denied the application the requested permission,
3453 or the permission is known to not be accessible or applicable to applications
3454 on the given platform.
3455
3456 \note On Android, there is no \c Undetermined status by the platform's APIs.
3457 Thus, if a permission is denied for an app,
3458 \l QCoreApplication::checkPermission() returns \c Undetermined
3459 by default until \l QCoreApplication::requestPermission() is called.
3460 After that \l QCoreApplication::checkPermission() reports a non \c Undetermined
3461 status.
3462
3463 \since 6.5
3464 \sa QCoreApplication::requestPermission(), QCoreApplication::checkPermission(),
3465 {Application Permissions}
3466*/
3467
3468/*!
3469 \enum Qt::ReturnByValueConstant
3470 \since 5.15
3471
3472 This is a dummy type, designed to help users transition from certain deprecated APIs to their replacement APIs.
3473
3474 \omitvalue ReturnByValue
3475
3476 \sa QCursor::bitmap()
3477 \sa QCursor::mask()
3478 \sa QLabel::picture()
3479 \sa QLabel::pixmap()
3480*/
3481
3482/*!
3483 \class QKeyCombination
3484 \inmodule QtCore
3485 \since 6.0
3486 \brief The QKeyCombination class stores a combination of a key with optional modifiers.
3487
3488 \compares equality
3489
3490 The QKeyCombination class can be used to represent a combination of a key
3491 with zero or more keyboard modifiers.
3492
3493 \sa QKeySequence
3494*/
3495
3496/*!
3497 \fn QKeyCombination::QKeyCombination(Qt::Key key = Qt::Key_unknown) noexcept
3498
3499 Constructs a QKeyCombination object that represents the key \a key
3500 and no modifiers.
3501
3502 \sa key()
3503*/
3504
3505/*!
3506 \fn QKeyCombination::QKeyCombination(Qt::Modifiers modifiers, Qt::Key key = Qt::Key_unknown) noexcept
3507
3508 Constructs a QKeyCombination object that represents the combination
3509 of \a key with the modifiers \a modifiers.
3510
3511 \sa key(), keyboardModifiers()
3512*/
3513
3514/*!
3515 \fn QKeyCombination::QKeyCombination(Qt::KeyboardModifiers modifiers, Qt::Key key = Qt::Key_unknown) noexcept
3516
3517 Constructs a QKeyCombination object that represents the combination
3518 of \a key with the modifiers \a modifiers.
3519
3520 \sa key(), keyboardModifiers()
3521*/
3522
3523/*!
3524 \fn Qt::KeyboardModifiers QKeyCombination::keyboardModifiers() const noexcept
3525
3526 Returns the keyboard modifiers represented by this QKeyCombination object.
3527
3528 \sa key()
3529*/
3530
3531/*!
3532 \fn Qt::Key QKeyCombination::key() const noexcept
3533
3534 Returns the key represented by this QKeyCombination object.
3535
3536 \sa keyboardModifiers()
3537*/
3538
3539/*!
3540 \fn QKeyCombination QKeyCombination::fromCombined(int combined)
3541
3542 Constructs a QKeyCombination object by extracting the key and the
3543 modifiers out of \a combined, which must be the result of a bitwise
3544 OR between a value of type Qt::Key and value of type
3545 Qt::KeyboardModifiers. toCombined() can be used in order to produce
3546 valid values for \a combined.
3547
3548 \sa toCombined()
3549*/
3550
3551/*!
3552 \fn int QKeyCombination::toCombined() const noexcept
3553
3554 Returns an integer value obtained by applying a bitwise OR between
3555 the values of key() and keyboardModifiers() represented
3556 by this object. A QKeyCombination object can be created from the
3557 returned integer value by using fromCombined().
3558
3559 \sa fromCombined(), key(), keyboardModifiers()
3560*/
3561
3562#if QT_DEPRECATED_SINCE(6, 0)
3563/*!
3564 \fn QKeyCombination::operator int() const noexcept
3565 \deprecated [6.0]
3566
3567 Use toCombined() instead.
3568*/
3569#endif
3570
3571/*!
3572 \fn bool QKeyCombination::operator==(const QKeyCombination &lhs, const QKeyCombination &rhs)
3573
3574 Returns \c true if \a lhs and \a rhs have the same combination
3575 of key and modifiers, and \c false otherwise.
3576*/
3577
3578/*!
3579 \fn bool QKeyCombination::operator!=(const QKeyCombination &lhs, const QKeyCombination &rhs)
3580
3581 Returns \c true if \a lhs and \a rhs have different combinations
3582 of key and modifiers, otherwise \c false.
3583*/
3584
3585/*!
3586 \fn QKeyCombination Qt::operator|(Qt::Modifier modifier, Qt::Key key) noexcept
3587 \fn QKeyCombination Qt::operator|(Qt::KeyboardModifier modifier, Qt::Key key) noexcept
3588 \fn QKeyCombination Qt::operator|(Qt::Key key, Qt::Modifier modifier) noexcept
3589 \fn QKeyCombination Qt::operator|(Qt::Key key, Qt::KeyboardModifier modifier) noexcept
3590
3591 \relates QKeyCombination
3592
3593 Returns a QKeyCombination object that represents the combination
3594 of \a key with the modifier \a modifier.
3595*/
3596
3597/*!
3598 \fn QKeyCombination Qt::operator|(Qt::Modifiers modifiers, Qt::Key key) noexcept
3599 \fn QKeyCombination Qt::operator|(Qt::KeyboardModifiers modifiers, Qt::Key key) noexcept
3600 \fn QKeyCombination Qt::operator|(Qt::Key key, Qt::Modifiers modifiers) noexcept
3601 \fn QKeyCombination Qt::operator|(Qt::Key key, Qt::KeyboardModifiers modifiers) noexcept
3602
3603 \relates QKeyCombination
3604
3605 Returns a QKeyCombination object that represents the combination
3606 of \a key with the modifiers \a modifiers.
3607*/
3608
3609/*!
3610 \fn QKeyCombination Qt::operator+(Qt::Modifier modifier, Qt::Key key) noexcept
3611 \fn QKeyCombination Qt::operator+(Qt::KeyboardModifier modifier, Qt::Key key) noexcept
3612 \fn QKeyCombination Qt::operator+(Qt::Key key, Qt::Modifier modifier) noexcept
3613 \fn QKeyCombination Qt::operator+(Qt::Key key, Qt::KeyboardModifier modifier) noexcept
3614
3615 \relates QKeyCombination
3616 \deprecated [6.0]
3617
3618 Use operator| instead.
3619
3620 Returns a QKeyCombination object that represents the combination
3621 of \a key with the modifier \a modifier.
3622*/
3623
3624/*!
3625 \fn QKeyCombination Qt::operator+(Qt::Modifiers modifiers, Qt::Key key) noexcept
3626 \fn QKeyCombination Qt::operator+(Qt::KeyboardModifiers modifiers, Qt::Key key) noexcept
3627 \fn QKeyCombination Qt::operator+(Qt::Key key, Qt::Modifiers modifiers) noexcept
3628 \fn QKeyCombination Qt::operator+(Qt::Key key, Qt::KeyboardModifiers modifiers) noexcept
3629
3630 \relates QKeyCombination
3631 \deprecated [6.0]
3632
3633 Use operator| instead.
3634
3635 Returns a QKeyCombination object that represents the combination
3636 of \a key with the modifiers \a modifiers.
3637*/
3638
3639/*!
3640 \fn size_t qHash(QKeyCombination key, size_t seed = 0) noexcept
3641 \qhashold{QKeyCombination}
3642*/
3643
3644#ifndef QT_NO_DEBUG_STREAM
3645/*!
3646 \fn QDebug operator<<(QDebug debug, QKeyCombination combination)
3647 \relates QKeyCombination
3648
3649 Writes the combination \a combination into the debug object \a debug for
3650 debugging purposes.
3651
3652 \sa {Debugging Techniques}
3653*/
3654#endif
3655
3656#ifndef QT_NO_DATASTREAM
3657/*!
3658 \fn QDataStream &operator<<(QDataStream &out, QKeyCombination combination)
3659 \relates QKeyCombination
3660
3661 Writes the combination \a combination into the stream \a out.
3662 Returns \a out.
3663
3664 \sa {Serializing Qt Data Types}
3665*/
3666
3667/*!
3668 \fn QDataStream &operator>>(QDataStream &in, QKeyCombination &combination)
3669 \relates QKeyCombination
3670
3671 Reads the combination \a combination from the stream \a in.
3672 Returns \a in.
3673
3674 \sa {Serializing Qt Data Types}
3675*/
3676#endif