summaryrefslogtreecommitdiffstats
path: root/doc/src
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/deployment/deployment.qdoc11
-rw-r--r--doc/src/development/assistant-manual.qdoc40
-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/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
14 files changed, 110 insertions, 71 deletions
diff --git a/doc/src/deployment/deployment.qdoc b/doc/src/deployment/deployment.qdoc
index f2038b2..3e8cfc4 100644
--- a/doc/src/deployment/deployment.qdoc
+++ b/doc/src/deployment/deployment.qdoc
@@ -87,29 +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 \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 5a30e43..824169d 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/examples/completer.qdoc b/doc/src/examples/completer.qdoc
index d092027..8a743a7 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 89456bf..ccf8c83 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 524f27c..35654d2 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 2d4f5c9..cf51e73 100644
--- a/doc/src/getting-started/examples.qdoc
+++ b/doc/src/getting-started/examples.qdoc
@@ -1103,6 +1103,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/howtos/timers.qdoc b/doc/src/howtos/timers.qdoc
index 85902be..189f1c3 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 f376af2..5a1010e 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 ecc25fe..94717db 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 5e759db..dc0e0ab 100644
--- a/doc/src/modules.qdoc
+++ b/doc/src/modules.qdoc
@@ -1038,13 +1038,3 @@
ANY WAY OUT OF THE USE OF THIS 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 85b9ff8..a1d3e9a 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 20fd8a6..bc49b48 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 24870b4..700d755 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-10 04:08:42 (GMT)