Table of Content
Qt for beginners — Finding information in the documentation
Qt documentation is a very valuable piece of information. It is the place to find everything related to Qt. But, Qt documentation is not a tutorial on how to use Qt. It is a collection of all information related to classes, as well as some examples. The goal of this chapter is to introduce you to the documentation as a basis for programming with Qt.
Where to find the documentation
The best source of documentation is on the internet, in this developer network :
Qt documentation on developer network [qt-project.org]
It provides the full doc, as well as some DocNotes, that users can add. These DocNotes gives more examples, and highlight some tricky points. The online documentation also have a quite powerful search engine and contains also all the documentation for all versions of Qt.
But it requires an internet connection. Without internet connection, the doc is still available. If the QtSDK was installed correctly, the documentation that matchs the current version of Qt should have been installed, and the Help section of QtCreator should not be empty. You can also use Qt Assistant, that is a standalone doc browser.
Important sections of the documentation
If you are running the offline documentation viewer, in either Qt Creator, or Qt Assistant, you will find in the summary that there are documentations for different components of the Qt SDK.
- Qt Assistant documentation
- Qt Designer documentation
- Qt Linguist documentation
- QMake documentation
- Qt reference documentation
The most important component is, of cause, Qt reference documentation.
Qt documentation provide nice introductions of many components, and also the documentation for all classes in Qt. This list is listed in the page All classes [qt-project.org]. Another interesting page is the page that lists All modules [qt-project.org]. This page provides information about the different components in Qt.
In this tutorial, we will mostly use these modules
The search function is also quite important. If you know the class to use, and want to find the documentation, you can either type the name of this class in the search field (online), or in the filter in the index (offline). You can also search for methods and enumerations in these fields.
Browse the documentation of a class
Classes documentations are always organized in the same fashion :
- Name and short description of the class
- Public methods
- Public slots
- Protected methods
Let’s take the QTextEdit [qt-project.org] class as an example.