diff options
| author | Timothy Pearson <[email protected]> | 2011-07-10 15:24:15 -0500 |
|---|---|---|
| committer | Timothy Pearson <[email protected]> | 2011-07-10 15:24:15 -0500 |
| commit | bd0f3345a938b35ce6a12f6150373b0955b8dd12 (patch) | |
| tree | 7a520322212d48ebcb9fbe1087e7fca28b76185c /examples/helpdemo/doc | |
| download | qt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.tar.gz qt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.zip | |
Add Qt3 development HEAD version
Diffstat (limited to 'examples/helpdemo/doc')
| -rw-r--r-- | examples/helpdemo/doc/handbook.png | bin | 0 -> 1060 bytes | |||
| -rw-r--r-- | examples/helpdemo/doc/helpdemo.adp | 27 | ||||
| -rw-r--r-- | examples/helpdemo/doc/index.html | 41 | ||||
| -rw-r--r-- | examples/helpdemo/doc/logo.png | bin | 0 -> 811 bytes | |||
| -rw-r--r-- | examples/helpdemo/doc/manual.html | 65 |
5 files changed, 133 insertions, 0 deletions
diff --git a/examples/helpdemo/doc/handbook.png b/examples/helpdemo/doc/handbook.png Binary files differnew file mode 100644 index 0000000..3bd2b92 --- /dev/null +++ b/examples/helpdemo/doc/handbook.png diff --git a/examples/helpdemo/doc/helpdemo.adp b/examples/helpdemo/doc/helpdemo.adp new file mode 100644 index 0000000..fbc0fc5 --- /dev/null +++ b/examples/helpdemo/doc/helpdemo.adp @@ -0,0 +1,27 @@ +<!DOCTYPE DCF> + +<assistantconfig version="3.2.0"> + +<profile> + <property name="name">HelpExample</property> + <property name="title">Help Example</property> + <property name="applicationicon">logo.png</property> + <property name="startpage">index.html</property> + <property name="aboutmenutext">About Help</property> + <property name="abouturl">../about.txt</property> + <property name="assistantdocs">../../../doc/html</property> +</profile> + +<DCF ref="index.html" icon="handbook.png" title="Help example"> + <section ref="./manual.html" title="How to use this Example"> + <keyword ref="./manual.html#onlydoc">Example Profile</keyword> + <keyword ref="./manual.html#lineedit">Filename</keyword> + <keyword ref="./manual.html#hide">Hide Sidebar</keyword> + <keyword ref="./manual.html#openqabutton">Open Assistant</keyword> + <keyword ref="./manual.html#closeqabutton">Close Assistant</keyword> + <keyword ref="./manual.html#displaybutton">Display</keyword> + <keyword ref="./manual.html#closebutton">Close</keyword> + </section> +</DCF> + +</assistantconfig> diff --git a/examples/helpdemo/doc/index.html b/examples/helpdemo/doc/index.html new file mode 100644 index 0000000..7b68152 --- /dev/null +++ b/examples/helpdemo/doc/index.html @@ -0,0 +1,41 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Help example</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + <p><h2>Help example</h2></p> + + <p> + This example demonstrates how to use Qt Assistant as help system + for your own application. You can control Qt Assistant either directly + using e.g. the open button or indirectly by pressing F1. + </p> + + <p> + This example provides a context sensitive help, i.e. pressing F1 will + show the help for the item under the mouse cursor. + </p> + + <p> + In order to run Qt Assistant as a custom help tool for this + application properly you have to specify a profile. A profile + is a file format similar to the documentation content files + that assistant used up to Qt 3.1. Once such a profile has been + specified Qt Assistant can be run with the option <code>-profile</code> + and then the filename of the profile. The HelpDemo example does + this for you if you press the <i>Run Qt Assistant customized for + HelpDemo</i>. + </p> + + <p> + Qt Assistant can also display arbitrary pages with the + <i>Display</i> button or using the context help (F1), but Qt + Assistant won't be customized for this example application. + </p> + + <ul> + <li><a href="manual.html">How to use this example</a></li> + </ul> + </body> +</html> diff --git a/examples/helpdemo/doc/logo.png b/examples/helpdemo/doc/logo.png Binary files differnew file mode 100644 index 0000000..16f7d1f --- /dev/null +++ b/examples/helpdemo/doc/logo.png diff --git a/examples/helpdemo/doc/manual.html b/examples/helpdemo/doc/manual.html new file mode 100644 index 0000000..7df0e3a --- /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 Qt 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 Qt 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 Qt Assistant. If it is not running nothing + will happen.</p> + + <br><br><br><br><br><br> + <p><a name="onlydoc"><h3>Run Qt Assistant customized for HelpDemo</h3></a></p> + <p>Check this item in order to run Qt Assistant as a customized help tool for + the HelpDemo example. Checking or unchecking has no effect if Qt + Assistant is already running. To apply changes you have to restart + Qt Assistant. Please see the <code>HelpDemo::setAssistantArguments()</code> + function to see how Qt 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 Qt Assistant with the sidebar hidden. + Checking or unchecking has no effect if Qt Assistant is already running. + To apply changes you have to restart Qt 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 Qt 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 quit this example application.</p> + </body> +</html> |
