From d796c9dd933ab96ec83b9a634feedd5d32e1ba3f Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Tue, 8 Nov 2011 12:31:36 -0600 Subject: Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731 --- examples/helpdemo/doc/handbook.png | Bin 0 -> 1060 bytes examples/helpdemo/doc/helpdemo.adp | 27 +++++++++++++++ examples/helpdemo/doc/index.html | 41 +++++++++++++++++++++++ examples/helpdemo/doc/logo.png | Bin 0 -> 811 bytes examples/helpdemo/doc/manual.html | 65 +++++++++++++++++++++++++++++++++++++ 5 files changed, 133 insertions(+) create mode 100644 examples/helpdemo/doc/handbook.png create mode 100644 examples/helpdemo/doc/helpdemo.adp create mode 100644 examples/helpdemo/doc/index.html create mode 100644 examples/helpdemo/doc/logo.png create mode 100644 examples/helpdemo/doc/manual.html (limited to 'examples/helpdemo/doc') diff --git a/examples/helpdemo/doc/handbook.png b/examples/helpdemo/doc/handbook.png new file mode 100644 index 000000000..3bd2b928b Binary files /dev/null and b/examples/helpdemo/doc/handbook.png differ diff --git a/examples/helpdemo/doc/helpdemo.adp b/examples/helpdemo/doc/helpdemo.adp new file mode 100644 index 000000000..fbc0fc55d --- /dev/null +++ b/examples/helpdemo/doc/helpdemo.adp @@ -0,0 +1,27 @@ + + + + + + HelpExample + Help Example + logo.png + index.html + About Help + ../about.txt + ../../../doc/html + + + +
+ Example Profile + Filename + Hide Sidebar + Open Assistant + Close Assistant + Display + Close +
+ + + diff --git a/examples/helpdemo/doc/index.html b/examples/helpdemo/doc/index.html new file mode 100644 index 000000000..9f1fb212c --- /dev/null +++ b/examples/helpdemo/doc/index.html @@ -0,0 +1,41 @@ + + + + Help example + + +

Help example

+ +

+ This example demonstrates how to use TQt Assistant as help system + for your own application. You can control TQt Assistant either directly + using e.g. the open button or indirectly by pressing F1. +

+ +

+ This example provides a context sensitive help, i.e. pressing F1 will + show the help for the item under the mouse cursor. +

+ +

+ In order to run TQt 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 TQt 3.1. Once such a profile has been + specified TQt Assistant can be run with the option -profile + and then the filename of the profile. The HelpDemo example does + this for you if you press the Run TQt Assistant customized for + HelpDemo. +

+ +

+ TQt Assistant can also display arbitrary pages with the + Display button or using the context help (F1), but TQt + Assistant won't be customized for this example application. +

+ + + + diff --git a/examples/helpdemo/doc/logo.png b/examples/helpdemo/doc/logo.png new file mode 100644 index 000000000..16f7d1f3a Binary files /dev/null and b/examples/helpdemo/doc/logo.png differ 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 @@ + + + + How to use this Example + + +

How to use this Example

+

There are three ways to get help in this example: +

+ +





+

Open Assistant Button

+

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.

+ +





+

Close Assistant Button

+

Click this button to close TQt Assistant. If it is not running nothing + will happen.

+ +





+

Run TQt Assistant customized for HelpDemo

+

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 HelpDemo::setAssistantArguments() + function to see how TQt Assistant can be started in customized mode. +

+ +





+

Hide Sidebar on Startup

+

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.

+ +





+

Filename

+

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.

+ +





+

Display Button

+

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.

+ +





+

Close Button

+

Click this button to tquit this example application.

+ + -- cgit v1.2.1