source: trunk/src/corelib/global/qnamespace.qdoc@ 651

Last change on this file since 651 was 651, checked in by Dmitry A. Kuminov, 15 years ago

trunk: Merged in qt 4.6.2 sources.

  • Property svn:eol-style set to native
File size: 109.6 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the documentation of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and Nokia.
15**
16** GNU Lesser General Public License Usage
17** Alternatively, this file may be used under the terms of the GNU Lesser
18** General Public License version 2.1 as published by the Free Software
19** Foundation and appearing in the file LICENSE.LGPL included in the
20** packaging of this file. Please review the following information to
21** ensure the GNU Lesser General Public License version 2.1 requirements
22** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23**
24** In addition, as a special exception, Nokia gives you certain additional
25** rights. These rights are described in the Nokia Qt LGPL Exception
26** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you have questions regarding the use of this file, please contact
37** Nokia at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42/*!
43 \namespace Qt
44 \inmodule QtCore
45
46 \brief The Qt namespace contains miscellaneous identifiers
47 used throughout the Qt library.
48*/
49
50/*!
51 \enum Qt::Orientation
52
53 This type is used to signify an object's orientation.
54
55 \value Horizontal
56 \value Vertical
57
58 Orientation is used with QScrollBar for example.
59*/
60
61/*!
62 \enum Qt::AlignmentFlag
63
64 This enum type is used to describe alignment. It contains
65 horizontal and vertical flags that can be combined to produce
66 the required effect.
67
68 The \l{TextElideMode} enum can also be used in many situations
69 to fine-tune the appearance of aligned text.
70
71 The horizontal flags are:
72
73 \value AlignLeft Aligns with the left edge.
74 \value AlignRight Aligns with the right edge.
75 \value AlignHCenter Centers horizontally in the available space.
76 \value AlignJustify Justifies the text in the available space.
77 \omitvalue AlignAuto
78
79 The vertical flags are:
80
81 \value AlignTop Aligns with the top.
82 \value AlignBottom Aligns with the bottom.
83 \value AlignVCenter Centers vertically in the available space.
84
85 You can use only one of the horizontal flags at a time. There is
86 one two-dimensional flag:
87
88 \value AlignCenter Centers in both dimensions.
89
90 You can use at most one horizontal and one vertical flag at a
91 time. Qt::AlignCenter counts as both horizontal and vertical.
92
93 Three enum values are useful in applications that can be run in
94 right-to-left mode:
95
96 \value AlignAbsolute If the widget's layout direction is
97 Qt::RightToLeft (instead of Qt::LeftToRight, the default),
98 Qt::AlignLeft refers to the \e right edge and Qt::AlignRight
99 to the \e left edge. This is normally the desired behavior.
100 If you want Qt::AlignLeft to always mean "left" and
101 Qt::AlignRight to always mean "right", combine the flag with
102 Qt::AlignAbsolute.
103 \value AlignLeading Synonym for Qt::AlignLeft.
104 \value AlignTrailing Synonym for Qt::AlignRight.
105
106 Masks:
107
108 \value AlignHorizontal_Mask
109 \value AlignVertical_Mask
110
111 Conflicting combinations of flags have undefined meanings.
112*/
113
114/*!
115 \enum Qt::ApplicationAttribute
116
117 This enum describes attributes that change the behavior of
118 application-wide features. These are enabled and disabled using
119 QCoreApplication::setAttribute(), and can be tested for with
120 QCoreApplication::testAttribute().
121
122 \value AA_ImmediateWidgetCreation Ensures that widgets are created
123 as soon as they are constructed. By default, resources for
124 widgets are allocated on demand to improve efficiency and
125 minimize resource usage. Setting or clearing this attribute
126 affects widgets constructed after the change. Setting it
127 tells Qt to create toplevel windows immediately.
128 Therefore, if it is important to minimize resource
129 consumption, do not set this attribute.
130
131 \value AA_MSWindowsUseDirect3DByDefault This value is obsolete and
132 has no effect.
133
134 \value AA_DontShowIconsInMenus Actions with the Icon property won't be
135 shown in any menus unless specifically set by the
136 QAction::iconVisibleInMenu property.
137 Menus that are currently open or menus already created in the native
138 Mac OS X menubar \e{may not} pick up a change in this attribute. Changes
139 in the QAction::iconVisibleInMenu property will always be picked up.
140
141 \value AA_NativeWindows Ensures that widgets have native windows.
142
143 \value AA_DontCreateNativeWidgetSiblings Ensures that siblings of native
144 widgets stay non-native unless specifically set by the
145 Qt::WA_NativeWindow attribute.
146
147 \value AA_MacPluginApplication Stops the Qt mac application from doing
148 specific initializations that do not necessarily make sense when using Qt
149 to author a plugin. This includes avoiding loading our nib for the main
150 menu and not taking possession of the native menu bar. When setting this
151 attribute to true will also set the AA_DontUseNativeMenuBar attribute
152 to true.
153
154 \value AA_DontUseNativeMenuBar All menubars created while this attribute is
155 set to true won't be used as a native menubar (e.g, the menubar at
156 the top of the main screen on Mac OS X or at the bottom in Windows CE).
157
158 \value AA_MacDontSwapCtrlAndMeta On Mac OS X by default, Qt swaps the
159 Control and Meta (Command) keys (i.e., whenever Control is pressed, Qt
160 sends Meta and whenever Meta is pressed Control is sent. When this
161 attribute is true, Qt will not do the flip. QKeySequence::StandardShortcuts
162 will also flip accordingly (i.e., QKeySequence::Copy will be
163 Command+C on the keyboard regardless of the value set, though what is output for
164 QKeySequence::toString(QKeySequence::PortableText) will be different).
165
166 \value AA_S60DontConstructApplicationPanes Stops Qt from initializing the S60 status
167 pane and softkey pane on Symbian. This is useful to save memory and reduce
168 startup time for applications that will run in fullscreen mode during their
169 whole lifetime. This attribute must be set before QApplication is
170 constructed.
171
172 \omitvalue AA_AttributeCount
173*/
174
175/*!
176 \enum Qt::MouseButton
177
178 This enum type describes the different mouse buttons.
179
180 \value NoButton The button state does not refer to any
181 button (see QMouseEvent::button()).
182 \value LeftButton The left button is pressed, or an event refers
183 to the left button. (The left button may be the right button on
184 left-handed mice.)
185 \value RightButton The right button.
186 \value MidButton The middle button.
187 \value XButton1 The first X button.
188 \value XButton2 The second X button.
189
190 \omitvalue MouseButtonMask
191
192 \sa KeyboardModifier Modifier
193*/
194
195/*!
196 \enum Qt::KeyboardModifier
197
198 This enum describes the modifier keys.
199
200 \value NoModifier No modifier key is pressed.
201 \value ShiftModifier A Shift key on the keyboard is pressed.
202 \value ControlModifier A Ctrl key on the keyboard is pressed.
203 \value AltModifier An Alt key on the keyboard is pressed.
204 \value MetaModifier A Meta key on the keyboard is pressed.
205 \value KeypadModifier A keypad button is pressed.
206 \value GroupSwitchModifier X11 only. A Mode_switch key on the keyboard is pressed.
207
208 \omitvalue KeyboardModifierMask
209
210 \note On Mac OS X, the \c ControlModifier value corresponds to
211 the Command keys on the Macintosh keyboard, and the \c MetaModifier value
212 corresponds to the Control keys. The \c KeypadModifier value will also be set
213 when an arrow key is pressed as the arrow keys are considered part of the
214 keypad.
215
216 \note On Windows Keyboards, Qt::MetaModifier and Qt::Key_Meta are mapped
217 to the Windows key.
218
219 \sa MouseButton Modifier
220*/
221
222/*!
223 \enum Qt::Modifier
224
225 This enum provides shorter names for the keyboard modifier keys
226 supported by Qt.
227
228 \bold{Note:} On Mac OS X, the \c CTRL value corresponds to
229 the Command keys on the Macintosh keyboard, and the \c META value
230 corresponds to the Control keys.
231
232 \value SHIFT The Shift keys provided on all standard keyboards.
233 \value META The Meta keys.
234 \value CTRL The Ctrl keys.
235 \value ALT The normal Alt keys, but not keys like AltGr.
236 \value UNICODE_ACCEL The shortcut is specified as a Unicode code
237 point, not as a Qt Key.
238 \omitvalue MODIFIER_MASK
239
240 \sa KeyboardModifier MouseButton
241*/
242
243/*!
244 \enum Qt::GlobalColor
245
246 \raw HTML
247 <style type="text/css" id="colorstyles">
248 #white { background-color: #ffffff; color: #000000 }
249 #black { background-color: #000000; color: #ffffff }
250 #red { background-color: #ff0000; color: #000000 }
251 #darkRed { background-color: #800000; color: #ffffff }
252 #green { background-color: #00ff00; color: #000000 }
253 #darkGreen { background-color: #008000; color: #ffffff }
254 #blue { background-color: #0000ff; color: #ffffff }
255 #darkBlue { background-color: #000080; color: #ffffff }
256 #cyan { background-color: #00ffff; color: #000000 }
257 #darkCyan { background-color: #008080; color: #ffffff }
258 #magenta { background-color: #ff00ff; color: #000000 }
259 #darkMagenta { background-color: #800080; color: #ffffff }
260 #yellow { background-color: #ffff00; color: #000000 }
261 #darkYellow { background-color: #808000; color: #ffffff }
262 #gray { background-color: #a0a0a4; color: #000000 }
263 #darkGray { background-color: #808080; color: #ffffff }
264 #lightGray { background-color: #c0c0c0; color: #000000 }
265 </style>
266 \endraw
267
268 Qt's predefined QColor objects:
269
270 \value white \raw HTML
271 White <tt id="white">(#ffffff)</tt>
272 \endraw
273 \value black \raw HTML
274 Black <tt id="black">(#000000)</tt>
275 \endraw
276 \value red \raw HTML
277 Red <tt id="red">(#ff0000)</tt>
278 \endraw
279 \value darkRed \raw HTML
280 Dark red <tt id="darkRed">(#800000)</tt>
281 \endraw
282 \value green \raw HTML
283 Green <tt id="green">(#00ff00)</tt>
284 \endraw
285 \value darkGreen \raw HTML
286 Dark green <tt id="darkGreen">(#008000)</tt>
287 \endraw
288 \value blue \raw HTML
289 Blue <tt id="blue">(#0000ff)</tt>
290 \endraw
291 \value darkBlue \raw HTML
292 Dark blue <tt id="darkBlue">(#000080)</tt>
293 \endraw
294 \value cyan \raw HTML
295 Cyan <tt id="cyan">(#00ffff)</tt>
296 \endraw
297 \value darkCyan \raw HTML
298 Dark cyan <tt id="darkCyan">(#008080)</tt>
299 \endraw
300 \value magenta \raw HTML
301 Magenta <tt id="magenta">(#ff00ff)</tt>
302 \endraw
303 \value darkMagenta \raw HTML
304 Dark magenta <tt id="darkMagenta">(#800080)</tt>
305 \endraw
306 \value yellow \raw HTML
307 Yellow <tt id="yellow">(#ffff00)</tt>
308 \endraw
309 \value darkYellow \raw HTML
310 Dark yellow <tt id="darkYellow">(#808000)</tt>
311 \endraw
312 \value gray \raw HTML
313 Gray <tt id="gray">(#a0a0a4)</tt>
314 \endraw
315 \value darkGray \raw HTML
316 Dark gray <tt id="darkGray">(#808080)</tt>
317 \endraw
318 \value lightGray \raw HTML
319 Light gray <tt id="lightGray">(#c0c0c0)</tt>
320 \endraw
321 \value transparent a transparent black value (i.e., QColor(0, 0, 0, 0))
322 \value color0 0 pixel value (for bitmaps)
323 \value color1 1 pixel value (for bitmaps)
324
325 \sa QColor
326
327*/
328
329/*!
330 \enum Qt::PenStyle
331
332 This enum type defines the pen styles that can be drawn using
333 QPainter. The styles are:
334
335 \table
336 \row
337 \o \inlineimage qpen-solid.png
338 \o \inlineimage qpen-dash.png
339 \o \inlineimage qpen-dot.png
340 \row
341 \o Qt::SolidLine
342 \o Qt::DashLine
343 \o Qt::DotLine
344 \row
345 \o \inlineimage qpen-dashdot.png
346 \o \inlineimage qpen-dashdotdot.png
347 \o \inlineimage qpen-custom.png
348 \row
349 \o Qt::DashDotLine
350 \o Qt::DashDotDotLine
351 \o Qt::CustomDashLine
352 \endtable
353
354 \value NoPen no line at all. For example, QPainter::drawRect()
355 fills but does not draw any boundary line.
356
357 \value SolidLine A plain line.
358 \value DashLine Dashes separated by a few pixels.
359 \value DotLine Dots separated by a few pixels.
360 \value DashDotLine Alternate dots and dashes.
361 \value DashDotDotLine One dash, two dots, one dash, two dots.
362 \value CustomDashLine A custom pattern defined using
363 QPainterPathStroker::setDashPattern().
364
365 \omitvalue MPenStyle
366
367 \sa QPen
368*/
369
370/*!
371 \enum Qt::PenCapStyle
372
373 This enum type defines the pen cap styles supported by Qt, i.e.
374 the line end caps that can be drawn using QPainter.
375
376 \table
377 \row
378 \o \inlineimage qpen-square.png
379 \o \inlineimage qpen-flat.png
380 \o \inlineimage qpen-roundcap.png
381 \row
382 \o Qt::SquareCap
383 \o Qt::FlatCap
384 \o Qt::RoundCap
385 \endtable
386
387 \value FlatCap a square line end that does not cover the end
388 point of the line.
389 \value SquareCap a square line end that covers the end point and
390 extends beyond it by half the line width.
391 \value RoundCap a rounded line end.
392 \omitvalue MPenCapStyle
393
394 \sa QPen
395*/
396
397/*!
398 \enum Qt::PenJoinStyle
399
400 This enum type defines the pen join styles supported by Qt, i.e.
401 which joins between two connected lines can be drawn using
402 QPainter.
403
404 \table
405 \row
406 \o \inlineimage qpen-bevel.png
407 \o \inlineimage qpen-miter.png
408 \o \inlineimage qpen-roundjoin.png
409 \row
410 \o Qt::BevelJoin
411 \o Qt::MiterJoin
412 \o Qt::RoundJoin
413 \endtable
414
415 \value MiterJoin The outer edges of the lines are extended to
416 meet at an angle, and this area is filled.
417 \value BevelJoin The triangular notch between the two lines is filled.
418 \value RoundJoin A circular arc between the two lines is filled.
419 \value SvgMiterJoin A miter join corresponding to the definition of
420 a miter join in the \l{SVG 1.2 Tiny} specification.
421 \omitvalue MPenJoinStyle
422
423 \sa QPen
424*/
425
426/*!
427 \enum Qt::BrushStyle
428
429 This enum type defines the brush styles supported by Qt, i.e. the
430 fill pattern of shapes drawn using QPainter.
431
432 \image brush-styles.png Brush Styles
433
434 \value NoBrush No brush pattern.
435 \value SolidPattern Uniform color.
436 \value Dense1Pattern Extremely dense brush pattern.
437 \value Dense2Pattern Very dense brush pattern.
438 \value Dense3Pattern Somewhat dense brush pattern.
439 \value Dense4Pattern Half dense brush pattern.
440 \value Dense5Pattern Somewhat sparse brush pattern.
441 \value Dense6Pattern Very sparse brush pattern.
442 \value Dense7Pattern Extremely sparse brush pattern.
443 \value HorPattern Horizontal lines.
444 \value VerPattern Vertical lines.
445 \value CrossPattern Crossing horizontal and vertical lines.
446 \value BDiagPattern Backward diagonal lines.
447 \value FDiagPattern Forward diagonal lines.
448 \value DiagCrossPattern Crossing diagonal lines.
449 \value LinearGradientPattern Linear gradient (set using a dedicated QBrush constructor).
450 \value ConicalGradientPattern Conical gradient (set using a dedicated QBrush constructor).
451 \value RadialGradientPattern Radial gradient (set using a dedicated QBrush constructor).
452 \value TexturePattern Custom pattern (see QBrush::setTexture()).
453
454 \omitvalue CustomPattern
455
456 \sa QBrush
457*/
458
459/*!
460 \enum Qt::TextFlag
461
462 This enum type is used to define some modifier flags. Some of
463 these flags only make sense in the context of printing:
464
465 \value TextSingleLine Treats all whitespace as spaces and prints just
466 one line.
467 \value TextDontClip If it's impossible to stay within the given bounds,
468 it prints outside.
469 \value TextExpandTabs Makes the U+0009 (ASCII tab) character move to
470 the next tab stop.
471 \value TextShowMnemonic Displays the string "\&P" as \underline{P}
472 (see QButton for an example). For an ampersand, use "\&\&".
473 \value TextWordWrap Breaks lines at appropriate points, e.g. at word
474 boundaries.
475 \value TextWrapAnywhere Breaks lines anywhere, even within words.
476 \value TextHideMnemonic Same as Qt::TextShowMnemonic but doesn't draw the underlines.
477 \value TextDontPrint Treat this text as "hidden" and don't print
478 it.
479 \value IncludeTrailingSpaces When this option is set, QTextLine::naturalTextWidth() and naturalTextRect() will
480 return a value that includes the width of trailing spaces in the text; otherwise
481 this width is excluded.
482 \value TextIncludeTrailingSpaces Same as IncludeTrailingSpaces
483 \value TextJustificationForced Ensures that text lines are justified.
484
485 \omitvalue BreakAnywhere
486 \omitvalue DontClip
487 \omitvalue DontPrint
488 \omitvalue ExpandTabs
489 \omitvalue IncludeTrailingSpaces
490 \omitvalue NoAccel
491 \omitvalue ShowPrefix
492 \omitvalue SingleLine
493 \omitvalue WordBreak
494 \omitvalue TextForceLeftToRight
495 \omitvalue TextForceRightToLeft
496 \omitvalue TextLongestVariant Always use the longest variant when computing the size of a multi-variant string
497
498 You can use as many modifier flags as you want, except that
499 Qt::TextSingleLine and Qt::TextWordWrap cannot be combined.
500
501 Flags that are inappropriate for a given use are generally
502 ignored.
503*/
504
505/*!
506 \enum Qt::BGMode
507
508 Background mode:
509
510 \value TransparentMode
511 \value OpaqueMode
512*/
513
514/*!
515 \enum Qt::ConnectionType
516
517 This enum describes the types of connection that can be used
518 between signals and slots. In particular, it determines whether a
519 particular signal is delivered to a slot immediately or queued for
520 delivery at a later time.
521
522 \value AutoConnection
523 (default) Same as DirectConnection, if the emitter and
524 receiver are in the same thread. Same as QueuedConnection,
525 if the emitter and receiver are in different threads.
526
527 \value DirectConnection
528 The slot is invoked immediately, when the signal is
529 emitted.
530
531 \value QueuedConnection
532 The slot is invoked when control returns to the event loop
533 of the receiver's thread. The slot is executed in the
534 receiver's thread.
535
536 \value BlockingQueuedConnection
537 Same as QueuedConnection, except the current thread blocks
538 until the slot returns. This connection type should only be
539 used where the emitter and receiver are in different
540 threads. \note Violating this rule can cause your
541 application to deadlock.
542
543 \value UniqueConnection
544 Same as AutoConnection, but the connection is made only if
545 it does not duplicate an existing connection. i.e., if the
546 same signal is already connected to the same slot for the
547 same pair of objects, then the connection will fail. This
548 connection type was introduced in Qt 4.6.
549
550 \value AutoCompatConnection
551 The default type when Qt 3 support is enabled. Same as
552 AutoConnection but will also cause warnings to be output in
553 certain situations. See \l{Porting to Qt 4#Compatibility
554 Signals and Slots}{Compatibility Signals and Slots} for
555 further information.
556
557 With queued connections, the parameters must be of types that are
558 known to Qt's meta-object system, because Qt needs to copy the
559 arguments to store them in an event behind the scenes. If you try
560 to use a queued connection and get the error message:
561
562 \snippet doc/src/snippets/code/doc_src_qnamespace.qdoc 0
563
564 Call qRegisterMetaType() to register the data type before you
565 establish the connection.
566
567 When using signals and slots with multiple threads, see \l{Signals and Slots Across Threads}.
568
569 \sa {Thread Support in Qt}, QObject::connect(), qRegisterMetaType()
570*/
571
572/*!
573 \enum Qt::DateFormat
574
575 \value TextDate The default Qt format, which includes the day and month name,
576 the day number in the month, and the year in full. The day and month names will
577 be short, localized names. This is basically equivalent to using the date format
578 string, "ddd MMM d yyyy". See QDate::toString() for more information.
579
580 \value ISODate ISO 8601 extended format: either \c{YYYY-MM-DD} for dates or
581 \c{YYYY-MM-DDTHH:MM:SS} for combined dates and times.
582
583 \value SystemLocaleShortDate The \l{QLocale::ShortFormat}{short format} used
584 by the \l{QLocale::system()}{operating system}.
585
586 \value SystemLocaleLongDate The \l{QLocale::LongFormat}{long format} used
587 by the \l{QLocale::system()}{operating system}.
588
589 \value DefaultLocaleShortDate The \l{QLocale::ShortFormat}{short format} specified
590 by the \l{QLocale::setDefault()}{application's locale}.
591
592 \value DefaultLocaleLongDate The \l{QLocale::LongFormat}{long format} used
593 by the \l{QLocale::setDefault()}{application's locale}.
594
595 \value SystemLocaleDate \e{This enum value is deprecated.} Use Qt::SystemLocaleShortDate
596 instead (or Qt::SystemLocaleLongDate if you want long dates).
597
598 \value LocaleDate \e{This enum value is deprecated.} Use Qt::DefaultLocaleShortDate
599 instead (or Qt::DefaultLocaleLongDate if you want long dates).
600
601 \value LocalDate \e{This enum value is deprecated.} Use Qt::SystemLocaleShortDate
602 instead (or Qt::SystemLocaleLongDate if you want long dates).
603
604 \note For \c ISODate formats, each \c Y, \c M and \c D represents a single digit
605 of the year, month and day used to specify the date. Each \c H, \c M and \c S
606 represents a single digit of the hour, minute and second used to specify the time.
607 The presence of a literal \c T character is used to separate the date and time when
608 both are specified.
609*/
610
611
612/*!
613 \enum Qt::TimeSpec
614
615 \value LocalTime Locale dependent time (Timezones and Daylight Savings Time).
616 \value UTC Coordinated Universal Time, replaces Greenwich Mean Time.
617 \value OffsetFromUTC An offset in seconds from Coordinated Universal Time.
618*/
619
620/*!
621 \enum Qt::DayOfWeek
622
623 \value Monday
624 \value Tuesday
625 \value Wednesday
626 \value Thursday
627 \value Friday
628 \value Saturday
629 \value Sunday
630*/
631
632/*!
633 \enum Qt::CaseSensitivity
634
635 \value CaseInsensitive
636 \value CaseSensitive
637*/
638
639/*!
640 \enum Qt::ToolBarArea
641
642 \value LeftToolBarArea
643 \value RightToolBarArea
644 \value TopToolBarArea
645 \value BottomToolBarArea
646 \value AllToolBarAreas
647 \value NoToolBarArea
648
649 \omitvalue ToolBarArea_Mask
650*/
651
652/*!
653 \enum Qt::DockWidgetArea
654
655 \value LeftDockWidgetArea
656 \value RightDockWidgetArea
657 \value TopDockWidgetArea
658 \value BottomDockWidgetArea
659 \value AllDockWidgetAreas
660 \value NoDockWidgetArea
661
662 \omitvalue DockWidgetArea_Mask
663*/
664
665/*!
666 \enum Qt::BackgroundMode
667
668 \compat
669
670 \value FixedColor
671 \value FixedPixmap
672 \value NoBackground
673 \value PaletteForeground
674 \value PaletteButton
675 \value PaletteLight
676 \value PaletteMidlight
677 \value PaletteDark
678 \value PaletteMid
679 \value PaletteText
680 \value PaletteBrightText
681 \value PaletteBase
682 \value PaletteBackground
683 \value PaletteShadow
684 \value PaletteHighlight
685 \value PaletteHighlightedText
686 \value PaletteButtonText
687 \value PaletteLink
688 \value PaletteLinkVisited
689 \value X11ParentRelative
690*/
691
692/*!
693 \enum Qt::ImageConversionFlag
694
695 The options marked "(default)" are set if no other values from
696 the list are included (since the defaults are zero):
697
698 Color/Mono preference (ignored for QBitmap):
699
700 \value AutoColor (default) - If the image has \link
701 QImage::depth() depth\endlink 1 and contains only
702 black and white pixels, the pixmap becomes monochrome.
703 \value ColorOnly The pixmap is dithered/converted to the
704 \link QPixmap::defaultDepth() native display depth\endlink.
705 \value MonoOnly The pixmap becomes monochrome. If necessary,
706 it is dithered using the chosen dithering algorithm.
707
708 Dithering mode preference for RGB channels:
709
710 \value DiffuseDither (default) - A high-quality dither.
711 \value OrderedDither A faster, more ordered dither.
712 \value ThresholdDither No dithering; closest color is used.
713
714 Dithering mode preference for alpha channel:
715
716 \value ThresholdAlphaDither (default) - No dithering.
717 \value OrderedAlphaDither A faster, more ordered dither.
718 \value DiffuseAlphaDither A high-quality dither.
719 \omitvalue NoAlpha
720
721 Color matching versus dithering preference:
722
723 \value PreferDither (default when converting to a pixmap) - Always dither
724 32-bit images when the image is converted to 8 bits.
725 \value AvoidDither (default when converting for the purpose of saving to
726 file) - Dither 32-bit images only if the image has more than 256
727 colors and it is being converted to 8 bits.
728 \omitvalue AutoDither
729
730 \omitvalue ColorMode_Mask
731 \omitvalue Dither_Mask
732 \omitvalue AlphaDither_Mask
733 \omitvalue DitherMode_Mask
734
735 \value NoOpaqueDetection Do not check whether the image contains non-opaque
736 pixels. Use this if you know that the image is semi-transparent and
737 you want to avoid the overhead of checking the pixels in the image
738 until a non-opaque pixel is found, or if you want the pixmap to
739 retain an alpha channel for some other reason. If the image has no
740 alpha channel this flag has no effect.
741*/
742
743/*! \enum Qt::GUIStyle
744
745 \compat
746
747 \value WindowsStyle
748 \value MotifStyle
749 \value MacStyle
750 \value Win3Style
751 \value PMStyle
752*/
753
754/*!
755 \enum Qt::UIEffect
756
757 This enum describes the available UI effects.
758
759 By default, Qt will try to use the platform specific desktop
760 settings for each effect. Use the
761 QApplication::setDesktopSettingsAware() function (passing \c false
762 as argument) to prevent this, and the
763 QApplication::setEffectEnabled() to enable or disable a particular
764 effect.
765
766 Note that all effects are disabled on screens running at less than
767 16-bit color depth.
768
769 \omitvalue UI_General
770
771 \value UI_AnimateMenu Show animated menus.
772 \value UI_FadeMenu Show faded menus.
773 \value UI_AnimateCombo Show animated comboboxes.
774 \value UI_AnimateTooltip Show tooltip animations.
775 \value UI_FadeTooltip Show tooltip fading effects.
776 \value UI_AnimateToolBox Reserved
777
778 \sa QApplication::setEffectEnabled(), QApplication::setDesktopSettingsAware()
779*/
780
781/*! \enum Qt::AspectRatioMode
782
783 This enum type defines what happens to the aspect ratio when
784 scaling an rectangle.
785
786 \image qimage-scaling.png
787
788 \value IgnoreAspectRatio The size is scaled freely. The aspect
789 ratio is not preserved.
790 \value KeepAspectRatio The size is scaled to a rectangle as
791 large as possible inside a given
792 rectangle, preserving the aspect ratio.
793 \value KeepAspectRatioByExpanding The size is scaled to a
794 rectangle as small as possible
795 outside a given rectangle,
796 preserving the aspect ratio.
797
798 \omitvalue ScaleFree
799 \omitvalue ScaleMin
800 \omitvalue ScaleMax
801
802 \sa QSize::scale(), QImage::scaled()
803*/
804
805/*! \typedef Qt::ScaleMode
806 \compat
807
808 Use Qt::AspectRatioMode instead.
809
810 The enum values have been renamed as follows:
811
812 \table
813 \row \i Old enum value \i New enum value
814 \row \i Qt::ScaleFree \i Qt::IgnoreAspectRatio
815 \row \i Qt::ScaleMin \i Qt::KeepAspectRatio
816 \row \i Qt::ScaleMax \i Qt::KeepAspectRatioByExpanding
817 \endtable
818*/
819
820/*! \enum Qt::TransformationMode
821
822 This enum type defines whether image transformations (e.g.,
823 scaling) should be smooth or not.
824
825 \value FastTransformation The transformation is performed
826 quickly, with no smoothing.
827 \value SmoothTransformation The resulting image is transformed
828 using bilinear filtering.
829
830 \sa QImage::scaled()
831*/
832
833/*! \enum Qt::Axis
834
835 This enum type defines three values to represent the three
836 axes in the cartesian coordinate system.
837
838 \value XAxis The X axis.
839 \value YAxis The Y axis.
840 \value ZAxis The Z axis.
841
842 \sa QTransform::rotate(), QTransform::rotateRadians()
843 */
844
845/*!
846 \enum Qt::WidgetAttribute
847
848 \keyword widget attributes
849
850 This enum type is used to specify various widget attributes.
851 Attributes are set and cleared with QWidget::setAttribute(), and
852 queried with QWidget::testAttribute(), although some have special
853 convenience functions which are mentioned below.
854
855 \value WA_AcceptDrops Allows data from drag and drop operations
856 to be dropped onto the widget (see QWidget::setAcceptDrops()).
857
858 \value WA_AlwaysShowToolTips Enables tooltips for inactive windows.
859
860 \value WA_ContentsPropagated This flag is superfluous and
861 obsolete; it no longer has any effect. Since Qt 4.1, all widgets
862 that do not set WA_PaintOnScreen propagate their contents.
863
864 \value WA_CustomWhatsThis Indicates that the widget wants to
865 continue operating normally in "What's This?" mode. This is set by the
866 widget's author.
867
868 \value WA_DeleteOnClose Makes Qt delete this widget when the
869 widget has accepted the close event (see QWidget::closeEvent()).
870
871 \value WA_Disabled Indicates that the widget is disabled, i.e.
872 it does not receive any mouse or keyboard events. There is also a
873 getter functions QWidget::isEnabled(). This is set/cleared by the
874 Qt kernel.
875
876 \value WA_DontShowOnScreen Indicates that the widget is hidden or is
877 not a part of the viewable Desktop.
878
879 \omitvalue WA_DropSiteRegistered
880 \omitvalue WA_ForceAcceptDrops
881
882 \value WA_ForceDisabled Indicates that the widget is
883 explicitly disabled, i.e. it will remain disabled even when all
884 its ancestors are set to the enabled state. This implies
885 WA_Disabled. This is set/cleared by QWidget::setEnabled() and
886 QWidget::setDisabled().
887
888 \value WA_ForceUpdatesDisabled Indicates that updates are
889 explicitly disabled for the widget; i.e. it will remain disabled
890 even when all its ancestors are set to the updates-enabled state.
891 This implies WA_UpdatesDisabled. This is set/cleared by
892 QWidget::setUpdatesEnabled().
893
894 \value WA_GroupLeader
895 \e{This attribute has been deprecated.} Use QWidget::windowModality
896 instead.
897
898 \value WA_Hover Forces Qt to generate paint events when the mouse
899 enters or leaves the widget. This feature is typically used when
900 implementing custom styles; see the \l{widgets/styles}{Styles}
901 example for details.
902
903 \value WA_InputMethodEnabled Enables input methods for Asian languages.
904 Must be set when creating custom text editing widgets.
905 On Windows CE and Symbian this flag can be used in addition to
906 QApplication::autoSipEnabled to automatically display the SIP when
907 entering a widget.
908
909 \value WA_KeyboardFocusChange Set on a toplevel window when
910 the users changes focus with the keyboard (tab, backtab, or shortcut).
911
912 \value WA_KeyCompression Enables key event compression if set,
913 and disables it if not set. By default key compression is off, so
914 widgets receive one key press event for each key press (or more,
915 since autorepeat is usually on). If you turn it on and your
916 program doesn't keep up with key input, Qt may try to compress key
917 events so that more than one character can be processed in each
918 event.
919 For example, a word processor widget might receive 2, 3 or more
920 characters in each QKeyEvent::text(), if the layout recalculation
921 takes too long for the CPU.
922 If a widget supports multiple character unicode input, it is
923 always safe to turn the compression on.
924 Qt performs key event compression only for printable characters.
925 Qt::Modifier keys, cursor movement keys, function keys and
926 miscellaneous action keys (e.g. Escape, Enter, Backspace,
927 PrintScreen) will stop key event compression, even if there are
928 more compressible key events available.
929 Platforms other than Mac and X11 do not support this compression,
930 in which case turning it on will have no effect.
931 This is set/cleared by the widget's author.
932
933 \value WA_LayoutOnEntireRect Indicates that the widget
934 wants QLayout to operate on the entire QWidget::rect(), not only
935 on QWidget::contentsRect(). This is set by the widget's author.
936
937 \value WA_LayoutUsesWidgetRect Ignore the layout item rect from the style
938 when laying out this widget with QLayout. This makes a difference in
939 QMacStyle and QPlastiqueStyle for some widgets.
940
941 \value WA_MacNoClickThrough When a widget that has this attribute set
942 is clicked, and its window is inactive, the click will make the window
943 active but won't be seen by the widget. Typical use of this attribute
944 is on widgets with "destructive" actions, such as a "Delete" button.
945 WA_MacNoClickThrough also applies to all child widgets of the widget
946 that has it set.
947
948 \value WA_MacOpaqueSizeGrip Indicates that the native Carbon size grip
949 should be opaque instead of transparent (the default). This attribute
950 is only applicable to Mac OS X and is set by the widget's author.
951
952 \value WA_MacShowFocusRect Indicates that this widget should get a
953 QFocusFrame around it. Some widgets draw their own focus halo
954 regardless of this attribute. Not that the QWidget::focusPolicy
955 also plays the main role in whether something is given focus or
956 not, this only controls whether or not this gets the focus
957 frame. This attribute is only applicable to Mac OS X.
958
959 \value WA_MacNormalSize Indicates the widget should have the
960 normal size for widgets in Mac OS X. This attribute is only
961 applicable to Mac OS X.
962
963 \value WA_MacSmallSize Indicates the widget should have the small
964 size for widgets in Mac OS X. This attribute is only applicable to
965 Mac OS X.
966
967 \value WA_MacMiniSize Indicates the widget should have the mini
968 size for widgets in Mac OS X. This attribute is only applicable to
969 Mac OS X.
970
971 \value WA_MacVariableSize Indicates the widget can choose between
972 alternative sizes for widgets to avoid clipping.
973 This attribute is only applicable to Mac OS X.
974
975 \value WA_MacBrushedMetal Indicates the widget should be drawn in
976 the brushed metal style as supported by the windowing system. This
977 attribute is only applicable to Mac OS X.
978
979 \omitvalue WA_MacMetalStyle
980
981 \value WA_Mapped Indicates that the widget is mapped on screen.
982 This is set/cleared by the Qt kernel.
983
984 \value WA_MouseNoMask Makes the widget receive mouse events for
985 the entire widget regardless of the currently set mask,
986 overriding QWidget::setMask(). This is not applicable for
987 top-level windows.
988
989 \value WA_MouseTracking Indicates that the widget has mouse
990 tracking enabled. See QWidget::mouseTracking.
991
992 \value WA_Moved Indicates that the widget has an explicit
993 position. This is set/cleared by QWidget::move() and
994 by QWidget::setGeometry().
995
996 \value WA_MSWindowsUseDirect3D This value is obsolete and has no
997 effect.
998
999 \value WA_NoBackground This value is obsolete. Use
1000 WA_OpaquePaintEvent instead.
1001
1002 \value WA_NoChildEventsForParent Indicates that the widget does
1003 not want ChildAdded or ChildRemoved events sent to its
1004 parent. This is rarely necessary but can help to avoid automatic
1005 insertion widgets like splitters and layouts. This is set by a
1006 widget's author.
1007
1008 \value WA_NoChildEventsFromChildren Indicates that the widget does
1009 not want to receive ChildAdded or ChildRemoved events sent from its
1010 children. This is set by a widget's author.
1011
1012 \value WA_NoMouseReplay Used for pop-up widgets. Indicates that the most
1013 recent mouse press event should not be replayed when the pop-up widget
1014 closes. The flag is set by the widget's author and cleared by the Qt kernel
1015 every time the widget receives a new mouse event.
1016
1017 \value WA_NoMousePropagation Prohibits mouse events from being propagated
1018 to the widget's parent. This attribute is disabled by default.
1019
1020 \value WA_TransparentForMouseEvents When enabled, this attribute disables
1021 the delivery of mouse events to the widget and its children. Mouse events
1022 are delivered to other widgets as if the widget and its children were not
1023 present in the widget hierarchy; mouse clicks and other events effectively
1024 "pass through" them. This attribute is disabled by default.
1025
1026 \value WA_NoSystemBackground Indicates that the widget has no background,
1027 i.e. when the widget receives paint events, the background is not
1028 automatically repainted. \note Unlike WA_OpaquePaintEvent, newly exposed
1029 areas are \bold never filled with the background (e.g., after showing a
1030 window for the first time the user can see "through" it until the
1031 application processes the paint events). This flag is set or cleared by the
1032 widget's author.
1033
1034 \value WA_OpaquePaintEvent Indicates that the widget paints all its pixels
1035 when it receives a paint event. Thus, it is not required for operations
1036 like updating, resizing, scrolling and focus changes to erase the widget
1037 before generating paint events. The use of WA_OpaquePaintEvent provides a
1038 small optimization by helping to reduce flicker on systems that do not
1039 support double buffering and avoiding computational cycles necessary to
1040 erase the background prior to painting. \note Unlike
1041 WA_NoSystemBackground, WA_OpaquePaintEvent makes an effort to avoid
1042 transparent window backgrounds. This flag is set or cleared by the widget's
1043 author.
1044
1045 \value WA_OutsideWSRange Indicates that the widget is outside
1046 the valid range of the window system's coordinate system. A widget
1047 outside the valid range cannot be mapped on screen. This is
1048 set/cleared by the Qt kernel.
1049
1050 \value WA_PaintOnScreen Indicates that the widget wants to draw directly
1051 onto the screen. Widgets with this attribute set do not participate in
1052 composition management, i.e. they cannot be semi-transparent or shine
1053 through semi-transparent overlapping widgets. \note This flag is only
1054 supported on X11 and it disables double buffering. On Qt for Embedded
1055 Linux, the flag only works when set on a top-level widget and it relies on
1056 support from the active screen driver. This flag is set or cleared by the
1057 widget's author. To render outside of Qt's paint system, e.g., if you
1058 require native painting primitives, you need to reimplement
1059 QWidget::paintEngine() to return 0 and set this flag.
1060
1061 \value WA_PaintOutsidePaintEvent Makes it possible to use QPainter to
1062 paint on the widget outside \l{QWidget::paintEvent()}{paintEvent()}. This
1063 flag is not supported on Windows, Mac OS X or Embedded Linux. We recommend
1064 that you use it only when porting Qt 3 code to Qt 4.
1065
1066 \value WA_PaintUnclipped Makes all painters operating on this widget
1067 unclipped. Children of this widget or other widgets in front of it do not
1068 clip the area the painter can paint on. This flag is only supported for
1069 widgets with the WA_PaintOnScreen flag set. The preferred way to do this in
1070 a cross platform way is to create a transparent widget that lies in front
1071 of the other widgets.
1072
1073 \value WA_PendingMoveEvent Indicates that a move event is pending, e.g.,
1074 when a hidden widget was moved. This flag is set or cleared by the Qt
1075 kernel.
1076
1077 \value WA_PendingResizeEvent Indicates that a resize event is pending,
1078 e.g., when a hidden widget was resized. This flag is set or cleared by the
1079 Qt kernel.
1080
1081 \value WA_QuitOnClose Makes Qt quit the application when the last widget
1082 with the attribute set has accepted closeEvent(). This behavior can be
1083 modified with the QApplication::quitOnLastWindowClosed property. By default
1084 this attribute is set for all widgets of type Qt::Window.
1085
1086 \value WA_Resized Indicates that the widget has an explicit size. This flag
1087 is set or cleared by QWidget::resize() and QWidget::setGeometry().
1088
1089 \value WA_RightToLeft Indicates that the layout direction for the widget
1090 is right to left.
1091
1092 \value WA_SetCursor Indicates that the widget has a cursor of its own. This
1093 flag is set or cleared by QWidget::setCursor() and QWidget::unsetCursor().
1094
1095 \value WA_SetFont Indicates that the widget has a font of its own. This
1096 flag is set or cleared by QWidget::setFont().
1097
1098 \value WA_SetPalette Indicates that the widget has a palette of its own.
1099 This flag is set or cleared by QWidget::setPalette().
1100
1101 \value WA_SetStyle Indicates that the widget has a style of its own. This
1102 flag is set or cleared by QWidget::setStyle().
1103
1104 \value WA_ShowModal \e{This attribute has been deprecated.} Use
1105 QWidget::windowModality instead.
1106
1107 \value WA_StaticContents Indicates that the widget contents are north-west
1108 aligned and static. On resize, such a widget will receive paint events only
1109 for parts of itself that are newly visible. This flag is set or cleared by
1110 the widget's author.
1111
1112 \value WA_StyleSheet Indicates that the widget is styled using a
1113 \l{Qt Style Sheets}{style sheet}.
1114
1115 \value WA_TranslucentBackground Indicates that the widget should have a
1116 translucent background, i.e., any non-opaque regions of the widgets will be
1117 translucent because the widget will have an alpha channel. Setting this
1118 flag causes WA_NoSystemBackground to be set. On Windows the
1119 widget also needs the Qt::FramelessWindowHint window flag to be set.
1120 This flag is set or cleared by the widget's author.
1121
1122 \value WA_UnderMouse Indicates that the widget is under the mouse cursor.
1123 The value is not updated correctly during drag and drop operations. There
1124 is also a getter function, QWidget::underMouse(). This flag is set or
1125 cleared by the Qt kernel.
1126
1127 \value WA_UpdatesDisabled Indicates that updates are blocked (including the
1128 system background). This flag is set or cleared by the Qt kernel.
1129 \warning This flag must \e never be set or cleared by the widget's author.
1130
1131 \value WA_WindowModified Indicates that the window is marked as modified.
1132 On some platforms this flag will do nothing, on others (including Mac OS X
1133 and Windows) the window will take a modified appearance. This flag is set
1134 or cleared by QWidget::setWindowModified().
1135
1136 \value WA_WindowPropagation Makes a toplevel window inherit font and
1137 palette from its parent.
1138
1139 \value WA_MacAlwaysShowToolWindow On Mac OS X, show the tool window even
1140 when the application is not active. By default, all tool windows are
1141 hidden when the application is inactive.
1142
1143 \value WA_SetLocale Indicates the locale should be taken into consideration
1144 in the widget.
1145
1146 \value WA_StyledBackground Indicates the widget should be drawn using a
1147 styled background.
1148
1149 \value WA_ShowWithoutActivating Show the widget without making it active.
1150
1151 \value WA_NativeWindow Indicates that a native window is created for the
1152 widget. Enabling this flag will also force a native window for the widget's
1153 ancestors unless Qt::WA_DontCreateNativeAncestors is set.
1154
1155 \value WA_DontCreateNativeAncestors Indicates that the widget's ancestors
1156 are kept non-native even though the widget itself is native.
1157
1158 \value WA_X11NetWmWindowTypeDesktop Adds _NET_WM_WINDOW_TYPE_DESKTOP to the
1159 window's _NET_WM_WINDOW_TYPE X11 window property. See
1160 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1161 has no effect on non-X11 platforms.
1162
1163 \value WA_X11NetWmWindowTypeDock Adds _NET_WM_WINDOW_TYPE_DOCK to the
1164 window's _NET_WM_WINDOW_TYPE X11 window property. See
1165 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1166 has no effect on non-X11 platforms.
1167
1168 \value WA_X11NetWmWindowTypeToolBar Adds _NET_WM_WINDOW_TYPE_TOOLBAR to the
1169 window's _NET_WM_WINDOW_TYPE X11 window property. See
1170 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1171 has no effect on non-X11 platforms. \note Qt automaticaly sets this
1172 attribute for QToolBar.
1173
1174 \value WA_X11NetWmWindowTypeMenu Adds _NET_WM_WINDOW_TYPE_MENU to the
1175 window's _NET_WM_WINDOW_TYPE X11 window property. See
1176 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1177 has no effect on non-X11 platforms. \note Qt automatically sets this
1178 attribute for QMenu when torn-off.
1179
1180 \value WA_X11NetWmWindowTypeUtility Adds _NET_WM_WINDOW_TYPE_UTILITY to the
1181 window's _NET_WM_WINDOW_TYPE X11 window property. See
1182 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1183 has no effect on non-X11 platforms. \note Qt automatically sets this
1184 attribute for the Qt::Tool window type.
1185
1186 \value WA_X11NetWmWindowTypeSplash Adds _NET_WM_WINDOW_TYPE_SPLASH to the
1187 window's _NET_WM_WINDOW_TYPE X11 window property. See
1188 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1189 has no effect on non-X11 platforms. \note Qt automatically sets this
1190 attribute for the Qt::SplashScreen window type.
1191
1192 \value WA_X11NetWmWindowTypeDialog Adds _NET_WM_WINDOW_TYPE_DIALOG
1193 to the window's _NET_WM_WINDOW_TYPE X11 window property. See
1194 http://standards.freedesktop.org/wm-spec/ for more details. This
1195 attribute has no effect on non-X11 platforms. \note Qt automatically sets
1196 this attribute for the Qt::Dialog and Qt::Sheet window types.
1197
1198 \value WA_X11NetWmWindowTypeDropDownMenu Adds
1199 _NET_WM_WINDOW_TYPE_DROPDOWN_MENU to the window's
1200 _NET_WM_WINDOW_TYPE X11 window property. See
1201 http://standards.freedesktop.org/wm-spec/ for more details. This
1202 attribute has no effect on non-X11 platforms. \note Qt
1203 automatically sets this attribute for QMenus added to a QMenuBar.
1204
1205 \value WA_X11NetWmWindowTypePopupMenu Adds _NET_WM_WINDOW_TYPE_POPUP_MENU
1206 to the window's _NET_WM_WINDOW_TYPE X11 window property. See
1207 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1208 has no effect on non-X11 platforms. \note Qt automatically sets this
1209 attribute for QMenu.
1210
1211 \value WA_X11NetWmWindowTypeToolTip Adds _NET_WM_WINDOW_TYPE_TOOLTIP to the
1212 window's _NET_WM_WINDOW_TYPE X11 window property. See
1213 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1214 has no effect on non-X11 platforms. \note Qt automatically sets this
1215 attribute for the Qt::ToolTip window type.
1216
1217 \value WA_X11NetWmWindowTypeNotification Adds
1218 _NET_WM_WINDOW_TYPE_NOTIFICATION to the window's _NET_WM_WINDOW_TYPE X11
1219 window property. See http://standards.freedesktop.org/wm-spec/ for more
1220 details. This attribute has no effect on non-X11 platforms.
1221
1222 \value WA_X11NetWmWindowTypeCombo Adds _NET_WM_WINDOW_TYPE_COMBO
1223 to the window's _NET_WM_WINDOW_TYPE X11 window property. See
1224 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1225 has no effect on non-X11 platforms. \note Qt automatically sets this
1226 attribute for the QComboBox pop-up.
1227
1228 \value WA_X11NetWmWindowTypeDND Adds _NET_WM_WINDOW_TYPE_DND to
1229 the window's _NET_WM_WINDOW_TYPE X11 window property. See
1230 http://standards.freedesktop.org/wm-spec/ for more details. This attribute
1231 has no effect on non-X11 platforms. \note Qt automatically sets this
1232 attribute on the feedback widget used during a drag.
1233
1234 \value WA_MacFrameworkScaled Enables resolution independence aware mode
1235 on Mac when using Carbon. This attribute has no effect on Cocoa.
1236 The attribute is off by default and can be enabled on a per-window basis.
1237
1238 \value WA_AcceptTouchEvents Allows touch events (see QTouchEvent)
1239 to be sent to the widget. Must be set on all widgets that can
1240 handle touch events. Without this attribute set, events from a
1241 touch device will be sent as mouse events.
1242
1243 \value WA_TouchPadAcceptSingleTouchEvents Allows touchpad single
1244 touch events to be sent to the widget.
1245
1246 \value WA_MergeSoftkeys Allows widget to merge softkeys with parent widget,
1247 i.e. widget can set only one softkeys and request softkey implementation
1248 to take rest of the softkeys from the parent. Note parents are traversed until
1249 WA_MergeSoftkeys is not set. See also Qt::WA_MergeSoftkeysRecursively
1250 This attribute currently has effect only on Symbian platforms
1251
1252 \value WA_MergeSoftkeysRecursively Allows widget to merge softkeys recursively
1253 with all parents. If this attribute is set, the widget parents are traversed until
1254 window boundary (widget without parent or dialog) is found.
1255 This attribute currently has effect only on Symbian platforms
1256
1257 \omitvalue WA_SetLayoutDirection
1258 \omitvalue WA_InputMethodTransparent
1259 \omitvalue WA_WState_CompressKeys
1260 \omitvalue WA_WState_ConfigPending
1261 \omitvalue WA_WState_Created
1262 \omitvalue WA_WState_DND
1263 \omitvalue WA_WState_ExplicitShowHide
1264 \omitvalue WA_WState_Hidden
1265 \omitvalue WA_WState_InPaintEvent
1266 \omitvalue WA_WState_OwnSizePolicy
1267 \omitvalue WA_WState_Polished
1268 \omitvalue WA_WState_Reparented
1269 \omitvalue WA_WState_Visible
1270 \omitvalue WA_SetWindowIcon
1271 \omitvalue WA_PendingUpdate
1272 \omitvalue WA_LaidOut
1273 \omitvalue WA_GrabbedShortcut
1274 \omitvalue WA_DontShowOnScreen
1275 \omitvalue WA_InvalidSize
1276 \omitvalue WA_ForceUpdatesDisabled
1277 \omitvalue WA_NoX11EventCompression
1278 \omitvalue WA_TintedBackground
1279 \omitvalue WA_X11OpenGLOverlay
1280 \omitvalue WA_CanHostQMdiSubWindowTitleBar
1281 \omitvalue WA_AttributeCount
1282 \omitvalue WA_StyleSheet
1283 \omitvalue WA_X11BypassTransientForHint
1284 \omitvalue WA_SetWindowModality
1285 \omitvalue WA_WState_WindowOpacitySet
1286 \omitvalue WA_WState_AcceptedTouchBeginEvent
1287*/
1288
1289/*! \typedef Qt::HANDLE
1290
1291 Platform-specific handle type for system objects. This is
1292 equivalent to \c{void *} on Mac OS X and embedded Linux,
1293 and to \c{unsigned long} on X11. On Windows it is the
1294 DWORD returned by the Win32 function getCurrentThreadId().
1295
1296 \warning Using this type is not portable.
1297*/
1298
1299/*!
1300 \enum Qt::Key
1301
1302 The key names used by Qt.
1303
1304 \value Key_Escape
1305 \value Key_Tab
1306 \value Key_Backtab
1307 \omitvalue Key_BackTab
1308 \value Key_Backspace
1309 \omitvalue Key_BackSpace
1310 \value Key_Return
1311 \value Key_Enter Typically located on the keypad.
1312 \value Key_Insert
1313 \value Key_Delete
1314 \value Key_Pause
1315 \value Key_Print
1316 \value Key_SysReq
1317 \value Key_Clear
1318 \value Key_Home
1319 \value Key_End
1320 \value Key_Left
1321 \value Key_Up
1322 \value Key_Right
1323 \value Key_Down
1324 \value Key_PageUp
1325 \omitvalue Key_Prior
1326 \value Key_PageDown
1327 \omitvalue Key_Next
1328 \value Key_Shift
1329 \value Key_Control On Mac OS X, this corresponds to the Command keys.
1330 \value Key_Meta On Mac OS X, this corresponds to the Control keys.
1331 On Windows keyboards, this key is mapped to the
1332 Windows key.
1333 \value Key_Alt
1334 \value Key_AltGr On Windows, when the KeyDown event for this key is
1335 sent, the Ctrl+Alt modifiers are also set.
1336 \value Key_CapsLock
1337 \value Key_NumLock
1338 \value Key_ScrollLock
1339 \value Key_F1
1340 \value Key_F2
1341 \value Key_F3
1342 \value Key_F4
1343 \value Key_F5
1344 \value Key_F6
1345 \value Key_F7
1346 \value Key_F8
1347 \value Key_F9
1348 \value Key_F10
1349 \value Key_F11
1350 \value Key_F12
1351 \value Key_F13
1352 \value Key_F14
1353 \value Key_F15
1354 \value Key_F16
1355 \value Key_F17
1356 \value Key_F18
1357 \value Key_F19
1358 \value Key_F20
1359 \value Key_F21
1360 \value Key_F22
1361 \value Key_F23
1362 \value Key_F24
1363 \value Key_F25
1364 \value Key_F26
1365 \value Key_F27
1366 \value Key_F28
1367 \value Key_F29
1368 \value Key_F30
1369 \value Key_F31
1370 \value Key_F32
1371 \value Key_F33
1372 \value Key_F34
1373 \value Key_F35
1374 \value Key_Super_L
1375 \value Key_Super_R
1376 \value Key_Menu
1377 \value Key_Hyper_L
1378 \value Key_Hyper_R
1379 \value Key_Help
1380 \value Key_Direction_L
1381 \value Key_Direction_R
1382 \value Key_Space
1383 \value Key_Any
1384 \value Key_Exclam
1385 \value Key_QuoteDbl
1386 \value Key_NumberSign
1387 \value Key_Dollar
1388 \value Key_Percent
1389 \value Key_Ampersand
1390 \value Key_Apostrophe
1391 \value Key_ParenLeft
1392 \value Key_ParenRight
1393 \value Key_Asterisk
1394 \value Key_Plus
1395 \value Key_Comma
1396 \value Key_Minus
1397 \value Key_Period
1398 \value Key_Slash
1399 \value Key_0
1400 \value Key_1
1401 \value Key_2
1402 \value Key_3
1403 \value Key_4
1404 \value Key_5
1405 \value Key_6
1406 \value Key_7
1407 \value Key_8
1408 \value Key_9
1409 \value Key_Colon
1410 \value Key_Semicolon
1411 \value Key_Less
1412 \value Key_Equal
1413 \value Key_Greater
1414 \value Key_Question
1415 \value Key_At
1416 \value Key_A
1417 \value Key_B
1418 \value Key_C
1419 \value Key_D
1420 \value Key_E
1421 \value Key_F
1422 \value Key_G
1423 \value Key_H
1424 \value Key_I
1425 \value Key_J
1426 \value Key_K
1427 \value Key_L
1428 \value Key_M
1429 \value Key_N
1430 \value Key_O
1431 \value Key_P
1432 \value Key_Q
1433 \value Key_R
1434 \value Key_S
1435 \value Key_T
1436 \value Key_U
1437 \value Key_V
1438 \value Key_W
1439 \value Key_X
1440 \value Key_Y
1441 \value Key_Z
1442 \value Key_BracketLeft
1443 \value Key_Backslash
1444 \value Key_BracketRight
1445 \value Key_AsciiCircum
1446 \value Key_Underscore
1447 \value Key_QuoteLeft
1448 \value Key_BraceLeft
1449 \value Key_Bar
1450 \value Key_BraceRight
1451 \value Key_AsciiTilde
1452 \value Key_nobreakspace
1453 \value Key_exclamdown
1454 \value Key_cent
1455 \value Key_sterling
1456 \value Key_currency
1457 \value Key_yen
1458 \value Key_brokenbar
1459 \value Key_section
1460 \value Key_diaeresis
1461 \value Key_copyright
1462 \value Key_ordfeminine
1463 \value Key_guillemotleft
1464 \value Key_notsign
1465 \value Key_hyphen
1466 \value Key_registered
1467 \value Key_macron
1468 \value Key_degree
1469 \value Key_plusminus
1470 \value Key_twosuperior
1471 \value Key_threesuperior
1472 \value Key_acute
1473 \value Key_mu
1474 \value Key_paragraph
1475 \value Key_periodcentered
1476 \value Key_cedilla
1477 \value Key_onesuperior
1478 \value Key_masculine
1479 \value Key_guillemotright
1480 \value Key_onequarter
1481 \value Key_onehalf
1482 \value Key_threequarters
1483 \value Key_questiondown
1484 \value Key_Agrave
1485 \value Key_Aacute
1486 \value Key_Acircumflex
1487 \value Key_Atilde
1488 \value Key_Adiaeresis
1489 \value Key_Aring
1490 \value Key_AE
1491 \value Key_Ccedilla
1492 \value Key_Egrave
1493 \value Key_Eacute
1494 \value Key_Ecircumflex
1495 \value Key_Ediaeresis
1496 \value Key_Igrave
1497 \value Key_Iacute
1498 \value Key_Icircumflex
1499 \value Key_Idiaeresis
1500 \value Key_ETH
1501 \value Key_Ntilde
1502 \value Key_Ograve
1503 \value Key_Oacute
1504 \value Key_Ocircumflex
1505 \value Key_Otilde
1506 \value Key_Odiaeresis
1507 \value Key_multiply
1508 \value Key_Ooblique
1509 \value Key_Ugrave
1510 \value Key_Uacute
1511 \value Key_Ucircumflex
1512 \value Key_Udiaeresis
1513 \value Key_Yacute
1514 \value Key_THORN
1515 \value Key_ssharp
1516 \omitvalue Key_agrave
1517 \omitvalue Key_aacute
1518 \omitvalue Key_acircumflex
1519 \omitvalue Key_atilde
1520 \omitvalue Key_adiaeresis
1521 \omitvalue Key_aring
1522 \omitvalue Key_ae
1523 \omitvalue Key_ccedilla
1524 \omitvalue Key_egrave
1525 \omitvalue Key_eacute
1526 \omitvalue Key_ecircumflex
1527 \omitvalue Key_ediaeresis
1528 \omitvalue Key_igrave
1529 \omitvalue Key_iacute
1530 \omitvalue Key_icircumflex
1531 \omitvalue Key_idiaeresis
1532 \omitvalue Key_eth
1533 \omitvalue Key_ntilde
1534 \omitvalue Key_ograve
1535 \omitvalue Key_oacute
1536 \omitvalue Key_ocircumflex
1537 \omitvalue Key_otilde
1538 \omitvalue Key_odiaeresis
1539 \value Key_division
1540 \omitvalue Key_oslash
1541 \omitvalue Key_ugrave
1542 \omitvalue Key_uacute
1543 \omitvalue Key_ucircumflex
1544 \omitvalue Key_udiaeresis
1545 \omitvalue Key_yacute
1546 \omitvalue Key_thorn
1547 \value Key_ydiaeresis
1548 \value Key_Multi_key
1549 \value Key_Codeinput
1550 \value Key_SingleCandidate
1551 \value Key_MultipleCandidate
1552 \value Key_PreviousCandidate
1553 \value Key_Mode_switch
1554 \value Key_Kanji
1555 \value Key_Muhenkan
1556 \value Key_Henkan
1557 \value Key_Romaji
1558 \value Key_Hiragana
1559 \value Key_Katakana
1560 \value Key_Hiragana_Katakana
1561 \value Key_Zenkaku
1562 \value Key_Hankaku
1563 \value Key_Zenkaku_Hankaku
1564 \value Key_Touroku
1565 \value Key_Massyo
1566 \value Key_Kana_Lock
1567 \value Key_Kana_Shift
1568 \value Key_Eisu_Shift
1569 \value Key_Eisu_toggle
1570 \value Key_Hangul
1571 \value Key_Hangul_Start
1572 \value Key_Hangul_End
1573 \value Key_Hangul_Hanja
1574 \value Key_Hangul_Jamo
1575 \value Key_Hangul_Romaja
1576 \value Key_Hangul_Jeonja
1577 \value Key_Hangul_Banja
1578 \value Key_Hangul_PreHanja
1579 \value Key_Hangul_PostHanja
1580 \value Key_Hangul_Special
1581 \value Key_Dead_Grave
1582 \value Key_Dead_Acute
1583 \value Key_Dead_Circumflex
1584 \value Key_Dead_Tilde
1585 \value Key_Dead_Macron
1586 \value Key_Dead_Breve
1587 \value Key_Dead_Abovedot
1588 \value Key_Dead_Diaeresis
1589 \value Key_Dead_Abovering
1590 \value Key_Dead_Doubleacute
1591 \value Key_Dead_Caron
1592 \value Key_Dead_Cedilla
1593 \value Key_Dead_Ogonek
1594 \value Key_Dead_Iota
1595 \value Key_Dead_Voiced_Sound
1596 \value Key_Dead_Semivoiced_Sound
1597 \value Key_Dead_Belowdot
1598 \value Key_Dead_Hook
1599 \value Key_Dead_Horn
1600 \value Key_Back
1601 \value Key_Forward
1602 \value Key_Stop
1603 \value Key_Refresh
1604 \value Key_VolumeDown
1605 \value Key_VolumeMute
1606 \value Key_VolumeUp
1607 \value Key_BassBoost
1608 \value Key_BassUp
1609 \value Key_BassDown
1610 \value Key_TrebleUp
1611 \value Key_TrebleDown
1612 \value Key_MediaPlay
1613 \value Key_MediaStop
1614 \value Key_MediaPrevious
1615 \omitvalue Key_MediaPrev
1616 \value Key_MediaNext
1617 \value Key_MediaRecord
1618 \value Key_HomePage
1619 \value Key_Favorites
1620 \value Key_Search
1621 \value Key_Standby
1622 \value Key_OpenUrl
1623 \value Key_LaunchMail
1624 \value Key_LaunchMedia
1625 \value Key_Launch0
1626 \value Key_Launch1
1627 \value Key_Launch2
1628 \value Key_Launch3
1629 \value Key_Launch4
1630 \value Key_Launch5
1631 \value Key_Launch6
1632 \value Key_Launch7
1633 \value Key_Launch8
1634 \value Key_Launch9
1635 \value Key_LaunchA
1636 \value Key_LaunchB
1637 \value Key_LaunchC
1638 \value Key_LaunchD
1639 \value Key_LaunchE
1640 \value Key_LaunchF
1641 \value Key_MonBrightnessUp
1642 \value Key_MonBrightnessDown
1643 \value Key_KeyboardLightOnOff
1644 \value Key_KeyboardBrightnessUp
1645 \value Key_KeyboardBrightnessDown
1646 \value Key_PowerOff
1647 \value Key_WakeUp
1648 \value Key_Eject
1649 \value Key_ScreenSaver
1650 \value Key_WWW
1651 \value Key_Memo
1652 \value Key_LightBulb
1653 \value Key_Shop
1654 \value Key_History
1655 \value Key_AddFavorite
1656 \value Key_HotLinks
1657 \value Key_BrightnessAdjust
1658 \value Key_Finance
1659 \value Key_Community
1660 \value Key_AudioRewind
1661 \value Key_BackForward
1662 \value Key_ApplicationLeft
1663 \value Key_ApplicationRight
1664 \value Key_Book
1665 \value Key_CD
1666 \value Key_Calculator
1667 \value Key_ToDoList
1668 \value Key_ClearGrab
1669 \value Key_Close
1670 \value Key_Copy
1671 \value Key_Cut
1672 \value Key_Display
1673 \value Key_DOS
1674 \value Key_Documents
1675 \value Key_Excel
1676 \value Key_Explorer
1677 \value Key_Game
1678 \value Key_Go
1679 \value Key_iTouch
1680 \value Key_LogOff
1681 \value Key_Market
1682 \value Key_Meeting
1683 \value Key_MenuKB
1684 \value Key_MenuPB
1685 \value Key_MySites
1686 \value Key_News
1687 \value Key_OfficeHome
1688 \value Key_Option
1689 \value Key_Paste
1690 \value Key_Phone
1691 \value Key_Calendar
1692 \value Key_Reply
1693 \value Key_Reload
1694 \value Key_RotateWindows
1695 \value Key_RotationPB
1696 \value Key_RotationKB
1697 \value Key_Save
1698 \value Key_Send
1699 \value Key_Spell
1700 \value Key_SplitScreen
1701 \value Key_Support
1702 \value Key_TaskPane
1703 \value Key_Terminal
1704 \value Key_Tools
1705 \value Key_Travel
1706 \value Key_Video
1707 \value Key_Word
1708 \value Key_Xfer
1709 \value Key_ZoomIn
1710 \value Key_ZoomOut
1711 \value Key_Away
1712 \value Key_Messenger
1713 \value Key_WebCam
1714 \value Key_MailForward
1715 \value Key_Pictures
1716 \value Key_Music
1717 \value Key_Battery
1718 \value Key_Bluetooth
1719 \value Key_WLAN
1720 \value Key_UWB
1721 \value Key_AudioForward
1722 \value Key_AudioRepeat
1723 \value Key_AudioRandomPlay
1724 \value Key_Subtitle
1725 \value Key_AudioCycleTrack
1726 \value Key_Time
1727 \value Key_Hibernate
1728 \value Key_View
1729 \value Key_TopMenu
1730 \value Key_PowerDown
1731 \value Key_Suspend
1732 \value Key_ContrastAdjust
1733 \value Key_MediaLast
1734 \value Key_unknown
1735
1736 \value Key_Call
1737 \value Key_Context1
1738 \value Key_Context2
1739 \value Key_Context3
1740 \value Key_Context4
1741 \value Key_Flip
1742 \value Key_Hangup
1743 \value Key_No
1744 \value Key_Select
1745 \value Key_Yes
1746
1747 \value Key_Execute
1748 \value Key_Printer
1749 \value Key_Play
1750 \value Key_Sleep
1751 \value Key_Zoom
1752 \value Key_Cancel
1753
1754 \sa QKeyEvent::key()
1755*/
1756
1757/*!
1758 \enum Qt::HitTestAccuracy
1759
1760 This enum contains the types of accuracy that can be used by the
1761 QTextDocument class when testing for mouse clicks on text documents.
1762
1763 \value ExactHit The point at which input occurred must coincide
1764 exactly with input-sensitive parts of the document.
1765 \value FuzzyHit The point at which input occurred can lie close to
1766 input-sensitive parts of the document.
1767
1768 This enum is defined in the \c <QTextDocument> header file.
1769*/
1770
1771/*!
1772 \enum Qt::WhiteSpaceMode
1773
1774 This enum describes the types of whitespace mode that are used by
1775 the QTextDocument class to meet the requirements of different kinds
1776 of textual information.
1777
1778 \value WhiteSpaceNormal The whitespace mode used to display
1779 normal word wrapped text in paragraphs.
1780 \value WhiteSpacePre A preformatted text mode in which
1781 whitespace is reproduced exactly.
1782 \value WhiteSpaceNoWrap
1783
1784 \omitvalue WhiteSpaceModeUndefined
1785
1786 This enum is defined in the \c <QTextDocument> header file.
1787*/
1788
1789/*!
1790 \enum Qt::ButtonState_enum
1791 \compat
1792 \value ShiftButton
1793 \value ControlButton
1794 \value AltButton
1795 \value MetaButton
1796 \value Keypad
1797 \value KeyButtonMask
1798
1799 Use Qt::KeyboardModifier instead.
1800*/
1801
1802/*!
1803 \typedef Qt::ButtonState
1804 \compat
1805
1806 Use Qt::KeyboardModifier instead.
1807*/
1808
1809/*!
1810 \enum Qt::CheckState
1811
1812 This enum describes the state of checkable items, controls, and widgets.
1813
1814 \value Unchecked The item is unchecked.
1815 \value PartiallyChecked The item is partially checked. Items in hierarchical models
1816 may be partially checked if some, but not all, of their
1817 children are checked.
1818 \value Checked The item is checked.
1819
1820 \sa QCheckBox, Qt::ItemFlags, Qt::ItemDataRole
1821*/
1822
1823
1824/*!
1825 \enum Qt::ToolButtonStyle
1826
1827 The style of the tool button, describing how the button's text and
1828 icon should be displayed.
1829
1830 \value ToolButtonIconOnly Only display the icon.
1831 \value ToolButtonTextOnly Only display the text.
1832 \value ToolButtonTextBesideIcon The text appears beside the icon.
1833 \value ToolButtonTextUnderIcon The text appears under the icon.
1834 \value ToolButtonFollowStyle Follow the \l{QStyle::SH_ToolButtonStyle}{style}.
1835*/
1836
1837/*!
1838 \enum Qt::Corner
1839
1840 This enum type specifies a corner in a rectangle:
1841
1842 \value TopLeftCorner The top-left corner of the rectangle.
1843 \value TopRightCorner The top-right corner of the rectangle.
1844 \value BottomLeftCorner The bottom-left corner of the rectangle.
1845 \value BottomRightCorner The bottom-right corner of the rectangle.
1846
1847 \omitvalue TopLeft
1848 \omitvalue TopRight
1849 \omitvalue BottomLeft
1850 \omitvalue BottomRight
1851*/
1852
1853/*!
1854 \enum Qt::ScrollBarPolicy
1855
1856 This enum type describes the various modes of QAbstractScrollArea's scroll
1857 bars.
1858
1859 \value ScrollBarAsNeeded QAbstractScrollArea shows a scroll bar when the
1860 content is too large to fit and not otherwise. This is the
1861 default.
1862
1863 \value ScrollBarAlwaysOff QAbstractScrollArea never shows a scroll bar.
1864
1865 \value ScrollBarAlwaysOn QAbstractScrollArea always shows a scroll bar.
1866
1867 (The modes for the horizontal and vertical scroll bars are
1868 independent.)
1869*/
1870
1871/*!
1872 \enum Qt::ArrowType
1873
1874 \value NoArrow
1875 \value UpArrow
1876 \value DownArrow
1877 \value LeftArrow
1878 \value RightArrow
1879*/
1880
1881/*!
1882 \enum Qt::FocusReason
1883
1884 This enum specifies why the focus changed. It will be passed
1885 through QWidget::setFocus and can be retrieved in the QFocusEvent
1886 sent to the widget upon focus change.
1887
1888 \value MouseFocusReason A mouse action occurred.
1889 \value TabFocusReason The Tab key was pressed.
1890 \value BacktabFocusReason A Backtab occurred. The input for this may
1891 include the Shift or Control keys;
1892 e.g. Shift+Tab.
1893 \value ActiveWindowFocusReason The window system made this window either
1894 active or inactive.
1895 \value PopupFocusReason The application opened/closed a pop-up that
1896 grabbed/released the keyboard focus.
1897 \value ShortcutFocusReason The user typed a label's buddy shortcut
1898 \value MenuBarFocusReason The menu bar took focus.
1899 \value OtherFocusReason Another reason, usually application-specific.
1900
1901 \omitvalue NoFocusReason
1902
1903 \sa {Keyboard Focus}
1904*/
1905
1906/*!
1907 \enum Qt::WindowState
1908
1909 \keyword window state
1910
1911 This enum type is used to specify the current state of a top-level
1912 window.
1913
1914 The states are
1915
1916 \value WindowNoState The window has no state set (in normal state).
1917 \value WindowMinimized The window is minimized (i.e. iconified).
1918 \value WindowMaximized The window is maximized with a frame around it.
1919 \value WindowFullScreen The window fills the entire screen without any frame around it.
1920 \value WindowActive The window is the active window, i.e. it has keyboard focus.
1921
1922*/
1923
1924/*!
1925 \enum Qt::ContextMenuPolicy
1926
1927 This enum type defines the various policies a widget can have with
1928 respect to showing a context menu.
1929
1930 \value NoContextMenu the widget does not feature a context menu,
1931 context menu handling is deferred to the widget's parent.
1932 \value PreventContextMenu the widget does not feature a context
1933 menu, and in contrast to \c NoContextMenu, the handling is \e not
1934 deferred to the widget's parent. This means that all right mouse
1935 button events are guaranteed to be delivered to the widget itself
1936 through mousePressEvent(), and mouseReleaseEvent().
1937 \value DefaultContextMenu the widget's QWidget::contextMenuEvent() handler is called.
1938 \value ActionsContextMenu the widget displays its QWidget::actions() as context menu.
1939 \value CustomContextMenu the widget emits the QWidget::customContextMenuRequested() signal.
1940*/
1941
1942/*!
1943 \enum Qt::FocusPolicy
1944
1945 This enum type defines the various policies a widget can have with
1946 respect to acquiring keyboard focus.
1947
1948 \value TabFocus the widget accepts focus by tabbing.
1949 \value ClickFocus the widget accepts focus by clicking.
1950 \value StrongFocus the widget accepts focus by both tabbing
1951 and clicking. On Mac OS X this will also
1952 be indicate that the widget accepts tab focus
1953 when in 'Text/List focus mode'.
1954 \value WheelFocus like Qt::StrongFocus plus the widget accepts
1955 focus by using the mouse wheel.
1956 \value NoFocus the widget does not accept focus.
1957
1958*/
1959
1960/*!
1961 \enum Qt::ShortcutContext
1962
1963 For a QEvent::Shortcut event to occur, the shortcut's key sequence
1964 must be entered by the user in a context where the shortcut is
1965 active. The possible contexts are these:
1966
1967 \value WidgetShortcut The shortcut is active when its
1968 parent widget has focus.
1969 \value WidgetWithChildrenShortcut The shortcut is active
1970 when its parent widget, or any of its children has focus.
1971 Children which are top-level widgets, except pop-ups, are
1972 not affected by this shortcut context.
1973 \value WindowShortcut The shortcut is active when its
1974 parent widget is a logical subwidget of the
1975 active top-level window.
1976 \value ApplicationShortcut The shortcut is active when one of
1977 the applications windows are active.
1978*/
1979
1980/*!
1981 \typedef Qt::WFlags
1982
1983 Synonym for Qt::WindowFlags.
1984*/
1985
1986/*!
1987 \enum Qt::WindowType
1988
1989 \keyword window flag
1990
1991 This enum type is used to specify various window-system properties
1992 for the widget. They are fairly unusual but necessary in a few
1993 cases. Some of these flags depend on whether the underlying window
1994 manager supports them.
1995
1996 The main types are
1997
1998 \value Widget This is the default type for QWidget. Widgets of
1999 this type are child widgets if they have a parent,
2000 and independent windows if they have no parent.
2001 See also Qt::Window and Qt::SubWindow.
2002
2003 \value Window Indicates that the widget is a window, usually
2004 with a window system frame and a title bar,
2005 irrespective of whether the widget has a parent or
2006 not. Note that it is not possible to unset this
2007 flag if the widget does not have a parent.
2008
2009 \value Dialog Indicates that the widget is a window that should
2010 be decorated as a dialog (i.e., typically no
2011 maximize or minimize buttons in the title bar).
2012 This is the default type for QDialog. If you want
2013 to use it as a modal dialog, it should be launched
2014 from another window, or have a parent and used
2015 with the QWidget::windowModality property. If you make
2016 it modal, the dialog will prevent other top-level
2017 windows in the application from getting any input.
2018 We refer to a top-level window that has a parent
2019 as a \e secondary window.
2020
2021 \value Sheet Indicates that the window is a Macintosh sheet. Since
2022 using a sheet implies window modality, the recommended
2023 way is to use QWidget::setWindowModality(), or
2024 QDialog::open(), instead.
2025
2026 \value Drawer Indicates that the widget is a Macintosh drawer.
2027
2028 \value Popup Indicates that the widget is a pop-up top-level
2029 window, i.e. that it is modal, but has a window
2030 system frame appropriate for pop-up menus.
2031
2032 \value Tool Indicates that the widget is a tool window. A tool
2033 window is often a small window with a smaller than
2034 usual title bar and decoration, typically used for
2035 collections of tool buttons. If there is a parent,
2036 the tool window will always be kept on top of it.
2037 If there isn't a parent, you may consider using
2038 Qt::WindowStaysOnTopHint as well. If the window
2039 system supports it, a tool window can be decorated
2040 with a somewhat lighter frame. It can also be
2041 combined with Qt::FramelessWindowHint.
2042 \br
2043 \br
2044 On Mac OS X, tool windows correspond to the
2045 \l{http://developer.apple.com/documentation/Carbon/Conceptual/HandlingWindowsControls/hitb-wind_cont_concept/chapter_2_section_2.html}{Floating}
2046 class of windows. This means that the window lives on a
2047 level above normal windows; it impossible to put a normal
2048 window on top of it. By default, tool windows will disappear
2049 when the application is inactive. This can be controlled by
2050 the Qt::WA_MacAlwaysShowToolWindow attribute.
2051
2052 \value ToolTip Indicates that the widget is a tooltip. This is
2053 used internally to implement
2054 \l{QWidget::toolTip}{tooltips}.
2055
2056 \value SplashScreen Indicates that the window is a splash screen.
2057 This is the default type for QSplashScreen.
2058
2059 \value Desktop Indicates that this widget is the desktop. This
2060 is the type for QDesktopWidget.
2061
2062 \value SubWindow Indicates that this widget is a sub-window, such
2063 as a QMdiSubWindow widget.
2064
2065 There are also a number of flags which you can use to customize
2066 the appearance of top-level windows. These have no effect on other
2067 windows:
2068
2069 \value MSWindowsFixedSizeDialogHint Gives the window a thin dialog border on Windows.
2070 This style is traditionally used for fixed-size dialogs.
2071
2072 \value MSWindowsOwnDC Gives the window its own display
2073 context on Windows.
2074
2075 \value X11BypassWindowManagerHint Bypass the window
2076 manager completely. This results in a borderless window
2077 that is not managed at all (i.e., no keyboard input unless
2078 you call QWidget::activateWindow() manually).
2079
2080 \value FramelessWindowHint Produces a borderless window.
2081 The user cannot move or resize a borderless window via the window
2082 system. On X11, the result of the flag is dependent on the window manager and its
2083 ability to understand Motif and/or NETWM hints. Most existing
2084 modern window managers can handle this.
2085
2086 The \c CustomizeWindowHint flag is used to enable customization of
2087 the window controls. This flag must be set to allow the \c
2088 WindowTitleHint, \c WindowSystemMenuHint, \c
2089 WindowMinimizeButtonHint, \c WindowMaximizeButtonHint and \c
2090 WindowCloseButtonHint flags to be changed.
2091
2092 \value CustomizeWindowHint Turns off the default window title hints.
2093
2094 \value WindowTitleHint Gives the window a title bar.
2095
2096 \value WindowSystemMenuHint Adds a window system menu, and
2097 possibly a close button (for example on Mac). If you need to hide
2098 or show a close button, it is more portable to use \c
2099 WindowCloseButtonHint.
2100
2101 \value WindowMinimizeButtonHint Adds a minimize button. On
2102 some platforms this implies Qt::WindowSystemMenuHint for it to work.
2103
2104 \value WindowMaximizeButtonHint Adds a maximize button. On
2105 some platforms this implies Qt::WindowSystemMenuHint for it to work.
2106
2107 \value WindowMinMaxButtonsHint Adds a minimize and a maximize
2108 button. On some platforms this implies Qt::WindowSystemMenuHint for it to work.
2109
2110 \value WindowCloseButtonHint Adds a close button. On
2111 some platforms this implies Qt::WindowSystemMenuHint for it
2112 to work.
2113
2114 \value WindowContextHelpButtonHint Adds a context help button to dialogs.
2115 On some platforms this implies Qt::WindowSystemMenuHint for it to work.
2116
2117 \value MacWindowToolBarButtonHint On Mac OS X adds a tool bar button (i.e.,
2118 the oblong button that is on the top right of windows that have toolbars.
2119
2120 \value BypassGraphicsProxyWidget Prevents the window and its children from
2121 automatically embedding themselves into a QGraphicsProxyWidget if the
2122 parent widget is already embedded. You can set this flag if you
2123 want your widget to always be a toplevel widget on the desktop,
2124 regardless of whether the parent widget is embedded in a scene or
2125 not.
2126
2127 \value WindowShadeButtonHint
2128
2129 \value WindowStaysOnTopHint Informs the window system that the
2130 window should stay on top of all other windows. Note that
2131 on some window managers on X11 you also have to pass
2132 Qt::X11BypassWindowManagerHint for this flag to work
2133 correctly.
2134
2135 \value WindowStaysOnBottomHint Informs the window system that the
2136 window should stay on bottom of all other windows. Note
2137 that on X11 this hint will work only in window managers
2138 that support _NET_WM_STATE_BELOW atom. If a window always
2139 on the bottom has a parent, the parent will also be left on
2140 the bottom. This window hint is currently not implemented
2141 for Mac OS X.
2142
2143 \value WindowOkButtonHint Adds an OK button to the window decoration of a dialog.
2144 Only supported for Windows CE.
2145
2146 \value WindowCancelButtonHint Adds a Cancel button to the window decoration of a dialog.
2147 Only supported for Windows CE.
2148
2149 \value WindowType_Mask A mask for extracting the window type
2150 part of the window flags.
2151
2152 Obsolete flags:
2153
2154 \value WMouseNoMask Use Qt::WA_MouseNoMask instead.
2155 \value WDestructiveClose Use Qt::WA_DeleteOnClose instead.
2156 \value WStaticContents Use Qt::WA_StaticContents instead.
2157 \value WGroupLeader No longer needed.
2158 \value WShowModal Use QWidget::windowModality instead.
2159 \value WNoMousePropagation Use Qt::WA_NoMousePropagation instead.
2160 \value WType_TopLevel Use Qt::Window instead.
2161 \value WType_Dialog Use Qt::Dialog instead.
2162 \value WType_Popup Use Qt::Popup instead.
2163 \value WType_Desktop Use Qt::Desktop instead.
2164 \value WType_Mask Use Qt::WindowType_Mask instead.
2165
2166 \value WStyle_Customize No longer needed.
2167 \value WStyle_NormalBorder No longer needed.
2168 \value WStyle_DialogBorder Use Qt::MSWindowsFixedSizeDialogHint instead.
2169 \value WStyle_NoBorder Use Qt::FramelessWindowHint instead.
2170 \value WStyle_Title Use Qt::WindowTitleHint instead.
2171 \value WStyle_SysMenu Use Qt::WindowSystemMenuHint instead.
2172 \value WStyle_Minimize Use Qt::WindowMinimizeButtonHint instead.
2173 \value WStyle_Maximize Use Qt::WindowMaximizeButtonHint instead.
2174 \value WStyle_MinMax Use Qt::WindowMinMaxButtonsHint instead.
2175 \value WStyle_Tool Use Qt::Tool instead.
2176 \value WStyle_StaysOnTop Use Qt::WindowStaysOnTopHint instead.
2177 \value WStyle_ContextHelp Use Qt::WindowContextHelpButtonHint instead.
2178
2179 \value WPaintDesktop No longer needed.
2180 \value WPaintClever No longer needed.
2181
2182 \value WX11BypassWM Use Qt::X11BypassWindowManagerHint instead.
2183 \value WWinOwnDC Use Qt::MSWindowsOwnDC instead.
2184 \value WMacSheet Use Qt::Sheet instead.
2185 \value WMacDrawer Use Qt::Drawer instead.
2186
2187 \value WStyle_Splash Use Qt::SplashScreen instead.
2188
2189 \value WNoAutoErase No longer needed.
2190 \value WRepaintNoErase No longer needed.
2191 \value WNorthWestGravity Use Qt::WA_StaticContents instead.
2192 \value WType_Modal Use Qt::Dialog and QWidget::windowModality instead.
2193 \value WStyle_Dialog Use Qt::Dialog instead.
2194 \value WStyle_NoBorderEx Use Qt::FramelessWindowHint instead.
2195 \value WResizeNoErase No longer needed.
2196 \value WMacNoSheet No longer needed.
2197
2198 \sa QWidget::windowFlags, {Window Flags Example}
2199*/
2200
2201/*!
2202 \enum Qt::DropAction
2203
2204 \value CopyAction Copy the data to the target.
2205 \value MoveAction Move the data from the source to the target.
2206 \value LinkAction Create a link from the source to the target.
2207 \value ActionMask
2208 \value IgnoreAction Ignore the action (do nothing with the data).
2209 \value TargetMoveAction On Windows, this value is used when the ownership of the D&D data
2210 should be taken over by the target application,
2211 i.e., the source application should not delete
2212 the data.
2213 \br
2214 On X11 this value is used to do a move.
2215 \br
2216 TargetMoveAction is not used on the Mac.
2217*/
2218
2219#if defined(Q_OS_WIN) && defined(QT3_SUPPORT)
2220/*!
2221 \enum Qt::WindowsVersion
2222 \compat
2223
2224 \value WV_32s
2225 \value WV_95
2226 \value WV_98
2227 \value WV_Me
2228 \value WV_DOS_based
2229 \value WV_NT
2230 \value WV_2000
2231 \value WV_XP
2232 \value WV_2003
2233 \value WV_NT_based
2234 \value WV_CE
2235 \value WV_CENET
2236 \value WV_CE_based
2237 \value WV_CE_5
2238 \value WV_CE_6
2239*/
2240#endif
2241
2242#if defined(Q_OS_MAC) && defined(QT3_SUPPORT)
2243/*!
2244 \enum Qt::MacintoshVersion
2245 \compat
2246
2247 \value MV_Unknown Use QSysInfo::MV_Unknown instead.
2248 \value MV_9 Use QSysInfo::MV_9 instead.
2249 \value MV_10_DOT_0 Use QSysInfo::MV_10_0 instead.
2250 \value MV_10_DOT_1 Use QSysInfo::MV_10_1 instead.
2251 \value MV_10_DOT_2 Use QSysInfo::MV_10_2 instead.
2252 \value MV_10_DOT_3 Use QSysInfo::MV_10_3 instead.
2253 \value MV_10_DOT_4 Use QSysInfo::MV_10_4 instead.
2254
2255 \value MV_CHEETAH Use QSysInfo::MV_10_0 instead.
2256 \value MV_PUMA Use QSysInfo::MV_10_1 instead.
2257 \value MV_JAGUAR Use QSysInfo::MV_10_2 instead.
2258 \value MV_PANTHER Use QSysInfo::MV_10_3 instead.
2259 \value MV_TIGER Use QSysInfo::MV_10_4 instead.
2260
2261 \sa QSysInfo::MacVersion
2262*/
2263#endif
2264
2265/*! \typedef Qt::ToolBarDock
2266 \compat
2267
2268 Use Qt::Dock instead.
2269*/
2270
2271/*!
2272 \enum Qt::Dock
2273 \compat
2274
2275 Each dock window can be in one of the following positions:
2276
2277 \value DockUnmanaged not managed by a Q3MainWindow.
2278
2279 \value DockTornOff the dock window floats as its own top level
2280 window which always stays on top of the main window.
2281
2282 \value DockTop above the central widget, below the menu bar.
2283
2284 \value DockBottom below the central widget, above the status bar.
2285
2286 \value DockRight to the right of the central widget.
2287
2288 \value DockLeft to the left of the central widget.
2289
2290 \value DockMinimized the dock window is not shown (this is
2291 effectively a 'hidden' dock area); the handles of all minimized
2292 dock windows are drawn in one row below the menu bar.
2293
2294 \omitvalue Bottom
2295 \omitvalue Left
2296 \omitvalue Minimized
2297 \omitvalue Right
2298 \omitvalue Top
2299 \omitvalue TornOff
2300 \omitvalue Unmanaged
2301*/
2302
2303/*!
2304 \enum Qt::AnchorAttribute
2305
2306 An anchor has one or more of the following attributes:
2307
2308 \value AnchorName the name attribute of the anchor. This attribute is
2309 used when scrolling to an anchor in the document.
2310
2311 \value AnchorHref the href attribute of the anchor. This attribute is
2312 used when a link is clicked to determine what content to load.
2313*/
2314
2315/*!
2316 \enum Qt::SortOrder
2317
2318 This enum describes how the items in a widget are sorted.
2319
2320 \value AscendingOrder The items are sorted ascending e.g. starts with
2321 'AAA' ends with 'ZZZ' in Latin-1 locales
2322
2323 \value DescendingOrder The items are sorted descending e.g. starts with
2324 'ZZZ' ends with 'AAA' in Latin-1 locales
2325
2326 \omitvalue Ascending
2327 \omitvalue Descending
2328*/
2329
2330/*!
2331 \enum Qt::ClipOperation
2332
2333 \value NoClip This operation turns clipping off.
2334
2335 \value ReplaceClip Replaces the current clip path/rect/region with
2336 the one supplied in the function call.
2337
2338 \value IntersectClip Intersects the current clip path/rect/region
2339 with the one supplied in the function call.
2340
2341 \value UniteClip Unites the current clip path/rect/region with the
2342 one supplied in the function call.
2343*/
2344
2345/*!
2346 \enum Qt::ItemSelectionMode
2347
2348 This enum is used in QGraphicsItem, QGraphicsScene and QGraphicsView to
2349 specify how items are selected, or how to determine if a shapes and items
2350 collide.
2351
2352 \value ContainsItemShape The output list contains only items whose
2353 \l{QGraphicsItem::shape()}{shape} is fully contained inside the
2354 selection area. Items that intersect with the area's outline are
2355 not included.
2356
2357 \value IntersectsItemShape The output list contains both items whose
2358 \l{QGraphicsItem::shape()}{shape} is fully contained inside the
2359 selection area, and items that intersect with the area's
2360 outline. This is a common mode for rubber band selection.
2361
2362 \value ContainsItemBoundingRect The output list contains only items whose
2363 \l{QGraphicsItem::boundingRect()}{bounding rectangle} is fully
2364 contained inside the selection area. Items that intersect with the
2365 area's outline are not included.
2366
2367 \value IntersectsItemBoundingRect The output list contains both items
2368 whose \l{QGraphicsItem::boundingRect()}{bounding rectangle} is
2369 fully contained inside the selection area, and items that intersect
2370 with the area's outline. This method is commonly used for
2371 determining areas that need redrawing.
2372
2373 \sa QGraphicsScene::items(), QGraphicsScene::collidingItems(),
2374 QGraphicsView::items(), QGraphicsItem::collidesWithItem(),
2375 QGraphicsItem::collidesWithPath()
2376*/
2377
2378/*!
2379 \enum Qt::FillRule
2380
2381 Specifies which method should be used to fill the paths and polygons.
2382
2383 \value OddEvenFill Specifies that the region is filled using the
2384 odd even fill rule. With this rule, we determine whether a point
2385 is inside the shape by using the following method.
2386 Draw a horizontal line from the point to a location outside the shape,
2387 and count the number of intersections. If the number of intersections
2388 is an odd number, the point is inside the shape. This mode is the
2389 default.
2390
2391 \value WindingFill Specifies that the region is filled using the
2392 non zero winding rule. With this rule, we determine whether a
2393 point is inside the shape by using the following method.
2394 Draw a horizontal line from the point to a location outside the shape.
2395 Determine whether the direction of the line at each intersection point
2396 is up or down. The winding number is determined by summing the
2397 direction of each intersection. If the number is non zero, the point
2398 is inside the shape. This fill mode can also in most cases be considered
2399 as the intersection of closed shapes.
2400*/
2401
2402/*!
2403 \enum Qt::PaintUnit
2404
2405 \compat
2406
2407 \value PixelUnit
2408 \value LoMetricUnit Obsolete
2409 \value HiMetricUnit Obsolete
2410 \value LoEnglishUnit Obsolete
2411 \value HiEnglishUnit Obsolete
2412 \value TwipsUnit Obsolete
2413*/
2414
2415/*!
2416 \enum Qt::TextFormat
2417
2418 This enum is used in widgets that can display both plain text and
2419 rich text, e.g. QLabel. It is used for deciding whether a text
2420 string should be interpreted as one or the other. This is normally
2421 done by passing one of the enum values to a setTextFormat()
2422 function.
2423
2424 \value PlainText The text string is interpreted as a plain text
2425 string.
2426
2427 \value RichText The text string is interpreted as a rich text
2428 string.
2429
2430 \value AutoText The text string is interpreted as for
2431 Qt::RichText if Qt::mightBeRichText() returns true, otherwise
2432 as Qt::PlainText.
2433
2434 \value LogText A special, limited text format which is only used
2435 by Q3TextEdit in an optimized mode.
2436*/
2437
2438/*!
2439 \enum Qt::CursorShape
2440
2441 This enum type defines the various cursors that can be used.
2442
2443 The standard arrow cursor is the default for widgets in a normal state.
2444
2445 \value ArrowCursor \inlineimage cursor-arrow.png
2446 The standard arrow cursor.
2447 \value UpArrowCursor \inlineimage cursor-uparrow.png
2448 An arrow pointing upwards toward the top of the screen.
2449 \value CrossCursor \inlineimage cursor-cross.png
2450 A crosshair cursor, typically used to help the
2451 user accurately select a point on the screen.
2452 \value WaitCursor \inlineimage cursor-wait.png
2453 An hourglass or watch cursor, usually shown during
2454 operations that prevent the user from interacting with
2455 the application.
2456 \value IBeamCursor \inlineimage cursor-ibeam.png
2457 A caret or ibeam cursor, indicating that a widget can
2458 accept and display text input.
2459 \value SizeVerCursor \inlineimage cursor-sizev.png
2460 A cursor used for elements that are used to vertically
2461 resize top-level windows.
2462 \value SizeHorCursor \inlineimage cursor-sizeh.png
2463 A cursor used for elements that are used to horizontally
2464 resize top-level windows.
2465 \value SizeBDiagCursor \inlineimage cursor-sizeb.png
2466 A cursor used for elements that are used to diagonally
2467 resize top-level windows at their top-right and
2468 bottom-left corners.
2469 \value SizeFDiagCursor \inlineimage cursor-sizef.png
2470 A cursor used for elements that are used to diagonally
2471 resize top-level windows at their top-left and
2472 bottom-right corners.
2473 \value SizeAllCursor \inlineimage cursor-sizeall.png
2474 A cursor used for elements that are used to resize
2475 top-level windows in any direction.
2476 \value BlankCursor A blank/invisible cursor, typically used when the cursor
2477 shape needs to be hidden.
2478 \value SplitVCursor \inlineimage cursor-vsplit.png
2479 A cursor used for vertical splitters, indicating that
2480 a handle can be dragged horizontally to adjust the use
2481 of available space.
2482 \value SplitHCursor \inlineimage cursor-hsplit.png
2483 A cursor used for horizontal splitters, indicating that
2484 a handle can be dragged vertically to adjust the use
2485 of available space.
2486 \value PointingHandCursor \inlineimage cursor-hand.png
2487 A pointing hand cursor that is typically used for
2488 clickable elements such as hyperlinks.
2489 \value ForbiddenCursor \inlineimage cursor-forbidden.png
2490 A slashed circle cursor, typically used during drag
2491 and drop operations to indicate that dragged content
2492 cannot be dropped on particular widgets or inside
2493 certain regions.
2494 \value OpenHandCursor \inlineimage cursor-openhand.png
2495 A cursor representing an open hand, typically used to
2496 indicate that the area under the cursor is the visible
2497 part of a canvas that the user can click and drag in
2498 order to scroll around.
2499 \value ClosedHandCursor \inlineimage cursor-closedhand.png
2500 A cursor representing a closed hand, typically used to
2501 indicate that a dragging operation is in progress that
2502 involves scrolling.
2503 \value WhatsThisCursor \inlineimage cursor-whatsthis.png
2504 An arrow with a question mark, typically used to indicate
2505 the presence of What's This? help for a widget.
2506 \value BusyCursor \inlineimage cursor-wait.png
2507 An hourglass or watch cursor, usually shown during
2508 operations that allow the user to interact with
2509 the application while they are performed in the
2510 background.
2511 \value BitmapCursor
2512 \omitvalue LastCursor
2513 \omitvalue CustomCursor
2514
2515 \omitvalue arrowCursor
2516 \omitvalue upArrowCursor
2517 \omitvalue crossCursor
2518 \omitvalue waitCursor
2519 \omitvalue ibeamCursor
2520 \omitvalue sizeVerCursor
2521 \omitvalue sizeHorCursor
2522 \omitvalue sizeBDiagCursor
2523 \omitvalue sizeFDiagCursor
2524 \omitvalue sizeAllCursor
2525 \omitvalue blankCursor
2526 \omitvalue splitVCursor
2527 \omitvalue splitHCursor
2528 \omitvalue pointingHandCursor
2529 \omitvalue forbiddenCursor
2530 \omitvalue whatsThisCursor
2531*/
2532
2533/*!
2534 \typedef Qt::TextFlags
2535 \compat
2536
2537 Use Qt::TextFlag instead.
2538*/
2539
2540/*!
2541 \enum Qt::LayoutDirection
2542
2543 Specifies the direction of Qt's layouts:
2544
2545 \value LeftToRight Left-to-right layout.
2546 \value RightToLeft Right-to-left layout.
2547
2548 Right-to-left layouts are necessary for certain languages,
2549 notably Arabic and Hebrew.
2550
2551 \sa QApplication::setLayoutDirection(), QWidget::setLayoutDirection()
2552*/
2553
2554/*!
2555 \enum Qt::AnchorPoint
2556
2557 Specifies a side of a layout item that can be anchored. This is used by
2558 QGraphicsAnchorLayout.
2559
2560 \value AnchorLeft The left side of a layout item.
2561 \value AnchorHorizontalCenter A "virtual" side that is centered between the left and the
2562 right side of a layout item.
2563 \value AnchorRight The right side of a layout item.
2564 \value AnchorTop The top side of a layout item.
2565 \value AnchorVerticalCenter A "virtual" side that is centered between the top and the
2566 bottom side of a layout item.
2567 \value AnchorBottom The bottom side of a layout item.
2568
2569 \sa QGraphicsAnchorLayout
2570*/
2571
2572/*!
2573 \enum Qt::InputMethodHint
2574
2575 \value ImhNone No hints.
2576
2577 Flags that alter the behavior:
2578
2579 \value ImhHiddenText Characters should be hidden, as is typically used when entering passwords.
2580 This is automatically set when setting QLineEdit::echoMode to \c Password.
2581 \value ImhNoAutoUppercase The input method should not try to automatically switch to upper case
2582 when a sentence ends.
2583 \value ImhPreferNumbers Numbers are preferred (but not required).
2584 \value ImhPreferUppercase Upper case letters are preferred (but not required).
2585 \value ImhPreferLowercase Lower case letters are preferred (but not required).
2586 \value ImhNoPredictiveText Do not use predictive text (i.e. dictionary lookup) while typing.
2587
2588 Flags that restrict input (exclusive flags):
2589
2590 \value ImhDigitsOnly Only digits are allowed.
2591 \value ImhFormattedNumbersOnly Only number input is allowed. This includes decimal point and minus sign.
2592 \value ImhUppercaseOnly Only upper case letter input is allowed.
2593 \value ImhLowercaseOnly Only lower case letter input is allowed.
2594 \value ImhDialableCharactersOnly Only characters suitable for phone dialling are allowed.
2595 \value ImhEmailCharactersOnly Only characters suitable for email addresses are allowed.
2596 \value ImhUrlCharactersOnly Only characters suitable for URLs are allowed.
2597
2598 Masks:
2599
2600 \value ImhExclusiveInputMask This mask yields nonzero if any of the exclusive flags are used.
2601
2602 \note If several exclusive flags are ORed together, the resulting character set will
2603 consist of the union of the specified sets. For instance specifying \c ImhNumbersOnly and
2604 \c ImhUppercaseOnly would yield a set consisting of numbers and uppercase letters.
2605
2606 \sa QGraphicsItem::inputMethodHints()
2607*/
2608
2609/*!
2610 \enum Qt::InputMethodQuery
2611
2612 \value ImMicroFocus The rectangle covering the area of the input cursor in widget coordinates.
2613 \value ImFont The currently used font for text input.
2614 \value ImCursorPosition The logical position of the cursor within the text surrounding the input area (see \c ImSurroundingText).
2615 \value ImSurroundingText The plain text around the input area, for example the current paragraph.
2616 \value ImCurrentSelection The currently selected text.
2617 \value ImMaximumTextLength The maximum number of characters that the widget can hold. If there is no limit, QVariant() is returned.
2618 \value ImAnchorPosition The position of the selection anchor. This may be less or greater than \c ImCursorPosition, depending on which side of selection the cursor is. If there is no selection, it returns the same as \c ImCursorPosition.
2619*/
2620
2621/*!
2622 \enum Qt::ItemDataRole
2623
2624 Each item in the model has a set of data elements associated with
2625 it, each with its own role. The roles are used by the view to indicate
2626 to the model which type of data it needs. Custom models should return
2627 data in these types.
2628
2629 The general purpose roles (and the associated types) are:
2630
2631 \value DisplayRole The key data to be rendered in the form of text. (QString)
2632 \value DecorationRole The data to be rendered as a decoration in the form
2633 of an icon. (QColor, QIcon or QPixmap)
2634 \value EditRole The data in a form suitable for editing in an
2635 editor. (QString)
2636 \value ToolTipRole The data displayed in the item's tooltip. (QString)
2637 \value StatusTipRole The data displayed in the status bar. (QString)
2638 \value WhatsThisRole The data displayed for the item in "What's This?"
2639 mode. (QString)
2640 \value SizeHintRole The size hint for the item that will be supplied
2641 to views. (QSize)
2642
2643 Roles describing appearance and meta data (with associated types):
2644
2645 \value FontRole The font used for items rendered with the default
2646 delegate. (QFont)
2647 \value TextAlignmentRole The alignment of the text for items rendered with the
2648 default delegate. (Qt::AlignmentFlag)
2649 \value BackgroundRole The background brush used for items rendered with
2650 the default delegate. (QBrush)
2651 \value BackgroundColorRole This role is obsolete. Use BackgroundRole instead.
2652 \value ForegroundRole The foreground brush (text color, typically)
2653 used for items rendered with the default delegate.
2654 (QBrush)
2655 \value TextColorRole This role is obsolete. Use ForegroundRole instead.
2656 \value CheckStateRole This role is used to obtain the checked state of
2657 an item. (Qt::CheckState)
2658
2659 Accessibility roles (with associated types):
2660
2661 \value AccessibleTextRole The text to be used by accessibility
2662 extensions and plugins, such as screen
2663 readers. (QString)
2664 \value AccessibleDescriptionRole A description of the item for accessibility
2665 purposes. (QString)
2666
2667 User roles:
2668
2669 \value UserRole The first role that can be used for application-specific purposes.
2670
2671 \omitvalue DisplayPropertyRole
2672 \omitvalue DecorationPropertyRole
2673 \omitvalue ToolTipPropertyRole
2674 \omitvalue StatusTipPropertyRole
2675 \omitvalue WhatsThisPropertyRole
2676
2677 For user roles, it is up to the developer to decide which types to use and ensure that
2678 components use the correct types when accessing and setting data.
2679*/
2680
2681/*!
2682 \enum Qt::ItemFlag
2683
2684 This enum describes the properties of an item:
2685
2686 \value NoItemFlags It does not have any properties set.
2687 \value ItemIsSelectable It can be selected.
2688 \value ItemIsEditable It can be edited.
2689 \value ItemIsDragEnabled It can be dragged.
2690 \value ItemIsDropEnabled It can be used as a drop target.
2691 \value ItemIsUserCheckable It can be checked or unchecked by the user.
2692 \value ItemIsEnabled The user can interact with the item.
2693 \value ItemIsTristate The item is checkable with three separate states.
2694
2695 Note that checkable items need to be given both a suitable set of flags
2696 and an initial state, indicating whether the item is checked or not.
2697 This is handled automatically for model/view components, but needs
2698 to be explicitly set for instances of QListWidgetItem, QTableWidgetItem,
2699 and QTreeWidgetItem.
2700
2701 \sa QAbstractItemModel
2702*/
2703
2704/*!
2705 \enum Qt::MatchFlag
2706
2707 This enum describes the type of matches that can be used when searching
2708 for items in a model.
2709
2710 \value MatchExactly Performs QVariant-based matching.
2711 \value MatchFixedString Performs string-based matching.
2712 String-based comparisons are case-insensitive unless the
2713 \c MatchCaseSensitive flag is also specified.
2714 \value MatchContains The search term is contained in the item.
2715 \value MatchStartsWith The search term matches the start of the item.
2716 \value MatchEndsWith The search term matches the end of the item.
2717 \value MatchCaseSensitive The search is case sensitive.
2718 \value MatchRegExp Performs string-based matching using a regular
2719 expression as the search term.
2720 \value MatchWildcard Performs string-based matching using a string with
2721 wildcards as the search term.
2722 \value MatchWrap Perform a search that wraps around, so that when
2723 the search reaches the last item in the model, it begins again at
2724 the first item and continues until all items have been examined.
2725 \value MatchRecursive Searches the entire hierarchy.
2726
2727 \sa QString::compare(), QRegExp
2728*/
2729
2730/*!
2731 \enum Qt::TextElideMode
2732
2733 This enum specifies where the ellipsis should appear when
2734 displaying texts that don't fit:
2735
2736 \value ElideLeft The ellipsis should appear at the beginning of the text.
2737 \value ElideRight The ellipsis should appear at the end of the text.
2738 \value ElideMiddle The ellipsis should appear in the middle of the text.
2739 \value ElideNone Ellipsis should NOT appear in the text.
2740
2741 Qt::ElideMiddle is normally the most appropriate choice for URLs (e.g.,
2742 "\l{http://qt.nokia.com/careers/movingto/brisbane/}{http://qt.nok...ovingto/brisbane/}"),
2743 whereas Qt::ElideRight is appropriate
2744 for other strings (e.g.,
2745 "\l{http://qt.nokia.com/doc/qq/qq09-mac-deployment.html}{Deploying Applications on Ma...}").
2746
2747 \sa QAbstractItemView::textElideMode, QFontMetrics::elidedText(), AlignmentFlag QTabBar::elideMode
2748*/
2749
2750/*!
2751 \enum Qt::WindowModality
2752
2753 \keyword modal
2754
2755 This enum specifies the behavior of a modal window. A modal window
2756 is one that blocks input to other windows. Note that windows that
2757 are children of a modal window are not blocked.
2758
2759 The values are:
2760 \value NonModal The window is not modal and does not block input to other windows.
2761 \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.
2762 \value ApplicationModal The window is modal to the application and blocks input to all windows.
2763
2764 \sa QWidget::windowModality, QDialog
2765*/
2766
2767/*!
2768 \enum Qt::TextInteractionFlag
2769
2770 This enum specifies how a text displaying widget reacts to user input.
2771
2772 \value NoTextInteraction No interaction with the text is possible.
2773 \value TextSelectableByMouse Text can be selected with the mouse and copied to the clipboard using
2774 a context menu or standard keyboard shortcuts.
2775 \value TextSelectableByKeyboard Text can be selected with the cursor keys on the keyboard. A text cursor is shown.
2776 \value LinksAccessibleByMouse Links can be highlighted and activated with the mouse.
2777 \value LinksAccessibleByKeyboard Links can be focused using tab and activated with enter.
2778 \value TextEditable The text is fully editable.
2779
2780 \value TextEditorInteraction The default for a text editor.
2781 \value TextBrowserInteraction The default for QTextBrowser.
2782*/
2783
2784/*!
2785 \enum Qt::MaskMode
2786
2787 This enum specifies the behavior of the
2788 QPixmap::createMaskFromColor() and QImage::createMaskFromColor()
2789 functions.
2790
2791 \value MaskInColor Creates a mask where all pixels matching the given color are opaque.
2792 \value MaskOutColor Creates a mask where all pixels matching the given color are transparent.
2793*/
2794
2795/*!
2796 \enum Qt::DockWidgetAreaSizes
2797 \internal
2798*/
2799
2800/*!
2801 \enum Qt::ToolBarAreaSizes
2802 \internal
2803*/
2804
2805/*!
2806 \enum Qt::EventPriority
2807
2808 This enum can be used to specify event priorities.
2809
2810 \value HighEventPriority Events with this priority are sent before
2811 events with NormalEventPriority or LowEventPriority.
2812
2813 \value NormalEventPriority Events with this priority are sent
2814 after events with HighEventPriority, but before events with
2815 LowEventPriority.
2816
2817 \value LowEventPriority Events with this priority are sent after
2818 events with HighEventPriority or NormalEventPriority.
2819
2820 Note that these values are provided purely for convenience, since
2821 event priorities can be any value between \c INT_MAX and \c
2822 INT_MIN, inclusive. For example, you can define custom priorities
2823 as being relative to each other:
2824
2825 \snippet doc/src/snippets/code/doc_src_qnamespace.qdoc 1
2826
2827 \sa QCoreApplication::postEvent()
2828*/
2829/*!
2830 \enum Qt::SizeHint
2831 \since 4.4
2832
2833 This enum is used by QGraphicsLayoutItem::sizeHint()
2834
2835 \value MinimumSize is used to specify the minimum size of a graphics layout item.
2836 \value PreferredSize is used to specify the preferred size of a graphics layout item.
2837 \value MaximumSize is used to specify the maximum size of a graphics layout item.
2838 \value MinimumDescent is used to specify the minimum descent of a text string in a graphics layout item.
2839 \omitvalue NSizeHints
2840
2841 \sa QGraphicsLayoutItem::sizeHint()
2842*/
2843
2844/*!
2845 \enum Qt::SizeMode
2846 \since 4.4
2847
2848 This enum is used by QPainter::drawRoundedRect() and QPainterPath::addRoundedRect()
2849 functions to specify the radii of rectangle corners with respect to the dimensions
2850 of the bounding rectangles specified.
2851
2852 \value AbsoluteSize Specifies the size using absolute measurements.
2853 \value RelativeSize Specifies the size relative to the bounding rectangle,
2854 typically using percentage measurements.
2855*/
2856
2857/*!
2858 \enum Qt::WindowFrameSection
2859 \since 4.4
2860
2861 This enum is used to describe parts of a window frame. It is returned by
2862 QGraphicsWidget::windowFrameSectionAt() to describe what section of the window
2863 frame is under the mouse.
2864
2865 \value NoSection
2866 \value LeftSection
2867 \value TopLeftSection
2868 \value TopSection
2869 \value TopRightSection
2870 \value RightSection
2871 \value BottomRightSection
2872 \value BottomSection
2873 \value BottomLeftSection
2874 \value TitleBarArea
2875
2876 \sa QGraphicsWidget::windowFrameEvent()
2877 \sa QGraphicsWidget::paintWindowFrame()
2878 \sa QGraphicsWidget::windowFrameSectionAt()
2879
2880*/
2881
2882/*!
2883 \enum Qt::TileRule
2884 \since 4.6
2885
2886 This enum describes how to repeat or stretch the parts of an image
2887 when drawing.
2888
2889 \value StretchTile Scale the image to fit to the available area.
2890
2891 \value RepeatTile Repeat the image until there is no more space. May
2892 crop the last image.
2893
2894 \value RoundTile Similar to Repeat, but scales the image down to
2895 ensure that the last tile is not cropped.
2896*/
2897
2898/*!
2899 \enum Qt::Initialization
2900 \internal
2901*/
2902
2903/*!
2904 \enum Qt::CoordinateSystem
2905 \since 4.6
2906
2907 This enum specifies the coordinate system.
2908
2909 \value DeviceCoordinates Coordinates are relative to the upper-left corner
2910 of the object's paint device.
2911
2912 \value LogicalCoordinates Coordinates are relative to the upper-left corner
2913 of the object.
2914*/
2915
2916/*!
2917 \enum Qt::GestureState
2918 \since 4.6
2919
2920 This enum type describes the state of a gesture.
2921
2922 \value GestureStarted A continuous gesture has started.
2923 \value GestureUpdated A gesture continues.
2924 \value GestureFinished A gesture has finished.
2925 \value GestureCanceled A gesture was canceled.
2926 \omitvalue NoGesture
2927
2928 \sa QGesture
2929*/
2930
2931/*!
2932 \enum Qt::GestureType
2933 \since 4.6
2934
2935 This enum type describes the standard gestures.
2936
2937 \value TapGesture A Tap gesture.
2938 \value TapAndHoldGesture A Tap-And-Hold (Long-Tap) gesture.
2939 \value PanGesture A Pan gesture.
2940 \value PinchGesture A Pinch gesture.
2941 \value SwipeGesture A Swipe gesture.
2942 \value CustomGesture A flag that can be used to test if the gesture is a
2943 user-defined gesture ID.
2944 \omitvalue LastGestureType
2945
2946 User-defined gestures are registered with the
2947 QGestureRecognizer::registerRecognizer() function which generates a custom
2948 gesture ID with the Qt::CustomGesture flag set.
2949
2950 \sa QGesture, QWidget::grabGesture(), QGraphicsObject::grabGesture()
2951*/
2952
2953/*!
2954 \enum Qt::GestureFlag
2955 \since 4.6
2956
2957 This enum type describes additional flags that can be used when subscribing
2958 to a gesture.
2959
2960 \value DontStartGestureOnChildren By default gestures can start on the
2961 widget or over any of its children. Use this flag to disable this and allow
2962 a gesture to start on the widget only.
2963
2964 \value ReceivePartialGestures Allows any ignored gesture events to be
2965 propagated to parent widgets which have specified this hint. By default
2966 only gestures that are in the Qt::GestureStarted state are propagated and
2967 the widget always gets the full gesture sequence starting with a gesture in
2968 the Qt::GestureStarted state and ending with a gesture in the
2969 Qt::GestureFinished or Qt::GestureCanceled states.
2970
2971 \sa QWidget::grabGesture(), QGraphicsObject::grabGesture()
2972*/
2973
2974/*!
2975 \enum Qt::NavigationMode
2976 \since 4.6
2977
2978 This enum type describes the mode for moving focus.
2979
2980 \value NavigationModeNone Only the touch screen is used.
2981 \value NavigationModeKeypadTabOrder Qt::Key_Up and Qt::Key_Down are used to change focus.
2982 \value NavigationModeKeypadDirectional Qt::Key_Up, Qt::Key_Down, Qt::Key_Left and Qt::Key_Right are used to change focus.
2983 \value NavigationModeCursorAuto The mouse cursor is used to change focus,
2984 it is displayed only on non touchscreen devices.
2985 The keypad is used to implement a virtual cursor, unless
2986 the device has an analog mouse type of input device (e.g. touchpad).
2987 This is the recommended setting for an application such as a web browser that
2988 needs pointer control on both touch and non-touch devices.
2989 \value NavigationModeCursorForceVisible The mouse cursor is used to change focus,
2990 it is displayed regardless of device type.
2991 The keypad is used to implement a virtual cursor, unless
2992 the device has an analog mouse type of input device (e.g. touchpad)
2993
2994 \note: in 4.6, cursor navigation is only implemented for Symbian OS.
2995 On other platforms, it behaves as NavigationModeNone.
2996 \sa QApplication::setNavigationMode()
2997 \sa QApplication::navigationMode()
2998*/
Note: See TracBrowser for help on using the repository browser.