Search from documentation

In the Help mode Search pane, you can use full-text search for finding a particular word in all the installed documents. Enter the term you are looking for, and select the Search button. All documents that have the specified term are listed. The list is sorted by document version (if you have installed several Qt versions, for example) and the number of search hits that the documents have. Select a document in the list to open it.

{Help mode Search pane}

The following are examples of common search patterns:

  • deep lists all the documents that have the word deep. The search is not case sensitive.
  • deep* lists all the documents that have a word beginning with deep
  • deep copy lists all documents that have both deep and copy
  • "deep copy" lists all documents that have the phrase deep copy

Full-text search is based on indexing all the installed documents the first time when you open the Search pane. If you add or remove documents, Qt Creator recreates the index.

If you cannot find words that you know are there, indexing might not have been completed for some reason. To regenerate the index, click (Regenerate Index).

Punctuation is not included in indexed terms. To find terms that have punctuation, such as domain names, use the asterisk as a wild card. For example, to find Pastebin.Com, enter the search term Pastebin*.

See also Find information in Qt documentation.

© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.