1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the documentation of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    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 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    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 

   138            Menus that are currently open or menus already created in the native

   139            Mac OS X menubar \e{may not} pick up a change in this attribute. Changes

   140            in the QAction::iconVisibleInMenu property will always be picked up.

   141 

   142     \value AA_NativeWindows Ensures that widgets have native windows.

   143 

   144     \value AA_DontCreateNativeWidgetSiblings Ensures that siblings of native

   145            widgets stay non-native unless specifically set by the

   146            Qt::WA_NativeWindow attribute.

   147 

   148     \value AA_MacPluginApplication Stops the Qt mac application from doing

   149            specific initializations that do not necessarily make sense when using Qt

   150            to author a plugin. This includes avoiding loading our nib for the main

   151            menu and not taking possession of the native menu bar. When setting this

   152            attribute to true will also set the AA_DontUseNativeMenuBar attribute

   153            to true.

   154 

   155     \value AA_DontUseNativeMenuBar All menubars created while this attribute is

   156            set to true won't be used as a native menubar (e.g, the menubar at

   157            the top of the main screen on Mac OS X or at the bottom in Windows CE).

   158 

   159     \value AA_MacDontSwapCtrlAndMeta On Mac OS X by default, Qt swaps the

   160            Control and Meta (Command) keys (i.e., whenever Control is pressed, Qt

   161            sends Meta and whenever Meta is pressed Control is sent. When this

   162            attribute is true, Qt will not do the flip. QKeySequence::StandardShortcuts

   163            will also flip accordingly (i.e., QKeySequence::Copy will be

   164            Command+C on the keyboard regardless of the value set, though what is output for

   165            QKeySequence::toString(QKeySequence::PortableText) will be different).

   166 

   167     \omitvalue AA_AttributeCount

   168 */

   169 

   170 /*!

   171     \enum Qt::MouseButton

   172 

   173     This enum type describes the different mouse buttons.

   174 

   175     \value NoButton        The button state does not refer to any

   176     button (see QMouseEvent::button()).

   177     \value LeftButton      The left button is pressed, or an event refers

   178     to the left button. (The left button may be the right button on

   179     left-handed mice.)

   180     \value RightButton     The right button.

   181     \value MidButton       The middle button.

   182     \value XButton1        The first X button.

   183     \value XButton2        The second X button.

   184 

   185     \omitvalue MouseButtonMask

   186 

   187     \sa KeyboardModifier Modifier

   188 */

   189 

   190 /*!

   191     \enum Qt::KeyboardModifier

   192 

   193     This enum describes the modifier keys.

   194 

   195     \value NoModifier       No modifier key is pressed.

   196     \value ShiftModifier    A Shift key on the keyboard is pressed.

   197     \value ControlModifier  A Ctrl key on the keyboard is pressed.

   198     \value AltModifier      An Alt key on the keyboard is pressed.

   199     \value MetaModifier     A Meta key on the keyboard is pressed.

   200     \value KeypadModifier   A keypad button is pressed.

   201     \value GroupSwitchModifier X11 only. A Mode_switch key on the keyboard is pressed.

   202 

   203     \omitvalue KeyboardModifierMask

   204 

   205     \note On Mac OS X, the \c ControlModifier value corresponds to

   206     the Command keys on the Macintosh keyboard, and the \c MetaModifier value

   207     corresponds to the Control keys. The \c KeypadModifier value will also be set

   208     when an arrow key is pressed as the arrow keys are considered part of the

   209     keypad.

   210 

   211     \note On Windows Keyboards, Qt::MetaModifier and Qt::Key_Meta are mapped

   212     to the Windows key.

   213 

   214     \sa MouseButton Modifier

   215 */

   216 

   217 /*!

   218     \enum Qt::Modifier

   219 

   220     This enum provides shorter names for the keyboard modifier keys

   221     supported by Qt.

   222 

   223     \bold{Note:} On Mac OS X, the \c CTRL value corresponds to

   224     the Command keys on the Macintosh keyboard, and the \c META value

   225     corresponds to the Control keys.

   226 

   227     \value SHIFT The Shift keys provided on all standard keyboards.

   228     \value META The Meta keys.

   229     \value CTRL The Ctrl keys.

   230     \value ALT The normal Alt keys, but not keys like AltGr.

   231     \value UNICODE_ACCEL The shortcut is specified as a Unicode code

   232     point, not as a Qt Key.

   233     \omitvalue MODIFIER_MASK

   234 

   235     \sa KeyboardModifier MouseButton

   236 */

   237 

   238 /*!

   239     \enum Qt::GlobalColor

   240 

   241     \raw HTML

   242     <style type="text/css" id="colorstyles">

   243      #white { background-color: #ffffff; color: #000000 }

   244      #black { background-color: #000000; color: #ffffff }

   245      #red { background-color: #ff0000; color: #000000 }

   246      #darkRed { background-color: #800000; color: #ffffff }

   247      #green { background-color: #00ff00; color: #000000 }

   248      #darkGreen { background-color: #008000; color: #ffffff }

   249      #blue { background-color: #0000ff; color: #ffffff }

   250      #darkBlue { background-color: #000080; color: #ffffff }

   251      #cyan { background-color: #00ffff; color: #000000 }

   252      #darkCyan { background-color: #008080; color: #ffffff }

   253      #magenta { background-color: #ff00ff; color: #000000 }

   254      #darkMagenta { background-color: #800080; color: #ffffff }

   255      #yellow { background-color: #ffff00; color: #000000 }

   256      #darkYellow { background-color: #808000; color: #ffffff }

   257      #gray { background-color: #a0a0a4; color: #000000 }

   258      #darkGray { background-color: #808080; color: #ffffff }

   259      #lightGray { background-color: #c0c0c0; color: #000000 }

   260     </style>

   261     \endraw

   262 

   263     Qt's predefined QColor objects:

   264 

   265     \value white       \raw HTML

   266     White <tt id="white">(#ffffff)</tt>

   267     \endraw

   268     \value black       \raw HTML

   269     Black <tt id="black">(#000000)</tt>

   270     \endraw

   271     \value red         \raw HTML

   272     Red <tt id="red">(#ff0000)</tt>

   273     \endraw

   274     \value darkRed     \raw HTML

   275     Dark red <tt id="darkRed">(#800000)</tt>

   276     \endraw

   277     \value green       \raw HTML

   278     Green <tt id="green">(#00ff00)</tt>

   279     \endraw

   280     \value darkGreen   \raw HTML

   281     Dark green <tt id="darkGreen">(#008000)</tt>

   282     \endraw

   283     \value blue        \raw HTML

   284     Blue <tt id="blue">(#0000ff)</tt>

   285     \endraw

   286     \value darkBlue    \raw HTML

   287     Dark blue <tt id="darkBlue">(#000080)</tt>

   288     \endraw

   289     \value cyan        \raw HTML

   290     Cyan <tt id="cyan">(#00ffff)</tt>

   291     \endraw

   292     \value darkCyan    \raw HTML

   293     Dark cyan <tt id="darkCyan">(#008080)</tt>

   294     \endraw

   295     \value magenta     \raw HTML

   296     Magenta <tt id="magenta">(#ff00ff)</tt>

   297     \endraw

   298     \value darkMagenta \raw HTML

   299     Dark magenta <tt id="darkMagenta">(#800080)</tt>

   300     \endraw

   301     \value yellow      \raw HTML

   302     Yellow <tt id="yellow">(#ffff00)</tt>

   303     \endraw

   304     \value darkYellow  \raw HTML

   305     Dark yellow <tt id="darkYellow">(#808000)</tt>

   306     \endraw

   307     \value gray        \raw HTML

   308     Gray <tt id="gray">(#a0a0a4)</tt>

   309     \endraw

   310     \value darkGray    \raw HTML

   311     Dark gray <tt id="darkGray">(#808080)</tt>

   312     \endraw

   313     \value lightGray   \raw HTML

   314     Light gray <tt id="lightGray">(#c0c0c0)</tt>

   315     \endraw

   316     \value transparent a transparent black value (i.e., QColor(0, 0, 0, 0))

   317     \value color0 0 pixel value (for bitmaps)

   318     \value color1 1 pixel value (for bitmaps)

   319 

   320     \sa QColor

   321 

   322 */

   323 

   324 /*!

   325     \enum Qt::PenStyle

   326 

   327     This enum type defines the pen styles that can be drawn using

   328     QPainter. The styles are:

   329 

   330     \table

   331     \row

   332     \o \inlineimage qpen-solid.png

   333     \o \inlineimage qpen-dash.png

   334     \o \inlineimage qpen-dot.png

   335     \row

   336     \o Qt::SolidLine

   337     \o Qt::DashLine

   338     \o Qt::DotLine

   339     \row

   340     \o \inlineimage qpen-dashdot.png

   341     \o \inlineimage qpen-dashdotdot.png

   342     \o \inlineimage qpen-custom.png

   343     \row

   344     \o Qt::DashDotLine

   345     \o Qt::DashDotDotLine

   346     \o Qt::CustomDashLine

   347     \endtable

   348 

   349     \value NoPen  no line at all. For example, QPainter::drawRect()

   350     fills but does not draw any boundary line.

   351 

   352     \value SolidLine  A plain line.

   353     \value DashLine  Dashes separated by a few pixels.

   354     \value DotLine  Dots separated by a few pixels.

   355     \value DashDotLine  Alternate dots and dashes.

   356     \value DashDotDotLine  One dash, two dots, one dash, two dots.

   357     \value CustomDashLine  A custom pattern defined using

   358                            QPainterPathStroker::setDashPattern().

   359 

   360     \omitvalue MPenStyle

   361 

   362     \sa QPen

   363 */

   364 

   365 /*!

   366     \enum Qt::PenCapStyle

   367 

   368     This enum type defines the pen cap styles supported by Qt, i.e.

   369     the line end caps that can be drawn using QPainter.

   370 

   371     \table

   372     \row

   373     \o \inlineimage qpen-square.png

   374     \o \inlineimage qpen-flat.png

   375     \o \inlineimage qpen-roundcap.png

   376     \row

   377     \o Qt::SquareCap

   378     \o Qt::FlatCap

   379     \o Qt::RoundCap

   380     \endtable

   381 

   382     \value FlatCap  a square line end that does not cover the end

   383         point of the line.

   384     \value SquareCap  a square line end that covers the end point and

   385         extends beyond it by half the line width.

   386     \value RoundCap  a rounded line end.

   387     \omitvalue MPenCapStyle

   388 

   389     \sa QPen

   390 */

   391 

   392 /*!

   393     \enum Qt::PenJoinStyle

   394 

   395     This enum type defines the pen join styles supported by Qt, i.e.

   396     which joins between two connected lines can be drawn using

   397     QPainter.

   398 

   399     \table

   400     \row

   401     \o \inlineimage qpen-bevel.png

   402     \o \inlineimage qpen-miter.png

   403     \o \inlineimage qpen-roundjoin.png

   404     \row

   405     \o Qt::BevelJoin

   406     \o Qt::MiterJoin

   407     \o Qt::RoundJoin

   408     \endtable

   409 

   410     \value MiterJoin  The outer edges of the lines are extended to

   411            meet at an angle, and this area is filled.

   412     \value BevelJoin  The triangular notch between the two lines is filled.

   413     \value RoundJoin  A circular arc between the two lines is filled.

   414     \value SvgMiterJoin A miter join corresponding to the definition of

   415            a miter join in the \l{SVG 1.2 Tiny} specification.

   416     \omitvalue MPenJoinStyle

   417 

   418     \sa QPen

   419 */

   420 

   421 /*!

   422     \enum Qt::BrushStyle

   423 

   424     This enum type defines the brush styles supported by Qt, i.e. the

   425     fill pattern of shapes drawn using QPainter.

   426 

   427     \image brush-styles.png Brush Styles

   428 

   429     \value NoBrush  No brush pattern.

   430     \value SolidPattern  Uniform color.

   431     \value Dense1Pattern  Extremely dense brush pattern.

   432     \value Dense2Pattern  Very dense brush pattern.

   433     \value Dense3Pattern  Somewhat dense brush pattern.

   434     \value Dense4Pattern  Half dense brush pattern.

   435     \value Dense5Pattern  Somewhat sparse brush pattern.

   436     \value Dense6Pattern  Very sparse brush pattern.

   437     \value Dense7Pattern  Extremely sparse brush pattern.

   438     \value HorPattern  Horizontal lines.

   439     \value VerPattern  Vertical lines.

   440     \value CrossPattern  Crossing horizontal and vertical lines.

   441     \value BDiagPattern  Backward diagonal lines.

   442     \value FDiagPattern  Forward diagonal lines.

   443     \value DiagCrossPattern  Crossing diagonal lines.

   444     \value LinearGradientPattern  Linear gradient (set using a dedicated QBrush constructor).

   445     \value ConicalGradientPattern  Conical gradient (set using a dedicated QBrush constructor).

   446     \value RadialGradientPattern  Radial gradient (set using a dedicated QBrush constructor).

   447     \value TexturePattern  Custom pattern (see QBrush::setTexture()).

   448 

   449     \omitvalue CustomPattern

   450 

   451     \sa QBrush

   452 */

   453 

   454 /*!

   455     \enum Qt::TextFlag

   456 

   457     This enum type is used to define some modifier flags. Some of

   458     these flags only make sense in the context of printing:

   459 

   460     \value TextSingleLine Treats all whitespace as spaces and prints just

   461            one line.

   462     \value TextDontClip If it's impossible to stay within the given bounds,

   463            it prints outside.

   464     \value TextExpandTabs Makes the U+0009 (ASCII tab) character move to

   465            the next tab stop.

   466     \value TextShowMnemonic Displays the string "\&P" as \underline{P}

   467            (see QButton for an example). For an ampersand, use "\&\&".

   468     \value TextWordWrap Breaks lines at appropriate points, e.g. at word

   469            boundaries.

   470     \value TextWrapAnywhere Breaks lines anywhere, even within words.

   471     \value TextHideMnemonic Same as Qt::TextShowMnemonic but doesn't draw the underlines.

   472     \value TextDontPrint Treat this text as "hidden" and don't print

   473     it.

   474     \value IncludeTrailingSpaces When this option is set, QTextLine::naturalTextWidth() and naturalTextRect() will

   475                                  return a value that includes the width of trailing spaces in the text; otherwise

   476                                  this width is excluded.

   477     \value TextIncludeTrailingSpaces Same as IncludeTrailingSpaces

   478     \value TextJustificationForced Ensures that text lines are justified.

   479 

   480     \omitvalue BreakAnywhere

   481     \omitvalue DontClip

   482     \omitvalue DontPrint

   483     \omitvalue ExpandTabs

   484     \omitvalue IncludeTrailingSpaces

   485     \omitvalue NoAccel

   486     \omitvalue ShowPrefix

   487     \omitvalue SingleLine

   488     \omitvalue WordBreak

   489     \omitvalue TextForceLeftToRight

   490     \omitvalue TextForceRightToLeft

   491     \omitvalue TextLongestVariant Always use the longest variant when computing the size of a multi-variant string

   492 

   493     You can use as many modifier flags as you want, except that

   494     Qt::TextSingleLine and Qt::TextWordWrap cannot be combined.

   495 

   496     Flags that are inappropriate for a given use are generally

   497     ignored.

   498 */

   499 

   500 /*!

   501     \enum Qt::BGMode

   502 

   503     Background mode:

   504 

   505     \value TransparentMode

   506     \value OpaqueMode

   507 */

   508 

   509 /*!

   510     \enum Qt::ConnectionType

   511 

   512     This enum describes the types of connection that can be used between signals and

   513     slots. In particular, it determines whether a particular signal is delivered to a

   514     slot immediately or queued for delivery at a later time.

   515 

   516     \value DirectConnection  When emitted, the signal is immediately delivered to the slot.

   517     \value QueuedConnection  When emitted, the signal is queued until the event loop is

   518                              able to deliver it to the slot.

   519     \value BlockingQueuedConnection

   520                              Same as QueuedConnection, except that the current thread blocks

   521                              until the slot has been delivered. This connection type should

   522                              only be used for receivers in a different thread. Note that misuse

   523                              of this type can lead to deadlocks in your application.

   524     \value AutoConnection    If the signal is emitted from the thread

   525                              in which the receiving object lives, the

   526                              slot is invoked directly, as with

   527                              Qt::DirectConnection; otherwise the

   528                              signal is queued, as with

   529                              Qt::QueuedConnection.

   530     \value UniqueConnection  Same as AutoConnection, but there will be a check that the signal is

   531                              not already connected to the same slot before connecting, otherwise,

   532                              the connection will fail.

   533                              This value was introduced in Qt 4.6.

   534     \value AutoCompatConnection

   535            The default connection type for signals and slots when Qt 3 support

   536            is enabled. Equivalent to AutoConnection for connections but will cause warnings

   537            to be output under certain circumstances. See

   538            \l{Porting to Qt 4#Compatibility Signals and Slots}{Compatibility Signals and Slots}

   539            for further information.

   540 

   541     With queued connections, the parameters must be of types that are known to

   542     Qt's meta-object system, because Qt needs to copy the arguments to store them

   543     in an event behind the scenes. If you try to use a queued connection and

   544     get the error message

   545 

   546     \snippet doc/src/snippets/code/doc_src_qnamespace.qdoc 0

   547 

   548     call qRegisterMetaType() to register the data type before you

   549     establish the connection.

   550 

   551     \sa {Thread Support in Qt}, QObject::connect(), qRegisterMetaType()

   552 */

   553 

   554 /*!

   555     \enum Qt::DateFormat

   556 

   557     \value TextDate The default Qt format, which includes the day and month name,

   558     the day number in the month, and the year in full. The day and month names will

   559     be short, localized names. This is basically equivalent to using the date format

   560     string, "ddd MMM d yyyy". See QDate::toString() for more information.

   561 

   562     \value ISODate ISO 8601 extended format: either \c{YYYY-MM-DD} for dates or

   563     \c{YYYY-MM-DDTHH:MM:SS} for combined dates and times.

   564 

   565     \value SystemLocaleShortDate The \l{QLocale::ShortFormat}{short format} used

   566     by the \l{QLocale::system()}{operating system}.

   567 

   568     \value SystemLocaleLongDate The \l{QLocale::LongFormat}{long format} used

   569     by the \l{QLocale::system()}{operating system}.

   570 

   571     \value DefaultLocaleShortDate The \l{QLocale::ShortFormat}{short format} specified

   572     by the \l{QLocale::setDefault()}{application's locale}.

   573 

   574     \value DefaultLocaleLongDate The \l{QLocale::LongFormat}{long format} used

   575     by the \l{QLocale::setDefault()}{application's locale}.

   576 

   577     \value SystemLocaleDate \e{This enum value is deprecated.} Use Qt::SystemLocaleShortDate

   578     instead (or Qt::SystemLocaleLongDate if you want long dates).

   579 

   580     \value LocaleDate \e{This enum value is deprecated.} Use Qt::DefaultLocaleShortDate

   581     instead (or Qt::DefaultLocaleLongDate if you want long dates).

   582 

   583     \value LocalDate \e{This enum value is deprecated.} Use Qt::SystemLocaleShortDate

   584     instead (or Qt::SystemLocaleLongDate if you want long dates).

   585 

   586     \note For \c ISODate formats, each \c Y, \c M and \c D represents a single digit

   587     of the year, month and day used to specify the date. Each \c H, \c M and \c S

   588     represents a single digit of the hour, minute and second used to specify the time.

   589     The presence of a literal \c T character is used to separate the date and time when

   590     both are specified.

   591 */

   592 

   593 

   594 /*!

   595     \enum Qt::TimeSpec

   596 

   597     \value LocalTime Locale dependent time (Timezones and Daylight Savings Time).

   598     \value UTC Coordinated Universal Time, replaces Greenwich Mean Time.

   599     \value OffsetFromUTC An offset in seconds from Coordinated Universal Time.

   600 */

   601 

   602 /*!

   603     \enum Qt::DayOfWeek

   604 

   605     \value Monday

   606     \value Tuesday

   607     \value Wednesday

   608     \value Thursday

   609     \value Friday

   610     \value Saturday

   611     \value Sunday

   612 */

   613 

   614 /*!

   615     \enum Qt::CaseSensitivity

   616 

   617     \value CaseInsensitive

   618     \value CaseSensitive

   619 */

   620 

   621 /*!

   622     \enum Qt::ToolBarArea

   623 

   624     \value LeftToolBarArea

   625     \value RightToolBarArea

   626     \value TopToolBarArea

   627     \value BottomToolBarArea

   628     \value AllToolBarAreas

   629     \value NoToolBarArea

   630 

   631     \omitvalue ToolBarArea_Mask

   632 */

   633 

   634 /*!

   635     \enum Qt::DockWidgetArea

   636 

   637     \value LeftDockWidgetArea

   638     \value RightDockWidgetArea

   639     \value TopDockWidgetArea

   640     \value BottomDockWidgetArea

   641     \value AllDockWidgetAreas

   642     \value NoDockWidgetArea

   643 

   644     \omitvalue DockWidgetArea_Mask

   645 */

   646 

   647 /*!

   648     \enum Qt::BackgroundMode

   649 

   650     \compat

   651 

   652     \value FixedColor

   653     \value FixedPixmap

   654     \value NoBackground

   655     \value PaletteForeground

   656     \value PaletteButton

   657     \value PaletteLight

   658     \value PaletteMidlight

   659     \value PaletteDark

   660     \value PaletteMid

   661     \value PaletteText

   662     \value PaletteBrightText

   663     \value PaletteBase

   664     \value PaletteBackground

   665     \value PaletteShadow

   666     \value PaletteHighlight

   667     \value PaletteHighlightedText

   668     \value PaletteButtonText

   669     \value PaletteLink

   670     \value PaletteLinkVisited

   671     \value X11ParentRelative

   672 */

   673 

   674 /*!

   675     \enum Qt::ImageConversionFlag

   676 

   677     The options marked "(default)" are set if no other values from

   678     the list are included (since the defaults are zero):

   679 

   680     Color/Mono preference (ignored for QBitmap):

   681 

   682     \value AutoColor (default) - If the image has \link

   683            QImage::depth() depth\endlink 1 and contains only

   684            black and white pixels, the pixmap becomes monochrome.

   685     \value ColorOnly The pixmap is dithered/converted to the

   686            \link QPixmap::defaultDepth() native display depth\endlink.

   687     \value MonoOnly The pixmap becomes monochrome. If necessary,

   688            it is dithered using the chosen dithering algorithm.

   689 

   690     Dithering mode preference for RGB channels:

   691 

   692     \value DiffuseDither (default) - A high-quality dither.

   693     \value OrderedDither A faster, more ordered dither.

   694     \value ThresholdDither No dithering; closest color is used.

   695 

   696     Dithering mode preference for alpha channel:

   697 

   698     \value ThresholdAlphaDither (default) - No dithering.

   699     \value OrderedAlphaDither A faster, more ordered dither.

   700     \value DiffuseAlphaDither A high-quality dither.

   701     \omitvalue NoAlpha

   702 

   703     Color matching versus dithering preference:

   704 

   705     \value PreferDither (default when converting to a pixmap) - Always dither

   706            32-bit images when the image is converted to 8 bits.

   707     \value AvoidDither (default when converting for the purpose of saving to

   708            file) - Dither 32-bit images only if the image has more than 256

   709            colors and it is being converted to 8 bits.

   710     \omitvalue AutoDither

   711 

   712     \omitvalue ColorMode_Mask

   713     \omitvalue Dither_Mask

   714     \omitvalue AlphaDither_Mask

   715     \omitvalue DitherMode_Mask

   716 

   717     \value NoOpaqueDetection Do not check whether the image contains non-opaque

   718            pixels. Use this if you know that the image is semi-transparent and

   719            you want to avoid the overhead of checking the pixels in the image

   720            until a non-opaque pixel is found, or if you want the pixmap to

   721            retain an alpha channel for some other reason. If the image has no

   722            alpha channel this flag has no effect.

   723 */

   724 

   725 /*! \enum Qt::GUIStyle

   726 

   727     \compat

   728 

   729     \value WindowsStyle

   730     \value MotifStyle

   731     \value MacStyle

   732     \value Win3Style

   733     \value PMStyle

   734 */

   735 

   736 /*!

   737     \enum Qt::UIEffect

   738 

   739     This enum describes the available UI effects.

   740 

   741     By default, Qt will try to use the platform specific desktop

   742     settings for each effect. Use the

   743     QApplication::setDesktopSettingsAware() function (passing \c false

   744     as argument) to prevent this, and the

   745     QApplication::setEffectEnabled() to enable or disable a particular

   746     effect.

   747 

   748     Note that all effects are disabled on screens running at less than

   749     16-bit color depth.

   750 

   751     \omitvalue UI_General

   752 

   753     \value UI_AnimateMenu Show animated menus.

   754     \value UI_FadeMenu Show faded menus.

   755     \value UI_AnimateCombo Show animated comboboxes.

   756     \value UI_AnimateTooltip Show tooltip animations.

   757     \value UI_FadeTooltip Show tooltip fading effects.

   758     \value UI_AnimateToolBox Reserved

   759 

   760     \sa QApplication::setEffectEnabled(), QApplication::setDesktopSettingsAware()

   761 */

   762 

   763 /*! \enum Qt::AspectRatioMode

   764 

   765     This enum type defines what happens to the aspect ratio when

   766     scaling an rectangle.

   767 

   768     \image qimage-scaling.png

   769 

   770     \value IgnoreAspectRatio  The size is scaled freely. The aspect

   771                               ratio is not preserved.

   772     \value KeepAspectRatio  The size is scaled to a rectangle as

   773                             large as possible inside a given

   774                             rectangle, preserving the aspect ratio.

   775     \value KeepAspectRatioByExpanding  The size is scaled to a

   776                                        rectangle as small as possible

   777                                        outside a given rectangle,

   778                                        preserving the aspect ratio.

   779 

   780     \omitvalue ScaleFree

   781     \omitvalue ScaleMin

   782     \omitvalue ScaleMax

   783 

   784     \sa QSize::scale(), QImage::scaled()

   785 */

   786 

   787 /*! \typedef Qt::ScaleMode

   788     \compat

   789 

   790     Use Qt::AspectRatioMode instead.

   791 

   792     The enum values have been renamed as follows:

   793 

   794     \table

   795     \row \i Old enum value \i New enum value

   796     \row \i Qt::ScaleFree  \i Qt::IgnoreAspectRatio

   797     \row \i Qt::ScaleMin   \i Qt::KeepAspectRatio

   798     \row \i Qt::ScaleMax   \i Qt::KeepAspectRatioByExpanding

   799     \endtable

   800 */

   801 

   802 /*! \enum Qt::TransformationMode

   803 

   804     This enum type defines whether image transformations (e.g.,

   805     scaling) should be smooth or not.

   806 

   807     \value FastTransformation  The transformation is performed

   808                                quickly, with no smoothing.

   809     \value SmoothTransformation  The resulting image is transformed

   810                                  using bilinear filtering.

   811 

   812     \sa QImage::scaled()

   813 */

   814 

   815 /*! \enum Qt::Axis

   816 

   817     This enum type defines three values to represent the three

   818     axes in the cartesian coordinate system.

   819 

   820     \value XAxis  The X axis.

   821     \value YAxis  The Y axis.

   822     \value ZAxis  The Z axis.

   823 

   824     \sa QTransform::rotate(), QTransform::rotateRadians()

   825  */

   826 

   827 /*!

   828     \enum Qt::WidgetAttribute

   829 

   830     \keyword widget attributes

   831 

   832     This enum type is used to specify various widget attributes.

   833     Attributes are set and cleared with QWidget::setAttribute(), and

   834     queried with QWidget::testAttribute(), although some have special

   835     convenience functions which are mentioned below.

   836 

   837     \value WA_AcceptDrops Allows data from drag and drop operations

   838     to be dropped onto the widget (see QWidget::setAcceptDrops()).

   839 

   840     \value WA_AlwaysShowToolTips Enables tooltips for inactive windows.

   841 

   842     \value WA_ContentsPropagated This flag is superfluous and

   843     obsolete; it no longer has any effect. Since Qt 4.1, all widgets

   844     that do not set WA_PaintOnScreen propagate their contents.

   845 

   846     \value WA_CustomWhatsThis Indicates that the widget wants to

   847     continue operating normally in "What's This?" mode. This is set by the

   848     widget's author.

   849 

   850     \value WA_DeleteOnClose Makes Qt delete this widget when the

   851     widget has accepted the close event (see QWidget::closeEvent()).

   852 

   853     \value WA_Disabled Indicates that the widget is disabled, i.e.

   854     it does not receive any mouse or keyboard events. There is also a

   855     getter functions QWidget::isEnabled().  This is set/cleared by the

   856     Qt kernel.

   857 

   858     \value WA_DontShowOnScreen Indicates that the widget is hidden or is

   859     not a part of the viewable Desktop.

   860 

   861     \omitvalue WA_DropSiteRegistered

   862     \omitvalue WA_ForceAcceptDrops

   863 

   864     \value WA_ForceDisabled Indicates that the widget is

   865     explicitly disabled, i.e. it will remain disabled even when all

   866     its ancestors are set to the enabled state. This implies

   867     WA_Disabled. This is set/cleared by QWidget::setEnabled() and

   868     QWidget::setDisabled().

   869 

   870     \value WA_ForceUpdatesDisabled Indicates that updates are

   871     explicitly disabled for the widget; i.e. it will remain disabled

   872     even when all its ancestors are set to the updates-enabled state.

   873     This implies WA_UpdatesDisabled. This is set/cleared by

   874     QWidget::setUpdatesEnabled().

   875 

   876     \value WA_GroupLeader

   877         \e{This attribute has been deprecated.} Use QWidget::windowModality

   878         instead.

   879 

   880     \value WA_Hover Forces Qt to generate paint events when the mouse

   881     enters or leaves the widget. This feature is typically used when

   882     implementing custom styles; see the \l{widgets/styles}{Styles}

   883     example for details.

   884 

   885     \value WA_InputMethodEnabled Enables input methods for Asian languages.

   886     Must be set when creating custom text editing widgets.

   887     On Windows CE this flag can be used in addition to

   888     QApplication::autoSipEnabled to automatically display the SIP when

   889     entering a widget.

   890 

   891     \value WA_KeyboardFocusChange Set on a toplevel window when

   892     the users changes focus with the keyboard (tab, backtab, or shortcut).

   893 

   894     \value WA_KeyCompression Enables key event compression if set,

   895     and disables it if not set. By default key compression is off, so

   896     widgets receive one key press event for each key press (or more,

   897     since autorepeat is usually on). If you turn it on and your

   898     program doesn't keep up with key input, Qt may try to compress key

   899     events so that more than one character can be processed in each

   900     event.

   901     For example, a word processor widget might receive 2, 3 or more

   902     characters in each QKeyEvent::text(), if the layout recalculation

   903     takes too long for the CPU.

   904     If a widget supports multiple character unicode input, it is

   905     always safe to turn the compression on.

   906     Qt performs key event compression only for printable characters.

   907     Qt::Modifier keys, cursor movement keys, function keys and

   908     miscellaneous action keys (e.g. Escape, Enter, Backspace,

   909     PrintScreen) will stop key event compression, even if there are

   910     more compressible key events available.

   911     Platforms other than Mac and X11 do not support this compression,

   912     in which case turning it on will have no effect.

   913     This is set/cleared by the widget's author.

   914 

   915     \value WA_LayoutOnEntireRect Indicates that the widget

   916     wants QLayout to operate on the entire QWidget::rect(), not only

   917     on QWidget::contentsRect(). This is set by the widget's author.

   918 

   919     \value WA_LayoutUsesWidgetRect Ignore the layout item rect from the style

   920     when laying out this widget with QLayout. This makes a difference in

   921     QMacStyle and QPlastiqueStyle for some widgets.

   922 

   923     \value WA_MacNoClickThrough When a widget that has this attribute set

   924     is clicked, and its window is inactive, the click will make the window

   925     active but won't be seen by the widget. Typical use of this attribute

   926     is on widgets with "destructive" actions, such as a "Delete" button.

   927     WA_MacNoClickThrough also applies to all child widgets of the widget

   928     that has it set.

   929 

   930     \value WA_MacOpaqueSizeGrip Indicates that the native Carbon size grip

   931     should be opaque instead of transparent (the default). This attribute

   932     is only applicable to Mac OS X and is set by the widget's author.

   933 

   934     \value WA_MacShowFocusRect Indicates that this widget should get a

   935     QFocusFrame around it. Some widgets draw their own focus halo

   936     regardless of this attribute. Not that the QWidget::focusPolicy

   937     also plays the main role in whether something is given focus or

   938     not, this only controls whether or not this gets the focus

   939     frame. This attribute is only applicable to Mac OS X.

   940 

   941     \value WA_MacNormalSize Indicates the widget should have the

   942     normal size for widgets in Mac OS X. This attribute is only

   943     applicable to Mac OS X.

   944 

   945     \value WA_MacSmallSize Indicates the widget should have the small

   946     size for widgets in Mac OS X. This attribute is only applicable to

   947     Mac OS X.

   948 

   949     \value WA_MacMiniSize Indicates the widget should have the mini

   950     size for widgets in Mac OS X. This attribute is only applicable to

   951     Mac OS X.

   952 

   953     \value WA_MacVariableSize Indicates the widget can choose between

   954     alternative sizes for widgets to avoid clipping.

   955     This attribute is only applicable to Mac OS X.

   956 

   957     \value WA_MacBrushedMetal Indicates the widget should be drawn in

   958     the brushed metal style as supported by the windowing system. This

   959     attribute is only applicable to Mac OS X.

   960 

   961     \omitvalue WA_MacMetalStyle

   962 

   963     \value WA_Mapped Indicates that the widget is mapped on screen.

   964     This is set/cleared by the Qt kernel.

   965 

   966     \value WA_MouseNoMask Makes the widget receive mouse events for

   967     the entire widget regardless of the currently set mask,

   968     overriding QWidget::setMask(). This is not applicable for

   969     top-level windows.

   970 

   971     \value WA_MouseTracking Indicates that the widget has mouse

   972     tracking enabled. See QWidget::mouseTracking.

   973 

   974     \value WA_Moved Indicates that the widget has an explicit

   975     position. This is set/cleared by QWidget::move() and

   976     by QWidget::setGeometry().

   977 

   978     \value WA_MSWindowsUseDirect3D This value is obsolete and has no

   979     effect.

   980 

   981     \value WA_NoBackground This value is obsolete. Use

   982     WA_OpaquePaintEvent instead.

   983 

   984     \value WA_NoChildEventsForParent Indicates that the widget does

   985     not want ChildAdded or ChildRemoved events sent to its

   986     parent. This is rarely necessary but can help to avoid automatic

   987     insertion widgets like splitters and layouts. This is set by a

   988     widget's author.

   989 

   990     \value WA_NoChildEventsFromChildren Indicates that the widget does

   991     not want to receive ChildAdded or ChildRemoved events sent from its

   992     children. This is set by a widget's author.

   993 

   994     \value WA_NoMouseReplay Used for pop-up widgets. Indicates that the most

   995     recent mouse press event should not be replayed when the pop-up widget

   996     closes. The flag is set by the widget's author and cleared by the Qt kernel

   997     every time the widget receives a new mouse event.

   998 

   999     \value WA_NoMousePropagation Prohibits mouse events from being propagated

  1000     to the widget's parent. This attribute is disabled by default.

  1001 

  1002     \value WA_TransparentForMouseEvents When enabled, this attribute disables

  1003     the delivery of mouse events to the widget and its children. Mouse events

  1004     are delivered to other widgets as if the widget and its children were not

  1005     present in the widget hierarchy; mouse clicks and other events effectively

  1006     "pass through" them. This attribute is disabled by default.

  1007 

  1008     \value WA_NoSystemBackground Indicates that the widget has no background,

  1009     i.e. when the widget receives paint events, the background is not

  1010     automatically repainted. \note Unlike WA_OpaquePaintEvent, newly exposed

  1011     areas are \bold never filled with the background (e.g., after showing a

  1012     window for the first time the user can see "through" it until the

  1013     application processes the paint events). This flag is set or cleared by the

  1014     widget's author.

  1015 

  1016     \value WA_OpaquePaintEvent Indicates that the widget paints all its pixels

  1017     when it receives a paint event. Thus, it is not required for operations

  1018     like updating, resizing, scrolling and focus changes to erase the widget

  1019     before generating paint events. The use of WA_OpaquePaintEvent provides a

  1020     small optimization by helping to reduce flicker on systems that do not

  1021     support double buffering and avoiding computational cycles necessary to

  1022     erase the background prior to painting. \note Unlike

  1023     WA_NoSystemBackground, WA_OpaquePaintEvent makes an effort to avoid

  1024     transparent window backgrounds. This flag is set or cleared by the widget's

  1025     author.

  1026 

  1027     \value WA_OutsideWSRange Indicates that the widget is outside

  1028     the valid range of the window system's coordinate system. A widget

  1029     outside the valid range cannot be mapped on screen. This is

  1030     set/cleared by the Qt kernel.

  1031 

  1032     \value WA_PaintOnScreen Indicates that the widget wants to draw directly

  1033     onto the screen. Widgets with this attribute set do not participate in

  1034     composition management, i.e. they cannot be semi-transparent or shine

  1035     through semi-transparent overlapping widgets. \note This flag is only

  1036     supported on X11 and it disables double buffering. On Qt for Embedded

  1037     Linux, the flag only works when set on a top-level widget and it relies on

  1038     support from the active screen driver. This flag is set or cleared by the

  1039     widget's author. To render outside of Qt's paint system, e.g., if you

  1040     require native painting primitives, you need to reimplement

  1041     QWidget::paintEngine() to return 0 and set this flag.

  1042 

  1043     \value WA_PaintOutsidePaintEvent Makes it possible to use QPainter to

  1044     paint on the widget outside \l{QWidget::paintEvent()}{paintEvent()}. This

  1045     flag is not supported on Windows, Mac OS X or Embedded Linux. We recommend

  1046     that you use it only when porting Qt 3 code to Qt 4.

  1047 

  1048     \value WA_PaintUnclipped Makes all painters operating on this widget

  1049     unclipped. Children of this widget or other widgets in front of it do not

  1050     clip the area the painter can paint on. This flag is only supported for

  1051     widgets with the WA_PaintOnScreen flag set. The preferred way to do this in

  1052     a cross platform way is to create a transparent widget that lies in front

  1053     of the other widgets.

  1054 

  1055     \value WA_PendingMoveEvent Indicates that a move event is pending, e.g.,

  1056     when a hidden widget was moved. This flag is set or cleared by the Qt

  1057     kernel.

  1058 

  1059     \value WA_PendingResizeEvent Indicates that a resize event is pending,

  1060     e.g., when a hidden widget was resized. This flag is set or cleared by the

  1061     Qt kernel.

  1062 

  1063     \value WA_QuitOnClose Makes Qt quit the application when the last widget

  1064     with the attribute set has accepted closeEvent(). This behavior can be

  1065     modified with the QApplication::quitOnLastWindowClosed property. By default

  1066     this attribute is set for all widgets of type Qt::Window.

  1067 

  1068     \value WA_Resized Indicates that the widget has an explicit size. This flag

  1069     is set or cleared by QWidget::resize() and QWidget::setGeometry().

  1070 

  1071     \value WA_RightToLeft Indicates that the layout direction for the widget

  1072     is right to left.

  1073 

  1074     \value WA_SetCursor Indicates that the widget has a cursor of its own. This

  1075     flag is set or cleared by QWidget::setCursor() and QWidget::unsetCursor().

  1076 

  1077     \value WA_SetFont Indicates that the widget has a font of its own. This

  1078     flag is set or cleared by QWidget::setFont().

  1079 

  1080     \value WA_SetPalette Indicates that the widget has a palette of its own.

  1081     This flag is set or cleared by QWidget::setPalette().

  1082 

  1083     \value WA_SetStyle Indicates that the widget has a style of its own. This

  1084     flag is set or cleared by QWidget::setStyle().

  1085 

  1086     \value WA_ShowModal \e{This attribute has been deprecated.} Use

  1087     QWidget::windowModality instead.

  1088 

  1089     \value WA_StaticContents Indicates that the widget contents are north-west

  1090     aligned and static. On resize, such a widget will receive paint events only

  1091     for parts of itself that are newly visible. This flag is set or cleared by

  1092     the widget's author.

  1093 

  1094     \value WA_StyleSheet Indicates that the widget is styled using a

  1095     \l{Qt Style Sheets}{style sheet}.

  1096 

  1097     \value WA_TranslucentBackground Indicates that the widget should have a

  1098     translucent background, i.e., any non-opaque regions of the widgets will be

  1099     translucent because the widget will have an alpha channel. Setting this

  1100     flag causes WA_NoSystemBackground to be set. On Windows the

  1101     widget also needs the Qt::FramelessWindowHint window flag to be set.

  1102     This flag is set or cleared by the widget's author.

  1103 

  1104     \value WA_UnderMouse Indicates that the widget is under the mouse cursor.

  1105     The value is not updated correctly during drag and drop operations. There

  1106     is also a getter function, QWidget::underMouse(). This flag is set or

  1107     cleared by the Qt kernel.

  1108 

  1109     \value WA_UpdatesDisabled Indicates that updates are blocked (including the

  1110     system background). This flag is set or cleared by the Qt kernel.

  1111     \warning This flag must \e never be set or cleared by the widget's author.

  1112 

  1113     \value WA_WindowModified Indicates that the window is marked as modified.

  1114     On some platforms this flag will do nothing, on others (including Mac OS X

  1115     and Windows) the window will take a modified appearance. This flag is set

  1116     or cleared by QWidget::setWindowModified().

  1117 

  1118     \value WA_WindowPropagation Makes a toplevel window inherit font and

  1119     palette from its parent.

  1120 

  1121     \value WA_MacAlwaysShowToolWindow On Mac OS X, show the tool window even

  1122     when the application is not active.  By default, all tool windows are

  1123     hidden when the application is inactive.

  1124 

  1125     \value WA_SetLocale Indicates the locale should be taken into consideration

  1126     in the widget.

  1127 

  1128     \value WA_StyledBackground Indicates the widget should be drawn using a

  1129     styled background.

  1130 

  1131     \value WA_ShowWithoutActivating Show the widget without making it active.

  1132 

  1133     \value WA_NativeWindow Indicates that a native window is created for the

  1134     widget. Enabling this flag will also force a native window for the widget's