src/corelib/global/qnamespace.qdoc
changeset 33 3e2da88830cd
parent 30 5dc02b23752f
equal deleted inserted replaced
30:5dc02b23752f 33:3e2da88830cd
     4 ** All rights reserved.
     4 ** All rights reserved.
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
     6 **
     6 **
     7 ** This file is part of the documentation of the Qt Toolkit.
     7 ** This file is part of the documentation of the Qt Toolkit.
     8 **
     8 **
     9 ** $QT_BEGIN_LICENSE:LGPL$
     9 ** $QT_BEGIN_LICENSE:FDL$
    10 ** No Commercial Usage
    10 ** Commercial Usage
    11 ** This file contains pre-release code and may not be distributed.
    11 ** Licensees holding valid Qt Commercial licenses may use this file in
    12 ** You may use this file in accordance with the terms and conditions
    12 ** accordance with the Qt Commercial License Agreement provided with the
    13 ** contained in the Technology Preview License Agreement accompanying
    13 ** Software or, alternatively, in accordance with the terms contained in a
    14 ** this package.
    14 ** written agreement between you and Nokia.
    15 **
    15 **
    16 ** GNU Lesser General Public License Usage
    16 ** GNU Free Documentation License
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
    17 ** Alternatively, this file may be used under the terms of the GNU Free
    18 ** General Public License version 2.1 as published by the Free Software
    18 ** Documentation License version 1.3 as published by the Free Software
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
    19 ** Foundation and appearing in the file included in the packaging of this
    20 ** packaging of this file.  Please review the following information to
    20 ** file.
    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 **
    21 **
    28 ** If you have questions regarding the use of this file, please contact
    22 ** If you have questions regarding the use of this file, please contact
    29 ** Nokia at qt-info@nokia.com.
    23 ** Nokia at qt-info@nokia.com.
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
    24 ** $QT_END_LICENSE$
    39 **
    25 **
    40 ****************************************************************************/
    26 ****************************************************************************/
    41 
    27 
    42 /*!
    28 /*!
   482                                  return a value that includes the width of trailing spaces in the text; otherwise
   468                                  return a value that includes the width of trailing spaces in the text; otherwise
   483                                  this width is excluded.
   469                                  this width is excluded.
   484     \value TextIncludeTrailingSpaces Same as IncludeTrailingSpaces
   470     \value TextIncludeTrailingSpaces Same as IncludeTrailingSpaces
   485     \value TextJustificationForced Ensures that text lines are justified.
   471     \value TextJustificationForced Ensures that text lines are justified.
   486 
   472 
       
   473     \omitvalue TextBypassShaping
   487     \omitvalue BreakAnywhere
   474     \omitvalue BreakAnywhere
   488     \omitvalue DontClip
   475     \omitvalue DontClip
   489     \omitvalue DontPrint
   476     \omitvalue DontPrint
   490     \omitvalue ExpandTabs
   477     \omitvalue ExpandTabs
   491     \omitvalue IncludeTrailingSpaces
   478     \omitvalue IncludeTrailingSpaces
   577     \value TextDate The default Qt format, which includes the day and month name,
   564     \value TextDate The default Qt format, which includes the day and month name,
   578     the day number in the month, and the year in full. The day and month names will
   565     the day number in the month, and the year in full. The day and month names will
   579     be short, localized names. This is basically equivalent to using the date format
   566     be short, localized names. This is basically equivalent to using the date format
   580     string, "ddd MMM d yyyy". See QDate::toString() for more information.
   567     string, "ddd MMM d yyyy". See QDate::toString() for more information.
   581 
   568 
   582     \value ISODate ISO 8601 extended format: either \c{YYYY-MM-DD} for dates or
   569     \value ISODate \l{ISO 8601} extended format: either \c{YYYY-MM-DD} for dates or
   583     \c{YYYY-MM-DDTHH:MM:SS} for combined dates and times.
   570     \c{YYYY-MM-DDTHH:MM:SS}, \c{YYYY-MM-DDTHH:MM:SSTZD} (e.g., 1997-07-16T19:20:30+01:00)
       
   571     for combined dates and times.
   584 
   572 
   585     \value SystemLocaleShortDate The \l{QLocale::ShortFormat}{short format} used
   573     \value SystemLocaleShortDate The \l{QLocale::ShortFormat}{short format} used
   586     by the \l{QLocale::system()}{operating system}.
   574     by the \l{QLocale::system()}{operating system}.
   587 
   575 
   588     \value SystemLocaleLongDate The \l{QLocale::LongFormat}{long format} used
   576     \value SystemLocaleLongDate The \l{QLocale::LongFormat}{long format} used
  1315     \omitvalue Key_BackSpace
  1303     \omitvalue Key_BackSpace
  1316     \value Key_Return
  1304     \value Key_Return
  1317     \value Key_Enter     Typically located on the keypad.
  1305     \value Key_Enter     Typically located on the keypad.
  1318     \value Key_Insert
  1306     \value Key_Insert
  1319     \value Key_Delete
  1307     \value Key_Delete
  1320     \value Key_Pause
  1308     \value Key_Pause    The Pause/Break key (\note Not anything to do with pausing media)
  1321     \value Key_Print
  1309     \value Key_Print
  1322     \value Key_SysReq
  1310     \value Key_SysReq
  1323     \value Key_Clear
  1311     \value Key_Clear
  1324     \value Key_Home
  1312     \value Key_Home
  1325     \value Key_End
  1313     \value Key_End
  1613     \value Key_BassBoost
  1601     \value Key_BassBoost
  1614     \value Key_BassUp
  1602     \value Key_BassUp
  1615     \value Key_BassDown
  1603     \value Key_BassDown
  1616     \value Key_TrebleUp
  1604     \value Key_TrebleUp
  1617     \value Key_TrebleDown
  1605     \value Key_TrebleDown
  1618     \value Key_MediaPlay
  1606     \value Key_MediaPlay    A key setting the state of the media player to play
  1619     \value Key_MediaStop
  1607     \value Key_MediaStop    A key setting the state of the media player to stop
  1620     \value Key_MediaPrevious
  1608     \value Key_MediaPrevious
  1621     \omitvalue Key_MediaPrev
  1609     \omitvalue Key_MediaPrev
  1622     \value Key_MediaNext
  1610     \value Key_MediaNext
  1623     \value Key_MediaRecord
  1611     \value Key_MediaRecord
       
  1612     \value Key_MediaPause   A key setting the state of the media player to pause (\note not the pause/break key)
       
  1613     \value Key_MediaTogglePlayPause   A key to toggle the play/pause state in the media player (rather than setting an absolute state)
  1624     \value Key_HomePage
  1614     \value Key_HomePage
  1625     \value Key_Favorites
  1615     \value Key_Favorites
  1626     \value Key_Search
  1616     \value Key_Search
  1627     \value Key_Standby
  1617     \value Key_Standby
  1628     \value Key_OpenUrl
  1618     \value Key_OpenUrl
  1739     \value Key_Suspend
  1729     \value Key_Suspend
  1740     \value Key_ContrastAdjust
  1730     \value Key_ContrastAdjust
  1741     \value Key_MediaLast
  1731     \value Key_MediaLast
  1742     \value Key_unknown
  1732     \value Key_unknown
  1743 
  1733 
  1744     \value Key_Call
  1734     \value Key_Call     A key to answer or initiate a call (see Qt::Key_ToggleCallHangup for a key to toggle current call state)
  1745     \value Key_Camera
  1735     \value Key_Camera   A key to activate the camera shutter
  1746     \value Key_CameraFocus
  1736     \value Key_CameraFocus  A key to focus the camera
  1747     \value Key_Context1
  1737     \value Key_Context1
  1748     \value Key_Context2
  1738     \value Key_Context2
  1749     \value Key_Context3
  1739     \value Key_Context3
  1750     \value Key_Context4
  1740     \value Key_Context4
  1751     \value Key_Flip
  1741     \value Key_Flip
  1752     \value Key_Hangup
  1742     \value Key_Hangup   A key to end an ongoing call (see Qt::Key_ToggleCallHangup for a key to toggle current call state)
  1753     \value Key_No
  1743     \value Key_No
  1754     \value Key_Select
  1744     \value Key_Select
  1755     \value Key_Yes
  1745     \value Key_Yes
       
  1746     \value Key_ToggleCallHangup A key to toggle the current call state (ie. either answer, or hangup) depending on current call state
       
  1747     \value Key_VoiceDial
       
  1748     \value Key_LastNumberRedial
  1756 
  1749 
  1757     \value Key_Execute
  1750     \value Key_Execute
  1758     \value Key_Printer
  1751     \value Key_Printer
  1759     \value Key_Play
  1752     \value Key_Play
  1760     \value Key_Sleep
  1753     \value Key_Sleep
  2565 */
  2558 */
  2566 
  2559 
  2567 /*!
  2560 /*!
  2568     \enum Qt::LayoutDirection
  2561     \enum Qt::LayoutDirection
  2569 
  2562 
  2570     Specifies the direction of Qt's layouts:
  2563     Specifies the direction of Qt's layouts and text handling.
  2571 
  2564 
  2572     \value LeftToRight  Left-to-right layout.
  2565     \value LeftToRight  Left-to-right layout.
  2573     \value RightToLeft  Right-to-left layout.
  2566     \value RightToLeft  Right-to-left layout.
       
  2567     \value LayoutDirectionAuto   Automatic layout.
  2574 
  2568 
  2575     Right-to-left layouts are necessary for certain languages,
  2569     Right-to-left layouts are necessary for certain languages,
  2576     notably Arabic and Hebrew.
  2570     notably Arabic and Hebrew.
  2577 
  2571 
  2578     \sa QApplication::setLayoutDirection(), QWidget::setLayoutDirection()
  2572     LayoutDirectionAuto serves two purposes. When used in conjunction with widgets and layouts, it
       
  2573     will imply to use the layout direction set on the parent widget or QApplication. This
       
  2574     has the same effect as QWidget::unsetLayoutDirection().
       
  2575 
       
  2576     When LayoutDirectoinAuto is used in conjunction with text layouting, it will imply that the text
       
  2577     directionality is determined from the content of the string to be layouted.
       
  2578 
       
  2579     \sa QApplication::setLayoutDirection(), QWidget::setLayoutDirection(), QTextOption::setTextDirection(), QString::isRightToLeft()
  2579 */
  2580 */
  2580 
  2581 
  2581 /*!
  2582 /*!
  2582     \enum Qt::AnchorPoint
  2583     \enum Qt::AnchorPoint
  2583 
  2584