Commit 9004dc41 authored by Oswald Buddenhagen's avatar Oswald Buddenhagen
Browse files

major doc update

squashed patch series from Mladen Zagorac and Rohan Shetty
who are working under contract.
parent e609e9a7
......@@ -125,11 +125,8 @@
Now that we have all the files we need, click \gui Finish so can start
designing the user interface.
\table
\row
\o \bold{Note:} For more details on how to create a \gui Project
with Qt Creator, refer to \l{Creating a Project in Qt Creator}.
\endtable
\note For more information on how to create a \gui Project, see
\l {Creating a project}.
\section1 Placing Widgets on The Form
......
......@@ -294,7 +294,7 @@ void AddressBook::loadFromFile()
QDataStream in(&file);
in.setVersion(QDataStream::Qt_4_5);
contacts.empty(); // empty existing contacts
contacts.clear(); // remove all items
in >> contacts;
//! [loadFromFile part2]
......
doc/images/qtcreator-breakdown.png

161 KB | W: | H:

doc/images/qtcreator-breakdown.png

123 KB | W: | H:

doc/images/qtcreator-breakdown.png
doc/images/qtcreator-breakdown.png
doc/images/qtcreator-breakdown.png
doc/images/qtcreator-breakdown.png
  • 2-up
  • Swipe
  • Onion skin
doc/images/qtcreator-debug-view.png

117 KB | W: | H:

doc/images/qtcreator-debug-view.png

23.1 KB | W: | H:

doc/images/qtcreator-debug-view.png
doc/images/qtcreator-debug-view.png
doc/images/qtcreator-debug-view.png
doc/images/qtcreator-debug-view.png
  • 2-up
  • Swipe
  • Onion skin
doc/images/qtcreator-locator.png

43.4 KB | W: | H:

doc/images/qtcreator-locator.png

18.1 KB | W: | H:

doc/images/qtcreator-locator.png
doc/images/qtcreator-locator.png
doc/images/qtcreator-locator.png
doc/images/qtcreator-locator.png
  • 2-up
  • Swipe
  • Onion skin
doc/images/qtcreator-projectpane.png

252 KB | W: | H:

doc/images/qtcreator-projectpane.png

59.5 KB | W: | H:

doc/images/qtcreator-projectpane.png
doc/images/qtcreator-projectpane.png
doc/images/qtcreator-projectpane.png
doc/images/qtcreator-projectpane.png
  • 2-up
  • Swipe
  • Onion skin
......@@ -8,22 +8,24 @@
/*!
\contentspage{index.html}{Qt Creator}
\page index.html
\nextpage creator-quick-tour.html
\nextpage creator-overview.html
\title Qt Creator Manual
\section1 Version 1.3.80
The goal of Qt Creator is to provide a cross-platform, complete Integrated
Development Environment (IDE) to develop Qt projects. It is available for
the Linux, Mac OS X and Windows platforms.
Qt Creator provides a cross-platform, complete integrated development
environment (IDE) for developing Qt projects. It is available for Linux,
Mac OS X and Windows operating systems. You can use Qt Creator to develop
applications for desktop and Symbian platforms. For more information, see
\l{Operating systems and supported platforms}.
\note Please report bugs and suggestions to the
\l{http://bugreports.qt.nokia.com}{Qt Bug Tracker}.
You can also join the Qt Creator mailing list. To subscribe,
send a message with the word \e subscribe to
\l{mailto:qt-creator-request@trolltech.com}
{qt-creator-request@trolltech.com}. For more information on Qt mailing
{qt-creator-request@trolltech.com}. For more information about Qt mailing
lists, visit \l{http://lists.trolltech.com}{http://lists.trolltech.com}.
\raw HTML
......@@ -31,26 +33,35 @@
\endraw
\list
\o \l{A Quick Tour of Qt Creator}
\o \l{Creating a Project in Qt Creator}
\o \l{Writing a Simple Program with Qt Creator}
\o \l{The Code Editor}
\o \l{Navigating Around Your Code with Locator}
\o \l{Session Management in Qt Creator}
\o \l{Qt Version Management}
\o \l{Project Settings}
\o \l{CMake Support in Qt Creator}
\o \l{Support for Generic Projects in Qt Creator}
\o \l{External Libraries}
\o \l{Development of Qt for Symbian Based Applications}
\o \l{Qt Creator and Debugging}
\o \l{Qt Creator and Version Control Systems}
\o \l{Tips and Tricks}
\o \l{Keyboard Shortcuts}
\o \l{Glossary}
\o \l{Supported Platforms}
\o \l{Known Issues}
\o \l{Acknowledgements}
\o \l{Operating Systems and Supported Platforms}
\o \l{Quick Tour}
\o \l{Writing a Simple Program}
\o \l{Using the Editor}
\list
\o \l{Finding and Replacing}
\o \l{Refactoring}
\o \l{Searching With the Locator}
\endlist
\o \l{Managing Projects}
\list
\o \l{Creating a Project}
\o \l{Setting Up a qmake Project}
\o \l{Setting Up a CMake Project}
\o \l{Setting Up a Generic Project}
\o \l{Managing Sessions}
\endlist
\o \l{Developing Applications}
\list
\o \l{Developing Maemo Applications}
\o \l{Developing Symbian Applications}
\endlist
\o \l{Debugging}
\o \l{Using Version Control Systems}
\o \l{Tips and Tricks}
\o \l{Keyboard Shortcuts}
\o \l{Known Issues}
\o \l{Glossary}
\o \l{Acknowledgements}
\endlist
*/
......@@ -58,77 +69,195 @@
/*!
\contentspage index.html
\previouspage index.html
\page creator-os-supported-platforms.html
\nextpage creator-quick-tour.html
\title Operating Systems and Supported Platforms
\section1 Operating Systems
Qt Creator is available in binary packages for the following operating
systems:
\list
\o Windows XP Service Pack 2
\o Windows Vista
\o (K)Ubuntu Linux 7.04 32-bit and 64-bit with the following:
\list
\o g++
\o make
\o libglib2.0-dev
\o libSM-dev
\o libxrender-dev
\o libfontconfig1-dev
\o libxext-dev
\o libfreetype6-dev
\o libx11-dev
\o libxcursor-dev
\o libxfixes-dev
\o libxft-dev
\o libxi-dev
\o libxrandr-dev
\o If you are using QtOpenGL, libglui-dev
\endlist
\o Mac OS 10.4 or later with the following:
\list
\o Xcode tools for your Mac OS X version available from your Mac
OS X installation DVDs or at \l http://developer.apple.com.
\endlist
\endlist
\section1 Building Qt Creator
To build Qt Creator itself from the source, you need:
\list
\o Qt 4.6.0 or later
\o On Windows, MinGW 4.4 or Microsoft Visual Studio 2008
\endlist
\section1 Supported Platforms
\table
\header
\o {1,2} Operating system
\o {2,1} Platform
\header
\o Desktop
\o Symbian
\row
\o Windows
\o Yes
\o Yes
\row
\o Linux
\o Yes
\o No
\row
\o Mac OS X
\o Yes
\o No
\endtable
*/
/*!
\contentspage index.html
\previouspage creator-os-supported-platforms.html
\page creator-quick-tour.html
\nextpage creator-creating-project.html
\nextpage creator-writing-program.html
\title A Quick Tour of Qt Creator
\title Quick Tour
The labeled screenshot below shows some of the components of Qt Creator, in
\gui Edit mode.
The figure below shows some of the components of Qt Creator in
\gui{Edit mode}.
\image qtcreator-breakdown.png
\section1 The Mode Selectors
When working in Qt Creator, you can be in one of six modes: \bold Welcome,
\bold Edit, \bold Debug, \bold Projects, \bold Help, and \bold Output.
\section1 Qt Creator Modes
Mode selectors allow you to quickly switch between tasks: editing, browsing
the Qt Creator manual, setting up the build environment, etc. You can
activate a mode by either clicking on its mode selector, or using the
\l{keyboard-shortcuts}{corresponding keyboard shortcut}. Certain actions also
trigger a mode change, e.g., \gui{Debug}/\gui{Start debugging} switches
to the \gui Debug mode.
The mode selector allows you to quickly switch between tasks such as
editing project and source files, configuring how projects are built and
executed, and debugging your applications. To change modes, click the
icons, or use the \l{keyboard-shortcuts}{corresponding keyboard shortcut}.
\list
\o Use the \gui Welcome mode to open recent sessions and projects.
\o Use the \gui Edit mode to edit project and source files.
\l{The sidebar} in the Edit mode provides different views for
browsing files.
\o Use the \gui Debug mode to inspect the state of your program while
debugging. For more information, see \l Debugging.
\o Use the \gui Projects mode to configure project builing and
execution. For more information, see \l{Managing Projects}.
\o Use the \gui Help mode to view Qt documentation. For more
information, see \l{Qt Help Integration}.
\o Use the \gui Output mode to examine, for example, build issues
and compile and application output. This information is also
available in \l{The output panes}{the output panes}.
\endlist
Certain actions in Qt Creator trigger a mode change. For example,
\gui Debug > \gui{Start debugging} > \gui{Start debugging}
automatically switches to \gui Debug mode.
\section1 The Sidebar
\o \gui{Welcome mode} - Displays a welcome screen allowing you to quickly
load sessions or recent individual projects. This is the mode displayed
when Qt Creator is run without command line switches.
Use the sidebar to browse files, projects and bookmarks.
\image qtcreator-sidebar.png
\o \gui{Edit mode} - Lets you edit both project and source files. A sidebar
on the left provides different views for navigating between files.
You can select the content of the sidebar in the sidebar menu:
\list
\o \gui Projects shows a list of projects open in the current
session.
\o \gui{File System} shows the content of the currently selected
directory.
\o \gui Bookmarks shows all bookmarks for the current session.
\o \gui{Open Documents} shows currently open files.
\endlist
\o \gui{Debug mode} - Provides various ways to inspect the state of the
program while debugging. See \l{Qt Creator and Debugging} for a hands-on
description of how to use this mode.
You can change the view of the sidebar in the following ways:
\list
\o To toggle the sidebar, click \inlineimage qtcreator-togglebutton.png
or press \key Alt+0 (\key Cmd+0 on Mac OS X).
\o To split the sidebar, click \inlineimage qtcreator-splitbar.png
. When you split the sidebar, the new view shows the same
contents as the view you are splitting.
\o To close a sidebar view, click
\inlineimage qtcreator-closesidebar.png
.
\endlist
\o \gui{Projects mode} - Lets you configure how projects can be built and
executed. Under the list of projects, there are tabs to configure the
build, run, and editor settings.
\o \gui{Help mode} - Shows all documentation registered by Qt Assistant,
such as the Qt library and Qt Creator documentation.
\section2 Project Tree
\o \gui{Output mode} - Lets you examine various data in detail, for example
build issues as well as compile and application output. This information
is also available in the output panes.
When the sidebar shows projects, they are displayed in a project tree. The
project tree contains a list of all projects open in the current session.
The files for each project are grouped according to their file type.
You can use the project tree in the following ways:
\list
\o Right-clicking an item in the project tree brings up a
context menu containing the actions most commonly needed.
For example, through the menu of the project root directory you can,
among other actions, build, re-build, clean and run the project.
\o To list all files in a project, click
\inlineimage qtcreator-filter.png
and select \gui{Simplify tree}.
\o During a build, the build system automatically generates source
files. To hide these files, click \inlineimage qtcreator-filter.png
and select \gui{Hide generated files}.
\o To toggle the synchronization of your project tree with the file
opened in the editor, click
\inlineimage qtcreator-synchronizefocus.png
.
\o To see the absolute path of a file, move the mouse pointer over the
file name.
\endlist
\section1 The Output Panes
The task pane in Qt Creator can display one of four different panes:
The task pane in Qt Creator can display one of the following panes:
\gui{Build Issues}, \gui{Search Results}, \gui{Application Output}, and
\gui{Compile Output}. These panes are available in all modes.
\gui{Compile Output}. Output panes are available in all
\l{Qt Creator modes}{modes}.
\section2 Build Issues
The \gui{Build Issues} pane provides a list of issues, e.g., error messages
or warnings that need to be fixed. It filters out irrelevant output from
the compiler and presents the issues in an organized way.
The \gui{Build Issues} pane provides a list of errors and warnings
encoutered during a build. The pane filters out irrelevant output from
the build tools and presents the issues in an organized way.
\image qtcreator-build-issues.png
\section2 Search Results
The \gui{Search Results} pane displays the results for global searches such
as searching within a current document, files on disk, or all projects. In
the screenshot below, we searched for all occurrences of \c{textfinder}
within the \c{"/TextFinder"} folder.
The \gui{Search Results} pane displays the results for global searches
such as searching within a current document, files on disk, or all
projects. The figure below shows an example output of search result for all
occurrences of \c textfinder within the \c "/TextFinder" directory.
\image qtcreator-search-pane.png
......@@ -136,7 +265,8 @@
\section2 Application Output
The \gui{Application Output} pane displays the status of a program when
it is executed, and the debug output, e.g., output from qDebug().
it is executed, and the debug output. The figure below shows an example
output from qDebug().
\image qtcreator-application-output.png
......@@ -145,7 +275,7 @@
The \gui{Compile Output} pane provides all output from the compiler. In
other words, it is a more detailed version of information displayed in the
\gui{Build Issues}
\gui{Build Issues} pane.
\image qtcreator-compile-pane.png
......@@ -153,28 +283,34 @@
\section1 Qt Help Integration
Qt Creator comes fully integrated with all of Qt's documentation and
examples via the Qt Help plugin. To view the documentation, switch
to the \gui{Help} mode. To obtain context sensitive help, move the text
cursor to a Qt class or function and press \key{F1}. The documentation
is displayed in a pane on the right, as shown in the screenshot
below. If there is enough vertical space, it is shown in the
fullscreen help mode.
examples using the Qt Help plugin.
\image qtcreator-context-sensitive-help.png
To view documentation, switch to \gui Help mode.
External documentation provided by the user can be used to augment or
replace the documentation shipped with Qt Creator and Qt.
To obtain context sensitive help, move the text cursor to a Qt class or
function and press \key F1. The documentation is displayed in a pane
next to the code editor, or, if there is not enough vertical space, in the
fullscreen \gui Help mode.
\image qtcreator-context-sensitive-help.png
\section1 Qt Designer Integration
To select and configure how the documentation is displayed in the
\gui Help mode, select \gui Tools > \gui Options... > \gui Help.
Qt Creator is fully integrated with Qt Designer to help you design user
interface forms like you would with the standalone version. The Qt
Designer integration also includes project management and code completion.
For more information on Qt Designer, see
\l{http://doc.trolltech.com/designer-manual.html}{The Designer Manual}.
\section2 Adding External Documentation
\image qtcreator-formedit.png
You can display external documentation in Qt Creator's \gui Help mode.
To augument or replace the documentation that ships with Qt Creator and Qt:
\list 1
\o Create a .qch file from your documentation.
For information on how to prepare your documentation and create a
.qch file, see
\l http://doc.qt.nokia.com/4.6/qthelp-framework.html
{The Qt help framework}.
\o Add the .qch file to Qt Creator by selecting \gui Tools >
\gui Options... > \gui Help > \gui Documentation > \gui Add.
\endlist
\section1 Keyboard Navigation
......@@ -182,47 +318,207 @@
Qt Creator caters not only to developers who are used to using the mouse,
but also to developers who are more comfortable with the keyboard. A wide
range of \l{keyboard-shortcuts}{keyboard} and
\l{Navigating Around Your Code with Locator}{navigation} shortcuts
are available to help speed up the process of developing your application.
\l{Searching With the Locator}{navigation} shortcuts are available to help
speed up the process of developing your application.
\section1 Qt Designer Integration
To help you design the user interface of your application, a complete
version of Qt Designer is integrated right into Qt Creator. Qt Creator
automatically opens all .ui files in Qt Designer.
The Qt Designer integration includes project management and code
completion.
\image qtcreator-formedit.png
To change the layout of Qt Designer user interface elements:
\list 1
\o Select \gui Tools > \gui{Form editor} > \gui Views >
\gui Locked.
When this option is unchecked, you can change the layout.
\o Click the header of an element and drag the element to a new
position.
\endlist
To change Qt Designer properties, select \gui Tools > \gui Options >
\gui Designer.
\list
\o Set the class properties and code generation preferences in \gui
{Class Generation}.
\o Set an additional folder for saving templates in \gui{Template
Paths}.
\o Set the grid settings and preview preferences in \gui Forms. To
preview your form with skins, enable \gui{Print/Preview
Configuration} and select your skin. Otherwise default preview
settings are used.
To preview the settings, select \gui Tools > \gui{Form Editor} >