doc/html/assistant-4.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/tools/assistant/book/assistant.leaf:130 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Qt Assistant in More Detail</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><p align="right">[<a href="assistant-3.html">Prev: The 1 Minute Guide to Using Qt Assistant</a>] [<a href="assistant.html">Home</a>] [<a href="assistant-5.html">Next: Full Text Searching</a>]</p>
<h2 align="center">Qt Assistant in More Detail</h2>
<p align="center"><img align="middle" src="assistant.png" width="788" height="443">
</p>
<blockquote><p align="center"><em>Qt Assistant</em></p></blockquote>
<h3><a name="1"></a>The Sidebar</h3>
<p align="center"><img align="middle" src="sidebar.png" width="277" height="212">
</p>
<p>The sidebar provides four ways of navigating documentation:</p>
<ol type=1><li><p>The <b>Contents</b> tab presents a tree view of the documentation sets that are available. If you click an item, its documentation will appear in the documentation window. If you double click an item or click a '+' sign to the left of an item, the item's sub-items will appear. Click a sub-item to make its page appear in the documentation window. Click a '-' sign to the left of an item to hide its sub-items.</p>
<li><p>The <b>Index</b> tab is used to look up key words or phrases. See <a href="assistant-3.html">The 1 Minute Guide to Using Qt Assistant</a> for how to use this tab.</p>
<li><p>The <b>Bookmarks</b> tab lists any bookmarks you've made. Double click a bookmark to make its page appear in the documentation window. The <b>Bookmarks</b> tab has a <b>New Bookmark</b> button and a <b>Delete Bookmark</b> button at the bottom. Click <b>New Bookmark</b> to bookmark the page that is showing in the documentation window. Click a bookmark in the list, then click <b>Delete Bookmark</b> to delete the highlighted bookmark.</p>
<li><p>The <b>Search</b> tab provides full text search of <em>all</em> the documents. See <a href="assistant-5.html">Full Text Searching</a> for more information about this feature.</p>
</ol><p>If you want the documentation window to use as much space as possible, you can easily hide or show the Sidebar. If the Sidebar is showing, press <b>Ctrl+T</b>, <b>Ctrl+I</b>, <b>Ctrl+B</b> or <b>Ctrl+S</b> to hide it. If the Sidebar is hidden, press <b>Ctrl+T</b> to show it on the Contents tab, or press <b>Ctrl+I</b> to show it on the Index tab (with the focus in the 'Look For' line edit box), or press <b>Ctrl+B</b> to show it on the Bookmarks tab, or press <b>Ctrl+S</b> to show it on the (full text) Search tab.</p>
<p>The Sidebar is a dock window, so you can drag it to the top, left, right or bottom of <em>Qt Assistant</em>'s window, or you can drag it outside <em>Qt Assistant</em> to float it.</p>
<h3><a name="2"></a>The Documentation Window</h3>
<p align="center"><img align="middle" src="docwindow.png" width="388" height="158">
</p>
<p>The documentation window offers a feature for viewing documentation by enabling you to create tabs for each documentation page that you view. Click the <b>Add Tab</b> button and a new tab will appear with the page name as the tab's caption. This makes it convenient to switch between pages when you are working with different documentation. You can delete a tab by clicking the <b>Close Tab</b> button located on the right side of the documentation window.</p>
<h3><a name="3"></a>The Toolbar</h3>
<p align="center"><img align="middle" src="toolbar1.png" width="290" height="31">
</p>
<p>The toolbar provides fast access to the most common actions.</p>
<ul><li><p><b>Previous</b> takes you to the previous page. The menu option is <b>Go|Previous</b> and the keyboard shortcut is <b>Alt+Left Arrow</b>.</p>
<li><p><b>Next</b> takes you to the next page. The menu option is <b>Go|Next</b> and the keyboard shortcut is <b>Alt+Right Arrow</b>.</p>
<li><p><b>Home</b> takes you to the home page (normally the home page of the Qt Reference Documentation). The menu option is <b>Go|Home</b> and the keyboard shortcut is <b>Ctrl+Home</b>.</p>
<li><p><b>Copy</b> copies any selected text to the clipboard. The menu option is <b>Edit|Copy</b> and the keyboard shortcut is <b>Ctrl+C</b>.</p>
<li><p><b>Find in Text</b> invokes the <em>Find Text</em> dialog. The menu option is <b>Edit|Find in Text</b> and the keyboard shortcut is <b>Ctrl+F</b>.</p>
<li><p><b>Print</b> invokes the <em>Print</em> dialog. The menu option is <b>File|Print</b> and the keyboard shortcut is <b>Ctrl+P</b>.</p>
<li><p><b>Zoom in</b> increases the font size. The menu option is <b>View|Zoom in</b> and the keyboard shortcut is <b>Ctrl++</b>.</p>
<li><p><b>Zoom out</b> decreases the font size. The menu option is <b>View|Zoom out</b> and the keyboard shortcut is <b>Ctrl+-</b>.</p>
<li><p><b>What's This?</b> provides a description of a <em>Qt Assistant</em> feature. The menu option is <b>Help|What's This?</b> and the keyboard shortcut is <b>Shift+F1</b>.</p>
</ul><p>The remaining toolbar buttons are bookmarks and will vary depending on your configuration.</p>
<h3><a name="4"></a>The Menus</h3>
<h4><a name="4-1"></a>The File Menu</h4>
<ul><li><p><b>File|Print</b> invokes the <em>Print</em> dialog.</p>
<li><p><b>File|Exit</b> terminates <em>Qt Assistant</em>.</p>
</ul><h4><a name="4-2"></a>The Edit Menu</h4>
<ul><li><p><b>Edit|Copy</b> copies any selected text to the clipboard.</p>
<li><p><b>Edit|Find in Text</b> invokes the <em>Find Text</em> dialog.</p>
<li><p><b>Edit|Settings</b> invokes the <em>Settings</em> dialog.</p>
</ul><h4><a name="4-3"></a>The View Menu</h4>
<ul><li><p><b>View|Zoom in</b> increases the font size.</p>
<li><p><b>View|Zoom out</b> decreases the font size.</p>
<li><p><b>View|Views|Sidebar</b> toggles the display of the Sidebar.</p>
<li><p><b>View|Views|Toolbar</b> toggles the display of the Toolbar.</p>
<li><p><b>View|Views|Line up</b> lines up the toolbar buttons in the Toolbar.</p>
</ul><h4><a name="4-4"></a>The Go Menu</h4>
<ul><li><p><b>Go|Previous</b> displays the previous page.</p>
<li><p><b>Go|Next</b> displays the next page.</p>
<li><p><b>Go|home</b> goes to the home page.</p>
</ul><p>This menu also has additional items; these are pre-defined bookmarks that vary depending on your configuration.</p>
<h4><a name="4-5"></a>The Bookmarks Menu</h4>
<ul><li><p><b>Bookmarks|Add</b> adds the current page to the list of bookmarks.</p>
</ul><p>This menu may have additional items, i.e. any bookmarks that you have already made. If you want to delete a bookmark go to the Bookmarks tab on the Sidebar.</p>
<h3><a name="5"></a>The Dialogs</h3>
<h4><a name="5-1"></a>The Print Dialog</h4>
<p>This dialog is platform-specific. It gives access to various printer options and can be used to print the current page.</p>
<h4><a name="5-2"></a>The Find Text Dialog</h4>
<p>This dialog is used to find text in the current page. Enter the text you want to find in the Find line edit. If you check the 'Whole words only' checkbox, the search will only consider whole words, i.e. if you search for 'spin' with this checkbox checked it will not match 'spinbox', but will match 'spin'. If you check the 'Case sensitive' check box then, for example, 'spin' will match 'spin' but not 'Spin'. You can search Forward or Backward from your current position in the page by clicking one of the Direction radio buttons. Click the <b>Find</b> button to search (or search again), and click the <b>Close</b> button to finish.</p>
<h4><a name="5-3"></a>The Settings Dialog</h4>
<p>The Settings dialog is used to set your preferences for <em>Qt Assistant</em>. The dialog has four tabs: General Settings, Web Settings, PDF Settings, and Profiles. <em>Qt Assistant</em> will remember your settings between sessions, including window sizes and positions, and which pages you have open. Each of the tabs is discussed as follows:</p>
<ul><li><p>General Settings</p>
<p align="center"><img align="middle" src="general.png" width="348" height="233">
</p>
<p>To change the base font used throughout <em>Qt Assistant</em>, select a font type from the Font combobox. To choose a new fixed-width font, for example, to show code snippets, choose a font type from the 'Fixed font' combobox. To change the color of hypertext links, click the 'Link color' color button. Uncheck the 'Underline links' checkbox if you don't want underlined links.</p>
<li><p>Web Settings</p>
<p align="center"><img align="middle" src="web.png" width="348" height="233">
</p>
<p>Some pages contain links to external web pages. In order to display these links, you must specify a web browser. Type the name of your browser's executable in the Web Browser Application line edit. Alternatively, click the <b>(ellipsis)</b> button to invoke the <em>Set Web Browser</em> dialog and navigate until you find the web browser you want to use. Click <b>Save</b> to accept the selection.</p>
<p>To change <em>Qt Assistant</em>'s default home page, enter the file name in the Home Page line edit. Alternatively, click the <b>(ellipsis)</b> button to invoke the <em>Set Homepage</em> dialog. Navigate until you find the home page file you want to use and then click <b>Save</b> to accept the selection.</p>
<li><p>PDF Settings</p>
<p align="center"><img align="middle" src="pdf1.png" width="296" height="233">
</p>
<p>Some pages contain links to PDF documents. In order to display these links, you must specify a PDF viewer. Type in the name of your PDF viewer's executable in the line edit. Alternatively, click the <b>(ellipsis)</b> button to invoke the <em>Set PDF Browser</em> dialog and navigate until you find the PDF viewer you want to use. Click <b>Save</b> to accept the selection.</p>
<!-- eof -->
<p align="right">[<a href="assistant-3.html">Prev: The 1 Minute Guide to Using Qt Assistant</a>] [<a href="assistant.html">Home</a>] [<a href="assistant-5.html">Next: Full Text Searching</a>]</p>
<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>