summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/src/deployment/deployment.qdoc12
-rw-r--r--doc/src/development/assistant-manual.qdoc40
-rw-r--r--doc/src/development/developing-on-mac.qdoc40
-rw-r--r--doc/src/development/qmake-manual.qdoc4
-rw-r--r--doc/src/examples/completer.qdoc30
-rw-r--r--doc/src/examples/contextsensitivehelp.qdoc47
-rw-r--r--doc/src/frameworks-technologies/activeqt-server.qdoc7
-rw-r--r--doc/src/getting-started/demos.qdoc2
-rw-r--r--doc/src/getting-started/examples.qdoc2
-rw-r--r--doc/src/getting-started/installation.qdoc4
-rw-r--r--doc/src/howtos/timers.qdoc2
-rw-r--r--doc/src/index.qdoc2
-rw-r--r--doc/src/internationalization/i18n.qdoc3
-rw-r--r--doc/src/modules.qdoc10
-rw-r--r--doc/src/platforms/platform-notes.qdoc8
-rw-r--r--doc/src/porting/porting4.qdoc9
-rw-r--r--doc/src/snippets/code/doc_src_assistant-manual.qdoc8
17 files changed, 133 insertions, 97 deletions
diff --git a/doc/src/deployment/deployment.qdoc b/doc/src/deployment/deployment.qdoc
index 8ba106c..bc6ae98 100644
--- a/doc/src/deployment/deployment.qdoc
+++ b/doc/src/deployment/deployment.qdoc
@@ -87,30 +87,30 @@
\header
\o {4,1} Qt's Libraries
\row
- \o \l {QtAssistant}
\o \l {QAxContainer}
\o \l {QAxServer}
\o \l {QtCore}
- \row
\o \l {QtDBus}
+ \row
\o \l {QtDesigner}
\o \l {QtGui}
\o \l {QtHelp}
- \row
\o \l {QtNetwork}
+ \row
\o \l {QtOpenGL}
\o \l {QtScript}
\o \l {QtScriptTools}
- \row
\o \l {QtSql}
+ \row
\o \l {QtSvg}
\o \l {QtWebKit}
\o \l {QtXml}
- \row
\o \l {QtXmlPatterns}
+ \row
\o \l {Phonon Module}{Phonon}
\o \l {Qt3Support}
- \o
+ \o \l {}
+ \o \l {}
\endtable
Since Qt is not a system library, it has to be redistributed along
diff --git a/doc/src/development/assistant-manual.qdoc b/doc/src/development/assistant-manual.qdoc
index c4eb615..7d56ea1 100644
--- a/doc/src/development/assistant-manual.qdoc
+++ b/doc/src/development/assistant-manual.qdoc
@@ -154,13 +154,17 @@
\row
\o -unregister <doc.qch>
\o Unregisters the specified compressed help file from the given
- collection file.
+ collection file.
\row
\o -remove-search-index
\o Purges the help search engine's index. This option is
useful in case the associated index files get corrupted.
\QA will re-index the documentation at the next start-up.
\row
+ \o -rebuild-search-index
+ \o Rebuilds the help search engine's index.
+ Note that this operation may take a while to finish.
+ \row
\o -setCurrentFilter <filter>
\o Sets the given filter as the active filter.
\row
@@ -638,12 +642,19 @@
file in the \c{file} tags. It is possible to specify a different file or any
language. The icon defined by the \c{icon} tags is applied to any language.
\row
- \o \c{<cacheDirectory>}
- \o Specified as a path relative to the directory given by
- QDesktopServices::DataLocation, the cache path is used to store index files
+ \o \c{<cacheDirectory base="collection|default">}
+ \o The cache directory is used to store index files
needed for the full text search and a copy of the collection file.
- The copy is needed because \QA stores all its settings in the collection file;
- i.e., it must be writable for the user.
+ The copy is needed because \QA stores all its settings in the collection file; i.e., it must be writable for the user.
+ The directory is specified as a relative path.
+ If the \c{base} attribute is set to "collection", the path is
+ relative to the directory the collection file resides in.
+ If the attribute is set to "default" or if it is missing,
+ the path is relative to the directory given by
+ QDesktopServices::DataLocation. The first form is useful for
+ collections that are used in a "mobile" way, e.g. carried around
+ on a USB stick.
+
\endtable
In addition to those \QA specific tags, the tags for generating and registering
@@ -677,9 +688,6 @@
to make Assistant listen to your application, turn on its remote control
functionality by passing the \c{-enableRemoteControl} command line option.
- \warning The trailing '\0' must be appended separately to the QByteArray,
- e.g., \c{QByteArray("command" + '\0')}.
-
The following example shows how this can be done:
\snippet doc/src/snippets/code/doc_src_assistant-manual.qdoc 2
@@ -690,6 +698,9 @@
\snippet doc/src/snippets/code/doc_src_assistant-manual.qdoc 3
+ Note that the trailing newline character is required to mark the end
+ of the input.
+
The following commands can be used to control \QA:
\table
@@ -727,13 +738,20 @@
\o Selects the item in the contents widget which corresponds to
the currently displayed page.
\row
- \o \c{setCurrentFilter}
+ \o \c{setCurrentFilter <filter>}
\o Selects the specified filter and updates the visual representation
accordingly.
\row
\o \c{expandToc <Depth>}
\o Expands the table of contents tree to the given depth. If depth
- is less than 1, the tree will be collapsed completely.
+ is 0, the tree will be collapsed completely. If depth is -1,
+ the tree will be expanded completely.
+ \row
+ \o \c{register <help file>}
+ \o Adds the given Qt compressed help file to the collection.
+ \row
+ \o \c{unregister <help file>}
+ \o Removes the given Qt compressed help file from the collection.
\endtable
If you want to send several commands within a short period of time, it is
diff --git a/doc/src/development/developing-on-mac.qdoc b/doc/src/development/developing-on-mac.qdoc
index b0862cf..20eefb7 100644
--- a/doc/src/development/developing-on-mac.qdoc
+++ b/doc/src/development/developing-on-mac.qdoc
@@ -60,26 +60,26 @@
\section1 What Versions of Mac OS X are Supported?
- As of Qt 4.6, Qt supports Mac OS X versions 10.4 and up. It is usually in
+ As of Qt 4.7, Qt supports Mac OS X versions 10.4 and up. It is usually in
the best interest of the developer and user to be running the latest
updates to any version. We test internally against Mac OS X 10.4.11 as well
as the updated release of Mac OS X 10.5 and Mac OS X 10.6.
\section2 Carbon or Cocoa?
- Historically, Qt has used the Carbon toolkit, which supports 32-bit
- applications on Mac OS X 10.4 and up. Qt 4.5 and up has support for the Cocoa
- toolkit, which requires 10.5 and provides 64-bit support.
-
- This detail is typically not important to Qt application developers. Qt is
- cross-platform across Carbon and Cocoa, and Qt applications behave
- the same way when configured for either one. Eventually, the Carbon
- version will be discontinued. This is something to keep in mind when you
- consider writing code directly against native APIs.
-
- The current binary for Qt is built in two flavors, 32-bit Carbon and full
- universal Cocoa (32-bit and 64-bit). If you want a different setup for
- Qt will use, you must build from scratch. Carbon or Cocoa is chosen when
+ Qt supports building in two flavors, using either the Carbon or Cocoa APIs.
+ Using the Cocoa toolkit, Qt requires 10.5 and provides 64-bit support. With
+ Carbon Qt can be developed on and deployed to 10.4, but there is no 64-bit
+ support.
+
+ With Qt 4.7 we now reccommend using the Cocoa version of Qt for developement,
+ unless you want to target the 10.4 platform. Qt now uses Cocoa by default,
+ both for the binary package and when configuring from source. Download the
+ Carbon binarypackages or configure with "-carbon" to use that version.
+
+ There are two versions of the Qt binary, one with x86 and x86_64
+ Cocoa and another with x86 and ppc Carbon. If you want a different setup
+ you must build from source. Carbon or Cocoa is chosen when
configuring the package for building. The configure process selects Carbon
by default, to specify Cocoa use the \c{-cocoa} flag. configure for a
64-bit architecture using one of the \c{-arch} flags (see \l{universal
@@ -147,13 +147,11 @@
Carbon and Cocoa both have their advantages and disadvantages. Probably the
easiest way to determine is to look at the version of Mac OS X you are
- targetting. If you are starting a new application and can target 10.5 and
- up, then please consider Cocoa only. If you have an existing application or
- need to target earlier versions of the operating system and do not need
- access to 64-bit or newer Apple technologies, then Carbon is a good fit. If
- your needs fall in between, you can go with a 64-bit Cocoa and 32-bit
- Carbon universal application with the appropriate checks in your code to
- choose the right path based on where you are running the application.
+ targetting. If your application can target 10.5 and up, then we reccomend
+ using Cocoa. If you need to target earlier versions of the operating system
+ and do not need access to 64-bit or newer Apple technologies, then Carbon
+ is a good fit. If your needs fall in between, you can go with a 64-bit Cocoa and 32-bit
+ Carbon universal application.
For Mac OS X 10.6, Apple has started recommending developers to build their
applications 64-bit. The main reason is that there is a small speed
diff --git a/doc/src/development/qmake-manual.qdoc b/doc/src/development/qmake-manual.qdoc
index d7aa0db..3d5c792 100644
--- a/doc/src/development/qmake-manual.qdoc
+++ b/doc/src/development/qmake-manual.qdoc
@@ -1977,7 +1977,7 @@ distinction between shared and
\section1 QMAKE_CFLAGS_WARN_OFF
This variable is not empty if the warn_off
- \l{#TEMPLATE}{TEMPLATE} option is specified. The value of this
+ \l{#CONFIG}{CONFIG} option is specified. The value of this
variable is typically handled by \c qmake or \l{#QMAKESPEC}{qmake.conf}
and rarely needs to be modified.
@@ -1985,7 +1985,7 @@ distinction between shared and
\section1 QMAKE_CFLAGS_WARN_ON
This variable is not empty if the warn_on
- \l{#TEMPLATE}{TEMPLATE} option is specified.
+ \l{#CONFIG}{CONFIG} option is specified.
The value of this variable is typically handled by
\c qmake or \l{#QMAKESPEC}{qmake.conf} and rarely needs
to be modified.
diff --git a/doc/src/examples/completer.qdoc b/doc/src/examples/completer.qdoc
index b69ea69..c0eb947 100644
--- a/doc/src/examples/completer.qdoc
+++ b/doc/src/examples/completer.qdoc
@@ -48,7 +48,7 @@
\image completer-example.png
- This example uses a custom item model, \c DirModel, and a QCompleter object.
+ This example uses a custom item model, \c FileSystemModel, and a QCompleter object.
QCompleter is a class that provides completions based on an item model. The
type of model, the completion mode, and the case sensitivity can be
selected using combo boxes.
@@ -61,32 +61,32 @@
\quotefile examples/tools/completer/completer.qrc
- \section1 DirModel Class Definition
+ \section1 FileSystemModel Class Definition
- The \c DirModel class is a subclass of QDirModel, which provides a data
+ The \c FileSystemModel class is a subclass of QFileSystemModel, which provides a data
model for the local filesystem.
- \snippet examples/tools/completer/dirmodel.h 0
+ \snippet examples/tools/completer/fsmodel.h 0
This class only has a constructor and a \c data() function as it is only
created to enable \c data() to return the entire file path for the
- display role, unlike \l{QDirModel}'s \c data() function that only returns
+ display role, unlike \l{QFileSystemModel}'s \c data() function that only returns
the folder and not the drive label. This is further explained in
- \c DirModel's implementation.
+ \c FileSystemModel's implementation.
- \section1 DirModel Class Implementation
+ \section1 FileSystemModel Class Implementation
- The constructor for the \c DirModel class is used to pass \a parent to
- QDirModel.
+ The constructor for the \c FileSystemModel class is used to pass \a parent to
+ QFileSystemModel.
- \snippet examples/tools/completer/dirmodel.cpp 0
+ \snippet examples/tools/completer/fsmodel.cpp 0
As mentioned earlier, the \c data() function is reimplemented in order to
get it to return the entire file parth for the display role. For example,
- with a QDirModel, you will see "Program Files" in the view. However, with
- \c DirModel, you will see "C:\\Program Files".
+ with a QFileSystemModel, you will see "Program Files" in the view. However, with
+ \c FileSystemModel, you will see "C:\\Program Files".
- \snippet examples/tools/completer/dirmodel.cpp 1
+ \snippet examples/tools/completer/fsmodel.cpp 1
The screenshots below illustrate this difference:
@@ -120,7 +120,7 @@
is then invoked.
We set up three QComboBox objects, \c modelComb, \c modeCombo and
- \c caseCombo. By default, the \c modelCombo is set to QDirModel,
+ \c caseCombo. By default, the \c modelCombo is set to QFileSystemModel,
the \c modeCombo is set to "Filtered Popup" and the \c caseCombo is set
to "Case Insensitive".
@@ -202,7 +202,7 @@
model selected by the user.
A \c switch statement is used to change the item model based on the index
- of \c modelCombo. If \c case is 0, we use an unsorted QDirModel, providing
+ of \c modelCombo. If \c case is 0, we use an unsorted QFileSystemModel, providing
us with a file path excluding the drive label.
\snippet examples/tools/completer/mainwindow.cpp 11
diff --git a/doc/src/examples/contextsensitivehelp.qdoc b/doc/src/examples/contextsensitivehelp.qdoc
new file mode 100644
index 0000000..668fa36
--- /dev/null
+++ b/doc/src/examples/contextsensitivehelp.qdoc
@@ -0,0 +1,47 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the Technology Preview License Agreement accompanying
+** this package.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \example help/contextsensitivehelp
+ \title Context-Sensitive Help Example
+
+ This example shows how to use the services of the QHelpEngineCore class.
+*/
diff --git a/doc/src/frameworks-technologies/activeqt-server.qdoc b/doc/src/frameworks-technologies/activeqt-server.qdoc
index f28097f..4afcee1 100644
--- a/doc/src/frameworks-technologies/activeqt-server.qdoc
+++ b/doc/src/frameworks-technologies/activeqt-server.qdoc
@@ -99,10 +99,6 @@
\o Register the server
\endlist
- Note that the QAxServer build system is not supported on Windows 98/ME
- (attaching of resources to a binary is not possible there), but a server
- built on Windows NT/2000/XP will work on previous Windows versions as well.
-
To skip the post-processing step, also set the \c qaxserver_no_postlink
configuration.
@@ -413,8 +409,7 @@
\footnote
OLE needs to marshal user defined types by reference (ByRef), and cannot
marshal them by value (ByVal). This is why const-references and object
- parameters are not supported for QRect, QSize and QPoint. Also note that
- servers with this datatype require Windows 98 or DCOM 1.2 to be installed.
+ parameters are not supported for QRect, QSize and QPoint.
\endfootnote
\o [in, out] struct QRect (user defined)
\row
diff --git a/doc/src/getting-started/demos.qdoc b/doc/src/getting-started/demos.qdoc
index 03e5aa6..6974634 100644
--- a/doc/src/getting-started/demos.qdoc
+++ b/doc/src/getting-started/demos.qdoc
@@ -46,7 +46,7 @@
\previouspage Qt Examples
\contentspage How to Learn Qt
- \nextpage What's New in Qt 4.6
+ \nextpage What's New in Qt 4.7
This is the list of demonstrations in Qt's \c demos directory.
These are larger and more complicated programs than the
diff --git a/doc/src/getting-started/examples.qdoc b/doc/src/getting-started/examples.qdoc
index 0c18773..bc6404c 100644
--- a/doc/src/getting-started/examples.qdoc
+++ b/doc/src/getting-started/examples.qdoc
@@ -1218,6 +1218,8 @@
\list
\o \l{help/simpletextviewer}{Simple Text Viewer}\raisedaster
+ \o \l{help/remotecontrol}{Remote Control}
+ \o \l{help/contextsensitivehelp}{Context-Sensitive Help}
\endlist
Examples marked with an asterisk (*) are fully documented.
diff --git a/doc/src/getting-started/installation.qdoc b/doc/src/getting-started/installation.qdoc
index 5f95c5a..3088892 100644
--- a/doc/src/getting-started/installation.qdoc
+++ b/doc/src/getting-started/installation.qdoc
@@ -740,9 +740,9 @@ If you are using pre-built binaries, follow the instructions given in the
\l{http://www.microsoft.com/downloads/details.aspx?FamilyId=BB4A75AB-E2D4-4C96-B39D-37BAF6B5B1DC&amp;displaylang=en}{here}
to avoid runtime conflicts.
- If you are using a source code package of Qt, you must first install Perl so
+ If you are using a source edition of Qt, you must first install Perl so
that the syncqt script invoked by configure can be executed. You can download
- this \l{http://www.activestate/downloads/}{here}.
+ this \l{http://www.activestate.com/downloads/}{here}.
To build Qt with Phonon on Windows, you require:
diff --git a/doc/src/howtos/timers.qdoc b/doc/src/howtos/timers.qdoc
index b9c7bfa..cfc2fb4 100644
--- a/doc/src/howtos/timers.qdoc
+++ b/doc/src/howtos/timers.qdoc
@@ -72,7 +72,7 @@
The upper limit for the interval value is determined by the number
of milliseconds that can be specified in a signed integer
(in practice, this is a period of just over 24 days). The accuracy
- depends on the underlying operating system. Windows 98 has 55
+ depends on the underlying operating system. Windows 2000 has 15
millisecond accuracy; other systems that we have tested can handle
1 millisecond intervals.
diff --git a/doc/src/index.qdoc b/doc/src/index.qdoc
index 7c3b4a1..0a603ce 100644
--- a/doc/src/index.qdoc
+++ b/doc/src/index.qdoc
@@ -60,7 +60,7 @@
<ul>
<li><a href="installation.html">Installation</a> and <a href="how-to-learn-qt.html">First Steps with Qt</a></li>
<li><a href="tutorials.html">Tutorials</a> and <a href="examples.html">Examples</a></li>
- <li><a href="demos.html">Demonstrations</a> and <a href="qt4-6-intro.html"><b>New in Qt 4.6</b></a></li>
+ <li><a href="demos.html">Demonstrations</a> and <a href="qt4-7-intro.html"><b>New in Qt 4.7</b></a></li>
</ul>
</td>
<td valign="top">
diff --git a/doc/src/internationalization/i18n.qdoc b/doc/src/internationalization/i18n.qdoc
index b26a983..1ca6ab3 100644
--- a/doc/src/internationalization/i18n.qdoc
+++ b/doc/src/internationalization/i18n.qdoc
@@ -512,9 +512,6 @@
Note that some Windows programs do not understand big-endian
Unicode text files even though that is the order prescribed by
the Unicode Standard in the absence of higher-level protocols.
- \o Unlike programs written with MFC or plain winlib, Qt programs
- are portable between Windows 98 and Windows NT.
- \e {You do not need different binaries to support Unicode.}
\endlist
\section2 Mac OS X
diff --git a/doc/src/modules.qdoc b/doc/src/modules.qdoc
index 44d6ed6..48e1358 100644
--- a/doc/src/modules.qdoc
+++ b/doc/src/modules.qdoc
@@ -1080,13 +1080,3 @@
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
\endlegalese
*/
-
-/*!
- \page qtassistant.html
- \title QtAssistant
-
- This module is no longer needed. Use the QtHelp module to integrate documentation
- into your application.
-
- \sa {QtHelp}
-*/
diff --git a/doc/src/platforms/platform-notes.qdoc b/doc/src/platforms/platform-notes.qdoc
index 6ea3df4..4a04a36 100644
--- a/doc/src/platforms/platform-notes.qdoc
+++ b/doc/src/platforms/platform-notes.qdoc
@@ -263,14 +263,6 @@
Install Qt into a subdirectory without spaces to avoid this problem.
- \section2 AccelGALAXY graphic card
-
- When you use a NT 4.0 machine with the driver number
- 4,00,1381,1000,021,4.0.0 there is a problem with drag an drop and icons.
- The computer freezes, and you have to reset. The problem disappears with
- the newest version of the driver, available at
- \l{http://www.es.com/}{www.es.com}.
-
\section2 Possible GL conflict
There is a known issue with running Microsoft NetMeeting, Lotus SameTime
diff --git a/doc/src/porting/porting4.qdoc b/doc/src/porting/porting4.qdoc
index d494b0c..25dc792 100644
--- a/doc/src/porting/porting4.qdoc
+++ b/doc/src/porting/porting4.qdoc
@@ -3793,11 +3793,10 @@
multimedia timer API, which gives us 1 millisecond resolution for
QTimer.
- Note that other versions of Windows have a lower timer resolution,
- and that code relying on underlying system timer restrictions
- encounters no such limitations using Qt 4 (e.g., setting an
- interval of 0 millisecond results in Qt occupying all of the
- processor time when no GUI events need processing).
+ Note that Windows 2000 has a lower timer resolution, and that code relying
+ on underlying system timer restrictions encounters no such limitations
+ using Qt 4 (e.g., setting an interval of 0 millisecond results in Qt
+ occupying all of the processor time when no GUI events need processing).
\section1 QToolBar
diff --git a/doc/src/snippets/code/doc_src_assistant-manual.qdoc b/doc/src/snippets/code/doc_src_assistant-manual.qdoc
index 7438365..96aa71d 100644
--- a/doc/src/snippets/code/doc_src_assistant-manual.qdoc
+++ b/doc/src/snippets/code/doc_src_assistant-manual.qdoc
@@ -58,7 +58,7 @@ assistant -collectionFile file
<cacheDirectory>mycompany/myapplication</cacheDirectory>
<aboutMenuText>
<text>About My Application</text>
- <text language="de">Über meine Applikation...</text>
+ <text language="de">Ãœber meine Applikation...</text>
</aboutMenuText>
<aboutDialog>
<file>about.txt</file>
@@ -95,8 +95,7 @@ if (!process->waitForStarted())
//! [3]
QByteArray ba;
-ba.append("setSource qthelp://com.mycompany.1_0_0/doc/index.html");
-ba.append('\0');
+ba.append("setSource qthelp://com.mycompany.1_0_0/doc/index.html\n");
process->write(ba);
//! [3]
@@ -105,8 +104,7 @@ process->write(ba);
QByteArray ba;
ba.append("hide bookmarks;");
ba.append("hide index;");
-ba.append("setSource qthelp://com.mycompany.1_0_0/doc/index.html");
-ba.append('\0');
+ba.append("setSource qthelp://com.mycompany.1_0_0/doc/index.html\n");
process->write(ba);
//! [4]
generated by cgit v0.12 at 2024-11-15 16:48:57 (GMT)