Ignore:
Timestamp:
May 5, 2011, 5:36:53 AM (14 years ago)
Author:
Dmitry A. Kuminov
Message:

trunk: Merged in qt 4.7.2 sources from branches/vendor/nokia/qt.

Location:
trunk
Files:
17 edited

Legend:

Unmodified
Added
Removed
  • trunk

  • trunk/doc/src/development/activeqt-dumpcpp.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
    1515**
    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.
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
  • trunk/doc/src/development/activeqt-dumpdoc.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
    1515**
    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.
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
  • trunk/doc/src/development/activeqt-idc.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
    1515**
    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.
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
  • trunk/doc/src/development/activeqt-testcon.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
    1515**
    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.
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
  • trunk/doc/src/development/assistant-manual.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
    1515**
    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.
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
     
    155141            \o -unregister <doc.qch>
    156142            \o Unregisters the specified compressed help file from the given
    157             collection file.
     143               collection file.
    158144        \row
    159145            \o -remove-search-index
     
    161147               useful in case the associated index files get corrupted.
    162148               \QA will re-index the documentation at the next start-up.
     149        \row
     150            \o -rebuild-search-index
     151            \o Rebuilds the help search engine's index.
     152               Note that this operation may take a while to finish.
    163153        \row
    164154            \o -setCurrentFilter <filter>
     
    356346    The \menu{Options} page lets you specify the homepage \QA will display when
    357347    you click the \gui{Home} button in \QA's main user interface. You can specify
    358     the hompage by typing it here or clicking on one of the buttons below the
     348    the homepage by typing it here or clicking on one of the buttons below the
    359349    textbox. \gui{Current Page} sets the currently displayed page as your home
    360350    page while \gui{Restore to default} will reset your home page to the default
     
    639629            language. The icon defined by the \c{icon} tags is applied to any language.
    640630        \row
    641             \o \c{<cacheDirectory>}
    642             \o Specified as a path relative to the directory given by
    643             QDesktopServices::DataLocation, the cache path is used to store index files
     631            \o \c{<cacheDirectory base="collection|default">}
     632            \o The cache directory is used to store index files
    644633            needed for the full text search and a copy of the collection file.
    645             The copy is needed because \QA stores all its settings in the collection file;
    646             i.e., it must be writable for the user.
     634            The copy is needed because \QA stores all its settings in the collection file; i.e., it must be writable for the user.
     635            The directory is specified as a relative path.
     636            If the \c{base} attribute is set to "collection", the path is
     637            relative to the directory the collection file resides in.
     638            If the attribute is set to "default" or if it is missing,
     639            the path is relative to the directory given by
     640            QDesktopServices::DataLocation. The first form is useful for
     641            collections that are used in a "mobile" way, e.g. carried around
     642            on a USB stick.
     643           
    647644    \endtable
    648645
     
    678675    functionality by passing the \c{-enableRemoteControl} command line option.
    679676
    680     \warning The trailing '\0' must be appended separately to the QByteArray,
    681     e.g., \c{QByteArray("command" + '\0')}.
    682 
    683677    The following example shows how this can be done:
    684678
     
    690684
    691685    \snippet doc/src/snippets/code/doc_src_assistant-manual.qdoc 3
     686
     687    Note that the trailing newline character is required to mark the end
     688    of the input.
    692689
    693690    The following commands can be used to control \QA:
     
    728725            the currently displayed page.
    729726        \row
    730             \o \c{setCurrentFilter}
     727            \o \c{setCurrentFilter <filter>}
    731728            \o Selects the specified filter and updates the visual representation
    732729            accordingly.
     
    734731            \o \c{expandToc <Depth>}
    735732            \o Expands the table of contents tree to the given depth. If depth
    736             is less than 1, the tree will be collapsed completely.
     733            is 0, the tree will be collapsed completely. If depth is -1,
     734            the tree will be expanded completely.
     735        \row
     736            \o \c{register <help file>}
     737            \o Adds the given Qt compressed help file to the collection.
     738        \row
     739            \o \c{unregister <help file>}
     740            \o Removes the given Qt compressed help file from the collection.
    737741    \endtable
    738742
  • trunk/doc/src/development/debug.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
     15**
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
     
    6450    frameworks is found at developer.apple.com in:
    6551    \l{http://developer.apple.com/technotes/tn2004/tn2124.html#SECDEBUGLIB}
    66     {Apple Technicle Note TN2124} Qt follows that.
     52    {Apple Technical Note TN2124}.
    6753
    6854    When you build Qt, frameworks are built by default, and inside the
  • trunk/doc/src/development/designer-manual.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
    1515**
    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.
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
     
    17841770    \title Using a Designer UI File in Your Application
    17851771
    1786     With Qt's integrated build tools, \l{qmake Manual}{qmake} and \l uic, the
    1787     code for user interface components created with \QD is automatically
    1788     generated when the rest of your application is built. Forms can be included
    1789     and used directly from your application. Alternatively, you can use them to
    1790     extend subclasses of standard widgets. These forms can be processed at
    1791     compile time or at run time, depending on the approach used.
    1792 
     1772    Qt Designer UI files represent the widget tree of the form in XML format. The
     1773    forms can be processed:
     1774
     1775    \list
     1776        \o \l{Compile Time Form Processing}{At compile time}, which means that forms
     1777            are converted to C++ code that can be compiled.
     1778        \o \l{Run Time Form Processing}{At runtime}, which means that forms are processed
     1779            by the QUiLoader class that dynamically constructs the widget tree while
     1780            parsing the XML file.
     1781    \endlist
    17931782
    17941783    \tableofcontents
    17951784    \section1 Compile Time Form Processing
    17961785
     1786    You create user interface components with \QD and use Qt's integrated build tools,
     1787    \l{qmake Manual}{qmake} and \l{User Interface Compiler (uic)}{uic}, to generate code
     1788    for them when the application is built. The generated code contains the form's user
     1789    interface object. It is a C++ struct that contains:
     1790
     1791    \list
     1792        \o Pointers to the form's widgets, layouts, layout items,
     1793           button groups, and actions.
     1794        \o A member function called \c setupUi() to build the widget tree
     1795           on the parent widget.
     1796        \o A member function called \c retranslateUi() that handles the
     1797           translation of the string properties of the form. For more information,
     1798           see \l{Reacting to Language Changes}.
     1799    \endlist
     1800
     1801    The generated code can be included in your application and used directly from
     1802    it. Alternatively, you can use it to extend subclasses of standard widgets.
     1803
    17971804    A compile time processed form can be used in your application with one of
    17981805    the following approaches:
    17991806
    18001807    \list
    1801         \o  The Direct Approach: you construct a widget to use as a placeholder
     1808        \o  \l{The Direct Approach}: you construct a widget to use as a placeholder
    18021809            for the component, and set up the user interface inside it.
    1803         \o  The Single Inheritance Approach: you subclass the form's base class
     1810        \o  \l{The Single Inheritance Approach}: you subclass the form's base class
    18041811            (QWidget or QDialog, for example), and include a private instance
    18051812            of the form's user interface object.
    1806         \o  The MultipleInheritance Approach: you subclass both the form's base
     1813        \o  \l{The Multiple Inheritance Approach}: you subclass both the form's base
    18071814            class and the form's user interface object. This allows the widgets
    18081815            defined in the form to be used directly from within the scope of
     
    18101817    \endlist
    18111818
    1812 
    1813     \section2 The Direct Approach
    1814 
    1815     To demonstrate how to use user interface (UI) files straight from
    1816     \QD, we create a simple Calculator Form application. This is based on the
     1819    To demonstrate, we create a simple Calculator Form application. It is based on the
    18171820    original \l{Calculator Form Example}{Calculator Form} example.
    18181821
     
    18321835    \c qmake which files to process with \c uic. In this case, the
    18331836    \c calculatorform.ui file is used to create a \c ui_calculatorform.h file
    1834     that can be used by any file listed in the \c SOURCES declaration. To
    1835     ensure that \c qmake generates the \c ui_calculatorform.h file, we need to
    1836     include it in a file listed in \c SOURCES. Since we only have \c main.cpp,
    1837     we include it there:
     1837    that can be used by any file listed in the \c SOURCES declaration.
     1838
     1839    \note You can use Qt Creator to create the Calculator Form project. It
     1840    automatically generates the main.cpp, UI, and .pro files, which you can
     1841    then modify.
     1842
     1843    \section2 The Direct Approach
     1844
     1845    To use the direct approach, we include the \c ui_calculatorform.h file
     1846    directly in \c main.cpp:
    18381847
    18391848    \snippet doc/src/snippets/uitools/calculatorform/main.cpp 0
    1840 
    1841     This include is an additional check to ensure that we do not generate code
    1842     for UI files that are not used.
    18431849
    18441850    The \c main function creates the calculator widget by constructing a
     
    18521858    and the connections between its signals and slots.
    18531859
    1854     This approach provides a quick and easy way to use simple, self-contained
    1855     components in your applications, but many componens created with \QD will
     1860    The direct approach provides a quick and easy way to use simple, self-contained
     1861    components in your applications. However, componens created with \QD often
    18561862    require close integration with the rest of the application code. For
    18571863    instance, the \c CalculatorForm code provided above will compile and run,
    18581864    but the QSpinBox objects will not interact with the QLabel as we need a
    18591865    custom slot to carry out the add operation and display the result in the
    1860     QLabel. To achieve this, we need to subclass a standard Qt widget (known as
    1861     the single inheritance approach).
    1862 
     1866    QLabel. To achieve this, we need to use the single inheritance approach.
    18631867
    18641868    \section2 The Single Inheritance Approach
     1869
     1870    To use the single inheritance approach, we subclass a standard Qt widget and
     1871    include a private instance of the form's user interface object. This can take
     1872    the form of:
     1873
     1874    \list
     1875        \o A member variable
     1876        \o A pointer member variable
     1877    \endlist
     1878
     1879    \section3 Using a Member Variable
    18651880
    18661881    In this approach, we subclass a Qt widget and set up the user interface
     
    18691884    standard system for making signal and slot connections between the user
    18701885    interface and other objects in your application.
     1886    The generated \c{Ui::CalculatorForm} structure is a member of the class.
    18711887
    18721888    This approach is used in the \l{Calculator Form Example}{Calculator Form}
     
    19081924    forms, for example.
    19091925
     1926    \section3 Using a Pointer Member Variable
     1927
     1928    Alternatively, the \c{Ui::CalculatorForm} structure can be made a pointer
     1929    member of the class. The header then looks as follows:
     1930
     1931    \code
     1932
     1933    namespace Ui {
     1934        class CalculatorForm;
     1935    }
     1936
     1937    class CalculatorForm : public QWidget
     1938    ...
     1939    virtual ~CalculatorForm();
     1940    ...
     1941    private:
     1942        Ui::CalculatorForm *ui;
     1943    ...
     1944
     1945    \endcode
     1946
     1947    The corresponding source file looks as follows:
     1948
     1949    \code
     1950    #include "ui_calculatorform.h"
     1951
     1952    CalculatorForm::CalculatorForm(QWidget *parent) :
     1953        QWidget(parent), ui(new Ui::CalculatorForm)
     1954    {
     1955        ui->setupUi(this);
     1956    }
     1957
     1958    CalculatorForm::~CalculatorForm()
     1959    {
     1960        delete ui;
     1961    }
     1962    \endcode
     1963
     1964    The advantage of this approach is that the user interface object can be
     1965    forward-declared, which means that we do not have to include the generated
     1966    \c ui_calculatorform.h file in the header. The form can then be changed without
     1967    recompiling the dependent source files. This is particularly important if the
     1968    class is subject to binary compatibility restrictions.
     1969
     1970    We generally recommend this approach for libraries and large applications.
     1971    For more information, see \l{Creating Shared Libraries}.
    19101972
    19111973    \section2 The Multiple Inheritance Approach
     
    19211983
    19221984    We need to include the header file that \c uic generates from the
    1923     \c calculatorform.ui file:
     1985    \c calculatorform.ui file, as follows:
    19241986
    19251987    \snippet examples/uitools/multipleinheritance/calculatorform.h 0
     
    19271989    The class is defined in a similar way to the one used in the
    19281990    \l{The Single Inheritance Approach}{single inheritance approach}, except that
    1929     this time we inherit from \e{both} QWidget and \c{Ui::CalculatorForm}:
     1991    this time we inherit from \e{both} QWidget and \c{Ui::CalculatorForm},
     1992    as follows:
    19301993
    19311994    \snippet examples/uitools/multipleinheritance/calculatorform.h 1
     
    19462009    \c{ui} prefix to access them.
    19472010
    1948     Subclassing using multiple inheritance gives us more direct access to the
    1949     contents of the form, is slightly cleaner than the single inheritance
    1950     approach, but does not conveniently support composition of multiple user
    1951     interfaces.
    1952 
     2011    \section2 Reacting to Language Changes
     2012
     2013    Qt notifies applications if the user interface language changes by sending an
     2014    event of the type QEvent::LanguageChange. To call the member function
     2015    \c retranslateUi() of the user interface object, we reimplement
     2016    \c QWidget::changeEvent() in the form class, as follows:
     2017
     2018    \code
     2019    void CalculatorForm::changeEvent(QEvent *e)
     2020    {
     2021        QWidget::changeEvent(e);
     2022        switch (e->type()) {
     2023        case QEvent::LanguageChange:
     2024            ui->retranslateUi(this);
     2025            break;
     2026        default:
     2027            break;
     2028       }
     2029    }
     2030    \endcode
    19532031
    19542032    \section1 Run Time Form Processing
     
    27772855
    27782856    \legalese
    2779     Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). \BR
     2857    Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). \BR
    27802858    Copyright (C) 2005 Bjoern Bergstroem
    27812859
  • trunk/doc/src/development/developing-on-mac.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
     15**
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
     
    4228/*!
    4329    \page developing-on-mac.html
    44     \title Developing Qt Applications on Mac OS X
    45     \brief A overview of items to be aware of when developing Qt applications
    46         on Mac OS X
     30    \title Developing Qt Applications for Mac OS X
     31    \brief Information for developing Qt applications for Mac OS X
    4732    \ingroup platform-specific
    4833
     
    6146    \section1 What Versions of Mac OS X are Supported?
    6247
    63     As of Qt 4.6, Qt supports Mac OS X versions 10.4 and up. It is usually in
     48    As of Qt 4.7, Qt supports Mac OS X versions 10.4 and up. It is usually in
    6449    the best interest of the developer and user to be running the latest
    6550    updates to any version. We test internally against Mac OS X 10.4.11 as well
     
    6853    \section2 Carbon or Cocoa?
    6954   
    70     Historically, Qt has used the Carbon toolkit, which supports 32-bit
    71     applications on Mac OS X 10.4 and up. Qt 4.5 and up has support for the Cocoa
    72     toolkit, which requires 10.5 and provides 64-bit support.
    73 
    74     This detail is typically not important to Qt application developers.  Qt is
    75     cross-platform across Carbon and Cocoa, and Qt applications behave
    76     the same way when configured for either one. Eventually, the Carbon
    77     version will be discontinued. This is something to keep in mind when you
    78     consider writing code directly against native APIs.
    79 
    80     The current binary for Qt is built in two flavors, 32-bit Carbon and full
    81     universal Cocoa (32-bit and 64-bit). If you want a different setup for
    82     Qt will use, you must build from scratch. Carbon or Cocoa is chosen when
    83     configuring the package for building. The configure process selects Carbon
    84     by default, to specify Cocoa use the \c{-cocoa} flag.  configure for a
    85     64-bit architecture using one of the \c{-arch} flags (see \l{universal
    86     binaries}{Universal Binaries}).
     55    Qt supports building in two flavors, using either the Carbon or Cocoa API.
     56    Using the Cocoa API, Qt requires 10.5 and provides both 32-bit and 64-bit support. With
     57    Carbon, Qt can be developed on and deployed to 10.4, but there is no 64-bit
     58    support.
     59
     60    Note: There is no accessibility support in the Cocoa version. This is planned
     61    for Qt 4.8.
     62
     63    With Qt 4.7 we recommend using the Cocoa version of Qt for development,
     64    unless you want to target the 10.4 platform. Qt uses Cocoa by default,
     65    both for the binary package and when configuring Qt from source (using the \c{configure}
     66    script). To build Qt for Carbon, specify the \c{-carbon} flag to configure.
     67
     68    There are two versions of the Qt binary, one with x86 and x86_64
     69    Cocoa and another with x86 and ppc Carbon. If you want a different setup
     70    you must build Qt yourself using the source package. To explicitly configure
     71    Qt to build for 34-bit or 64-bit architectures (or both), use
     72    the \c{-arch} flags (see \l{universal binaries}{Universal Binaries}).
     73    For the Cocoa version, 64 bit is chosen by default.
    8774
    8875    Currently, Apple's default GCC compiler is used by default (GCC 4.0.1 on
     
    148135    Carbon and Cocoa both have their advantages and disadvantages. Probably the
    149136    easiest way to determine is to look at the version of Mac OS X you are
    150     targetting.  If you are starting a new application and can target 10.5 and
    151     up, then please consider Cocoa only. If you have an existing application or
    152     need to target earlier versions of the operating system and do not need
    153     access to 64-bit or newer Apple technologies, then Carbon is a good fit. If
    154     your needs fall in between, you can go with a 64-bit Cocoa and 32-bit
    155     Carbon universal application with the appropriate checks in your code to
    156     choose the right path based on where you are running the application.
     137    targetting. If your application can target 10.5 and up, then we recommend
     138    using Cocoa. If you need to target earlier versions of the operating system
     139    and do not need access to 64-bit or newer Apple technologies, then Carbon
     140    is a good fit. If your needs fall in between, you can go with a 64-bit Cocoa and 32-bit
     141    Carbon universal application.
    157142
    158143    For Mac OS X 10.6, Apple has started recommending developers to build their
     
    163148    to follow this advice, there is only one choice, 64-bit Cocoa.
    164149
     150
     151    \section2 Building Qt statically
     152
     153    We recommend building Qt as shared frameworks. Static builds are only partially
     154    supported, meaning that you can build most of Qt statically, but some modules,
     155    like web-kit and Designer, will fail. You can specify which modules to build
     156    from configure (e.g. -no-webkit -nomake tools). For Cocoa configurations, both
     157    static and no-framework builds requires manually copying the
     158    'src/gui/mac/qt_menu.nib/ directory into the " Resources" directory in
     159    the application bundle.
     160
    165161    \target universal binaries
    166162    \section1 Universal Binaries
     
    197193    \endtable
    198194
    199     If there are no \c{-arch} flags specified, configure builds for the 32-bit
    200     architecture, if you are currently on one. Universal binaries were initially
     195    If there are no \c{-arch} flags specified, configure builds Qt for a 32-bit
     196    architecture when using Carbon, and a 64-bit architecture when using Cocoa. Universal
     197    binaries were initially
    201198    used to simplify the PPC to Intel migration. You can use \c{-universal} to
    202199    build for both the 32-bit Intel and PPC architectures.
     
    211208    \endcode
    212209
     210    \section2 Working with several versions of Qt
     211    You can only install one version of Qt at a time when using the binary
     212    package. The reason for this is that a binary installation will install different parts of Qt
     213    (frameworks, documentation, examples, tools, etc) to different
     214    predefined locations on the OS, as described by Apple. If you want
     215    to work against other versions at the same time, you need
     216    to build the other versions explicitly from source. When doing so, you can
     217    provide \c{-prefix} to configure to set install location.
     218    The binary package will install Qt to the following locations:
     219
     220    \table
     221        \header
     222            \o Qt
     223            \o Location
     224        \row
     225            \o Designer, Linguist ...
     226            \o /Developer/Applications/Qt
     227        \row
     228            \o Documentation
     229            \o /Developer/Documentation/Qt
     230        \row
     231            \o Examples
     232            \o /Developer/Examples/Qt
     233        \row
     234            \o Plugins
     235            \o /Developer/Applications/Qt/Plugins
     236        \row
     237            \o Frameworks
     238            \o /Library/Frameworks
     239        \row
     240            \o Libraries
     241            \o /usr/lib
     242        \row
     243            \o qmake, moc, uic ...
     244            \o /Developer/Tools/Qt (symlink to /usr/bin)
     245        \row
     246            \o uninstall-qt.py, uninstall-qtsdk.py
     247            \o /Developer/Tools
     248    \endtable
    213249
    214250    \section1 Day-to-Day Application Development on OS X
  • trunk/doc/src/development/developing-with-qt.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
    1515**
    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.
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
     
    4228/*!
    4329    \page developing-with-qt.html
    44     \title Cross Platform Development with Qt
     30   
     31    \title Cross-platform & Platform-specific Development
     32        Qt allows you to write advanced applications and UIs once, and deploy them
     33        across desktop and embedded operating systems without rewriting the source
     34        code. The top section of this page provides an overview of the tools and
     35        techniques used in Qt application development. Still, you might want to add
     36        platform-specific features to your code. The bottom section of the page
     37        links to documents that describe platform-specific features provided by Qt,
     38        and discuss issues related to particular platforms and environments.
     39
     40        \section1 Cross-platform Development with Qt
    4541
    4642    Qt is provided with a set of build tools to help developers automate
    4743    the process of building and installing Qt applications.
    4844
    49     \table 100%
     45    \table
    5046    \header \o Development \o Cross-Platform Issues \o Specific Tools
    5147    \row
     
    7268    \endlist
    7369    \endtable
     70       
     71        \section1 Platform-specific Development with Qt
     72       
     73    These documents describe platform-specific features provided by Qt, and
     74    discuss issues related to particular platforms and environments.
     75       
     76    \table
     77    \row
     78    \o
     79     \list
     80        \o \l {Calling Qt Functions From Unix Signal Handlers}
     81        \o \l {Compiler Notes}
     82        \o \l {Developing Qt Applications for Mac OS X}
     83        \o \l {Known Issues}
     84        \o \l {Platform and Compiler Notes}
     85        \o \l {Platform and Compiler Notes - Symbian}
     86        \o \l {ActiveX in Qt}
     87        \o \l {Qt for Embedded Linux Classes}
     88        \o \l {Qt for Embedded Platforms}
     89        \o \l {Qt for Mac OS X - Specific Issues}
     90        \o \l {Qt is Mac OS X Native}
     91        \o \l {Supported Platforms}
     92        \o \l {The qtmain Library}
     93        \o \l {Window System Specific Notes}
     94     \endlist
     95    \o
     96    \list
     97        \o  Workaround to make it work.
     98        \o  Information about the C++ compilers and tools used to build Qt.
     99        \o  Information for developing Qt applications for Mac OS X
     100        \o  A summary of known issues in this Qt version at the time of release.
     101        \o  Information about the platforms on which Qt can be used.
     102        \o  Information about the state of support for the Symbian platform.
     103        \o  Qt API's for using ActiveX controls, servers, and COM.
     104        \o  Classes that are specific to Qt for Embedded Linux.
     105        \o  Documents related to Qt for Embedded Platforms.
     106        \o  A description of issues with Qt that are specific to Mac OS X.
     107        \o  An explanation of Qt's native features on Mac OS X.
     108        \o  The platforms supported by Nokia for Qt.
     109        \o  Describes the use and license of the qtmain helper library.
     110        \o  Collections of notes about Qt implementations on different window systems.
     111    \endlist
     112    \endtable
     113       
     114       
    74115*/
  • trunk/doc/src/development/moc.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
     15**
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
  • trunk/doc/src/development/qmake-manual.qdoc

    r769 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
    1515**
    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.
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
     
    348334                             an application.
    349335    \row    \o vclib         \o Creates a Visual Studio Project file to build a library.
     336    \row    \o vcsubdirs     \o Creates a Visual Studio Solution file to build projects in sub-directories.
    350337    \endtable
    351338
     
    873860    Developers using Visual Studio to write Qt applications can use the
    874861    Visual Studio integration facilities provided with the
    875     \l{Qt Commercial Editions} and do not need to worry about how
     862    \l{Qt Commercial Edition} and do not need to worry about how
    876863    project dependencies are managed.
    877864
     
    953940    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 130
    954941
    955     The default values depend on the version of the Symbian SDK you're using.
     942    The default values depend on the version of the Symbian SDK you're using,
     943        however, the Qt toolchain sets this to the maximum possible value and this
     944        should not be changed.
    956945
    957946    \section2 Compiler specific options
     
    972961    Here is how to define them in a project file:
    973962
    974     There are four types of IDs supported: \c UID2, \c UID3, \c SID, and \c VID. They
     963    There are four available types of IDs supported: \c UID2, \c UID3, \c SID, and \c VID. They
    975964    are specified like this:
    976965
    977966    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 132
    978967
    979     If \c UID2 is not specified, it defaults to the same value as \c UID3.
     968    If \c SID is not specified, it defaults to the same value as \c UID3.
    980969    If \c UID3 is not specified, qmake will automatically generate a \c UID3
    981970    suitable for development and debugging. This value should be manually
    982971    specified for applications that are to be released. In order to obtain
    983     an official UID, please contact Nokia. Both \c SID and \c VID default to empty values.
    984 
    985     For more information about unique identifiers and their meaning for
    986     Symbian applications, please refer to the Symbian SDK documentation.
    987 
     972    an official UID, please contact \l{Symbian}{http:\\www.symbiansigned.com}.
     973        Both \c SID and \c VID default to empty values.
     974
     975    There exists one UID1 too, but this should not be touched by any application.
     976       
     977        The UID2 has a specific value for different types of files - e.g. apps/exes
     978        are always 0x100039CE. The toolchain will set this for value for the most common file types like,
     979        EXE/APP and shared library DLL.
     980       
     981        For more information about unique identifiers and their meaning for Symbian applications,
     982        please refer to the \l{Symbian SDK documentation}{http://developer.symbian.org/main/documentation/reference/s3/pdk/GUID-380A8C4F-3EB6-5E1C-BCFB-ED5B866136D9.html}
     983       
    988984    \section2 Capabilities
    989985
    990     Capabilities define extra priviledges for the application, such as the
     986    Capabilities define extra privileges for the application, such as the
    991987    ability to list all files on the file system. Capabilities are defined
    992988    in the project file like this:
     
    10931089    \target BLD_INF_RULES
    10941090    \section1 BLD_INF_RULES
    1095    
     1091
    10961092    \e {This is only used on the Symbian platform.}
    1097    
     1093
    10981094    Generic \c bld.inf file content can be specified with \c BLD_INF_RULES variables.
    10991095    The section of \c bld.inf file where each rule goes is appended to
    11001096    \c BLD_INF_RULES with a dot.
    1101    
     1097
    11021098    For example:
    1103    
    1104     \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 146
    1105    
     1099
     1100    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 152
     1101
    11061102    This will add the specified statements to the \c prj_exports section of the
    11071103    generated \c bld.inf file.
    1108    
     1104
    11091105    It is also possible to add multiple rows in a single block. Each double
    11101106    quoted string will be placed on a new row in the generated \c bld.inf file.
    1111    
     1107
    11121108    For example:
    1113    
     1109
    11141110    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 143
    1115        
     1111
    11161112    Any rules you define will be added after automatically generated
    11171113    rules in each section.
     
    12881284
    12891285    These options only have an effect on the Symbian platform:
    1290    
     1286
    12911287    \table 95%
    12921288    \header \o Option \o Description
     
    12991295         Note that this only affects automatically generated bld.inf content;
    13001296         the content added via \c BLD_INF_RULES variable is not affected.
     1297    \row \o localize_deployment \o Makes \c lupdate tool add fields for
     1298         application captions and package file names into generated \c{.ts}
     1299         files. Qmake generates properly localized \c{.loc} and \c{.pkg} files
     1300         based on available translations. Translation file name bodies must
     1301         end with underscore and the language code for deployment localization
     1302         to work. E.g. \c{myapp_en.ts}.
     1303         \bold{Note:} All languages supported by Qt are not supported by Symbian,
     1304         so some \c{.ts} files may be ignored by qmake.
    13011305    \endtable
    1302    
     1306
    13031307    These options have an effect on Linux/Unix platforms:
    13041308
     
    13301334    \section1 DEF_FILE
    13311335
    1332     \e {This is only used on Windows when using the \c app template}.
    1333 
    1334     Specifies a \c .def file to be included in the project.
     1336    \e {This is only used on Windows when using the \c app template,
     1337    and on Symbian when building a shared DLL}.
     1338
     1339    Specifies a \c .def file to be included in the project. On Symbian
     1340    a directory may be specified instead, in which case the real files
     1341    will be located under the standard Symbian directories \c bwins and
     1342    \c eabi.
    13351343
    13361344    \target DEPENDPATH
     
    13631371    \c{%CSIDL_PROGRAM_FILES%\target}, which usually gets expanded to
    13641372    \c{\Program Files\target}. For the Symbian platform, the default target
    1365 is the application private directory on the drive it is installed to.
     1373    is the application private directory on the drive it is installed to.
    13661374
    13671375    It is also possible to specify multiple \c sources to be deployed on
     
    13761384    specified by \c{myFiles.path}. On Symbian platform all libraries and executables
    13771385    will always be deployed to the \\sys\\bin of the installation drive.
    1378    
     1386
    13791387    Since the Symbian platform build system automatically moves binaries to certain
    13801388    directories under the epoc32 directory, custom plugins, executables or
     
    13951403    variable. You can use either \c pkg_prerules or \c pkg_postrules to
    13961404    pass raw data to PKG file. The strings in \c pkg_prerules are added before
    1397     package-body and \c pkg_postrules after. The strings defined in
    1398     \c pkg_postrules or \c pkg_prerules are not parsed by qmake, so they
    1399     should be in a format understood by Symbian package generation tools.
     1405    package-body and \c pkg_postrules after. \c pkg_prerules is used for
     1406    defining vendor information, dependencies, custom package headers, and the
     1407    like, while \c pkg_postrules is used for custom file deployment and
     1408    embedded sis directives.
     1409    The strings defined in \c pkg_postrules or \c pkg_prerules are not parsed
     1410    by qmake, so they should be in a format understood by Symbian package
     1411    generation tools.
    14001412    Please consult the Symbian platform documentation for correct syntax.
    1401    
    1402     For example, to deploy DLL and add a new dependency: 
     1413
     1414    For example, to deploy DLL and add a new dependency:
    14031415
    14041416    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 140
     
    14071419    pkg file. If no pkg_prerules is defined, qmake makes sure that PKG file
    14081420    syntax is correct and it contains all mandatory statements such as:
    1409    
     1421
    14101422    \list
    14111423    \o languages, for example \BR
     
    14161428        %{"Vendor-EN", ..., "Vendor-FR"}
    14171429        :"Unique vendor name"
    1418     \endlist   
    1419    
    1420     If you decide to override any of these statements, you need to pay 
     1430    \endlist
     1431
     1432    If you decide to override any of these statements, you need to pay
    14211433    attention that also other statements stay valid. For example if you
    14221434    override languages statement, you must override also package-header
    14231435    statement and all other statements which are language specific.
     1436
     1437    On the Symbian platform, three separate PKG files are generated:
     1438
     1439    \list
     1440    \o <app>_template.pkg - For application SIS file. Rules suffix: \c{.main}
     1441    \o <app>_installer.pkg - For smart installer SIS file. Rules suffix: \c{.installer}
     1442    \o <app>_stub.pkg - For ROM stubs. Rules suffix: \c{.stub}
     1443    \endlist
     1444
     1445    \c pkg_prerules and \c pkg_postrules given without rules suffix will
     1446    intelligently apply to each of these files, but rules can also be
     1447    targeted to only one of above files by appending listed rules suffix
     1448    to the variable name:
     1449
     1450    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 153
    14241451
    14251452    On the Symbian platform, the \c default_deployment item specifies
     
    14291456    more languages need to be supported by the package file. The supported
    14301457    \c default_deployment rules that can be disabled are:
    1431    
     1458
    14321459    \list
    14331460    \o pkg_depends_qt
     
    14371464
    14381465    For example:
    1439    
     1466
    14401467    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 141
    1441    
     1468
     1469    On the Symbian platform, a default deployment is generated for all
     1470    application projects. You can modify the autogenerated default
     1471    deployment via following \c DEPLOYMENT variable values:
     1472
     1473    \list
     1474    \o default_bin_deployment - Application executable
     1475    \o default_resource_deployment - Application resources, including icon
     1476    \o default_reg_deployment - Application registration file
     1477    \endlist
     1478
     1479    For example:
     1480
     1481    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 154
     1482
     1483    This will entirely remove the default application deployment.
     1484
     1485    On the Symbian platform, you can specify file specific install options
     1486    with \c{.flags} modifier. Please consult the Symbian platform documentation
     1487    for supported options.
     1488
     1489    For example:
     1490
     1491    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 155
     1492
     1493    This will show a message box that gives user an option to cancel the
     1494    installation and then automatically runs the application after
     1495    installation is complete.
     1496
     1497    \note Automatically running the applications after install may require signing
     1498    the package with better than self-signed certificate, depending on the phone model.
     1499    Additionally, some tools such as Runonphone may not work properly with sis
     1500    packages that automatically run the application upon install.
     1501
     1502    On the Symbian platform, the default package name and the default name that
     1503    appears in application menu is derived from the \c TARGET variable.
     1504    Often the default is not optimal for displaying to end user. To set a better
     1505    display name for these purposes, use \c{DEPLOYMENT.display_name} variable:
     1506
     1507    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 156
     1508
    14421509    On the Symbian platform, you can use \c{DEPLOYMENT.installer_header}
    14431510    variable to generate smart installer wrapper for your application.
     
    14641531    If the application depends on plugins, these plugins have to be specified
    14651532    manually.
    1466    
     1533
    14671534    \note On the Symbian platform, all plugins supported by this variable
    1468 will be deployed by default with Qt libraries, so generally using this
    1469 variable is not needed.
     1535    will be deployed by default with Qt libraries, so generally using this
     1536    variable is not needed.
    14701537
    14711538    For example:
     
    15711638
    15721639    See also \l{#SOURCES}{SOURCES}.
    1573    
     1640
    15741641    \target ICON
    15751642    \section1 ICON
    1576    
     1643
    15771644    This variable is used only in MAC and the Symbian platform to set the application icon.
    15781645    Please see \l{Setting the Application Icon}{the application icon documentation}
    15791646    for more information.
    1580    
     1647
    15811648    \target INCLUDEPATH
    15821649    \section1 INCLUDEPATH
     
    16111678
    16121679    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 36
     1680
     1681    Note that \c qmake will skip files that are executable. If you need to install
     1682    executable files, you can unset the files' executable flags.
    16131683
    16141684    \target LEXIMPLS
     
    16671737
    16681738    \bold{Note:} On the Symbian platform, the build system makes a
    1669 distinction between shared and
     1739    distinction between shared and
    16701740    static libraries. In most cases, qmake will figure out which library you
    16711741    are refering to, but in some cases you may have to specify it explicitly to
     
    17031773    handled by \c qmake or \l{#QMAKESPEC}{qmake.conf} and rarely needs to be modified.
    17041774
     1775    \bold{Note:} On the Symbian platform, this variable is ignored.
     1776
    17051777    \target MAKEFILE_GENERATOR
    17061778    \section1 MAKEFILE_GENERATOR
     
    17121784    \target MMP_RULES
    17131785    \section1 MMP_RULES
    1714    
     1786
    17151787    \e {This is only used on the Symbian platform.}
    1716    
     1788
    17171789    Generic MMP file content can be specified with this variable.
    1718    
     1790
    17191791    For example:
    1720    
     1792
    17211793    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 137
    1722    
     1794
    17231795    This will add the specified statement to the end of the generated MMP file.
    1724    
     1796
    17251797    It is also possible to add multiple rows in a single block. Each double
    17261798    quoted string will be placed on a new row in the generated MMP file.
    1727    
     1799
    17281800    For example:
    1729    
     1801
    17301802    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 138
    1731        
     1803
    17321804    If you need to include a hash (\c{#}) character inside the
    17331805    \c MMP_RULES statement, it can be done with the variable
    17341806    \c LITERAL_HASH as follows:
    1735    
     1807
    17361808    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 139
    17371809
     
    20052077
    20062078    This variable is not empty if the warn_off
    2007     \l{#TEMPLATE}{TEMPLATE} option is specified.  The value of this
     2079    \l{#CONFIG}{CONFIG} option is specified.  The value of this
    20082080    variable is typically handled by \c qmake or \l{#QMAKESPEC}{qmake.conf}
    20092081    and rarely needs to be modified.
     
    20132085
    20142086    This variable is not empty if the warn_on
    2015     \l{#TEMPLATE}{TEMPLATE} option is specified.
     2087    \l{#CONFIG}{CONFIG} option is specified.
    20162088    The value of this variable is typically handled by
    20172089    \c qmake or \l{#QMAKESPEC}{qmake.conf} and rarely needs
     
    20412113
    20422114    \bold{Note:} On the Symbian platform, this variable can be used to pass
    2043 architecture specific options to each compiler in the Symbian build system.
    2044 For example:
     2115    architecture specific options to each compiler in the Symbian build system.
     2116    For example:
    20452117
    20462118    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 131
     
    22802352    then QMAKE_INCDIR_EGL may also need to be set.
    22812353
    2282     \section1 QMAKE_INCDIR_OPENGL_ES1, QMAKE_INCDIR_OPENGL_ES1CL, QMAKE_INCDIR_OPENGL_ES2
     2354    \section1 QMAKE_INCDIR_OPENGL_ES1, QMAKE_INCDIR_OPENGL_ES2
    22832355
    22842356    These variables contain the location of OpenGL headers files to be added
    2285     to INCLUDEPATH when building an application with OpenGL ES 1, OpenGL ES 1 Common
    2286     Lite or OpenGL ES 2 support respectively.
     2357    to INCLUDEPATH when building an application with OpenGL ES 1
     2358    or OpenGL ES 2 support respectively.
    22872359
    22882360    The value of this variable is typically handled by \c qmake or
     
    23842456
    23852457    \e {This is used on Unix platforms only.}
    2386    
     2458
    23872459    Library paths in this definition are added to the executable at link
    23882460    time so that the added paths will be preferentially searched at runtime.
    2389    
     2461
    23902462    \section1 QMAKE_LFLAGS_QT_DLL
    23912463
     
    25382610     \l{#QMAKESPEC}{qmake.conf} and rarely needs to be modified.
    25392611
    2540     \section1 QMAKE_LIBS_OPENGL_ES1, QMAKE_LIBS_OPENGL_ES1CL, QMAKE_LIBS_OPENGL_ES2
    2541 
    2542     These variables contain all the OpenGL libraries for OpenGL ES 1,
    2543     OpenGL ES 1 Common Lite profile and OpenGL ES 2.
     2612    \section1 QMAKE_LIBS_OPENGL_ES1, QMAKE_LIBS_OPENGL_ES2
     2613
     2614    These variables contain all the OpenGL libraries for OpenGL ES 1
     2615    and OpenGL ES 2.
    25442616
    25452617    The value of these variables is typically handled by \c qmake or
     
    26102682    \section1 QMAKE_LIBS_THREAD
    26112683
    2612     \e {This is used on Unix platforms only.}
     2684    \e {This is used on Unix and Symbian platforms only.}
    26132685
    26142686    This variable contains all libraries that need to be linked against
     
    27262798
    27272799    \section1 QMAKE_RPATH
    2728    
     2800
    27292801    \e {This is used on Unix platforms only.}
    27302802
     
    28802952    The value of this variable is typically handled by \c qmake or
    28812953     \l{#QMAKESPEC}{qmake.conf} and rarely needs to be modified.
    2882      
     2954
    28832955    \target RSS_RULES
    28842956    \section1 RSS_RULES
    2885    
     2957
    28862958    \e {This is only used on the Symbian platform.}   
    2887    
     2959
    28882960    Generic RSS file content can be specified with this variable. The syntax is
    28892961    similar to \c MMP_RULES and \c BLD_INF_RULES.
    2890    
     2962
    28912963    For example:
    2892    
     2964
    28932965    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 144
    2894    
     2966
    28952967    This will add the specified statement to the end of the \c APP_REGISTRATION_INFO
    28962968    resource struct in the generated registration resource file.
    28972969    As an impact of this statement, the application will not be visible in application shell.
    2898    
     2970
    28992971    It is also possible to add multiple rows in a single block. Each double
    29002972    quoted string will be placed on a new row in the registration resource file.
    2901    
     2973
    29022974    For example:
    2903    
     2975
    29042976    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 145
    2905    
     2977
    29062978    This example will install the application to MyFolder in the Symbian
    29072979    platform application shell. In addition it will make the application to
     
    29433015
    29443016    \e {This is only used on the Symbian platform.}
    2945    
     3017
    29463018    Contains the version number of the underlying S60 SDK; e.g. "5.0".
    29473019
     
    29793051
    29803052    This variable, when used with the \l{#TEMPLATE}{\c subdirs template}
    2981     contains the names of all subdirectories that contain parts of the project
    2982     that need be built. Each subdirectory must contain its own project file.
     3053    contains the names of all subdirectories or project files that contain
     3054    parts of the project that need be built. Each subdirectory specified
     3055    using this variable must contain its own project file.
    29833056
    29843057    For example:
     
    30243097
    30253098    \snippet doc/src/snippets/code/doc_src_qmake-manual.qdoc 150
     3099
     3100    \target SYMBIAN_VERSION
     3101    \section1 SYMBIAN_VERSION
     3102
     3103    \e {This is only used on the Symbian platform.}
     3104
     3105    Contains the version number of the underlying Symbian SDK; e.g. "9.2" or "Symbian3".
    30263106
    30273107    \target TARGET
  • trunk/doc/src/development/qmsdev.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
    1515**
    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.
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
  • trunk/doc/src/development/qtestlib.qdoc

    r769 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
    1515**
    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.
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
     
    4632
    4733    \ingroup frameworks-technologies
     34    \ingroup qt-basic-concepts
     35
    4836    \keyword qtestlib
    4937
     
    5341    well as extensions for testing graphical user interfaces.
    5442
    55     Table of contents:
    56 
    57     \tableofcontents
    58 
    5943    \section1 QTestLib Features
    6044
     
    10185    \endtable
    10286
    103     Note: For higher-level GUI and application testing needs, please
    104     see the \l{Third-Party Tools}{Qt testing products provided by
    105     Nokia partners}.
     87    \note For higher-level GUI and application testing needs, please
     88    see the \l{Partner Directory} for Qt testing products provided by
     89    Nokia partners.
    10690
    10791
     
    230214
    231215    \section2 Creating a Benchmark
    232    
    233     To create a benchmark, follow the instructions for crating a test and then add a
     216
     217    To create a benchmark, follow the instructions for creating a test and then add a
    234218    QBENCHMARK macro to the test function that you want to benchmark.
    235    
     219
    236220    \snippet doc/src/snippets/code/doc_src_qtestlib.qdoc 12
    237    
    238     The code insde the QBENCHMARK macro will be measured, and possibly also repeated
     221
     222    The code inside the QBENCHMARK macro will be measured, and possibly also repeated
    239223    several times in order to get an accurate measurement. This depends on the selected
    240224    measurement back-end. Several back-ends are available. They can be selected on the
    241225    command line:
    242    
     226
    243227    \target testlib-benchmarking-measurement
    244228
     
    260244         \o All platforms
    261245    \endtable
    262    
     246
    263247    In short, walltime is always available but requires many repetitions to
    264     get a useful result. 
    265     Tick counters are usually available and can provide 
    266     results with fewer repetitions, but can be susceptible to CPU frequency 
    267     scaling issues. 
     248    get a useful result.
     249    Tick counters are usually available and can provide
     250    results with fewer repetitions, but can be susceptible to CPU frequency
     251    scaling issues.
    268252    Valgrind provides exact results, but does not take
    269253    I/O waits into account, and is only available on a limited number of
     
    272256    that were received by the event loop before they are sent to their corresponding
    273257    targets (this might include non-Qt events).
    274        
     258
    275259    \note Depending on the device configuration, Tick counters on the
    276260     Windows CE platform may not be as fine-grained, compared to other platforms.
     
    281265
    282266    \section1 Using QTestLib remotely on Windows CE
    283     \c cetest is a convenience application which helps the user to launch an 
     267    \c cetest is a convenience application which helps the user to launch an
    284268    application remotely on a Windows CE device or emulator.
    285269
     
    337321    cetest and QtRemote successfully.
    338322
    339     Prior to \l{Installing Qt on Windows CE}{installation} of Qt, you need to set your
     323    Prior to \l{Installing Qt for Windows CE}{installation} of Qt, you need to set your
    340324    \c INCLUDE and \c LIB environment variables properly.
    341325
     
    351335    The CPU tick counters used for benchmarking is licensed under the following
    352336    license: (from src/testlib/3rdparty/cycle.h)
    353                    
     337
    354338    \legalese
    355339    Copyright (c) 2003, 2006 Matteo Frigo\br
     
    382366    \contentspage QTestLib Manual
    383367    \nextpage {Chapter 1: Writing a Unit Test}{Chapter 1}
     368    \ingroup best-practices
    384369
    385370    \title QTestLib Tutorial
    386371
    387372    This tutorial gives a short introduction to how to use some of the
    388     features of the QTestLib framework. It is divided into four
     373    features of the QTestLib framework. It is divided into five
    389374    chapters:
    390375
     
    583568    \example qtestlib/tutorial3
    584569
    585     \previouspage {Chapter 2 Data Driven Testing}{Chapter 2}
     570    \previouspage {Chapter 2: Data Driven Testing}{Chapter 2}
    586571    \contentspage {QTestLib Tutorial}{Contents}
    587572    \nextpage {Chapter 4: Replaying GUI Events}{Chapter 4}
     
    733718    \section1 Writing a Benchmark
    734719    To create a benchmark we extend a test function with a QBENCHMARK macro.
    735     A benchmark test function will then typically consist of setup code and 
     720    A benchmark test function will then typically consist of setup code and
    736721    a QBENCHMARK macro that contains the code to be measured. This test
    737722    function benchmarks QString::localeAwareCompare().
     
    739724    \snippet examples/qtestlib/tutorial5/benchmarking.cpp 0
    740725
    741     Setup can be done at the beginning of the function, the clock is not 
     726    Setup can be done at the beginning of the function, the clock is not
    742727    running at this point. The code inside the QBENCHMARK macro will be
    743     measured, and possibly repeated several times in order to  get an 
     728    measured, and possibly repeated several times in order to  get an
    744729    accurate measurement.
    745730
     
    749734    \section1 Data Functions
    750735
    751     Data functions are useful for creating benchmarks that compare 
     736    Data functions are useful for creating benchmarks that compare
    752737    multiple data inputs, for example locale aware compare against standard
    753738    compare.
     
    759744    \snippet examples/qtestlib/tutorial5/benchmarking.cpp 2
    760745
    761     The "if(useLocaleCompare)" switch is placed outside the QBENCHMARK 
     746    The "if(useLocaleCompare)" switch is placed outside the QBENCHMARK
    762747    macro to avoid measuring its overhead. Each benchmark test function
    763     can have one active QBENCHMARK macro. 
     748    can have one active QBENCHMARK macro.
    764749
    765750    \section1 External Tools
    766751
    767752    Tools for handling and visualizing test data are available as part of
    768     the \l{qtestlib-tools} project on the Qt Labs Web site. These include
    769     a tool for comparing performance data obtained from test runs and a
    770     utility to generate Web-based graphs of performance data.
    771 
    772     See the \l{qtestlib-tools Announcement} for more information on these
    773     tools and a simple graphing example.
     753    the \l {qtestlib-tools} project in the \l{Qt Labs} web site.
     754        These include a tool for comparing performance data obtained from test
     755        runs and a utility to generate Web-based graphs of performance data.
     756
     757    See the \l{qtestlib-tools Announcement}{qtestlib-tools announcement}
     758    for more information on these tools and a simple graphing example.
    774759
    775760*/
  • trunk/doc/src/development/rcc.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
    1515**
    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.
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
     
    6147
    6248    \row \o \c{-name} \o \c{name} \o Create an external initialization
    63                                      function with \c{name}.
     49                                     function with \c{name}.
    6450
    65     \row \o \c{-threshold} \o \c{level} \o Specifies a threshold \c{level} (in
    66                                            bytes) to use when deciding whether
    67                                            to compress a file. If the file is
    68                                            smaller than the threshold \c{level},
    69                                            it is not compressed. The default
    70                                            threshold level is 70 bytes.
    71                                              
     51    \row \o \c{-threshold} \o \c{level} \o Specifies a threshold \c{level} (as a
     52                           percentage) to use when deciding whether to compress
     53                           a file. If the reduction in the file size is greater than
     54                           the threshold \c{level}, it is compressed; otherwise,
     55                           the uncompressed data is stored instead. The default
     56                           threshold level is 70%, meaning that compressed files
     57                           which are 30% or less of their original size are
     58                           stored as compressed data.
     59
    7260    \row \o \c{-compress} \o \c{level} \o Compress input files to the given
    73                                           compression \c{level}, which is an 
    74                                           integer in the range 1 to 9. Level 1
    75                                           does the least compression but is
    76                                           fastest. Level 9 does the most
    77                                           compression but is slowest. To turn
    78                                           off compression, use \c{-no-compress}.
    79                                           The default value for \c{level} is -1,
    80                                           which means use zlib's default
    81                                           compression level.
     61                                          compression \c{level}, which is an
     62                                          integer in the range 1 to 9. Level 1
     63                                          does the least compression but is
     64                                          fastest. Level 9 does the most
     65                                          compression but is slowest. To turn
     66                                          off compression, use \c{-no-compress}.
     67                                          The default value for \c{level} is -1,
     68                                          which means use zlib's default
     69                                          compression level.
    8270
    8371    \row \o \c{-root} \o \c{path} \o Prefix the resource access path with \c{path}.
    84                                      The default is no prefix.
     72                                     The default is no prefix.
    8573
    8674    \row \o \c{-no-compress} \o \o Disable compression.
  • trunk/doc/src/development/tools-list.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
    1515**
    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.
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
  • trunk/doc/src/development/uic.qdoc

    r651 r846  
    11/****************************************************************************
    22**
    3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
    44** All rights reserved.
    55** Contact: Nokia Corporation (qt-info@nokia.com)
     
    77** This file is part of the documentation of the Qt Toolkit.
    88**
    9 ** $QT_BEGIN_LICENSE:LGPL$
     9** $QT_BEGIN_LICENSE:FDL$
    1010** Commercial Usage
    1111** Licensees holding valid Qt Commercial licenses may use this file in
    1212** 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.
     13** Software or, alternatively, in accordance with the terms contained in a
     14** written agreement between you and Nokia.
    1515**
    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.
     16** GNU Free Documentation License
     17** Alternatively, this file may be used under the terms of the GNU Free
     18** Documentation License version 1.3 as published by the Free Software
     19** Foundation and appearing in the file included in the packaging of this
     20** file.
    3521**
    3622** If you have questions regarding the use of this file, please contact
Note: See TracChangeset for help on using the changeset viewer.