~oif-team/ubuntu/natty/qt4-x11/xi2.1

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="annotated.html"><font color="#004faf">Annotated</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

[Previous: <a href="qmake-advanced-usage.html">qmake Advanced Usage</a>]

[<a href="qmake-manual.html">Contents</a>]

[Next: <a href="qmake-common-projects.html">qmake Common Projects</a>]

</p>

<h1 align="center">qmake Tutorial</h1>

<p>This tutorial teaches you how to use <tt>qmake</tt>. We recommend that you read the <tt>qmake</tt> user guide after completing this tutorial.</p>

<h2>Starting off Simple</h2>

<p>Let's assume that you have just finished a basic implementation of your application, and you have created the following files:</p>

<ul>

<li>hello.cpp</li>

<li>hello.h</li>

</ul>

<p>You will find these files in <tt>qt/qmake/examples/tutorial</tt>. The only other thing you know about the setup of the application is that it's written in Qt. First, using your favorite plain text editor, create a file called <tt>hello.pro</tt> in <tt>qt/qmake/tutorial</tt>. The first thing you need to do is add the lines that tell <tt>qmake</tt> about the source and header files that are part of your development project.</p>

<p>We'll add the source files to the project file first. To do this you need to use the SOURCES variable. Just start a new line with <tt>SOURCES +=</tt> and put hello.cpp after it. You should have something like:</p>

<pre>  SOURCES += hello.cpp</pre>

<p>We repeat this for each source file in the project, until we end up with:</p>

<pre>  SOURCES += hello.cpp

SOURCES += main.cpp</pre>

<p>If you prefer to use a Make-like syntax, with all the files listed in one go you can use the newline escaping like this:</p>

<pre>  SOURCES = hello.cpp \

main.cpp</pre>

<p>Now that the source files are listed in the project file, the header files must be added. These are added in exactly the same way as source files, except that the variable name is HEADERS:</p>

<p>Once you have done this, your project file should look something like this:</p>

<pre>  HEADERS += hello.h

SOURCES += hello.cpp

SOURCES += main.cpp</pre>

<p>The target name is set automatically; it is the same as the project file, but with the suffix appropriate to the platform. For example, if the project file is called <tt>hello.pro</tt>, the target will be <tt>hello.exe</tt> on Windows and <tt>hello</tt> on Unix. If you want to use a different name you can set it in the project file:</p>

<pre>  TARGET = helloworld</pre>

<p>The final step is to set the <tt>CONFIG</tt> variable. Since this is a Qt application, we need to put <tt>qt</tt> on the CONFIG line so that <tt>qmake</tt> will add the relevant libraries to be linked against and ensure that build lines for <tt>moc</tt> and <tt>uic</tt> are included in the makefile.</p>

<p>The finished project file should look like this:</p>

<pre>  CONFIG += qt

HEADERS += hello.h

SOURCES += hello.cpp

SOURCES += main.cpp</pre>

<p>You can now use <tt>qmake</tt> to generate a makefile for your application. On the command line, in your application directory, type:</p>

<pre>  qmake -o Makefile hello.pro</pre>

<p>Then type <tt>make</tt> or <tt>nmake</tt> depending on the compiler you use.</p>

<p>For Visual Studio users, <tt>qmake</tt> can also generate <tt>.dsp</tt> or <tt>.vcproj</tt> files, for example:</p>

<pre>  qmake -tp vc -o hello.dsp hello.pro</pre>

<h2>Making an Application Debuggable</h2>

<p>The release version of an application doesn't contain any debugging symbols or other debuggin information. During development it is useful to produce a debugging version of the application that has the relevant information. This is easily achieved by adding <tt>debug</tt> to the CONFIG variable in the project file.</p>

<p>For example:</p>

<pre>  CONFIG += qt debug

HEADERS += hello.h

SOURCES += hello.cpp

SOURCES += main.cpp</pre>

<p>Use <tt>qmake</tt> as before to generate a makefile and you will be able to debug your application.</p>

<h2>Adding Platform-Specific Source Files</h2>

<p>After a few hours of coding, you might have made a start on the platform specific part of your application, and decided to keep the platform dependent code separate. So you now have two new files to include into your project file - <tt>hellowin.cpp</tt> and <tt>hellounix.cpp</tt>. We can't just add these to the <tt>SOURCES</tt> variable since this will put both files in the makefile. So what we need to do here is to use a scope which will be processed depending on which platform <tt>qmake</tt> is run on.</p>

<p>A simple scope which will add in the platform dependent file for Windows looks like this:</p>

<pre>  win32 {

SOURCES += hellowin.cpp

}</pre>

<p>So if <tt>qmake</tt> is run on Windows, it will add <tt>hellowin.cpp</tt> to the list of source files. If <tt>qmake</tt> is run on any other platform, it will simply ignore it. Now all that is left to be done is to create a scope for the unix dependent file.</p>

<p>When you have done that, your project file should now look something like this:</p>

<pre>  CONFIG += qt debug

HEADERS += hello.h

SOURCES += hello.cpp

SOURCES += main.cpp

win32 {

SOURCES += hellowin.cpp

}

unix {

SOURCES += hellounix.cpp

}</pre>

<p>Use <tt>qmake</tt> as before to generate a makefile.</p>

<h2>Stopping qmake If a File Doesn't Exist</h2>

<p>You may not want to create a makefile if a certain file doesn't exist. We can check if a file exists by using the exists() function. We can stop <tt>qmake</tt> from processing by using the error() function. This works in the same way as scopes. Simply replace the scope condition with the function. A check for a main.cpp file looks like this:</p>

<pre>  !exists( main.cpp ) {

error( "No main.cpp file found" )

}</pre>

100

<p>The "!" is used to negate the test, i.e. <tt>exists( main.cpp )</tt> is true if the file exists and <tt>!exists( main.cpp )</tt> is true if the file doesn't exist.</p>

101

<pre>  CONFIG += qt debug

102

HEADERS += hello.h

103

SOURCES += hello.cpp

104

SOURCES += main.cpp

105

win32 {

106

SOURCES += hellowin.cpp

107

}

108

unix {

109

SOURCES += hellounix.cpp

110

}

111

!exists( main.cpp ) {

112

error( "No main.cpp file found" )

113

}</pre>

114

<p>Use <tt>qmake</tt> as before to generate a makefile. If you rename <tt>main.cpp</tt> temporarily, you will see the message and <tt>qmake</tt> will stop processing.</p>

115

116

<h2>Checking for More than One Condition</h2>

117

<p>Suppose you use Windows and you want to be able to see the <a href="qtglobal.html#qDebug">qDebug</a>() statements when you run your application on the command line. Unless you build your application with the console setting, you won't see the output. We can easily put <tt>console</tt> on the CONFIG line so that on Windows the makefile will have this setting. But let's say that we only want to add the CONFIG line if we are running on Windows <tt>and</tt> when <tt>debug</tt> is already on the CONFIG line. This requires using two nested scopes; just create one scope, then create the other inside that one. Put the settings to be processed inside the last scope, like this:</p>

118

<pre>  win32 {

119

debug {

120

CONFIG += console

121

}

122

}</pre>

123

<p>Nested scopes can be joined together using colons, so the final project file looks like this:</p>

124

<pre>  CONFIG += qt debug

125

HEADERS += hello.h

126

SOURCES += hello.cpp

127

SOURCES += main.cpp

128

win32 {

129

SOURCES += hellowin.cpp

130

}

131

unix {

132

SOURCES += hellounix.cpp

133

}

134

!exists( main.cpp ) {

135

error( "No main.cpp file found" )

136

}

137

win32:debug {

138

CONFIG += console

139

}</pre>

140

<p>That's it! You have now completed the tutorial for <tt>qmake</tt>, and are ready to write project files for your development projects.</p>

141

<p>

142

[Previous: <a href="qmake-advanced-usage.html">qmake Advanced Usage</a>]

143

[<a href="qmake-manual.html">Contents</a>]

144

[Next: <a href="qmake-common-projects.html">qmake Common Projects</a>]

145

</p>

146

147

148

149

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

150

151

</tr></table></div></address></body>

152

</html>

Older »