src/corelib/global/qnamespace.qdoc
changeset 7 f7bc934e204c
parent 3 41300fa6a67c
equal deleted inserted replaced
3:41300fa6a67c 7:f7bc934e204c
     1 /****************************************************************************
     1 /****************************************************************************
     2 **
     2 **
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
     3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     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 **
   132            has no effect.
   132            has no effect.
   133 
   133 
   134     \value AA_DontShowIconsInMenus Actions with the Icon property won't be
   134     \value AA_DontShowIconsInMenus Actions with the Icon property won't be
   135            shown in any menus unless specifically set by the
   135            shown in any menus unless specifically set by the
   136            QAction::iconVisibleInMenu property.
   136            QAction::iconVisibleInMenu property.
   137 
       
   138            Menus that are currently open or menus already created in the native
   137            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
   138            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.
   139            in the QAction::iconVisibleInMenu property will always be picked up.
   141 
   140 
   142     \value AA_NativeWindows Ensures that widgets have native windows.
   141     \value AA_NativeWindows Ensures that widgets have native windows.
   156            set to true won't be used as a native menubar (e.g, the menubar at
   155            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).
   156            the top of the main screen on Mac OS X or at the bottom in Windows CE).
   158 
   157 
   159     \value AA_MacDontSwapCtrlAndMeta On Mac OS X by default, Qt swaps the
   158     \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
   159            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
   160            sends Meta, and whenever Meta is pressed Control is sent). When this
   162            attribute is true, Qt will not do the flip. QKeySequence::StandardShortcuts
   161            attribute is true, Qt will not do the flip. QKeySequence::StandardShortcuts
   163            will also flip accordingly (i.e., QKeySequence::Copy will be
   162            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
   163            Command+C on the keyboard regardless of the value set, though what is output for
   165            QKeySequence::toString(QKeySequence::PortableText) will be different).
   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.
   166 
   171 
   167     \omitvalue AA_AttributeCount
   172     \omitvalue AA_AttributeCount
   168 */
   173 */
   169 
   174 
   170 /*!
   175 /*!
   486     \omitvalue ShowPrefix
   491     \omitvalue ShowPrefix
   487     \omitvalue SingleLine
   492     \omitvalue SingleLine
   488     \omitvalue WordBreak
   493     \omitvalue WordBreak
   489     \omitvalue TextForceLeftToRight
   494     \omitvalue TextForceLeftToRight
   490     \omitvalue TextForceRightToLeft
   495     \omitvalue TextForceRightToLeft
   491     \omitvalue TextLongestVariant Always use the longest variant when computing the size of a multi-variant string
   496     \omitvalue TextLongestVariant Always use the longest variant when computing the size of a multi-variant string.
   492 
   497 
   493     You can use as many modifier flags as you want, except that
   498     You can use as many modifier flags as you want, except that
   494     Qt::TextSingleLine and Qt::TextWordWrap cannot be combined.
   499     Qt::TextSingleLine and Qt::TextWordWrap cannot be combined.
   495 
   500 
   496     Flags that are inappropriate for a given use are generally
   501     Flags that are inappropriate for a given use are generally
   507 */
   512 */
   508 
   513 
   509 /*!
   514 /*!
   510     \enum Qt::ConnectionType
   515     \enum Qt::ConnectionType
   511 
   516 
   512     This enum describes the types of connection that can be used between signals and
   517     This enum describes the types of connection that can be used
   513     slots. In particular, it determines whether a particular signal is delivered to a
   518     between signals and slots. In particular, it determines whether a
   514     slot immediately or queued for delivery at a later time.
   519     particular signal is delivered to a slot immediately or queued for
   515 
   520     delivery at a later time.
   516     \value DirectConnection  When emitted, the signal is immediately delivered to the slot.
   521 
   517     \value QueuedConnection  When emitted, the signal is queued until the event loop is
   522     \value AutoConnection
   518                              able to deliver it to the slot.
   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 
   519     \value BlockingQueuedConnection
   536     \value BlockingQueuedConnection
   520                              Same as QueuedConnection, except that the current thread blocks
   537            Same as QueuedConnection, except the current thread blocks
   521                              until the slot has been delivered. This connection type should
   538            until the slot returns. This connection type should only be
   522                              only be used for receivers in a different thread. Note that misuse
   539            used where the emitter and receiver are in different
   523                              of this type can lead to deadlocks in your application.
   540            threads.  \note Violating this rule can cause your
   524     \value AutoConnection    If the signal is emitted from the thread
   541            application to deadlock.
   525                              in which the receiving object lives, the
   542 
   526                              slot is invoked directly, as with
   543     \value UniqueConnection
   527                              Qt::DirectConnection; otherwise the
   544            Same as AutoConnection, but the connection is made only if
   528                              signal is queued, as with
   545     	   it does not duplicate an existing connection. i.e., if the
   529                              Qt::QueuedConnection.
   546     	   same signal is already connected to the same slot for the
   530     \value UniqueConnection  Same as AutoConnection, but there will be a check that the signal is
   547     	   same pair of objects, then the connection will fail. This
   531                              not already connected to the same slot before connecting, otherwise,
   548     	   connection type was introduced in Qt 4.6.
   532                              the connection will fail.
   549 
   533                              This value was introduced in Qt 4.6.
       
   534     \value AutoCompatConnection
   550     \value AutoCompatConnection
   535            The default connection type for signals and slots when Qt 3 support
   551     	   The default type when Qt 3 support is enabled. Same as
   536            is enabled. Equivalent to AutoConnection for connections but will cause warnings
   552 	   AutoConnection but will also cause warnings to be output in
   537            to be output under certain circumstances. See
   553 	   certain situations. See \l{Porting to Qt 4#Compatibility
   538            \l{Porting to Qt 4#Compatibility Signals and Slots}{Compatibility Signals and Slots}
   554 	   Signals and Slots}{Compatibility Signals and Slots} for
   539            for further information.
   555 	   further information.
   540 
   556 
   541     With queued connections, the parameters must be of types that are known to
   557     With queued connections, the parameters must be of types that are
   542     Qt's meta-object system, because Qt needs to copy the arguments to store them
   558     known to Qt's meta-object system, because Qt needs to copy the
   543     in an event behind the scenes. If you try to use a queued connection and
   559     arguments to store them in an event behind the scenes. If you try
   544     get the error message
   560     to use a queued connection and get the error message:
   545 
   561 
   546     \snippet doc/src/snippets/code/doc_src_qnamespace.qdoc 0
   562     \snippet doc/src/snippets/code/doc_src_qnamespace.qdoc 0
   547 
   563 
   548     call qRegisterMetaType() to register the data type before you
   564     Call qRegisterMetaType() to register the data type before you
   549     establish the connection.
   565     establish the connection.
       
   566 
       
   567     When using signals and slots with multiple threads, see \l{Signals and Slots Across Threads}.
   550 
   568 
   551     \sa {Thread Support in Qt}, QObject::connect(), qRegisterMetaType()
   569     \sa {Thread Support in Qt}, QObject::connect(), qRegisterMetaType()
   552 */
   570 */
   553 
   571 
   554 /*!
   572 /*!
  1222     handle touch events. Without this attribute set, events from a
  1240     handle touch events. Without this attribute set, events from a
  1223     touch device will be sent as mouse events.
  1241     touch device will be sent as mouse events.
  1224 
  1242 
  1225     \value WA_TouchPadAcceptSingleTouchEvents Allows touchpad single
  1243     \value WA_TouchPadAcceptSingleTouchEvents Allows touchpad single
  1226     touch events to be sent to the widget.
  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
  1227 
  1256 
  1228     \omitvalue WA_SetLayoutDirection
  1257     \omitvalue WA_SetLayoutDirection
  1229     \omitvalue WA_InputMethodTransparent
  1258     \omitvalue WA_InputMethodTransparent
  1230     \omitvalue WA_WState_CompressKeys
  1259     \omitvalue WA_WState_CompressKeys
  1231     \omitvalue WA_WState_ConfigPending
  1260     \omitvalue WA_WState_ConfigPending
  1591     \value Key_Search
  1620     \value Key_Search
  1592     \value Key_Standby
  1621     \value Key_Standby
  1593     \value Key_OpenUrl
  1622     \value Key_OpenUrl
  1594     \value Key_LaunchMail
  1623     \value Key_LaunchMail
  1595     \value Key_LaunchMedia
  1624     \value Key_LaunchMedia
  1596     \value Key_Launch0
  1625     \value Key_Launch0 On X11 this key is mapped to "My Computer" (XF86XK_MyComputer) key for legacy reasons.
  1597     \value Key_Launch1
  1626     \value Key_Launch1 On X11 this key is mapped to "Calculator" (XF86XK_Calculator) key for legacy reasons.
  1598     \value Key_Launch2
  1627     \value Key_Launch2 On X11 this key is mapped to XF86XK_Launch0 key for legacy reasons.
  1599     \value Key_Launch3
  1628     \value Key_Launch3 On X11 this key is mapped to XF86XK_Launch1 key for legacy reasons.
  1600     \value Key_Launch4
  1629     \value Key_Launch4 On X11 this key is mapped to XF86XK_Launch2 key for legacy reasons.
  1601     \value Key_Launch5
  1630     \value Key_Launch5 On X11 this key is mapped to XF86XK_Launch3 key for legacy reasons.
  1602     \value Key_Launch6
  1631     \value Key_Launch6 On X11 this key is mapped to XF86XK_Launch4 key for legacy reasons.
  1603     \value Key_Launch7
  1632     \value Key_Launch7 On X11 this key is mapped to XF86XK_Launch5 key for legacy reasons.
  1604     \value Key_Launch8
  1633     \value Key_Launch8 On X11 this key is mapped to XF86XK_Launch6 key for legacy reasons.
  1605     \value Key_Launch9
  1634     \value Key_Launch9 On X11 this key is mapped to XF86XK_Launch7 key for legacy reasons.
  1606     \value Key_LaunchA
  1635     \value Key_LaunchA On X11 this key is mapped to XF86XK_Launch8 key for legacy reasons.
  1607     \value Key_LaunchB
  1636     \value Key_LaunchB On X11 this key is mapped to XF86XK_Launch9 key for legacy reasons.
  1608     \value Key_LaunchC
  1637     \value Key_LaunchC On X11 this key is mapped to XF86XK_LaunchA key for legacy reasons.
  1609     \value Key_LaunchD
  1638     \value Key_LaunchD On X11 this key is mapped to XF86XK_LaunchB key for legacy reasons.
  1610     \value Key_LaunchE
  1639     \value Key_LaunchE On X11 this key is mapped to XF86XK_LaunchC key for legacy reasons.
  1611     \value Key_LaunchF
  1640     \value Key_LaunchF On X11 this key is mapped to XF86XK_LaunchD key for legacy reasons.
  1612     \value Key_MonBrightnessUp
  1641     \value Key_MonBrightnessUp
  1613     \value Key_MonBrightnessDown
  1642     \value Key_MonBrightnessDown
  1614     \value Key_KeyboardLightOnOff
  1643     \value Key_KeyboardLightOnOff
  1615     \value Key_KeyboardBrightnessUp
  1644     \value Key_KeyboardBrightnessUp
  1616     \value Key_KeyboardBrightnessDown
  1645     \value Key_KeyboardBrightnessDown
  1632     \value Key_BackForward
  1661     \value Key_BackForward
  1633     \value Key_ApplicationLeft
  1662     \value Key_ApplicationLeft
  1634     \value Key_ApplicationRight
  1663     \value Key_ApplicationRight
  1635     \value Key_Book
  1664     \value Key_Book
  1636     \value Key_CD
  1665     \value Key_CD
  1637     \value Key_Calculator
  1666     \value Key_Calculator On X11 this key is not mapped for legacy reasons. Use Qt::Key_Launch1 instead.
  1638     \value Key_ToDoList
  1667     \value Key_ToDoList
  1639     \value Key_ClearGrab
  1668     \value Key_ClearGrab
  1640     \value Key_Close
  1669     \value Key_Close
  1641     \value Key_Copy
  1670     \value Key_Copy
  1642     \value Key_Cut
  1671     \value Key_Cut
  2084 
  2113 
  2085     \value WindowContextHelpButtonHint  Adds a context help button to dialogs.
  2114     \value WindowContextHelpButtonHint  Adds a context help button to dialogs.
  2086            On some platforms this implies Qt::WindowSystemMenuHint for it to work.
  2115            On some platforms this implies Qt::WindowSystemMenuHint for it to work.
  2087 
  2116 
  2088     \value MacWindowToolBarButtonHint On Mac OS X adds a tool bar button (i.e.,
  2117     \value MacWindowToolBarButtonHint On Mac OS X adds a tool bar button (i.e.,
  2089            the oblong button that is on the top right of windows that have toolbars.
  2118            the oblong button that is on the top right of windows that have toolbars).
  2090 
  2119 
  2091     \value BypassGraphicsProxyWidget Prevents the window and its children from
  2120     \value BypassGraphicsProxyWidget Prevents the window and its children from
  2092            automatically embedding themselves into a QGraphicsProxyWidget if the
  2121            automatically embedding themselves into a QGraphicsProxyWidget if the
  2093            parent widget is already embedded. You can set this flag if you
  2122            parent widget is already embedded. You can set this flag if you
  2094            want your widget to always be a toplevel widget on the desktop,
  2123            want your widget to always be a toplevel widget on the desktop,
  2114     \value WindowOkButtonHint Adds an OK button to the window decoration of a dialog.
  2143     \value WindowOkButtonHint Adds an OK button to the window decoration of a dialog.
  2115            Only supported for Windows CE.
  2144            Only supported for Windows CE.
  2116 
  2145 
  2117     \value WindowCancelButtonHint Adds a Cancel button to the window decoration of a dialog.
  2146     \value WindowCancelButtonHint Adds a Cancel button to the window decoration of a dialog.
  2118            Only supported for Windows CE.
  2147            Only supported for Windows CE.
       
  2148 
       
  2149     \value WindowSoftkeysVisibleHint Makes softkeys visible when widget is fullscreen.
       
  2150            Only supported for Symbian.
       
  2151 
       
  2152     \value WindowSoftkeysRespondHint Makes softkeys to receive key events even
       
  2153            when invisible. With this hint the softkey actions are triggered
       
  2154            even the softkeys are invisible i.e. the window is displayed with
       
  2155            \c showFullscreen(). Only supported for Symbian.
  2119 
  2156 
  2120     \value WindowType_Mask  A mask for extracting the window type
  2157     \value WindowType_Mask  A mask for extracting the window type
  2121                             part of the window flags.
  2158                             part of the window flags.
  2122 
  2159 
  2123     Obsolete flags:
  2160     Obsolete flags: