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