diff options
| -rw-r--r-- | doc/src/declarative/elements.qdoc | 106 | ||||
| -rw-r--r-- | doc/src/getting-started/installation.qdoc | 263 | ||||
| -rw-r--r-- | doc/src/snippets/code/doc_src_installation.qdoc | 13 | ||||
| -rw-r--r-- | src/corelib/kernel/qcoreapplication.cpp | 9 | ||||
| -rw-r--r-- | src/declarative/graphicsitems/qdeclarativeflickable.cpp | 21 | ||||
| -rw-r--r-- | tools/qdoc3/doc/qdoc-manual.qdocconf | 253 | ||||
| -rw-r--r-- | tools/qdoc3/htmlgenerator.cpp | 10 |
7 files changed, 507 insertions, 168 deletions
diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc index a0eb95d..54f07a2 100644 --- a/doc/src/declarative/elements.qdoc +++ b/doc/src/declarative/elements.qdoc @@ -37,8 +37,110 @@ To see the QML elements listed by functional area, see the \l{Groups Of Related QML Elements} page. - \generatelist qmlclasses - + \table + \header \o {2,1} \bold {Basic Visual Items} + \row \o \l {Item} \o Basic item element inherited by all visual items in QML + \row \o \l {Rectangle} \o Basic visual rectangle element + \row \o \l {Gradient} \o Defines a gradient between two or more colors + \row \o \l {GradientStop} \o Defines a color used in a \l {Gradient} + \row \o \l {Image} \o Allows the use of bitmaps to a scene + \row \o \l {BorderImage} (Item-specific) \o Defines an image as a border + \row \o \l {AnimatedImage} \o For playing animations stored as a series of frames + \row \o \l {Text} \o Allows the use of formatted text in a scene + \row \o \l {TextInput} \o Displays an editable line of text + \row \o \l {IntValidator} \o Validator for integer values + \row \o \l {DoubleValidator} \o Validator for non-integer values + \row \o \l {RegExpValidator} \o Validator for string regular expressions + \row \o \l {TextEdit} \o Displays multiple lines of editable formatted text + + \header \o {2,1} \bold {Basic Interaction Items} + \row \o \l {MouseArea} \o Handles mouse interactions + \row \o \l {FocusScope} \o For keyboard focus handling + \row \o \l {Flickable} \o Provides a surface that can be "flicked" + \row \o \l {Flipable} \o Provides a surface that produces flipping effects + \row \o \l {GestureArea} (experimental) \o Enables simple gesture handling + + \header \o {2,1} \bold {States} + \row \o \l {State} \o Defines sets of configurations of objects and properties + \row \o \l {PropertyChanges} \o Describes property changes within a state + \row \o \l {StateGroup} \o Contains a set of states and state transitions + \row \o \l {StateChangeScript} \o Allows script binding in a state + \row \o \l {ParentChange} (Item-specific) \o Re-parent an Item in a state change + \row \o \l {AnchorChanges} \o Change the anchors of an item in a state + + \header \o {2,1} \bold {Animation and Transitions} + \row \o \l {Behavior} \o Specifies a default animation for property changes + \row \o \l {SequentialAnimation} \o Runs animations sequentially + \row \o \l {ParallelAnimation} \o Runs animations in parallel + \row \o \l {PropertyAnimation} \o Animates property changes + \row \o \l {NumberAnimation} \o Animates properties of type qreal + \row \o \l {Vector3dAnimation} \o Animates properties of type QVector3d + \row \o \l {ColorAnimation} \o Animates color changes + \row \o \l {RotationAnimation} \o Animates rotations + \row \o \l {ParentAnimation} \o Animates parent changes + \row \o \l {AnchorAnimation} \o Animates anchor changes + \row \o \l {PauseAnimation} \o Pauses an animation + \row \o \l {SmoothedAnimation} \o Allows a property to smoothly track a value + \row \o \l {SpringAnimation} \o Allows a property to track a value in a spring-like motion + \row \o \l {PropertyAction} \o Sets immediate property changes during animation + \row \o \l {ScriptAction} \o Runs scripts during an animation + \row \o \l {Transition} \o Animates transitions during state changes + + \header \o {2,1} \bold {Working with Data} + \row \o \l {Binding} \o Binds any value to any property + \row \o \l {ListModel} \o Defines a list of data + \row \o \l {ListElement} \o Defines a data item in a \l {ListModel} + \row \o \l {VisualItemModel} \o Contains items that already defines its own visual delegate + \row \o \l {VisualDataModel} \o Encapsulates a model and a delegate + \row \o \l {Package} \o Collection that enables sharing of items within different views + \row \o \l {XmlListModel} \o Specifies a model using XPath expressions + \row \o \l {XmlRole} \o Specifies a role for an \l {XmlListModel} + + \header \o {2,1} \bold {Views} + \row \o \l {ListView} \o Provides a list visualization of a model + \row \o \l {GridView} \o Provides a grid visualization of a model + \row \o \l {PathView} \o Visualizes a model's contents along a path + \row \o \l {Path} \o Defines a path used by \l {PathView} + \row \o \l {PathLine} \o Defines a line in \l {Path} + \row \o \l {PathQuad} \o Defines a quadratic Bezier curve in a \l {Path} + \row \o \l {PathCubic} \o Defines a cubic Bezier curve in a \l {Path} + \row \o \l {PathAttribute} \o Allows the setting of attributes along a \l {Path} + \row \o \l {PathPercent} \o Modifies the item distribution along a \l {Path} + \row \o \l {WebView} \o Allows the addition of web content to a canvas + + \header \o {2,1} \bold {Positioners} + \row \o \l {Column} \o Arranges its children vertically + \row \o \l {Row} \o Arranges its children horizontally + \row \o \l {Grid} \o Positions its children in a grid + \row \o \l {Flow} \o Positions its children with wrapping support + + \header \o {2,1} \bold {Utility} + \row \o \l {Connections} \o Explicitly connects signals and signal handlers + \row \o \l {Component} \o Encapsulate QML items as a component + \row \o \l {Timer} \o Provides timed triggers + \row \o \l {QML:QtObject} {QtObject} \o Basic element containing only the objectName property + \row \o \l {QML:Qt} {Qt} \o The QML global Qt object provides useful enums and functions from Qt. + \row \o \l {WorkerScript} \o Enables the use of threads in QML + \row \o \l {Loader} \o Controls the loading of items or components + \row \o \l {Repeater} \o Uses a model to create multiples of components + \row \o \l {SystemPalette} \o Provides access to the Qt palettes + \row \o \l {FontLoader} \o Loads fonts by name or URL + \row \o \l {LayoutItem} \o Allows declarative UI elements inside Qt's Graphics View layouts + + \header \o {2,1} \bold {Transforms} + \row \o \l {Scale} \o Assigns item scaling behaviors + \row \o \l {Rotation} \o Assigns item rotation behaviors + \row \o \l {Translate} \o Assigns item translation behaviors + + \header \o {2,1} \bold {Effects} + \row \o \l {Particles} (experimental) \o Generates and animates particles + \row \o \l {ParticleMotionLinear} \o Adds linear motion behavior to \l {Particles} + \row \o \l {ParticleMotionGravity} \o Adds gravitational motion to \l {Particles} + \row \o \l {ParticleMotionWander} \o Adds varied motions to \l {Particles} + \endtable + + + */ diff --git a/doc/src/getting-started/installation.qdoc b/doc/src/getting-started/installation.qdoc index 8f6f16a..a68310c 100644 --- a/doc/src/getting-started/installation.qdoc +++ b/doc/src/getting-started/installation.qdoc @@ -697,187 +697,224 @@ the Symbian platform from scratch, using Linux as the build host. Qt for Symbian binaries can be downloaded directly so development of applications using Qt for Symbian can start right away. -\section1 Step 1: Setup the development environment +\section1 Step 1: Setup the Development Environment + +Qt for the Symbian platform has some requirements on the development +platform. The Symbian SDK for Linux as well as a cross compiler for the ARM +processor used on Symbian devices should be present on the development +machine. + +See \l{http://qt.gitorious.org/qt/pages/QtCreatorSymbianLinux} for more details. + - Qt for the Symbian platform has some requirements on the development - platform. The Symbian SDK for Linux as well as a cross compiler for the ARM - processor used on Symbian devices should be present on the development - machine. - - See \l{http://qt.gitorious.org/qt/pages/QtCreatorSymbianLinux} for more details. \section1 Step 2: Unpack the Archive - Uncompress the \l{http://qt.nokia.com/downloads}{downloaded} source package into the - directory you want Qt installed, e.g. \c{/home/user/qt/%VERSION%}. +Uncompress the \l{http://qt.nokia.com/downloads}{downloaded} source package into the +directory you want Qt installed, e.g. \c{/home/user/qt/%VERSION%}. + \section1 Step 3: Set the Environment Variables - In order to build and use Qt, the \c PATH environment variable needs - to be extended to fine Qt tools and also to find the Symbian platform tools: +In order to build and use Qt, the \c PATH environment variable needs +to be extended to fine Qt tools and also to find the Symbian platform tools: - First you need to set the \c EPOCROOT environment variable to point to the - location of your S60 SDK: +First you need to set the \c EPOCROOT environment variable to point to the +location of your S60 SDK: \snippet doc/src/snippets/code/doc_src_installation.qdoc 36 - Then you can update the PATH variable; +Then you can update the PATH variable; + +\snippet doc/src/snippets/code/doc_src_installation.qdoc 37 - \snippet doc/src/snippets/code/doc_src_installation.qdoc 37 \section1 Step 4: Configure Qt - To configure Qt for the Symbian platform, do: +To configure Qt for the Symbian platform, do: \snippet doc/src/snippets/code/doc_src_installation.qdoc 38 - to build the libraries using RVCT or + +to build the libraries using RVCT or \snippet doc/src/snippets/code/doc_src_installation.qdoc 39 - to build the libraries using GCCE. + +to build the libraries using GCCE. + \section1 Step 5: Build Qt - To build Qt for the device, type: +To build Qt for the device, type: \snippet doc/src/snippets/code/doc_src_installation.qdoc 40 - Congratulations, Qt is now ready to use. +Congratulations, Qt is now ready to use. -\section1 Step 6: Building Qt packages for the Device - To run any application or demo on a real device, you need to install it - on the device. To do this you first have to create a a package for the - device, containing the libraries: +\section1 Step 6: Building Qt Packages for the Device - \bold{Building a Qt package without a certificate} +To run any application or demo on a real device, you need to install it +on the device. To do this you first have to create a a package for the +device, containing the libraries: - If you have no certificate, build a self signed Qt: +\bold{Building a Qt package without a certificate} - \snippet doc/src/snippets/code/doc_src_installation.qdoc 41 +If you have no certificate, build a self signed Qt: - The Qt libraries are built with "All -Tcb" capability, so that - they can support all types of applications. However, these - capabilities are automatically lowered if you make a self-signed - package. +\snippet doc/src/snippets/code/doc_src_installation.qdoc 41 - \bold{Building a Qt package with a Symbian developer certificate} +The Qt libraries are built with "All -Tcb" capability, so that +they can support all types of applications. However, these +capabilities are automatically lowered if you make a self-signed +package. - If you have a symbian-signed developer certificate, specify the - capabilities you can sign for, for example: +\bold{Building a Qt package with a Symbian developer certificate} - \snippet doc/src/snippets/code/doc_src_installation.qdoc 42 - - \section2 Installing Qt packages to the device. +If you have a Symbian-signed developer certificate, specify the +capabilities you can sign for, for example: - It is possible to install packages to a phone in Linux by putting - the package on the phone memory card and then installing manually - from the phone menu. However, this is tedious and will not work - on phones without a memory card, so the method recommended by Qt is - to use the App TRK tool. +\snippet doc/src/snippets/code/doc_src_installation.qdoc 42 - \section3 Obtaining the App TRK package. +\section2 Installing Qt Packages to the Device. - Download the package from the following location. +It is possible to install packages to a phone in Linux by putting +the package on the phone memory card and then installing manually +from the phone menu. However, this is tedious and will not work +on phones without a memory card, so the method recommended by Qt is +to use the App TRK tool. - \list - \o \l{http://tools.ext.nokia.com/trk/}{Application TRK}. - Choose the correct installation package based on the - S60 version of your device - (\c{S60_<S60-version>_app_trk_<TRK-version>.sisx}). - \endlist +\section3 Obtaining the App TRK package. - This package currently has to be installed by putting the - package on the memory card and installing from the phone - menu, or using a Windows PC for doing the install. However, - the installation only has to be done once. +Download the package from the following location. - \section3 Configuring App TRK on the phone. +\list +\o \l{http://tools.ext.nokia.com/trk/}{Application TRK}. + Choose the correct installation package based on the + S60 version of your device + (\c{S60_<S60-version>_app_trk_<TRK-version>.sisx}). +\endlist - When App TRK is installed, connect the phone to the PC using - the USB cable. Select "PCSuite" as connection type. Then run - App TRK on the phone, and make sure that the connection type is - USB. This can be changed under - the \c Settings menu entry. If necessary, choose \c Connect - from the menu. +This package currently has to be installed by putting the +package on the memory card and installing from the phone +menu, or using a Windows PC for doing the install. However, +the installation only has to be done once. - \section3 Configuring the USB serial driver on the Linux system. +\section3 Configuring App TRK on the Phone - On Linux, phone should appear as the \c /dev/ttyUSB1 device, - however if you are running an old kernel, you may need to - force the USB module to be loaded correctly before the device - will appear: +When App TRK is installed, connect the phone to the PC using +the USB cable. Select "PCSuite" as connection type. Then run +App TRK on the phone, and make sure that the connection type is +USB. This can be changed under the \c Settings menu entry. +If necessary, choose \c Connect from the menu. - \snippet doc/src/snippets/code/doc_src_installation.qdoc 43 +\section3 Configuring the USB Serial Driver on the Linux System - Note the identifier on the line where your Symbian device - appears. Then execute the following, using the first and - second part of the identifier in place of \c XXX, - respectively. +On Linux, phone should appear as the \c /dev/ttyUSB1 device, +however if you are running an old kernel, you may need to +force the USB module to be loaded correctly before the device +will appear: - \snippet doc/src/snippets/code/doc_src_installation.qdoc 44 +\snippet doc/src/snippets/code/doc_src_installation.qdoc 43 - The \c rmmod step may fail if the module is not already - loaded, but that is harmless. +Note the identifier on the line where your Symbian device +appears. Then execute the following, using the first and +second part of the identifier in place of \c XXX, +respectively. - \section3 Building the \c runonphone tool. +\snippet doc/src/snippets/code/doc_src_installation.qdoc 44 - Note that building the \c runonphone tool requires a separate - installation of Qt for Linux. If there is a version of Qt - installed by your distribution's package mechanism, that that - should do fine. Some distributions separate the libraries from - the development setup which includes qmake. Make sure you have - both installed. +The \c rmmod step may fail if the module is not already +loaded, but that is harmless. - First make sure that the \c qmake you use is taken from the - Linux installation of Qt. The easiest way to make sure of this - is to open a new shell and run the following command: +\section3 Building the runonphone Tool. - \snippet doc/src/snippets/code/doc_src_installation.qdoc 45 +Note that building the \c runonphone tool requires a separate +installation of Qt for Linux. If there is a version of Qt +installed by your distribution's package mechanism, that that +should do fine. Some distributions separate the libraries from +the development setup which includes \c qmake. Make sure you +have both installed. - \c qmake will tell you where it is installed. +You will also need the \l{libusb} libraries and header files +installed. Usually, installing a development package such as +\c{libusb-dev} will ensure that you have all the necessary +dependencies installed. - Copy the \c{%QTDIR%/tools/runonphone} folder to a place outside - of the Qt tree. Then go to the folder in a shell and build it: +First, make sure that the \c qmake you use is taken from the +Linux installation of Qt. The easiest way to make sure of this +is to open a new shell and run the following command: - \snippet doc/src/snippets/code/doc_src_installation.qdoc 46 +\snippet doc/src/snippets/code/doc_src_installation.qdoc 45 - Copy the resulting executable to a folder which is in your - \c PATH environment variable. +\c qmake will tell you where it is installed. - \section3 Installing the built package onto the phone. +Copy the \c{%QTDIR%/tools/runonphone} folder to a place outside +of the Qt tree. Then go to the folder in a shell and build it: - Return to the root of the Qt tree configured for Symbian. Then - install the Qt libraries by running the following: +\snippet doc/src/snippets/code/doc_src_installation.qdoc 46 - \snippet doc/src/snippets/code/doc_src_installation.qdoc 47 +Copy the resulting executable to a folder which is in your +\c PATH environment variable. - \note If the installation fails, please make sure that there is - no previously installed version of Qt on the phone. +\section3 Installing the Built Package onto the Phone - Qt requires some dependent packages to be installed on the device, - they are shipped in the Symbian SDK and can be installed using the - runonphone tool as well. - The packages can be found in the EPOCROOT at the following locations; +\note Before starting, please make sure that there is no previously +installed version of Qt on the phone. - \snippet doc/src/snippets/code/doc_src_installation.qdoc 50 +Return to the root of the Qt tree configured for Symbian. Then +install the Qt libraries by running the following: -\section1 Running Qt demos +\snippet doc/src/snippets/code/doc_src_installation.qdoc 47 - We've included a subset of the Qt demos in this package for you - to try out. An excellent starting point is the "fluidlauncher" - demo. +You may need to supply the path of the serial device file using +the \c{-p} option: - Install and run the demo by using the following commands: +\snippet doc/src/snippets/code/doc_src_installation.qdoc runonphone with device file path - \snippet doc/src/snippets/code/doc_src_installation.qdoc 48 +If the installation fails, please make sure that there is +no previously installed version of Qt on the phone. - The same command can be used for other applications: +Qt requires some dependent packages to be installed on the device, +they are shipped in the Symbian SDK and can be installed using the +runonphone tool as well. +The packages can be found in the EPOCROOT at the following locations; - \snippet doc/src/snippets/code/doc_src_installation.qdoc 49 +\snippet doc/src/snippets/code/doc_src_installation.qdoc 50 - For more information about building and running Qt programs on the - Symbian platform, see \l{The Symbian platform - Introduction to Qt}. +It is also possible to install packages onto the device using the +\c runonphone build rule that \c qmake automatically generates for +each Qt project. Options can be supplied to the \c runonphone tool +that is invoked begind the scenes: - We hope you will enjoy using Qt. +\snippet doc/src/snippets/code/doc_src_installation.qdoc make runonphone with options + +If you are running \c runonphone or invoking the \c runonphone +build rule often, it is possible to set the \c QT_RUN_ON_PHONE_OPTIONS +environment variable with the options you normally use: + +\snippet doc/src/snippets/code/doc_src_installation.qdoc make runonphone with preset environment variable + +This makes installation of packages onto a device easier and less +error-prone. + + +\section1 Running Qt Demos + +We've included a subset of the Qt demos in this package for you +to try out. An excellent starting point is the "fluidlauncher" +demo. + +Install and run the demo by using the following commands: + +\snippet doc/src/snippets/code/doc_src_installation.qdoc 48 + +The same command can be used for other applications: + +\snippet doc/src/snippets/code/doc_src_installation.qdoc 49 + +For more information about building and running Qt programs on the +Symbian platform, see \l{The Symbian platform - Introduction to Qt}. + +We hope you will enjoy using Qt. */ /*! diff --git a/doc/src/snippets/code/doc_src_installation.qdoc b/doc/src/snippets/code/doc_src_installation.qdoc index 0593567..2e59db9 100644 --- a/doc/src/snippets/code/doc_src_installation.qdoc +++ b/doc/src/snippets/code/doc_src_installation.qdoc @@ -301,11 +301,24 @@ make runonphone -s lib/Qt.sis //! [47] +//! [runonphone with device file path] +runonphone -s lib/Qt.sis -p /dev/ttyUSB1 +//! [runonphone with device file path] + //! [48] cd demos/embedded/fluidlauncher runonphone -s fluidlauncher.sis fluidlauncher.exe //! [48] +//! [make runonphone with options] +make runonphone "QT_RUN_ON_PHONE_OPTIONS=-p /dev/ttyUSB1" +//! [make runonphone with options] + +//! [make runonphone with preset environment variable] +export QT_RUN_ON_PHONE_OPTIONS="-p /dev/ttyUSB1" +make runonphone +//! [make runonphone with preset environment variable] + //! [49] cd myapp qmake diff --git a/src/corelib/kernel/qcoreapplication.cpp b/src/corelib/kernel/qcoreapplication.cpp index d3f399b..5598187 100644 --- a/src/corelib/kernel/qcoreapplication.cpp +++ b/src/corelib/kernel/qcoreapplication.cpp @@ -406,11 +406,10 @@ QString qAppName() operations can call processEvents() to keep the application responsive. - Some Qt classes, such as QString, can be used without a - QCoreApplication object. However, in general, we recommend that - you create a QCoreApplication or a QApplication object in your \c - main() function as early as possible. exit() will not return - until the event loop exits; e.g., when quit() is called. + In general, we recommend that you create a QCoreApplication or + a QApplication object in your \c main() function as early as + possible. exit() will not return until the event loop exits; + e.g., when quit() is called. Several static convenience functions are also provided. The QCoreApplication object is available from instance(). Events can diff --git a/src/declarative/graphicsitems/qdeclarativeflickable.cpp b/src/declarative/graphicsitems/qdeclarativeflickable.cpp index b737785..a88fc2b 100644 --- a/src/declarative/graphicsitems/qdeclarativeflickable.cpp +++ b/src/declarative/graphicsitems/qdeclarativeflickable.cpp @@ -1182,19 +1182,18 @@ void QDeclarativeFlickable::setBoundsBehavior(BoundsBehavior b) \qmlproperty real Flickable::contentWidth \qmlproperty real Flickable::contentHeight - The dimensions of the content (the surface controlled by Flickable). Typically this - should be set to the combined size of the items placed in the Flickable. Note this - can be set automatically using \l {Item::childrenRect.width}{childrenRect.width} - and \l {Item::childrenRect.height}{childrenRect.height}. For example: + The dimensions of the content (the surface controlled by Flickable). + This should typically be set to the combined size of the items placed in the + Flickable. - \code - Flickable { - width: 320; height: 480 - contentWidth: childrenRect.width; contentHeight: childrenRect.height + The following snippet shows how these properties are used to display + an image that is larger than the Flickable item itself: - Image { id: image; source: "bigImage.png" } - } - \endcode + \snippet doc/src/snippets/declarative/flickable.qml document + + In some cases, the the content dimensions can be automatically set + using the \l {Item::childrenRect.width}{childrenRect.width} + and \l {Item::childrenRect.height}{childrenRect.height} properties. */ qreal QDeclarativeFlickable::contentWidth() const { diff --git a/tools/qdoc3/doc/qdoc-manual.qdocconf b/tools/qdoc3/doc/qdoc-manual.qdocconf index 26fd09c..1e7ff01 100644 --- a/tools/qdoc3/doc/qdoc-manual.qdocconf +++ b/tools/qdoc3/doc/qdoc-manual.qdocconf @@ -1,7 +1,7 @@ project = QDoc description = QDoc3 Manual -indexes = $QTDIR/doc/html/qt.index +indexes = ../../../doc/html/qt.index outputdir = html @@ -9,41 +9,226 @@ sources = qdoc-manual.qdoc sourcedirs = $PWD exampledirs += $PWD \ - $QTDIR/examples + ../../../examples imagedirs += images extraimages.HTML = qt-logo -HTML.stylesheets = classic.css - -HTML.style = "h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }\n" \ - "a:link { color: #004faf; text-decoration: none }\n" \ - "a:visited { color: #672967; text-decoration: none }\n" \ - "td.postheader { font-family: sans-serif }\n" \ - "tr.address { font-family: sans-serif }\n" \ - "body { background: #ffffff; color: black; }" - -HTML.postheader = "<table border=\"0\" cellpadding=\"0\" cellspacing=\"5\" width=\"100%\">\n" \ - "<tr>\n" \ - "<td align=\"left\" valign=\"top\" width=\"32\">" \ - "<a href=\"http://qt.nokia.com/\"><img src=\"images/qt-logo.png\" align=\"left\" border=\"0\" /></a>" \ - "</td>\n" \ - "<td class=\"postheader\" valign=\"center\">" \ - "<a href=\"01-qdoc-manual.html\">" \ - "<font color=\"#004faf\">Home: QDoc Manual</font></a> ·" \ - "<a href=\"http://qt.nokia.com/doc/4.7\">" \ - "<font color=\"#004faf\"> Qt Reference Documentation</font></a>" \ - "</td>\n" \ - "</tr></table>" - -HTML.footer = "<p /><address><hr /><div align=\"center\">\n" \ - "<table width=\"100%\" cellspacing=\"0\" border=\"0\"><tr class=\"address\">\n" \ - "<td width=\"40%\" align=\"left\">Copyright © 2010 Nokia Corporation and/or its subsidiary(-ies)</td>\n" \ - "<td width=\"20%\" align=\"center\"><a href=\"trademarks.html\">Trademarks</a></td>\n" \ - "<td width=\"40%\" align=\"right\"><div align=\"right\">Qt \\version</div></td>\n" \ - "</tr></table></div></address>" - -spurious += "Missing '\\}'" -spurious += "Cannot use .*" -spurious += "Unexpected .*" +HTML.stylesheets = style/style.css \ + style/OfflineStyle.css \ + style/style_ie7.css \ + style/style_ie8.css \ + style/style_ie6.css + +HTML.postheader = " <div class=\"header\" id=\"qtdocheader\">\n" \ + " <div class=\"content\"> \n" \ + " <div id=\"nav-logo\">\n" \ + " <a href=\"index.html\">Home</a></div>\n" \ + " <a href=\"index.html\" class=\"qtref\"><span>Qt Reference Documentation</span></a>\n" \ + " <div id=\"narrowsearch\"></div>\n" \ + " <div id=\"nav-topright\">\n" \ + " <ul>\n" \ + " <li class=\"nav-topright-home\"><a href=\"http://qt.nokia.com/\">Qt HOME</a></li>\n" \ + " <li class=\"nav-topright-dev\"><a href=\"http://developer.qt.nokia.com/\">DEV</a></li>\n" \ + " <li class=\"nav-topright-labs\"><a href=\"http://labs.qt.nokia.com/blogs/\">LABS</a></li>\n" \ + " <li class=\"nav-topright-doc nav-topright-doc-active\"><a href=\"http://doc.qt.nokia.com/\">\n" \ + " DOC</a></li>\n" \ + " <li class=\"nav-topright-blog\"><a href=\"http://blog.qt.nokia.com/\">BLOG</a></li>\n" \ + " </ul>\n" \ + " </div>\n" \ + " <div id=\"shortCut\">\n" \ + " <ul>\n" \ + " <li class=\"shortCut-topleft-inactive\"><span><a href=\"index.html\">Qt 4.7</a></span></li>\n" \ + " <li class=\"shortCut-topleft-active\"><a href=\"http://doc.qt.nokia.com\">ALL VERSIONS" \ + " </a></li>\n" \ + " </ul>\n" \ + " </div>\n" \ + " <ul class=\"sf-menu\" id=\"narrowmenu\"> \n" \ + " <li><a href=\"#\">API Lookup</a> \n" \ + " <ul> \n" \ + " <li><a href=\"classes.html\">Class index</a></li> \n" \ + " <li><a href=\"functions.html\">Function index</a></li> \n" \ + " <li><a href=\"modules.html\">Modules</a></li> \n" \ + " <li><a href=\"namespaces.html\">Namespaces</a></li> \n" \ + " <li><a href=\"qtglobal.html\">Global Declarations</a></li> \n" \ + " <li><a href=\"qdeclarativeelements.html\">QML elements</a></li> \n" \ + " </ul> \n" \ + " </li> \n" \ + " <li><a href=\"#\">Qt Topics</a> \n" \ + " <ul> \n" \ + " <li><a href=\"qt-basic-concepts.html\">Programming with Qt</a></li> \n" \ + " <li><a href=\"qtquick.html\">Device UIs & Qt Quick</a></li> \n" \ + " <li><a href=\"qt-gui-concepts.html\">UI Design with Qt</a></li> \n" \ + " <li><a href=\"developing-with-qt.html\">Cross-platform and Platform-specific</a></li> \n" \ + " <li><a href=\"platform-specific.html\">Platform-specific info</a></li> \n" \ + " <li><a href=\"technology-apis.html\">Qt and Key Technologies</a></li> \n" \ + " <li><a href=\"best-practices.html\">How-To's and Best Practices</a></li> \n" \ + " </ul> \n" \ + " </li> \n" \ + " <li><a href=\"#\">Examples</a> \n" \ + " <ul> \n" \ + " <li><a href=\"all-examples.html\">Examples</a></li> \n" \ + " <li><a href=\"tutorials.html\">Tutorials</a></li> \n" \ + " <li><a href=\"demos.html\">Demos</a></li> \n" \ + " <li><a href=\"qdeclarativeexamples.html\">QML Examples</a></li> \n" \ + " </ul> \n" \ + " </li> \n" \ + " </ul> \n" \ + " </div>\n" \ + " </div>\n" \ + " <div class=\"wrapper\">\n" \ + " <div class=\"hd\">\n" \ + " <span></span>\n" \ + " </div>\n" \ + " <div class=\"bd group\">\n" \ + " <div class=\"sidebar\">\n" \ + " <div class=\"searchlabel\">\n" \ + " Search index:</div>\n" \ + " <div class=\"search\" id=\"sidebarsearch\">\n" \ + " <form id=\"qtdocsearch\" action=\"\" onsubmit=\"return false;\">\n" \ + " <fieldset>\n" \ + " <input type=\"text\" name=\"searchstring\" id=\"pageType\" value=\"\" />\n" \ + " <div id=\"resultdialog\"> \n" \ + " <a href=\"#\" id=\"resultclose\">Close</a> \n" \ + " <p id=\"resultlinks\" class=\"all\"><a href=\"#\" id=\"showallresults\">All</a> | <a href=\"#\" id=\"showapiresults\">API</a> | <a href=\"#\" id=\"showarticleresults\">Articles</a> | <a href=\"#\" id=\"showexampleresults\">Examples</a></p> \n" \ + " <p id=\"searchcount\" class=\"all\"><span id=\"resultcount\"></span><span id=\"apicount\"></span><span id=\"articlecount\"></span><span id=\"examplecount\"></span> results:</p> \n" \ + " <ul id=\"resultlist\" class=\"all\"> \n" \ + " </ul> \n" \ + " </div> \n" \ + " </fieldset>\n" \ + " </form>\n" \ + " </div>\n" \ + " <div class=\"box first bottombar\" id=\"lookup\">\n" \ + " <h2 title=\"API Lookup\"><span></span>\n" \ + " API Lookup</h2>\n" \ + " <div id=\"list001\" class=\"list\">\n" \ + " <ul id=\"ul001\" >\n" \ + " <li class=\"defaultLink\"><a href=\"classes.html\">Class index</a></li>\n" \ + " <li class=\"defaultLink\"><a href=\"functions.html\">Function index</a></li>\n" \ + " <li class=\"defaultLink\"><a href=\"modules.html\">Modules</a></li>\n" \ + " <li class=\"defaultLink\"><a href=\"namespaces.html\">Namespaces</a></li>\n" \ + " <li class=\"defaultLink\"><a href=\"qtglobal.html\">Global Declarations</a></li>\n" \ + " <li class=\"defaultLink\"><a href=\"qdeclarativeelements.html\">QML elements</a></li>\n" \ + " </ul> \n" \ + " </div>\n" \ + " </div>\n" \ + " <div class=\"box bottombar\" id=\"topics\">\n" \ + " <h2 title=\"Qt Topics\"><span></span>\n" \ + " Qt Topics</h2>\n" \ + " <div id=\"list002\" class=\"list\">\n" \ + " <ul id=\"ul002\" >\n" \ + " <li class=\"defaultLink\"><a href=\"qt-basic-concepts.html\">Programming with Qt</a></li> \n" \ + " <li class=\"defaultLink\"><a href=\"qtquick.html\">Device UIs & Qt Quick</a></li> \n" \ + " <li class=\"defaultLink\"><a href=\"qt-gui-concepts.html\">UI Design with Qt</a></li> \n" \ + " <li class=\"defaultLink\"><a href=\"developing-with-qt.html\">Cross-platform and Platform-specific</a></li> \n" \ + " <li class=\"defaultLink\"><a href=\"platform-specific.html\">Platform-specific info</a></li> \n" \ + " <li class=\"defaultLink\"><a href=\"technology-apis.html\">Qt and Key Technologies</a></li> \n" \ + " <li class=\"defaultLink\"><a href=\"best-practices.html\">How-To's and Best Practices</a></li> \n" \ + " </ul> \n" \ + " </div>\n" \ + " </div>\n" \ + " <div class=\"box\" id=\"examples\">\n" \ + " <h2 title=\"Examples\"><span></span>\n" \ + " Examples</h2>\n" \ + " <div id=\"list003\" class=\"list\">\n" \ + " <ul id=\"ul003\">\n" \ + " <li class=\"defaultLink\"><a href=\"all-examples.html\">Examples</a></li>\n" \ + " <li class=\"defaultLink\"><a href=\"tutorials.html\">Tutorials</a></li>\n" \ + " <li class=\"defaultLink\"><a href=\"demos.html\">Demos</a></li>\n" \ + " <li class=\"defaultLink\"><a href=\"qdeclarativeexamples.html\">QML Examples</a></li>\n" \ + " </ul> \n" \ + " </div>\n" \ + " </div>\n" \ + " </div>\n" \ + " <div class=\"wrap\">\n" \ + " <div class=\"toolbar\">\n" \ + " <div class=\"breadcrumb toolblock\">\n" \ + " <ul>\n" \ + " <li class=\"first\"><a href=\"index.html\">Home</a></li>\n" \ + " <!-- Bread crumbs goes here -->\n" + +HTML.postpostheader = " </ul>\n" \ + " </div>\n" \ + " <div class=\"toolbuttons toolblock\">\n" \ + " <ul>\n" \ + " <li id=\"smallA\" class=\"t_button\">A</li>\n" \ + " <li id=\"medA\" class=\"t_button active\">A</li>\n" \ + " <li id=\"bigA\" class=\"t_button\">A</li>\n" \ + " <li id=\"print\" class=\"t_button\"><a href=\"javascript:this.print();\">\n" \ + " <span>Print</span></a></li>\n" \ + " </ul>\n" \ + " </div>\n" \ + " </div>\n" \ + " <div class=\"content mainContent\">\n" + +HTML.footer = "" \ + " <div class=\"feedback t_button\">\n" \ + " [+] Documentation Feedback</div>\n" \ + " </div>\n" \ + " </div>\n" \ + " </div> \n" \ + " <div class=\"ft\">\n" \ + " <span></span>\n" \ + " </div>\n" \ + " </div> \n" \ + " <div class=\"footer\">\n" \ + " <p>\n" \ + " <acronym title=\"Copyright\">©</acronym> 2008-2010 Nokia Corporation and/or its\n" \ + " subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation \n" \ + " in Finland and/or other countries worldwide.</p>\n" \ + " <p>\n" \ + " All other trademarks are property of their respective owners. <a title=\"Privacy Policy\"\n" \ + " href=\"http://qt.nokia.com/about/privacy-policy\">Privacy Policy</a></p>\n" \ + " <br />\n" \ + " <p>\n" \ + " Licensees holding valid Qt Commercial licenses may use this document in accordance with the" \ + " Qt Commercial License Agreement provided with the Software or, alternatively, in accordance" \ + " with the terms contained in a written agreement between you and Nokia.</p>\n" \ + " <p>\n" \ + " Alternatively, this document may be used under the terms of the <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU\n" \ + " Free Documentation License version 1.3</a>\n" \ + " as published by the Free Software Foundation.</p>\n" \ + " </div>\n" \ + " <div id=\"feedbackBox\">\n" \ + " <div id=\"feedcloseX\" class=\"feedclose t_button\">X</div>\n" \ + " <form id=\"feedform\" action=\"http://doc.qt.nokia.com/docFeedbck/feedback.php\" method=\"get\">\n" \ + " <p id=\"noteHead\">Thank you for giving your feedback.</p> <p class=\"note\">Make sure it is related to this specific page. For more general bugs and \n" \ + " requests, please use the <a href=\"http://bugreports.qt.nokia.com/secure/Dashboard.jspa\">Qt Bug Tracker</a>.</p>\n" \ + " <p><textarea id=\"feedbox\" name=\"feedText\" rows=\"5\" cols=\"40\"></textarea></p>\n" \ + " <p><input id=\"feedsubmit\" class=\"feedclose\" type=\"submit\" name=\"feedback\" /></p>\n" \ + " </form>\n" \ + " </div>\n" \ + " <div id=\"blurpage\">\n" \ + " </div>\n" + +# This stuff is used by the Qt 4.7 doc format. +scriptdirs = ../../../doc/src/template/scripts +styledirs = ../../../doc/src/template/style + +scripts.HTML = functions.js \ + narrow.js \ + superfish.js \ + jquery.js + +styles.HTML = style.css \ + narrow.css \ + superfish.css \ + superfish_skin.css \ + style_ie6.css \ + style_ie7.css \ + style_ie8.css + +# Files not referenced in any qdoc file (last four are needed by qtdemo) +# See also extraimages.HTML +qhp.Qt.extraFiles = scripts/functions.js \ + scripts/jquery.js \ + scripts/narrow.js \ + scripts/superfish.js \ + style/narrow.css \ + style/superfish.css \ + style/style_ie6.css \ + style/style_ie7.css \ + style/style_ie8.css \ + style/style.css + diff --git a/tools/qdoc3/htmlgenerator.cpp b/tools/qdoc3/htmlgenerator.cpp index fb04175..9e45f8c 100644 --- a/tools/qdoc3/htmlgenerator.cpp +++ b/tools/qdoc3/htmlgenerator.cpp @@ -1930,7 +1930,7 @@ void HtmlGenerator::generateHeader(const QString& title, } if (node && !node->links().empty()) - out() << "<p>\n" << navigationLinks << "</p><p/>\n"; + out() << "<p class=\"naviNextPrevious headerNavi\">\n" << navigationLinks << "</p><p/>\n"; } void HtmlGenerator::generateTitle(const QString& title, @@ -1955,7 +1955,7 @@ void HtmlGenerator::generateTitle(const QString& title, void HtmlGenerator::generateFooter(const Node *node) { if (node && !node->links().empty()) - out() << "<p>\n" << navigationLinks << "</p>\n"; + out() << "<p class=\"naviNextPrevious footerNavi\">\n" << navigationLinks << "</p>\n"; out() << QString(footer).replace("\\" + COMMAND_VERSION, myTree->version()) << QString(address).replace("\\" + COMMAND_VERSION, myTree->version()); @@ -3719,7 +3719,11 @@ void HtmlGenerator::findAllClasses(const InnerNode *node) (*c)->subType() == Node::QmlClass && !(*c)->doc().isEmpty()) { QString qmlClassName = (*c)->name(); - qmlClasses.insert(qmlClassName,*c); + // Remove the "QML:" prefix if present. + if (qmlClassName.startsWith(QLatin1String("QML:"))) + qmlClasses.insert(qmlClassName.mid(4),*c); + else + qmlClasses.insert(qmlClassName,*c); } else if ((*c)->isInnerNode()) { findAllClasses(static_cast<InnerNode *>(*c)); |