diff options
| author | Qt by Nokia <qt-info@nokia.com> | 2011-04-27 12:05:43 +0200 |
|---|---|---|
| committer | axis <qt-info@nokia.com> | 2011-04-27 12:05:43 +0200 |
| commit | 50123887ba0f33cf47520bee7c419d68742af2d1 (patch) | |
| tree | 0eb8679b9e4e4370e59b44bfdcae616816e39aca /examples/help/simpletextviewer/documentation | |
Initial import from the monolithic Qt.
This is the beginning of revision history for this module. If you
want to look at revision history older than this, please refer to the
Qt Git wiki for how to use Git history grafting. At the time of
writing, this wiki is located here:
http://qt.gitorious.org/qt/pages/GitIntroductionWithQt
If you have already performed the grafting and you don't see any
history beyond this commit, try running "git log" with the "--follow"
argument.
Branched from the monolithic repo, Qt master branch, at commit
896db169ea224deb96c59ce8af800d019de63f12
Diffstat (limited to 'examples/help/simpletextviewer/documentation')
20 files changed, 364 insertions, 0 deletions
diff --git a/examples/help/simpletextviewer/documentation/about.txt b/examples/help/simpletextviewer/documentation/about.txt new file mode 100644 index 000000000..eeab35f4a --- /dev/null +++ b/examples/help/simpletextviewer/documentation/about.txt @@ -0,0 +1,9 @@ +The Simple Text Viewer enables the user to select and view existing +files. + +HTML files is displayed using rich text, while other files are +presented as plain text. The application provides a file dialog +allowing the user to search for files using wildcard matching. The +search is performed within in the specified directory, and the user is +given an option to browse the existing file system to find the +relevant directory. diff --git a/examples/help/simpletextviewer/documentation/browse.html b/examples/help/simpletextviewer/documentation/browse.html new file mode 100644 index 000000000..987abf31f --- /dev/null +++ b/examples/help/simpletextviewer/documentation/browse.html @@ -0,0 +1,34 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Browse</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>Browse</h2></center></p> + + <p> + The file dialog let you browse the current file system to + specify the directory in which the file you want to open + resides. + Note that only the specified directory will be searched, any + subdirectories will simply be ignored. + </p> + + <br /> + <br /> + <table align="center" cellpadding="2" cellspacing="1" border="0" width="100%"> + <tr valign="top" bgcolor="#f0f0f0"> + <td><center><img src="images/browse.png" /></center></td> + </tr> + </table> + + <br /> + <br /> + <p> + See also: <a href="filedialog.html">File Dialog</a>, <a href="wildcardmatching.html">Wildcard Matching</a>, + <a href="findfile.html">Find File</a> + </p> + </body> +</html> + diff --git a/examples/help/simpletextviewer/documentation/filedialog.html b/examples/help/simpletextviewer/documentation/filedialog.html new file mode 100644 index 000000000..afa65ed57 --- /dev/null +++ b/examples/help/simpletextviewer/documentation/filedialog.html @@ -0,0 +1,48 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>File Dialog</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>File Dialog</h2></center></p> + + <p> + In the file dialog you can name a particular file name, or + search for files using wildcard matching, i.e. specify a + file name containing wildcards. In addition you must specify + the directory in which the file you search for resides. + </p> + + <br /> + <br /> + <table align="center" cellpadding="2" cellspacing="1" border="0" width="100%"> + <tr valign="top" bgcolor="#f0f0f0"> + <td><center><img src="images/filedialog.png" /></center></td> + </tr> + </table> + + <br /> + <br /> + <p> + By default the dialog will search for all files (*) in the + current directory (the directory the application is run from). + </p> + + <p> + When editing the file name and directory parameters, an + overview of the matching files are displayed in the + dialog. The overview is updated whenever the parameters + change. + </p> + + <br /> + <br /> + <p> + See also: <a href="browse.html">Browse</a>, <a href="wildcardmatching.html">Wildcard Matching</a>, + <a href="findfile.html">Find File</a> + </p> + </body> +</html> + + diff --git a/examples/help/simpletextviewer/documentation/findfile.html b/examples/help/simpletextviewer/documentation/findfile.html new file mode 100644 index 000000000..32e014718 --- /dev/null +++ b/examples/help/simpletextviewer/documentation/findfile.html @@ -0,0 +1,32 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Find File</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>Find File</h2></center></p> + + <p> + To open and view a file in the Simple Text Viewer, select the + 'Open...' option in the 'File' menu. The application will then + provide you with a file dialog that you can use to search for + any existing file. + </p> + + <br /> + <br /> + <table align="center" cellpadding="2" cellspacing="1" border="0" width="100%"> + <tr valign="top" bgcolor="#f0f0f0"> + <td><center><img src="images/fadedfilemenu.png" /></center></td> + </tr> + </table> + + <br /> + <br /> + <p> + See also: <a href="openfile.html">Open File</a>, <a href="filedialog.html">File Dialog</a> + </p> + </body> +</html> + diff --git a/examples/help/simpletextviewer/documentation/images/browse.png b/examples/help/simpletextviewer/documentation/images/browse.png Binary files differnew file mode 100644 index 000000000..86db6b19e --- /dev/null +++ b/examples/help/simpletextviewer/documentation/images/browse.png diff --git a/examples/help/simpletextviewer/documentation/images/fadedfilemenu.png b/examples/help/simpletextviewer/documentation/images/fadedfilemenu.png Binary files differnew file mode 100644 index 000000000..fde0e43f6 --- /dev/null +++ b/examples/help/simpletextviewer/documentation/images/fadedfilemenu.png diff --git a/examples/help/simpletextviewer/documentation/images/filedialog.png b/examples/help/simpletextviewer/documentation/images/filedialog.png Binary files differnew file mode 100644 index 000000000..883a33a26 --- /dev/null +++ b/examples/help/simpletextviewer/documentation/images/filedialog.png diff --git a/examples/help/simpletextviewer/documentation/images/handbook.png b/examples/help/simpletextviewer/documentation/images/handbook.png Binary files differnew file mode 100644 index 000000000..3bd2b928b --- /dev/null +++ b/examples/help/simpletextviewer/documentation/images/handbook.png diff --git a/examples/help/simpletextviewer/documentation/images/icon.png b/examples/help/simpletextviewer/documentation/images/icon.png Binary files differnew file mode 100644 index 000000000..6daec0ade --- /dev/null +++ b/examples/help/simpletextviewer/documentation/images/icon.png diff --git a/examples/help/simpletextviewer/documentation/images/mainwindow.png b/examples/help/simpletextviewer/documentation/images/mainwindow.png Binary files differnew file mode 100644 index 000000000..c28d5e9ff --- /dev/null +++ b/examples/help/simpletextviewer/documentation/images/mainwindow.png diff --git a/examples/help/simpletextviewer/documentation/images/open.png b/examples/help/simpletextviewer/documentation/images/open.png Binary files differnew file mode 100644 index 000000000..1e5bba3c8 --- /dev/null +++ b/examples/help/simpletextviewer/documentation/images/open.png diff --git a/examples/help/simpletextviewer/documentation/images/wildcard.png b/examples/help/simpletextviewer/documentation/images/wildcard.png Binary files differnew file mode 100644 index 000000000..6e83a56cc --- /dev/null +++ b/examples/help/simpletextviewer/documentation/images/wildcard.png diff --git a/examples/help/simpletextviewer/documentation/index.html b/examples/help/simpletextviewer/documentation/index.html new file mode 100644 index 000000000..5a7b1d5fa --- /dev/null +++ b/examples/help/simpletextviewer/documentation/index.html @@ -0,0 +1,41 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Manual</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>Simple Text Viewer</h2></center></p> + + <p> + The Simple Text Viewer enables the user to select and view + existing files. + </p> + + <p><center> + <img src="images/mainwindow.png" /> + </center></p> + + <p> + HTML files is displayed using rich text, while + other files are presented as plain text. The application + provides a file dialog allowing the user to search for files + using wildcard matching. The search is performed within in the + specified directory, and the user is given an option to browse + the existing file system to find the relevant directory. + </p> + + <ul> + <li><a href="findfile.html">Find File</a></li> + <ul> + <li><a href="filedialog.html">File Dialog</a></li> + <li><a href="wildcardmatching.html">WildCard Matching</a></li> + <li><a href="browse.html">Browse</a></li> + </ul> + <li><a href="openfile.html">Open File</a></li> + </ul> + </body> +</html> + + + diff --git a/examples/help/simpletextviewer/documentation/intro.html b/examples/help/simpletextviewer/documentation/intro.html new file mode 100644 index 000000000..2e2aa40de --- /dev/null +++ b/examples/help/simpletextviewer/documentation/intro.html @@ -0,0 +1,28 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Manual</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>Simple Text Viewer</h2></center></p> + + <p> + The Simple Text Viewer enables the user to select and view + existing files. + </p> + + <p><center> + <img src="images/mainwindow.png" /> + </center></p> + + <p> + The application provides its own custom documentation that is + available through the <b>Help</b> menu in the main window's menubar + and through the <b>Help</b> button in the application's find file + dialog. + </p> + + </body> +</html> + diff --git a/examples/help/simpletextviewer/documentation/openfile.html b/examples/help/simpletextviewer/documentation/openfile.html new file mode 100644 index 000000000..e172de95e --- /dev/null +++ b/examples/help/simpletextviewer/documentation/openfile.html @@ -0,0 +1,36 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Open File</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>Open File</h2></center></p> + + <p> + Once the file you want to view appears in the dialog's + display, you can open it in two different ways. + </p> + + <p> + By pressing the 'Open' button the currently selected file will + be opened. By default, the first file in the list of matching + files is selected. Another way of opening a file is to simply + double click the displayed file name. + </p> + + <br /> + <br /> + <table align="center" cellpadding="2" cellspacing="1" border="0" width="100%"> + <tr valign="top" bgcolor="#f0f0f0"> + <td><center><img src="images/open.png" /></center></td> + </tr> + </table> + + <br /> + <br /> + <p> + See also: <a href="findfile.html">Find File</a> + </p> + </body> +</html> diff --git a/examples/help/simpletextviewer/documentation/simpletextviewer.qch b/examples/help/simpletextviewer/documentation/simpletextviewer.qch Binary files differnew file mode 100644 index 000000000..c40132803 --- /dev/null +++ b/examples/help/simpletextviewer/documentation/simpletextviewer.qch diff --git a/examples/help/simpletextviewer/documentation/simpletextviewer.qhc b/examples/help/simpletextviewer/documentation/simpletextviewer.qhc Binary files differnew file mode 100644 index 000000000..db380cabf --- /dev/null +++ b/examples/help/simpletextviewer/documentation/simpletextviewer.qhc diff --git a/examples/help/simpletextviewer/documentation/simpletextviewer.qhcp b/examples/help/simpletextviewer/documentation/simpletextviewer.qhcp new file mode 100644 index 000000000..e7c23210b --- /dev/null +++ b/examples/help/simpletextviewer/documentation/simpletextviewer.qhcp @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="UTF-8"?> +<QHelpCollectionProject version="1.0"> + <assistant> + <title>Simple Text Viewer</title> + <applicationIcon>images/handbook.png</applicationIcon> + <cacheDirectory>Trolltech/SimpleTextViewer</cacheDirectory> + <startPage>qthelp://com.trolltech.examples.simpletextviewer/doc/index.html</startPage> + <aboutMenuText> + <text>About Simple Text Viewer</text> + </aboutMenuText> + <aboutDialog> + <file>about.txt</file> + <icon>images/icon.png</icon> + </aboutDialog> + <enableDocumentationManager>false</enableDocumentationManager> + <enableAddressBar>false</enableAddressBar> + <enableFilterFunctionality>false</enableFilterFunctionality> + </assistant> + <docFiles> + <generate> + <file> + <input>simpletextviewer.qhp</input> + <output>simpletextviewer.qch</output> + </file> + </generate> + <register> + <file>simpletextviewer.qch</file> + </register> + </docFiles> + </QHelpCollectionProject> diff --git a/examples/help/simpletextviewer/documentation/simpletextviewer.qhp b/examples/help/simpletextviewer/documentation/simpletextviewer.qhp new file mode 100644 index 000000000..4cb83a5f3 --- /dev/null +++ b/examples/help/simpletextviewer/documentation/simpletextviewer.qhp @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8"?> +<QtHelpProject version="1.0"> + <namespace>com.trolltech.examples.simpletextviewer</namespace> + <virtualFolder>doc</virtualFolder> + <filterSection> + <toc> + <section title="Simple Text Viewer" ref="index.html"> + <section title="Find File" ref="./findfile.html"> + <section title="File Dialog" ref="./filedialog.html"></section> + <section title="Wildcard Matching" ref="./wildcardmatching.html"></section> + <section title="Browse" ref="./browse.html"></section> + </section> + <section title="Open File" ref="./openfile.html"></section> + </section> + </toc> + <keywords> + <keyword name="Display" ref="./index.html"/> + <keyword name="Rich text" ref="./index.html"/> + <keyword name="Plain text" ref="./index.html"/> + <keyword name="Find" ref="./findfile.html"/> + <keyword name="File menu" ref="./findfile.html"/> + <keyword name="File name" ref="./filedialog.html"/> + <keyword name="File dialog" ref="./filedialog.html"/> + <keyword name="File globbing" ref="./wildcardmatching.html"/> + <keyword name="Wildcard matching" ref="./wildcardmatching.html"/> + <keyword name="Wildcard syntax" ref="./wildcardmatching.html"/> + <keyword name="Browse" ref="./browse.html"/> + <keyword name="Directory" ref="./browse.html"/> + <keyword name="Open" ref="./openfile.html"/> + <keyword name="Select" ref="./openfile.html"/> + </keywords> + <files> + <file>browse.html</file> + <file>filedialog.html</file> + <file>findfile.html</file> + <file>index.html</file> + <file>intro.html</file> + <file>openfile.html</file> + <file>wildcardmatching.html</file> + <file>images/browse.png</file> + <file>images/fadedfilemenu.png</file> + <file>images/filedialog.png</file> + <file>images/handbook.png</file> + <file>images/mainwindow.png</file> + <file>images/open.png</file> + <file>images/wildcard.png</file> + </files> + </filterSection> + </QtHelpProject> diff --git a/examples/help/simpletextviewer/documentation/wildcardmatching.html b/examples/help/simpletextviewer/documentation/wildcardmatching.html new file mode 100644 index 000000000..eb1839a06 --- /dev/null +++ b/examples/help/simpletextviewer/documentation/wildcardmatching.html @@ -0,0 +1,57 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Wildcard Matching</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + + <p><center><h2>Wildcard Matching</h2></center></p> + + <p> + Most command shells such as bash or cmd.exe support "file + globbing", the ability to identify a group of files by using + wildcards. + + <br /> + <br /> + <table align="center" cellpadding="2" cellspacing="1" border="0" width="100%"> + <tr valign="top" bgcolor="#f0f0f0"> + <td><center><img src="images/wildcard.png" /></center></td> + </tr> + </table> + + <br /> + <br /> + <p> + Wildcard matching provides four features: + </p> + + <ul> + <li>Any character represents itself apart from those + mentioned below. Thus 'c' matches the character 'c'. + </li> + <li>The '?' character matches any single character.</li> + <li>The '*' matches zero or more of any characters.</li> + <li>Sets of characters can be represented in square brackets. + Within the character class, like outside, backslash + has no special meaning. + </li> + </ul> + + <p> + For example we could identify HTML files with + <code>*.html</code>. This will match zero or more characters + followed by a dot followed by 'h', 't', 'm' and 'l'. + </p> + + <br /> + <br /> + <p> + See also: <a href="browse.html">Browse</a>, <a href="filedialog.html">File Dialog</a>, + <a href="findfile.html">Find File</a> + </p> + </body> +</html> + + + |
