Sophie

Sophie

distrib > Fedora > 18 > x86_64 > by-pkgid > ff187cb994c94c614ecc64c5a8528b1b > files > 105

qt-doc-4.8.5-10.fc18.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- assistant-manual.qdoc -->
  <title>Qt 4.8: Qt Assistant in More Detail</title>
  <link rel="stylesheet" type="text/css" href="style/style.css" />
  <script src="scripts/jquery.js" type="text/javascript"></script>
  <script src="scripts/functions.js" type="text/javascript"></script>
  <link rel="stylesheet" type="text/css" href="style/superfish.css" />
  <link rel="stylesheet" type="text/css" href="style/narrow.css" />
  <!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->

<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>

</head>
<body class="" onload="CheckEmptyAndLoadList();">
 <div class="header" id="qtdocheader">
    <div class="content"> 
    <div id="nav-logo">
      <a href="index.html">Home</a></div>
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
    <div id="narrowsearch"></div>
    <div id="nav-topright">
      <ul>
        <li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
        <li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
        <li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
          DOC</a></li>
        <li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
      </ul>
    </div>
    <div id="shortCut">
      <ul>
        <li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
        <li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS        </a></li>
      </ul>
     </div>
 <ul class="sf-menu" id="narrowmenu"> 
             <li><a href="#">API Lookup</a> 
                 <ul> 
                     <li><a href="classes.html">Class index</a></li> 
           <li><a href="functions.html">Function index</a></li> 
           <li><a href="modules.html">Modules</a></li> 
           <li><a href="namespaces.html">Namespaces</a></li> 
           <li><a href="qtglobal.html">Global Declarations</a></li> 
           <li><a href="qdeclarativeelements.html">QML elements</a></li> 
             </ul> 
             </li> 
             <li><a href="#">Qt Topics</a> 
                 <ul> 
                        <li><a href="qt-basic-concepts.html">Programming with Qt</a></li>  
                        <li><a href="qtquick.html">Device UIs &amp; Qt Quick</a></li>  
                        <li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>  
                        <li><a href="supported-platforms.html">Supported Platforms</a></li>  
                        <li><a href="technology-apis.html">Qt and Key Technologies</a></li>  
                        <li><a href="best-practices.html">How-To's and Best Practices</a></li>  
              </ul> 
                 </li> 
                 <li><a href="#">Examples</a> 
                     <ul> 
                       <li><a href="all-examples.html">Examples</a></li> 
                       <li><a href="tutorials.html">Tutorials</a></li> 
                       <li><a href="demos.html">Demos</a></li> 
                       <li><a href="qdeclarativeexamples.html">QML Examples</a></li> 
                </ul> 
                     </li> 
                 </ul> 
    </div>
  </div>
  <div class="wrapper">
    <div class="hd">
      <span></span>
    </div>
    <div class="bd group">
      <div class="sidebar">
        <div class="searchlabel">
          Search index:</div>
        <div class="search" id="sidebarsearch">
          <form id="qtdocsearch" action="" onsubmit="return false;">
            <fieldset>
              <input type="text" name="searchstring" id="pageType" value="" />
 <div id="resultdialog"> 
 <a href="#" id="resultclose">Close</a> 
 <p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p> 
 <p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span>&nbsp;results:</p> 
 <ul id="resultlist" class="all"> 
 </ul> 
 </div> 
            </fieldset>
          </form>
        </div>
        <div class="box first bottombar" id="lookup">
          <h2 title="API Lookup"><span></span>
            API Lookup</h2>
          <div  id="list001" class="list">
          <ul id="ul001" >
              <li class="defaultLink"><a href="classes.html">Class index</a></li>
              <li class="defaultLink"><a href="functions.html">Function index</a></li>
              <li class="defaultLink"><a href="modules.html">Modules</a></li>
              <li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
              <li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
              <li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
            </ul> 
          </div>
        </div>
        <div class="box bottombar" id="topics">
          <h2 title="Qt Topics"><span></span>
            Qt Topics</h2>
          <div id="list002" class="list">
            <ul id="ul002" >
               <li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li> 
               <li class="defaultLink"><a href="qtquick.html">Device UIs &amp; Qt Quick</a></li> 
               <li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li> 
               <li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>  
               <li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li> 
               <li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li> 
            </ul>  
          </div>
        </div>
        <div class="box" id="examples">
          <h2 title="Examples"><span></span>
            Examples</h2>
          <div id="list003" class="list">
        <ul id="ul003">
              <li class="defaultLink"><a href="all-examples.html">Examples</a></li>
              <li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
              <li class="defaultLink"><a href="demos.html">Demos</a></li>
              <li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
            </ul> 
          </div>
        </div>
      </div>
      <div class="wrap">
        <div class="toolbar">
          <div class="breadcrumb toolblock">
            <ul>
              <li class="first"><a href="index.html">Home</a></li>
              <!--  Breadcrumbs go here -->
<li>Qt Assistant in More Detail</li>
            </ul>
          </div>
          <div class="toolbuttons toolblock">
            <ul>
              <li id="smallA" class="t_button">A</li>
              <li id="medA" class="t_button active">A</li>
              <li id="bigA" class="t_button">A</li>
              <li id="print" class="t_button"><a href="javascript:this.print();">
                <span>Print</span></a></li>
            </ul>
        </div>
        </div>
        <div class="content mainContent">
  <link rel="prev" href="assistant-manual.html" />
  <link rel="next" href="assistant-custom-help-viewer.html" />
<p class="naviNextPrevious headerNavi">
<a class="prevPage" href="assistant-manual.html">Qt Assistant Manual</a>
<a class="nextPage" href="assistant-custom-help-viewer.html">Using Qt Assistant as a Custom Help Viewer</a>
</p><p/>
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#command-line-options">Command Line Options</a></li>
<li class="level1"><a href="#tool-windows">Tool Windows</a></li>
<li class="level1"><a href="#documentation-window">Documentation Window</a></li>
<li class="level1"><a href="#toolbars">Toolbars</a></li>
<li class="level1"><a href="#menus">Menus</a></li>
<li class="level2"><a href="#file-menu">File Menu</a></li>
<li class="level2"><a href="#edit-menu">Edit Menu</a></li>
<li class="level2"><a href="#view-menu">View Menu</a></li>
<li class="level2"><a href="#go-menu">Go Menu</a></li>
<li class="level2"><a href="#bookmarks-menu">Bookmarks Menu</a></li>
<li class="level1"><a href="#dialogs">Dialogs</a></li>
<li class="level2"><a href="#print-dialog">Print Dialog</a></li>
<li class="level2"><a href="#preferences-dialog">Preferences Dialog</a></li>
<li class="level1"><a href="#find-text-control">Find Text Control</a></li>
<li class="level1"><a href="#filtering-help-contents">Filtering Help Contents</a></li>
<li class="level1"><a href="#full-text-searching">Full Text Searching</a></li>
</ul>
</div>
<h1 class="title">Qt Assistant in More Detail</h1>
<span class="subtitle"></span>
<!-- $$$assistant-details.html-description -->
<div class="descr"> <a name="details"></a>
<p class="centerAlign"><img src="images/assistant-assistant.png" alt="" /></p><a name="command-line-options"></a>
<h2>Command Line Options</h2>
<p><i>Qt Assistant</i> handles the following command line options:</p>
<table class="generic">
<thead><tr class="qt-style"><th >Command Line Option</th><th >Brief Description</th></tr></thead>
<tr valign="top" class="odd"><td >-collectionFile &lt;file.qhc&gt;</td><td >Uses the specified collection file instead of the default one.</td></tr>
<tr valign="top" class="even"><td >-showUrl &lt;URL&gt;</td><td >Shows the document referenced by URL.</td></tr>
<tr valign="top" class="odd"><td >-enableRemoteControl</td><td >Enables <i>Qt Assistant</i> to be remotly controlled.</td></tr>
<tr valign="top" class="even"><td >-show &lt;widget&gt;</td><td >Shows the specified dockwidget which can be &quot;contents&quot;, &quot;index&quot;, &quot;bookmarks&quot; or &quot;search&quot;.</td></tr>
<tr valign="top" class="odd"><td >-hide &lt;widget&gt;</td><td >Hides the specified dockwidget which can be &quot;contents&quot;, &quot;index&quot;, &quot;bookmarks&quot; or &quot;search.</td></tr>
<tr valign="top" class="even"><td >-activate &lt;widget&gt;</td><td >Activates the specified dockwidget which can be &quot;contents&quot;, &quot;index&quot;, &quot;bookmarks&quot; or &quot;search.</td></tr>
<tr valign="top" class="odd"><td >-register &lt;doc.qch&gt;</td><td >Registers the specified compressed help file in the given help collection.</td></tr>
<tr valign="top" class="even"><td >-unregister &lt;doc.qch&gt;</td><td >Unregisters the specified compressed help file from the given collection file.</td></tr>
<tr valign="top" class="odd"><td >-remove-search-index</td><td >Purges the help search engine's index. This option is useful in case the associated index files get corrupted. <i>Qt Assistant</i> will re-index the documentation at the next start-up.</td></tr>
<tr valign="top" class="even"><td >-rebuild-search-index</td><td >Rebuilds the help search engine's index. Note that this operation may take a while to finish.</td></tr>
<tr valign="top" class="odd"><td >-setCurrentFilter &lt;filter&gt;</td><td >Sets the given filter as the active filter.</td></tr>
<tr valign="top" class="even"><td >-quiet</td><td >Doesn't show any error, warning or success messages.</td></tr>
</table>
<a name="tool-windows"></a>
<h2>Tool Windows</h2>
<p class="centerAlign"><img src="images/assistant-dockwidgets.png" alt="" /></p><p>The tool windows provide four ways to navigate the documentation:</p>
<ul>
<li>The <b>Contents</b> window presents a table of contents implemented as a tree view for the documentation that is available. If you click an item, its documentation will appear in the <i>Documentation</i> window. If you double click an item or click on the control to the left of it, the item's sub-items will appear. Click a sub-item to make its page appear in the <i>Documentation</i> window. Click on the control next to an open item to hide its sub-items.</li>
<li>The <b>Index</b> window is used to look up key words or phrases. See <a href="assistant-manual.html#the-one-minute-guide-to-using-qt-assistant">The One-Minute Guide to Using Qt Assistant</a> for how to use this window.</li>
<li>The <b>Bookmarks</b> window lists any bookmarks you have made. Double click a bookmark to make its page appear in the <i>Documentation</i> window. The <b>Bookmarks</b> window provides a context menu with <b>Show Item</b>, <b>Delete Item</b> as well as <b>Rename Item</b>. Click in the main menu <b>Bookmark|Add Bookmark..&#x2e;</b> (or press <b>Ctrl+B</b>) to bookmark the page that is currently showing in the <i>Documentation</i> window. Right click a bookmark in the list to rename or delete the highlighted bookmark.</li>
</ul>
<p>If you want the <b>Documentation</b> window to use as much space as possible, you can easily group, move or hide the tool windows. To group the windows, drag one on top of the other and release the mouse. If one or all tool windows are not shown, press <b>Alt+C</b>, <b>Alt+I</b> or <b>Alt+O</b> to show the required window.</p>
<p>The tool windows can be docked into the main window, so you can drag them to the top, left, right or bottom of <i>Qt Assistant's</i> window, or you can drag them outside <i>Qt Assistant</i> to float them as independent windows.</p>
<a name="documentation-window"></a>
<h2>Documentation Window</h2>
<p class="centerAlign"><img src="images/assistant-docwindow.png" alt="" /></p><p>The <b>Documentation</b> window lets you create a tab 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 <b>Documentation</b> window.</p>
<a name="toolbars"></a>
<h2>Toolbars</h2>
<p class="centerAlign"><img src="images/assistant-toolbar.png" alt="" /></p><p>The main toolbar provides fast access to the most common actions.</p>
<table class="generic">
<thead><tr class="qt-style"><th >Action</th><th >Description</th><th >Menu Item</th><th >Shortcut</th></tr></thead>
<tr valign="top" class="odd"><td ><b>Previous</b></td><td >Takes you to the previous page in the history.</td><td ><b>Go|Previous</b></td><td ><b>Alt+Left Arrow</b></td></tr>
<tr valign="top" class="even"><td ><b>Next</b></td><td >Takes you to the next page in the history.</td><td ><b>Go|Next</b></td><td ><b>Alt+Right Arrow</b></td></tr>
<tr valign="top" class="odd"><td ><b>Home</b></td><td >Takes you to the home page as specified in the Preferences Dialog.</td><td ><b>Go|Home</b></td><td ><b>Ctrl+Home</b>.</td></tr>
<tr valign="top" class="even"><td ><b>Sync with Table of Contents</b></td><td >Synchronizes the <b>Contents</b> tool window with the page currently shown in the <b>Documentation</b> window.</td><td ><b>Go|Sync with Table of Contents</b></td><td ></td></tr>
<tr valign="top" class="odd"><td ><b>Copy</b></td><td >Copies any selected text to the clipboard.</td><td ><b>Edit|Copy</b></td><td ><b>Ctrl+C</b></td></tr>
<tr valign="top" class="even"><td ><b>Print</b></td><td >Opens the <b>Print</b> dialog.</td><td ><b>File|Print</b></td><td ><b>Ctrl+P</b></td></tr>
<tr valign="top" class="odd"><td ><b>Find in Text</b></td><td >Opens the <b>Find Text</b> dialog.</td><td ><b>Edit|Find in Text</b></td><td ><b>Ctrl+F</b></td></tr>
<tr valign="top" class="even"><td ><b>Zoom in</b></td><td >Increases the font size used to display text in the current tab.</td><td ><b>View|Zoom in</b></td><td ><b>Ctrl++</b></td></tr>
<tr valign="top" class="odd"><td ><b>Zoom out</b></td><td >Decreases the font size used to display text in the current tab.</td><td ><b>View|Zoom out</b></td><td ><b>Ctrl+-</b></td></tr>
<tr valign="top" class="even"><td ><b>Normal Size</b></td><td >Resets the font size to its normal size in the current tab.</td><td ><b>View|Normal Size</b></td><td ><b>Ctrl+0</b></td></tr>
</table>
<p class="centerAlign"><img src="images/assistant-address-toolbar.png" alt="" /></p><p>The address toolbar provides a fast way to enter a specific URL for a documentation file. By default, the address toolbar is not shown, so it has to be activated via <b>View|Toolbars|Address Toolbar</b>.</p>
<p class="centerAlign"><img src="images/assistant-filter-toolbar.png" alt="" /></p><p>The filter toolbar allows you to apply a filter to the currently installed documentation. As with the address toolbar, the filter toolbar is not visible by default and has to be activated via <b>View|Toolbars|Filter Toolbar</b>.</p>
<a name="menus"></a>
<h2>Menus</h2>
<a name="file-menu"></a>
<h3>File Menu</h3>
<ul>
<li><b>File|Page Setup..&#x2e;</b> invokes a dialog allowing you to define page layout properties, such as margin sizes, page orientation and paper size.</li>
<li><b>File|Print Preview..&#x2e;</b> provides a preview of the printed pages.</li>
<li><b>File|Print..&#x2e;</b> opens the <a href="#print-dialog"><b>Print</b> dialog</a>.</li>
<li><b>File|New Tab</b> opens a new empty tab in the <b>Documentation</b> window.</li>
<li><b>File|Close Tab</b> closes the current tab of the <b>Documentation</b> window.</li>
<li><b>File|Exit</b> closes the <i>Qt Assistant</i> application.</li>
</ul>
<a name="edit-menu"></a>
<h3>Edit Menu</h3>
<ul>
<li><b>Edit|Copy</b> copies any selected text to the clipboard.</li>
<li><b>Edit|Find in Text</b> invokes the <a href="#find-text-control"><b>Find Text</b> control</a> at the lower end of the <b>Documentation</b> window.</li>
<li><b>Edit|Find Next</b> looks for the next occurance of the specified text in the <b>Find Text</b> control.</li>
<li><b>Edit|Find Previous</b> looks for the previous occurance of the specified text in the <a href="#find-text-control"><b>Find Text</b> control</a>.</li>
<li><b>Edit|Preferences</b> invokes the <a href="#preferences-dialog"><b>Preferences</b> dialog</a>.</li>
</ul>
<a name="view-menu"></a>
<h3>View Menu</h3>
<ul>
<li><b>View|Zoom in</b> increases the font size in the current tab.</li>
<li><b>View|Zoom out</b> decreases the font size in the current tab.</li>
<li><b>View|Normal Size</b> resets the font size in the current tab.</li>
<li><b>View|Contents</b> toggles the display of the <b>Contents</b> tool window.</li>
<li><b>View|Index</b> toggles the display of the <b>Index</b> tool window.</li>
<li><b>View|Bookmarks</b> toggles the display of the <b>Bookmarks</b> tool window.</li>
<li><b>View|Search</b> toggles the display of the Search in the <b>Documentation</b> window.</li>
</ul>
<a name="go-menu"></a>
<h3>Go Menu</h3>
<ul>
<li><b>Go|Home</b> goes to the home page.</li>
<li><b>Go|Back</b> displays the previous page in the history.</li>
<li><b>Go|Forward</b> displays the next page in the history.</li>
<li><b>Go|Sync with Table of Contents</b> syncs the <b>Contents</b> tool window to the currently shown page.</li>
<li><b>Go|Next Page</b> selects the next tab in the <b>Documentation</b> window.</li>
<li><b>Go|Previous Page</b> selects the previous tab in the <b>Documentation</b> window.</li>
</ul>
<a name="bookmarks-menu"></a>
<h3>Bookmarks Menu</h3>
<ul>
<li><b>Bookmarks|Add</b> adds the current page to the list of bookmarks.</li>
</ul>
<a name="dialogs"></a>
<h2>Dialogs</h2>
<a name="print-dialog"></a>
<h3>Print Dialog</h3>
<p>This dialog is platform-specific. It gives access to various printer options and can be used to print the document shown in the current tab.</p>
<a name="preferences-dialog"></a>
<h3>Preferences Dialog</h3>
<p class="centerAlign"><img src="images/assistant-preferences-fonts.png" alt="" /></p><p>The <b>Fonts</b> page allows you to change the font family and font sizes of the browser window displaying the documentation or the application itself.</p>
<p class="centerAlign"><img src="images/assistant-preferences-filters.png" alt="" /></p><p>The <b>Filters</b> page lets you create and remove documentation filters. To add a new filter, click the <b>Add</b> button, specify a filter name in the pop-up dialog and click <b>OK</b>, then select the filter attributes in the list box on the right hand side. You can delete a filter by selecting it and clicking the <b>Remove</b> button.</p>
<p class="centerAlign"><img src="images/assistant-preferences-documentation.png" alt="" /></p><p>The <b>Documentation</b> page lets you install and remove compressed help files. Click the <b>Install</b> button and choose the path of the compressed help file (*.qch) you would like to install. To delete a help file, select a documentation set in the list and click <b>Remove</b>.</p>
<p class="centerAlign"><img src="images/assistant-preferences-options.png" alt="" /></p><p>The <b>Options</b> page lets you specify the homepage <i>Qt Assistant</i> will display when you click the <b>Home</b> button in <i>Qt Assistant</i>'s main user interface. You can specify the homepage by typing it here or clicking on one of the buttons below the textbox. <b>Current Page</b> sets the currently displayed page as your home page while <b>Restore to default</b> will reset your home page to the default home page.</p>
<a name="find-text-control"></a>
<h2>Find Text Control</h2>
<p>This control is used to find text in the current page. Enter the text you want to find in the line edit. The search is incremental, meaning that the most relevant result is shown as you enter characters into the line edit.</p>
<p>If you check the <b>Whole words only</b> checkbox, the search will only consider whole words; for example, if you search for &quot;spin&quot; with this checkbox checked it will not match &quot;spinbox&quot;, but will match &quot;spin&quot;. If you check the <b>Case sensitive</b> checkbox then, for example, &quot;spin&quot; will match &quot;spin&quot; but not &quot;Spin&quot;. You can search forwards or backwards from your current position in the page by clicking the <b>Previous</b> or <b>Next</b> buttons. To hide the find control, either click the <b>Close</b> button or hit the <b>Esc</b> key.</p>
<a name="filtering-help-contents"></a>
<h2>Filtering Help Contents</h2>
<p><i>Qt Assistant</i> allows you to install any kind of documentation as long as it is organized in Qt compressed help files (*.qch). For example, it is possible to install the Qt reference documentation for Qt 4.4&#x2e;0 and Qt 4.4&#x2e;1 at the same time. In many respects, this is very convenient since only one version of <i>Qt Assistant</i> is needed. However, at the same time it becomes more complicated when performing tasks like searching the index because nearly every keyword is defined in Qt 4.4&#x2e;0 as well as in Qt 4.4&#x2e;1&#x2e; This means that <i>Qt Assistant</i> will always ask the user to choose which one should be displayed.</p>
<p>We use documentation filters to solve this issue. A filter is identified by its name, and contains a list of filter attributes. An attribute is just a string and can be freely chosen. Attributes are defined by the documentation itself, this means that every documentation set usually has one or more attributes.</p>
<p>For example, the Qt 4.4&#x2e;0 <i>Qt Assistant</i> documentation defines the attributes <tt>assistant</tt>, <tt>tools</tt> and <tt>4.4&#x2e;0</tt>, <i>Qt Designer</i> defines <tt>designer</tt>, <tt>tools</tt> and <tt>4.4&#x2e;0</tt>. The filter to display all tools would then define only the attribute <tt>tools</tt> since this attribute is part of both documentation sets. Adding the attribute <tt>assistant</tt> to the filter would then only show <i>Qt Assistant</i> documentation since the <i>Qt Designer</i> documentation does not contain this attribute. Having an empty list of attributes in a filter will match all documentation; i.e&#x2e;, it is equivalent to requesting unfiltered documentation.</p>
<a name="full-text-searching"></a>
<h2>Full Text Searching</h2>
<p class="centerAlign"><img src="images/assistant-search.png" alt="" /></p><p><i>Qt Assistant</i> provides a powerful full text search engine. To search for certain words or text, click the <b>Search</b> tab in the <b>Documentation</b> window. Then enter the text you want to look for and press <b>Enter</b> or click the <b>Search</b> button. The search is not case sensitive, so, for example, Foo, fOo and FOO are all treated as the same. The following are examples of common search patterns:</p>
<ul>
<li><tt>deep</tt> -- lists all the documents that contain the word 'deep'</li>
<li><tt>deep*</tt> -- lists all the documents that contain a word beginning with 'deep'</li>
<li><tt>deep copy</tt> -- lists all documents that contain both 'deep' <i>and</i> 'copy'</li>
<li><tt>&quot;deep copy&quot;</tt> -- list all documents that contain the phrase 'deep copy'</li>
</ul>
<p>It is also possible to use the <b>Advanced search</b> to get more flexibility. You can specify some words so that hits containing these are excluded from the result, or you can search for an exact phrase. Searching for similar words will give results like these:</p>
<ul>
<li><tt>QStin</tt> -- lists all the documents with titles that are similar, such as <tt>QString</tt></li>
<li><tt>QSting</tt> -- lists all the documents with titles that are similar, such as <tt>QString</tt></li>
<li><tt>QStrin</tt> -- lists all the documents with titles that are similar, such as <tt>QString</tt></li>
</ul>
<p>Options can be combined to improve the search results.</p>
<p>The list of documents found is ordered according to the number of occurrences of the search text which they contain, with those containing the highest number of occurrences appearing first. Simply click any document in the list to display it in the <b>Documentation</b> window.</p>
<p>If the documentation has changed &mdash; for example, if documents have been added or removed &mdash; <i>Qt Assistant</i> will index them again.</p>
</div>
<!-- @@@assistant-details.html -->
<p class="naviNextPrevious footerNavi">
<a class="prevPage" href="assistant-manual.html">Qt Assistant Manual</a>
<a class="nextPage" href="assistant-custom-help-viewer.html">Using Qt Assistant as a Custom Help Viewer</a>
</p>
      </div>
    </div>
    </div> 
    <div class="ft">
      <span></span>
    </div>
  </div> 
  <div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2013 Digia Plc and/or its
      subsidiaries. Documentation contributions included herein are the copyrights of
      their respective owners.</p>
    <br />
    <p>
      The documentation provided herein is licensed under the terms of the
      <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
      License version 1.3</a> as published by the Free Software Foundation.</p>
    <p>
      Documentation sources may be obtained from <a href="http://www.qt-project.org">
      www.qt-project.org</a>.</p>
    <br />
    <p>
      Digia, Qt and their respective logos are trademarks of Digia Plc 
      in Finland and/or other countries worldwide. All other trademarks are property
      of their respective owners. <a title="Privacy Policy"
      href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
  </div>

  <script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>