summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorck <qt-info@nokia.com>2009-11-11 13:35:17 (GMT)
committerck <qt-info@nokia.com>2009-11-11 14:20:18 (GMT)
commit96592943598151ea3f64364eab3475904931ca16 (patch)
tree41488c1b2c49915c355212c2d5dd138e5dbe025a /doc
parent7af4abab649d1ea4f9c8289a58b9d479237bd815 (diff)
downloadQt-96592943598151ea3f64364eab3475904931ca16.zip
Qt-96592943598151ea3f64364eab3475904931ca16.tar.gz
Qt-96592943598151ea3f64364eab3475904931ca16.tar.bz2
Assistant: Update documentation for remote commands.
- Assistant understands a newline character as well as '\0' to mark the end of a remote command. Since the former is considerably less complicated to do and to explain, the documentation now uses that approach. - The related examples have been updated accordingly. - The qdoc file now uses the encoding it promises in the header. Reviewed-by: kh1 Reviewed-by: David Boddie
Diffstat (limited to 'doc')
-rw-r--r--doc/src/development/assistant-manual.qdoc6
-rw-r--r--doc/src/snippets/code/doc_src_assistant-manual.qdoc8
2 files changed, 6 insertions, 8 deletions
diff --git a/doc/src/development/assistant-manual.qdoc b/doc/src/development/assistant-manual.qdoc
index 8de500e..3ecadc7 100644
--- a/doc/src/development/assistant-manual.qdoc
+++ b/doc/src/development/assistant-manual.qdoc
@@ -672,9 +672,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
@@ -685,6 +682,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
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]