summaryrefslogtreecommitdiffstats
path: root/examples/helpdemo/doc/manual.html
diff options
context:
space:
mode:
Diffstat (limited to 'examples/helpdemo/doc/manual.html')
-rw-r--r--examples/helpdemo/doc/manual.html65
1 files changed, 65 insertions, 0 deletions
diff --git a/examples/helpdemo/doc/manual.html b/examples/helpdemo/doc/manual.html
new file mode 100644
index 000000000..8410a99d5
--- /dev/null
+++ b/examples/helpdemo/doc/manual.html
@@ -0,0 +1,65 @@
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <title>How to use this Example</title>
+ </head>
+ <body style="font-size:12pt;font-family:helvetica">
+ <p><h2>How to use this Example</h2></p>
+ <p>There are three ways to get help in this example:
+ <ul>
+ <li>
+ Press F1. Depending where your mouse position is you get either the
+ help for the item under the mouse cursor or the general help for this
+ example.
+ </li>
+ <li>
+ Press the right mouse button to invoke a context menu, then click
+ 'Help'. The displayed help page is choose as described above.
+ </li>
+ <li>
+ Use the buttons to control TQt Assistant directly. For a further
+ explanation see below.
+ </li>
+ </ul>
+
+ <br><br><br><br><br><br>
+ <p><a name="openqabutton"><h3>Open Assistant Button</h3></a></p>
+ <p>Click this button to open TQt Assistant. If it is already open nothing
+ will happen. The displayed page is the one that was last displayed.</p>
+
+ <br><br><br><br><br><br>
+ <p><a name="closeqabutton"><h3>Close Assistant Button</h3></a></p>
+ <p>Click this button to close TQt Assistant. If it is not running nothing
+ will happen.</p>
+
+ <br><br><br><br><br><br>
+ <p><a name="onlydoc"><h3>Run TQt Assistant customized for HelpDemo</h3></a></p>
+ <p>Check this item in order to run TQt Assistant as a customized help tool for
+ the HelpDemo example. Checking or unchecking has no effect if TQt
+ Assistant is already running. To apply changes you have to restart
+ TQt Assistant. Please see the <code>HelpDemo::setAssistantArguments()</code>
+ function to see how TQt Assistant can be started in customized mode.
+ </p>
+
+ <br><br><br><br><br><br>
+ <p><a name="hide"><h3>Hide Sidebar on Startup</h3></a></p>
+ <p>Check this item to run TQt Assistant with the sidebar hidden.
+ Checking or unchecking has no effect if TQt Assistant is already running.
+ To apply changes you have to restart TQt Assistant.</p>
+
+ <br><br><br><br><br><br>
+ <p><a name="lineedit"><h3>Filename</h3></a></p>
+ <p>Enter the file name of a help page you want to get displayed here. The path
+ can be specified as an absolute or relative path.</p>
+
+ <br><br><br><br><br><br>
+ <p><a name="displaybutton"><h3>Display Button</h3></a></p>
+ <p>Click this button in order to get the help page which is specified in the file name
+ line edit displayed. If TQt Assistant is currently not open, it will be
+ opened automatically.</p>
+
+ <br><br><br><br><br><br>
+ <p><a name="closebutton"><h3>Close Button</h3></a></p>
+ <p>Click this button to tquit this example application.</p>
+ </body>
+</html>