feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: restructure doc according to developer workflow

Browse Source 
Add and remove illustrations.
Add landing pages.

Change-Id: I927d62aee9dc43814ef7f4d7424a83eee2af156b
Reviewed-by: Erik Verbruggen <erik.verbruggen@nokia.com>
This commit is contained in:
Leena Miettinen
2011-12-13 11:52:47 +01:00
parent aeebb26ef1
commit 88e29febba
85 changed files with 1794 additions and 1153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/images/creator-gs-01.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 7.0 KiB

BIN
doc/images/creator-gs-02.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 5.7 KiB

After

Width:  |  Height:  |  Size: 2.4 KiB

BIN
doc/images/creator-gs-03.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 11 KiB

BIN
doc/images/creator-gs-04.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 7.2 KiB

After

Width:  |  Height:  |  Size: 3.7 KiB

BIN
doc/images/creator_advanceduse.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.1 KiB

BIN
doc/images/creator_buildingrunning.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.7 KiB

BIN
doc/images/creator_coding.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.1 KiB

BIN
doc/images/creator_createanimation.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.4 KiB

BIN
doc/images/creator_createcode.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.8 KiB

BIN
doc/images/creator_createcomponents.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.2 KiB

BIN
doc/images/creator_createproject.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.6 KiB

BIN
doc/images/creator_createscreen.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.2 KiB

BIN
doc/images/creator_createuserinter.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.9 KiB

BIN
doc/images/creator_designinguserinterface.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.7 KiB

BIN
doc/images/creator_devices.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 11 KiB

BIN
doc/images/creator_gettinghelp.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
doc/images/creator_gettingstarted.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.1 KiB

BIN
doc/images/creator_managingprojects.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 11 KiB

BIN
doc/images/creator_publishing.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.3 KiB

BIN
doc/images/creator_testing.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 11 KiB

BIN
doc/images/qtcreator-overview.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 21 KiB

48
doc/src/analyze/creator-analyze.qdoc
View File

@@ -33,25 +33,11 @@
\title Analyzing Code
The memory available on mobile devices is limited and you should use it
carefully. \QC contains tools that you can use to analyze your code.
The \gui {QML Profiler} allows you to profile your Qt
Quick applications. You can inspect binding evaluations, signal handling,
and painting operations when running QML code. This is useful for
identifying potential bottlenecks, especially in the evaluation of bindings.
In addition, \QC integrates Valgrind code analysis tools for
detecting memory leaks and profiling function execution. These tools are
supported locally only on Linux and Mac OS. You can run them on a remote
host from Windows. You have to download and install them
separately to use them from \QC.
You can use the code analysis tools in the \gui Analyze mode. To switch to
\gui Analyze mode, select \gui Analyze in the mode selector, or select the
\gui {Analyze} menu and then select a tool. When you are in the
\gui Analyze mode, you can switch
between tools by selecting them in the menu on the toolbar.
\gui Analyze mode, you can switch between tools by selecting them in the
menu on the toolbar.
\image qtcreator-analyze-menu.png "Analyze mode menu"
@@ -62,33 +48,21 @@
sessions. Select \gui {Window > Views > Reset to Default Layout} to reset
the views to their original sizes and positions.
To run the Valgrind tools on a remote host over SSH, select \gui {Analyze
> Valgrind Analyze Memory (Remote)} or \gui {Valgrind Function Profile
(Remote)}.
To stop the currently running analyzer, select \gui {Analyze
> Stop}.
To select options for the Valgrind tools, select \gui {Tools > Options >
Analyzer}. You can override the general settings for each project in the
\gui {Run Settings} for the project.
The following sections describe how to use the code analysis tools:
You can use the following code analysis tools in the \gui Analyze mode:
\list
\o \l{Profiling QML Applications} describes how to inspect binding
evaluations, signal handling, and painting operations when running
QML code.
\o \l{Profiling QML Applications}{QML Profiler}
\o \l{Detecting Memory Leaks} describes how to use the Valgrind
Memcheck tool to detect problems in memory management.
You can inspect binding evaluations, signal handling, and
painting operations when running QML code. This is useful for
identifying potential bottlenecks, especially in the evaluation
of bindings.
\o \l{Profiling Function Execution} describes how to use the Valgrind
Callgrind tool to find cache misses in the code.
\o \l{Using Valgrind Code Analysis Tools}{Valgrind Code Analysis Tools}
\o \l{Running Valgrind Tools Remotely} describes how to run the
Valgrind tools on a remote host.
You can detect problems in memory management by using the Memcheck
tool and find cache misses in the code by using the Callgrind tool.
\endlist

64
doc/src/analyze/creator-valgrind-overview.qdoc Normal file
View File

@@ -0,0 +1,64 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-qml-performance-monitor.html
\page creator-valgrind-overview.html
\nextpage creator-analyzer.html
\title Using Valgrind Code Analysis Tools
\QC integrates Valgrind code analysis tools for detecting memory leaks and
profiling function execution. You must download and install them separately
to use them from \QC.
To run the Valgrind tools on a remote host over SSH, select \gui {Analyze
> Valgrind Analyze Memory (Remote)} or \gui {Valgrind Function Profile
(Remote)}.
To stop the currently running analyzer, select \gui {Analyze
> Stop}.
To select options for the Valgrind tools, select \gui {Tools > Options >
Analyzer}. You can override the general settings for each project in the
\gui {Run Settings} for the project.
The following sections describe how to use the Valgrind tools:
\list
\o \l{Detecting Memory Leaks}
\o \l{Profiling Function Execution}
\o \l{Running Valgrind Tools Remotely}
\endlist
*/

4
doc/src/analyze/creator-valgrind.qdoc
View File

@@ -27,7 +27,7 @@
/*!
\contentspage index.html
\previouspage creator-qml-performance-monitor.html
\previouspage creator-valgrind-overview.html
\page creator-analyzer.html
\nextpage creator-cache-profiler.html
@@ -226,7 +226,7 @@
\contentspage index.html
\previouspage creator-cache-profiler.html
\page creator-running-valgrind-remotely.html
\nextpage creator-deployment.html
\nextpage creator-publish-ovi.html
\title Running Valgrind Tools Remotely

2
doc/src/analyze/qtquick-profiler.qdoc
View File

@@ -29,7 +29,7 @@
\contentspage index.html
\previouspage creator-analyze-mode.html
\page creator-qml-performance-monitor.html
\nextpage creator-analyzer.html
\nextpage creator-valgrind-overview.html
\title Profiling QML Applications

138
doc/src/debugger/creator-debugger.qdoc
View File

@@ -27,7 +27,7 @@
/*!
\contentspage index.html
\previouspage creator-running-targets.html
\previouspage creator-testing.html
\page creator-debugging.html
\nextpage creator-debugging-example.html
@@ -37,37 +37,62 @@
core and external native debuggers such as the GNU Symbolic Debugger (GDB),
the Microsoft Console Debugger (CDB), and a QML/JavaScript debugger.
The following sections describe debugging with \QC:
\list
\if defined(qcmanual)
\o \l{Debugging the Example Application} uses an example application
to illustrate how to debug Qt C++ applications in the \gui Debug
\o \l{Debugging the Example Application}
Illustrates how to debug Qt C++ applications in the \gui Debug
mode.
\endif
\o \l{Launching the Debugger} describes the
operating modes in which the debugger plugin runs, depending on
where and how the process is started and run.
\o \l{Launching the Debugger}
\o \l{Interacting with the Debugger} describes the views and functions
available in the \gui Debug mode.
To start a program under the control of the debugger, press
\key{F5}. \QC checks whether the compiled program is up-to-date,
and rebuilds it if necessary. The debugger then takes over and
starts the program. The debugger is launched in the appropriate
operating mode (plain, terminal, or on-device), based on the
build and run settings for the active project. You can also launch
the debugger in other mode.
\o \l{Setting Up Debugger} summarizes the support for debugging C++
code and requirements for installation. Typically, the interaction
between \QC and the native debugger is set up automatically
and you do not need to do anything.
\o \l{Interacting with the Debugger}
\o \l{Using Debugging Helpers} describes how to get more detailed data
on complex data.
You can use the \QC \gui Debug mode to inspect the state of your
application while debugging.
\o \l{Debugging Qt Quick Projects} describes how to debug Qt Quick
projects.
\o \l{Setting Up Debugger}
\o \l{Troubleshooting Debugger} lists some typical problems that you
might encounter while debugging and solutions to them.
The debugger plugin tries to automatically pick up a suitable
native debugger. You only need to set it up if the automatic setup
fails, because the native debugger is missing (as is usually the
case for the CDB debugger on Windows, which you always must install
yourself) or because the installed version is not supported.
\o \l{Using Debugging Helpers}
\QC is able to show complex data types in a customized,
user-extensible manner. For this purpose, it takes advantage of
two technologies, collectively referred to as \e {debugging
helpers}. Using the debugging helpers is not essential for
debugging with \QC, but they help you to quickly examine complex
data.
\o \l{Debugging Qt Quick Projects}
In the \gui Debug mode, you can inspect the state of the
application while debugging JavaScript functions. You can set
breakpoints, view call stack trace, and examine locals and
expressions. When the application is interrupted by a breakpoint,
you can use the QML Script Console to execute JavaScript expressions
in the current context.
While the application is running, you can use the QML Inspector
view to explore the object structure, debug animations, and
inspect colors.
\o \l{Troubleshooting Debugger}
If you encounter problems while debugging, check for possible
solutions to them.
\endlist
*/
@@ -445,11 +470,6 @@
\section1 Installing Native Debuggers
There are various reasons why the debugger plugin may fail to automatically
pick up a suitable native debugger. The native debugger might be missing
(which is usually the case for the CDB debugger on Windows which always
needs to be installed manually by the user) or the installed version is not
supported.
Check the table below for the supported versions and other important
information about installing native debuggers.
@@ -628,6 +648,48 @@
\title Interacting with the Debugger
You can use the \QC \gui Debug mode to inspect the state of your application
while debugging. You can interact with the debugger in several ways,
including the following:
\list
\o Go through a program line-by-line or instruction-by-instruction.
\o Interrupt running programs.
\o Set breakpoints.
\o Examine the contents of the call stack.
\o Examine and modify registers and memory contents of
the debugged program.
\o Examine and modify registers and memory contents of
local and global variables.
\o Examine the list of loaded shared libraries.
\o Create snapshots of the current state of the debugged program
and re-examine them later.
\endlist
\QC displays the raw information provided by the native debuggers in a clear
and concise manner with the goal to simplify the debugging process as much
as possible without losing the power of the native debuggers.
In addition to the generic IDE functionality provided by stack view, views
for locals and expressions, registers, and so on, \QC includes features to
make debugging Qt-based applications easy. The debugger plugin understands
the internal layout of several Qt classes, for example, QString, the Qt
containers, and most importantly QObject (and classes derived from it), as
well as most containers of the C++ Standard Library and some GCC extensions.
This deeper understanding is used to present objects of such classes in a
useful way.
\section1 Using the Debugger
In \gui Debug mode, you can use several views to interact with the
program you are debugging. The availability of views depends on whether
you are debugging C++ or QML. Frequently used views are shown by
@@ -643,8 +705,6 @@
\gui {Window > Views > Reset to Default Layout} to reset the views to
their original sizes and positions.
\section1 Using the Debugger
Once the program starts running under the control of the debugger, it
behaves and performs as usual. You can interrupt a running C++ program by
selecting \gui{Debug} > \gui {Interrupt}. The program is automatically
@@ -986,23 +1046,15 @@
\title Using Debugging Helpers
\QC is able to show complex data types in a customized,
user-extensible manner. For this purpose, it takes advantage of
two technologies, collectively referred to as \e{Debugging Helpers}.
Using the debugging helpers is not \e essential for debugging
with \QC, but they enhance the user's ability to quickly
examine complex data significantly.
There are two approaches to displaying complex data types. The first and
original one is to use debugging helpers based on C++. While it has been
superseded on most platforms by the more robust and more flexible second
approch that uses Python scripting, it is the only feasible one on
Windows/MSVC, Mac OS, and old Linux distributions. Moreover, this approach
is automatically chosen as fallback if the Python based approach fails.
\section1 Debugging Helpers Based on C++
This is the first and original approach to display complex data
types. While it has been superseded on most platforms by the more
robust and more flexible second approch using Python scripting,
it is the only feasible one on Windows/MSVC, Mac OS, and
old Linux distributions. Moreover, this approach will automatically
be chosen as fallback in case the Python based approach fails.
During debugging with the C++ based debugging helpers,
\QC dynamically loads a helper library in form of a DLL or a
shared object into the debugged process.

131
doc/src/editors/creator-coding-edit-mode.qdoc Normal file
View File

@@ -0,0 +1,131 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-editor-functions.html
\page creator-coding-navigating.html
\nextpage creator-highlighting.html
\title Working in Edit Mode
This section describes how to use the \gui Edit mode. For more information
about using the sidebar, see \l{Browsing Project Contents}.
\section1 Using the Editor Toolbar
The editor toolbar is located at the top of the editor view. The editor
toolbar is context sensitive and shows items relevant to the file currently
open in the editor.
\image qtcreator-editortoolbar-symbols.png
Use the toolbar to navigate between open files and symbols in use.
To browse forward or backward through your location history, click
\inlineimage qtcreator-back.png
and \inlineimage qtcreator-forward.png
.
To go to any open file, select it from the \gui{Open files} drop-down menu.
Right-click the menu title and select \gui {Copy Full Path to Clipboard} to
copy the path and name of the current file to the clipboard.
To jump to any symbol used in the current file, select it from the
\gui Symbols drop-down menu. By default, the symbols are displayed in the
order in which they appear in the file. Right-click the menu title and
select \gui {Sort Alphabetically} to arrange the symbols in alphabetic
order.
\section1 Splitting the Editor View
Split the editor view when you want to work on and view multiple files on
the same screen.
\image qtcreator-spliteditorview.png
You can split the editor view in the following ways:
\list
\o To split the editor view into a top and bottom view, select
\gui Window > \gui Split or press \key{Ctrl+E, 2}.
Split command creates views below the currently active editor view.
\o To split the editor view into adjacent views, select
\gui Window > \gui{Split Side by Side} or press \key{Ctrl+E, 3}.
Side by side split command creates views to the right of the
currently active editor view.
\endlist
To move between split views, select \gui Window > \gui{Go to Next Split} or
press \key{Ctrl+E, O}.
To remove a split view, place the cursor within the view you want to
remove and select \gui Window > \gui{Remove Current Split} or press
\key{Ctrl+E, 0}. To remove all but the currently selected split view,
select \gui Window > \gui{Remove All Splits} or press \key{Ctrl+E, 1}.
\section1 Using Bookmarks
To insert or delete a bookmark right-click the line number and select
\gui{Toggle Bookmark} or press \key{Ctrl+M}.
\image qtcreator-togglebookmark.png
To go to previous bookmark in the current session, press \key{Ctrl+,}.
To go to next bookmark in the current session, press \key{Ctrl+.}.
\section1 Moving to Symbol Definition or Declaration
You can move directly to the definition or the declaration of a symbol by
holding the \key Ctrl and clicking the symbol.
To enable this moving function, in \gui Tools > \gui{Options} >
\gui{Text Editor} > \gui Behavior, select \gui{Enable mouse navigation}.
You can also select the symbol and press \key F2, or right-click the symbol
and select \gui {Follow Symbol Under Cursor} to move to its definition or
declaration. This feature is supported for namespaces, classes, methods,
variables, include statements, and macros.
To switch between the definition and declaration of a symbol, press
\key {Shift+F2} or right-click the symbol and select \gui {Switch Between
Method Declaration/Definition}.
\section1 Using Update Code Model
To refresh the internal information in \QC pertaining to your code,
select \gui{Tools} > \gui{C++} > \gui{Update Code Model}.
\note In \QC indexing updates the code automatically. Use
\gui{Update Code Model} only as an emergency command.
*/

81
doc/src/editors/creator-coding.qdoc Normal file
View File

@@ -0,0 +1,81 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-usability.html
\page creator-coding.html
\nextpage creator-editor-functions.html
\title Coding
\image creator_coding.png
\list
\o \l{Writing Code}
Writing, editing, and navigating in source code are core tasks in
application development. Therefore, the code editor is one of the
key components of \QC. You can use the code editor in the \gui Edit
mode.
\o \l{Finding}
Use the incremental and advanced search to search from currently
open projects or files on the file system or use the locator to
browse through projects, files, classes, methods, documentation and
file systems.
\o \l{Refactoring}
Code refactoring is the process of improving and simplifying code
without modifying the existing functionality of an application. You
can easily find and rename symbols and apply predefined actions to
refactor code.
\o \l{Configuring the Editor}
You can change the fonts, colors, highlighting, and indentation.
If you are used to the the Vim editor, you can even run the main
editor in a manner similar to it in the \gui{FakeVim} mode.
\endlist
\section1 Related Topics
\list
\o \l{Editing MIME Types}
\QC uses the MIME type of a file to determine which mode and editor
to use for opening the file. If your files do not match the
predefined MIME types, you can edit the MIME types.
\endlist
*/

89
doc/src/editors/creator-editors-options-text.qdoc Normal file
View File

@@ -0,0 +1,89 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-editor-options.html
\page creator-editor-options-text.html
\nextpage creator-editor-fakevim.html
\title Specifying Text Editor Settings
Set the font preferences and apply color schemes for syntax highlighting in
\gui {Tools > Options > Text Editor > Font & Colors}.
\image qtcreator-font-colors.png "Text editor options"
\section2 Configuring Fonts
You can select the font family and size. You can specify a zoom setting in
percentage for viewing the text. You can also zoom in or out by pressing
\key {Ctrl++} or \key {Ctrl +-}, or by pressing \key Ctrl and rolling
the mouse button up or down. To disable the mouse wheel function, select
\gui {Tools > Options > Text Editor > Behavior} and deselect the
\gui {Enable scroll wheel zooming} check box.
Antialiasing is used by default to make text look smoother and more
readable on the screen. Deselect the \gui Antialias check box to
turn off antialiasing.
\section2 Defining Color Schemes
You can select one of the predefined color schemes for syntax highlighting
or create customized color schemes. The color schemes apply to highlighting
both C++ and QML files and generic files.
To create a color scheme:
\list 1
\o Select \gui {Tools > Options > Text Editor > Fonts & Color > Copy}.
\o Enter a name for the color scheme and click \gui OK.
\o In the \gui Foreground field, specify the color of the selected
code element.
\o In the \gui Background field, select the background
color for the code element.
The backgound of the \gui Text element determines the background of the
code editor.
\endlist
When you copy code from \QC, it is copied in both plain text and HTML
format. The latter makes sure that syntax highlighting is preserved when
pasting to a rich-text editor.
\section2 File Encoding
To define the default file encoding, select the desired encoding in
\gui {Default encoding}. By default, \QC uses the file encoding
used by your system.
*/

89
doc/src/editors/creator-editors-options.qdoc Normal file
View File

@@ -0,0 +1,89 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-editor-refactoring.html
\page creator-editor-options.html
\nextpage creator-editor-options-text.html
\title Configuring the Editor
\QC allows you to configure the text editor to suit your specific
needs. To configure the editor, select \gui Tools > \gui{Options} >
\gui{Text Editor}.
These settings apply to all projects. To specify editor behavior for an
open project, select \gui {Projects > Editor Settings}. For more
information, see \l{Specifying Editor Settings}.
You can also specify indentation settings separately for C++ and QML files
either globally or for the open project. For more information, see
\l{Indenting Code}.
You can perform the following configuration actions:
\list
\o Set the \l{Specifying Text Editor Settings}{font preferences and
apply color schemes} for syntax highlighting in \gui{Font & Colors}.
\o Specify \l{Generic Highlighting}
{definition files for syntax highlighting} for other types of files
than C++ or QML in \gui{Generic Highlighter}.
\o Set \l{Indenting Code}{tabs, indentation, the handling of
whitespace, and mouse operations} in \gui Behavior.
\o Set various display properties, for example,
\l{Highlighting and folding blocks}
{highlighting and folding blocks}, text wrapping or
\l{Moving to symbol definition or declaration}
{moving to symbol definition or declaration} in \gui Display.
\o Add, modify, and remove \l{Editing Code Snippets}{code snippets} in
\gui Snippets.
\o View and remove \l{Using Text Editing Macros}{text editing macros}
in \gui Macros.
\o Configure \l{Completing Code}{code completion} in \gui Completion.
\endlist
\section1 Related Topics
\list
\o \l{Using FakeVim Mode}
Run the main editor in a manner similar to the Vim editor in the
FakeVim mode.
\endlist
*/

94
doc/src/editors/creator-editors-writing-code.qdoc Normal file
View File

@@ -0,0 +1,94 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-coding.html
\page creator-editor-functions.html
\nextpage creator-coding-navigating.html
\title Writing Code
The \QC code editor is fully equipped with semantic highlighting, syntax
checking, code completion, code indentation, context sensitive help, and
in-line error indicators while you are typing.
\list
\o \l{Working in Edit Mode}
You can use the editor toolbar to navigate between open files
and symbols in use. You can also split the view to work on
several files simultaneously, add bookmarks, and move between
symbol definitions and declarations.
\o \l{Semantic Highlighting}
\QC enables you to write well formatted code by highlighting
code elements and blocks. You can use syntax highlighting
also for other types of files than C++ or QML.
\o \l{Checking Code Syntax}
\QC checks for errors when you write code and displays inline
error and warning messages.
\o \l{Completing Code}
\QC anticipates what you are going to write and completes code
and code snippets for elements, properties, and IDs.
\o \l{Indenting Code}
\QC indents code according to rules that you specify either
globally for all files or separately for text, C++, or QML files.
\o \l{Using Qt Quick Toolbars}
When you edit QML code in the code editor, you specify the
properties of QML components. For some properties, such as
colors and font names, this is not a trivial task. For example,
few people can visualize the color #18793f. To easily edit these
properties, you can use the Qt Quick Toolbars.
\o \l{Pasting and Fetching Code Snippets}
You can cooperate with other developers by pasting and fetching
snippets of code from a server. For example, you might ask
colleagues to review a change that you plan to submit to a
version control system.
\o \l{Using Text Editing Macros}
When you have a file open in the code editor, you can record a
keyboard sequence as a macro. You can then play the macro to
repeat the sequence. You can save the latest macro and assign a
keyboard shortcut for running it or run it from the locator.
\endlist
*/

321
doc/src/editors/creator-editors.qdoc
View File

@@ -27,185 +27,7 @@
/*!
\contentspage index.html
\previouspage creator-project-managing-sessions.html
\page creator-coding.html
\nextpage creator-editor-using.html
\title Coding
Writing, editing, and navigating in source code are core tasks in
application development. Therefore, the code editor is one of the key
components of \QC. You can use the code editor in the \gui Edit
mode.
The following sections describe coding with \QC:
\list
\o \l{Using the Editor} describes how to work in the code editor, use
the editor toolbar, split the view, add bookmarks, and move between
symbol definitions and declarations.
\o \l{Semantic Highlighting} describes highlighting code elements and
blocks, as well as using syntax highlighting also for other types
of files than C++ or QML.
\o \l{Checking Code Syntax} describes how errors are visualized
while you write code.
\o \l{Completing Code} describes how code and code snippets are
completed for elements, properties, an IDs.
\o \l{Indenting Code} describes how to specify indentation either
globally for all files or separately for: text, C++, or QML files.
\o \l{Finding and Replacing} describes the incremental search that
highlights the matching strings in the window while typing and the
advanced search that allows you to search from currently open
projects or files on the file system. In addition, you can search
for symbols when you want to refactor code.
\o \l{Refactoring} describes the features that help you improve the
internal quality or your application, its performance and
extendibility, and code readability and maintainability, as well as
to simplify code structure.
\o \l{Using Qt Quick Toolbars} describes how to use the Qt Quick
Toolbars to edit the properties of QML elements in the code editor.
\o \l{Searching with the Locator} describes how to browse through
projects, files, classes, methods, documentation and file systems.
\o \l{Pasting and Fetching Code Snippets} describes how to cooperate
with other developers by pasting and fetching snippets of code from
a server.
\o \l{Using Text Editing Macros} describes how to record and play
text editing macros.
\o \l{Configuring the Editor} describes how to change the text editor
options to suit your specific needs.
\o \l{Using FakeVim Mode} describes how to run the main editor in a
manner similar to the Vim editor.
\endlist
*/
/*!
\contentspage index.html
\previouspage creator-coding.html
\page creator-editor-using.html
\nextpage creator-highlighting.html
\title Using the Editor
\QC's code editor is designed to aid you in creating, editing and
navigating code. \QC's code editor is fully equipped with syntax
checking, code completion, context sensitive help and in-line error
indicators while you are typing.
\image qtcreator-edit-mode.png "Edit mode"
\section1 Using the Editor Toolbar
The editor toolbar is located at the top of the editor view. The editor
toolbar is context sensitive and shows items relevant to the file currently
open in the editor.
\image qtcreator-editortoolbar-symbols.png
Use the toolbar to navigate between open files and symbols in use.
To browse forward or backward through your location history, click
\inlineimage qtcreator-back.png
and \inlineimage qtcreator-forward.png
.
To go to any open file, select it from the \gui{Open files} drop-down menu.
Right-click the menu title and select \gui {Copy Full Path to Clipboard} to
copy the path and name of the current file to the clipboard.
To jump to any symbol used in the current file, select it from the
\gui Symbols drop-down menu. By default, the symbols are displayed in the
order in which they appear in the file. Right-click the menu title and
select \gui {Sort Alphabetically} to arrange the symbols in alphabetic
order.
\section1 Splitting the Editor View
Split the editor view when you want to work on and view multiple files on
the same screen.
\image qtcreator-spliteditorview.png
You can split the editor view in the following ways:
\list
\o To split the editor view into a top and bottom view, select
\gui Window > \gui Split or press \key{Ctrl+E, 2}.
Split command creates views below the currently active editor view.
\o To split the editor view into adjacent views, select
\gui Window > \gui{Split Side by Side} or press \key{Ctrl+E, 3}.
Side by side split command creates views to the right of the
currently active editor view.
\endlist
To move between split views, select \gui Window > \gui{Go to Next Split} or
press \key{Ctrl+E, O}.
To remove a split view, place the cursor within the view you want to
remove and select \gui Window > \gui{Remove Current Split} or press
\key{Ctrl+E, 0}. To remove all but the currently selected split view,
select \gui Window > \gui{Remove All Splits} or press \key{Ctrl+E, 1}.
\section1 Using Bookmarks
To insert or delete a bookmark right-click the line number and select
\gui{Toggle Bookmark} or press \key{Ctrl+M}.
\image qtcreator-togglebookmark.png
To go to previous bookmark in the current session, press \key{Ctrl+,}.
To go to next bookmark in the current session, press \key{Ctrl+.}.
\section1 Moving to Symbol Definition or Declaration
You can move directly to the definition or the declaration of a symbol by
holding the \key Ctrl and clicking the symbol.
To enable this moving function, in \gui Tools > \gui{Options} >
\gui{Text Editor} > \gui Behavior, select \gui{Enable mouse navigation}.
You can also select the symbol and press \key F2, or right-click the symbol
and select \gui {Follow Symbol Under Cursor} to move to its definition or
declaration. This feature is supported for namespaces, classes, methods,
variables, include statements, and macros.
To switch between the definition and declaration of a symbol, press
\key {Shift+F2} or right-click the symbol and select \gui {Switch Between
Method Declaration/Definition}.
\section1 Using Update Code Model
To refresh the internal information in \QC pertaining to your code,
select \gui{Tools} > \gui{C++} > \gui{Update Code Model}.
\note In \QC indexing updates the code automatically. Use
\gui{Update Code Model} only as an emergency command.
*/
/*!
\contentspage index.html
\previouspage creator-editor-using.html
\previouspage creator-coding-navigating.html
\page creator-highlighting.html
\nextpage creator-checking-code-syntax.html
@@ -918,7 +740,7 @@
/*!
\contentspage index.html
\previouspage creator-editor-locator.html
\previouspage qt-quick-toolbars.html
\page creator-editor-codepasting.html
\nextpage creator-macros.html
@@ -967,15 +789,10 @@
\contentspage index.html
\previouspage creator-editor-codepasting.html
\page creator-macros.html
\nextpage creator-editor-options.html
\nextpage creator-finding-overview.html
\title Using Text Editing Macros
When you have a file open in the code editor, you can record a keyboard
sequence as a macro. You can then play the macro to repeat the sequence.
You can save the latest macro and assign a keyboard shortcut for running
it or run it from the locator.
To record a text editing macro, select \gui {Tools > Macros > Record Macro}
or press \key {Alt+(}. To stop recording, select \gui {Tools > Macros >
Stop Recording Macro} or press \key {Alt+)}.
@@ -1000,9 +817,9 @@
/*!
\contentspage index.html
\previouspage creator-editor-options.html
\previouspage creator-editor-options-text.html
\page creator-editor-fakevim.html
\nextpage creator-design-mode.html
\nextpage creator-mime-types.html
\title Using FakeVim Mode
@@ -1036,116 +853,11 @@
*/
/*!
\contentspage index.html
\previouspage creator-macros.html
\page creator-editor-options.html
\nextpage creator-editor-fakevim.html
\title Configuring the Editor
\QC allows you to configure the text editor to suit your specific
needs. To configure the editor, select \gui Tools > \gui{Options} >
\gui{Text Editor}.
These settings apply to all projects. To specify editor behavior for an
open project, select \gui {Projects > Editor Settings}. For more
information, see \l{Specifying Editor Settings}.
You can also specify indentation settings separately for C++ and QML files
either globally or for the open project. For more information, see
\l{Indenting Code}.
\image qtcreator-font-colors.png "Text editor options"
You can perform the following configuration actions:
\list
\o Set the font preferences and apply color schemes for syntax
highlighting in \gui{Font & Colors}.
\o Specify \l{Generic Highlighting}
{definition files for syntax highlighting} for other types of files
than C++ or QML in \gui{Generic Highlighter}.
\o Set tabs, indentation, the handling of whitespace, and mouse
operations in \gui Behavior. For more information, see
\l{Indenting Code}.
\o Set various display properties, for example,
\l{Highlighting and folding blocks}
{highlighting and folding blocks}, text wrapping or
\l{Moving to symbol definition or declaration}
{moving to symbol definition or declaration} in \gui Display.
\o Add, modify, and remove \l{Editing Code Snippets}{code snippets} in
\gui Snippets.
\o View and remove \l{Using Text Editing Macros}{text editing macros}
in \gui Macros.
\o Configure \l{Completing Code}{code completion} in \gui Completion.
\endlist
\section2 Configuring Fonts
You can select the font family and size. You can specify a zoom setting in
percentage for viewing the text. You can also zoom in or out by pressing
\key {Ctrl++} or \key {Ctrl +-}, or by pressing \key Ctrl and rolling
the mouse button up or down. To disable the mouse wheel function, select
\gui {Tools > Options > Text Editor > Behavior} and deselect the
\gui {Enable scroll wheel zooming} check box.
Antialiasing is used by default to make text look smoother and more
readable on the screen. Deselect the \gui Antialias check box to
turn off antialiasing.
\section2 Defining Color Schemes
You can select one of the predefined color schemes for syntax highlighting
or create customized color schemes. The color schemes apply to highlighting
both C++ and QML files and generic files.
To create a color scheme:
\list 1
\o Select \gui {Tools > Options > Text Editor > Fonts & Color > Copy}.
\o Enter a name for the color scheme and click \gui OK.
\o In the \gui Foreground field, specify the color of the selected
code element.
\o In the \gui Background field, select the background
color for the code element.
The backgound of the \gui Text element determines the background of the
code editor.
\endlist
When you copy code from \QC, it is copied in both plain text and HTML
format. The latter makes sure that syntax highlighting is preserved when
pasting to a rich-text editor.
\section2 File Encoding
To define the default file encoding, select the desired encoding in
\gui {Default encoding}. By default, \QC uses the file encoding
used by your system.
*/
/*!
\contentspage index.html
\previouspage creator-completing-code.html
\page creator-indenting-code.html
\nextpage creator-editor-finding.html
\nextpage qt-quick-toolbars.html
\title Indenting Code
@@ -1353,9 +1065,9 @@
/*!
\contentspage index.html
\previouspage creator-indenting-code.html
\previouspage creator-finding-overview.html
\page creator-editor-finding.html
\nextpage creator-editor-refactoring.html
\nextpage creator-editor-locator.html
\title Finding and Replacing
@@ -1479,15 +1191,13 @@
/*!
\contentspage index.html
\previouspage creator-editor-finding.html
\previouspage creator-editor-locator.html
\page creator-editor-refactoring.html
\nextpage qt-quick-toolbars.html
\nextpage creator-editor-options.html
\title Refactoring
Code refactoring is the process of changing the code without modifying the
existing functionality of your application. By refactoring your code you
can:
Refactor code to:
\list
@@ -2013,16 +1723,13 @@
/*!
\contentspage index.html
\previouspage qt-quick-toolbars.html
\previouspage creator-editor-finding.html
\page creator-editor-locator.html
\nextpage creator-editor-codepasting.html
\nextpage creator-editor-refactoring.html
\title Searching with the Locator
The locator provides one of the easiest ways in \QC to browse through
projects, files, classes, methods, documentation and file systems. You can
find the locator in the bottom left of the \QC window.
You can find the locator in the bottom left of the \QC window.
To activate the locator, press \key Ctrl+K (\key Cmd+K on Mac OS X) or
select \gui Tools > \gui Locate.

54
doc/src/editors/creator-finding.qdoc Normal file
View File

@@ -0,0 +1,54 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-macros.html
\page creator-finding-overview.html
\nextpage creator-editor-finding.html
\title Finding
\list
\o \l{Finding and Replacing}
The incremental search highlights the matching strings in the
window while typing and the advanced search enables you to
search from currently open projects or files on the file system.
In addition, you can search for symbols when you want to
refactor code. You can also search from the search results.
\o \l{Searching with the Locator}
The locator provides one of the easiest ways in \QC to browse
through projects, files, classes, methods, documentation and
file systems.
\endlist
*/

4
doc/src/editors/creator-mime-types.qdoc
View File

@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage creator-maemo-emulator.html
\previouspage creator-editor-fakevim.html
\page creator-mime-types.html
\nextpage creator-task-lists.html
\nextpage creator-building-running.html
\title Editing MIME Types

2
doc/src/howto/creator-cli.qdoc
View File

@@ -27,7 +27,7 @@
/*!
\contentspage index.html
\previouspage creator-task-lists.html
\previouspage creator-project-generic.html
\page creator-cli.html
\nextpage creator-keyboard-shortcuts.html

4
doc/src/howto/creator-external-tools.qdoc
View File

@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage adding-plugins.html
\previouspage creator-keyboard-shortcuts.html
\page creator-editor-external.html
\nextpage creator-maemo-emulator.html
\nextpage creator-task-lists.html
\title Using External Tools

6
doc/src/howto/creator-help.qdoc
View File

@@ -27,11 +27,11 @@
/*!
\contentspage index.html
\previouspage creator-remote-compiler.html
\previouspage creator-help-overview.html
\page creator-help.html
\nextpage creator-advanced.html
\nextpage creator-faq.html
\title Getting Help
\title Using the Help Mode
\QC comes fully integrated with Qt documentation and examples using the Qt
Help plugin.

2
doc/src/howto/creator-keyboard-shortcuts.qdoc
View File

@@ -29,7 +29,7 @@
\contentspage index.html
\previouspage creator-cli.html
\page creator-keyboard-shortcuts.html
\nextpage creator-faq.html
\nextpage creator-editor-external.html
\title Keyboard Shortcuts

4
doc/src/howto/creator-sessions.qdoc
View File

@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage creator-developing-symbian.html
\previouspage creator-sharing-project-settings.html
\page creator-project-managing-sessions.html
\nextpage creator-coding.html
\nextpage creator-design-mode.html
\title Managing Sessions

4
doc/src/howto/creator-task-lists.qdoc
View File

@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage creator-mime-types.html
\previouspage creator-editor-external.html
\page creator-task-lists.html
\nextpage creator-cli.html
\nextpage creator-help-overview.html
\title Showing Task List Files in Issues Pane

4
doc/src/howto/creator-ui.qdoc
View File

@@ -76,10 +76,10 @@
\o \gui Welcome mode for opening projects.
\o \gui{\l{Using the Editor}{Edit}} mode for editing project and source
\o \gui{\l{Coding}{Edit}} mode for editing project and source
files.
\o \gui{\l{Developing Application UI}{Design}} mode for designing and
\o \gui{\l{Designing User Interfaces}{Design}} mode for designing and
developing application user interfaces. This mode is available for
UI files.

4
doc/src/howto/creator-vcs.qdoc
View File

@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage creator-project-generic.html
\previouspage creator-project-wizards.html
\page creator-version-control.html
\nextpage adding-plugins.html
\nextpage creator-configuring-projects.html
\title Using Version Control Systems

2
doc/src/howto/qtcreator-faq.qdoc
View File

@@ -21,7 +21,7 @@
/*!
\contentspage index.html
\previouspage creator-keyboard-shortcuts.html
\previouspage creator-help.html
\page creator-faq.html
\nextpage creator-tips.html

2
doc/src/linux-mobile/creator-deployment-madde.qdoc
View File

@@ -29,7 +29,7 @@
\contentspage index.html
\previouspage creator-deployment-symbian.html
\page creator-deployment-maemo.html
\nextpage creator-publishing-to-maemo-extras.html
\nextpage creator-connecting-mobile.html
\title Deploying Applications to Maemo or MeeGo Harmattan Devices

4
doc/src/linux-mobile/creator-madde-emulator.qdoc
View File

@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage creator-editor-external.html
\previouspage creator-build-process-customizing.html
\page creator-maemo-emulator.html
\nextpage creator-mime-types.html
\nextpage creator-remote-compiler.html
\title Using Maemo or MeeGo Harmattan Emulator

4
doc/src/linux-mobile/creator-publish-maemo-extras-devel.qdoc
View File

@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage creator-deployment-maemo.html
\previouspage creator-publish-ovi-meego.html
\page creator-publishing-to-maemo-extras.html
\nextpage creator-publish-ovi.html
\nextpage creator-advanced.html
\title Publishing Maemo Applications to Extras-devel

8
doc/src/linux-mobile/creator-publish-ovi-meego.qdoc
View File

@@ -29,15 +29,11 @@
\contentspage index.html
\previouspage creator-publish-ovi-maemo.html
\page creator-publish-ovi-meego.html
\nextpage creator-remote-compiler.html
\nextpage creator-publishing-to-maemo-extras.html
\title Publishing Qt Content for MeeGo Harmattan Devices
You cannot publish applications that are built with the beta version of the
MeeGo Harmattan tool chain to Nokia Store.
However, you can prepare for publishing by making sure that your application
meets the
The applications that you publish to Nokia Store, must meet the
\l{http://www.developer.nokia.com/info/sw.nokia.com/id/44affcd1-ceba-4aca-8b65-670ce2cbbd1e/MeeGo_1_2_Harmattan_Applications_Ovi_Store_Entry_Requirements.html}
{MeeGo 1.2 Harmattan Applications: Nokia Store Entry Requirements}.

2
doc/src/linux-mobile/meegodev.qdoc
View File

@@ -23,7 +23,7 @@
\contentspage index.html
\if defined(qcmanual)
\previouspage creator-sharing-project-settings.html
\previouspage creator-connecting-mobile.html
\else
\previouspage creator-developing-symbian.html
\endif

2
doc/src/overview/creator-acknowledgements.qdoc
View File

@@ -27,7 +27,7 @@
/*!
\contentspage index.html
\previouspage creator-glossary.html
\previouspage technical-support.html
\page creator-acknowledgements.html
\title Acknowledgements

66
doc/src/overview/creator-advanced.qdoc
View File

@@ -27,45 +27,69 @@
/*!
\contentspage index.html
\previouspage creator-help.html
\previouspage creator-publishing-to-maemo-extras.html
\page creator-advanced.html
\nextpage creator-os-supported-platforms.html
\title Advanced Use
\image creator_advanceduse.png
\QC attempts to meet your development needs, whether you are an
experienced Qt developer or a newcomer to Qt. When you install \QC
as a part of \QSDK, the default configuration allows you to start coding,
building, running and debugging applications with very little effort.
However, you can easily change or extend the default configuration, by
choosing a different build system, adding project wizards, integrating
external tools, or editing the standard MIME types that \QC uses
to recognize your files.
choosing a different build system or integrating external tools.
You can also use special options to start \QC from the command line and use
it mainly from the keyboard.
\list
\o \l{Supported Platforms}
You can install and run \QC on several operating systems to create
applications for multiple desktop and mobile device platforms.
\o \l{Using Other Build Systems}
\QC is integrated with cross-platform systems for build automation:
qmake and CMake. In addition, you can import generic projects that
do not use qmake or CMake, and specify that \QC ignores your build
system.
\o \l{Using Command Line Options}
You can start \QC and specify some options for running it from the
command line.
This following topics describe advanced use of \QC:
\o \l{Keyboard Shortcuts}
\QC provides various keyboard shortcuts to speed up your development
process. You can change the keyboard shortcuts, as well as import
and export keyboard shortcut mapping schemes.
\o \l{Using External Tools}
You can use external tools directly from \QC. Qt Linguist,
QML Viewer, the default text editor for your system, and the \c sort
tool are preconfigured for use. You can change their default
configurations and configure new tools.
\endlist
\section1 Related Topics
\list
\o \l{Supported Platforms}
\o \l{Adding New Custom Wizards}
\o \l{Setting Up a CMake Project}
\o \l{Setting Up a Generic Project}
\o \l{Using Version Control Systems}
\if defined(qcmanual)
\o \l{Adding Qt Designer Plugins}
\endif
\o \l{Using External Tools}
\if defined(qcmanual)
\o \l{Using Maemo or MeeGo Harmattan Emulator}
\endif
\o \l{Editing MIME Types}
\o \l{Showing Task List Files in Issues Pane}
\o \l{Using Command Line Options}
\o \l{Keyboard Shortcuts}
\o \l{Glossary}
You can load report files created by code scanning and analysis
tools to the \gui Issues output pane. You can navigate to the
corresponding source code by clicking the error message.
\endlist
*/

42
doc/src/overview/creator-deployment-overview.qdoc
View File

@@ -27,31 +27,43 @@
/*!
\contentspage index.html
\previouspage creator-running-valgrind-remotely.html
\previouspage creator-running-targets.html
\page creator-deployment.html
\nextpage creator-deployment-symbian.html
\title Deploying Applications to Mobile Devices
\title Deploying to Mobile Devices
Deploy configurations in the \gui Project mode \gui {Run Settings} handle
the packaging of the application as an executable and copying it to a
location you want to run the executable at. The files can be copied to a
location in the file system of the development PC or a mobile device.
When you are ready to publish the application on a publishing channel, you
must make sure that the installation file meets the requirements for
publishing and installing applications to the target devices. The following
sections describe the steps that you have to take to create installation
packages for publishing on different channels:
\if defined(qcmanual)
\list
\o \l{Deploying Applications to Symbian Devices}
\o \l{Deploying Applications to Maemo or MeeGo Harmattan Devices}
\o \l{Publishing Maemo Applications to Extras-devel}
\o \l{Publishing Applications to Nokia Store}
\o \l{Building with Remote Compiler}
\o \l{Deploying Applications to Symbian Devices}
When you deploy the application for the \gui{Symbian Device} target,
\QC automatically generates a Symbian installation system (SIS) file
in the project folder and copies it to the connected device. You can
sign the SIS file and wrap it in a Nokia Smart Installer for Symbian
package. You can test and debug the application on the device.
\o \l{Deploying Applications to Maemo or MeeGo Harmattan Devices}
When you deploy the application on the \gui{Maemo5} or
\gui Harmattan target, \QC generates a Debian installation package
in the build directory and copies it to the connected device. You
can test and debug the application on the device.
\endlist
\endif
\section1 Related Topics
\list
\o \l{Publishing}
When you are ready to publish the application on a publishing
channel, you must make sure that the installation file meets the
requirements for publishing and installing applications to the
target devices.
\endlist
*/

53
doc/src/overview/creator-deployment-ovi.qdoc
View File

@@ -27,42 +27,53 @@
/*!
\contentspage index.html
\previouspage creator-publishing-to-maemo-extras.html
\previouspage creator-running-valgrind-remotely.html
\page creator-publish-ovi.html
\nextpage creator-publish-ovi-symbian.html
\title Publishing Applications to Nokia Store
\title Publishing
Nokia Store is the global content market of Nokia, which reaches millions of
people worldwide. Consumers can access Nokia Store through either of these
platforms:
\image creator_publishing.png
\list
\o Nokia Store applications on mobile devices
\o Web browsers on desktop computers, laptops, netbooks, and tablets
\endlist
Consumers have access to a wide selection of content and can download
content in a few easy clicks.
You can publish applications to app stores, such as Nokia Store, and other
channels, such as Extras-devel for Maemo applications. Nokia Store is the
global content market of Nokia that consumers can access directly from Nokia
devices or through Web browsers.
The process and requirements to publish Qt applications to Nokia Store are
described in the
\l {http://www.developer.nokia.com/Community/Wiki/Guide_to_Publishing_Qt_Applications_to_the_Ovi_Store}
{Guide to Publishing Qt Applications to the Nokia Store} wiki.
This section describes how to generate installation packages that you can
publish to Nokia Store.
\if defined(qcmanual)
\list
\o \l{Publishing Qt Content for Symbian Devices}
\o \l{Publishing Qt Content for Maemo Devices}
The \gui {Publish Qt Symbian Applications to Nokia Store}
wizard ensures that your application can be published to Nokia
Store by verifying that the the application UID, vendor name,
and the capabilities used meet the Nokia Publish criteria.
\o \l{Publishing Qt Content for MeeGo Harmattan Devices}
\QC generates installation packages that you can publish to
Nokia Store. However, you must make sure that the packages meet
the requirements of the Nokia Store.
\o \l{Publishing Qt Content for Maemo Devices}
\QC generates installation packages that you can publish to
Nokia Store. However, you must make sure that the packages meet
the requirements of the Nokia Store.
\o \l{Publishing Maemo Applications to Extras-devel}
You can use the \gui {Publish for Fremantle Extras-devel Free
Repository} wizard to create a source archive and, optionally,
upload it to a build server for compiling and packaging. The
package is then moved to the Extras-devel repository that
contains free Maemo applications.
\endlist
\endif
*/

56
doc/src/overview/creator-design-overview.qdoc
View File

@@ -27,48 +27,48 @@
/*!
\contentspage index.html
\previouspage creator-editor-fakevim.html
\previouspage creator-project-managing-sessions.html
\page creator-design-mode.html
\nextpage creator-visual-editor.html
\title Developing Application UI
\title Designing User Interfaces
Large high-resolution screens, touch input, and significant graphics power
are becoming common in portable consumer devices, such as mobile phones,
media players, set-top boxes, and netbooks. To fully benefit from these
features and to create intuitive, modern-looking, fluid user interfaces,
you can use \l {http://doc.qt.nokia.com/4.7/qtquick.html}{Qt Quick}.
\image creator_designinguserinterface.png
Qt Quick consists of a rich set of user interface elements, a declarative
language for describing user interfaces, and a language runtime. A
collection of C++ APIs is used to integrate these high level features with
classic Qt applications.
You can edit QML code in the code editor or in the integrated \QMLD.
\image qtcreator-design-mode.png "Design mode"
The integration includes project management and code completion.
\if defined(qcmanual)
If you need a traditional user interface that is clearly structured and
enforces a platform look and feel, you can use the integrated \QD. You can
compose and customize your widgets or dialogs and test them using different
styles and resolutions.
\endif
The following sections describe how to develop application UI:
\QC provides two integrated visual editors, \QMLD and \QD. The integration
includes project management and code completion.
\list
\o \l{Developing Qt Quick Applications}
\if defined(qcmanual)
You can either create Qt Quick projects from scratch or import
existing projects to \QC. You can use the code editor (Edit mode)
or the visual editor (Design mode) to develop Qt Quick applications.
\o \l{Developing Widget Based Applications}
\endif
Widgets and forms created with \QD are integrated seamlessly with
programmed code by using the Qt signals and slots mechanism that
allows you to easily assign behavior to graphical elements. All
properties set in \QD can be changed dynamically within the code.
Furthermore, features such as widget promotion and custom
plugins allow you to use your own widgets with \QD.
\o \l{Optimizing Applications for Mobile Devices}
Mobile devices have been designed for use when mobile. Keep the
characteristics of mobile devices in mind when you create
applications for them.
\endlist
\section1 Related Topics
\list
\o \l{Adding Qt Designer Plugins}
You can use Qt APIs to create plugins that extend Qt applications.
This enables you to add your own widgets to \QD.
\endlist
*/

10
doc/src/overview/creator-getting-started.qdoc
View File

@@ -27,7 +27,7 @@
/*!
\contentspage index.html
\previouspage index.html
\previouspage creator-glossary.html
\page creator-getting-started.html
\nextpage creator-overview.html
@@ -40,22 +40,22 @@
\i \inlineimage creator-gs-03.png
\i \inlineimage creator-gs-04.png
\row
\i \l{IDE Overview}
\o \bold {\l{IDE Overview}}
If you have not used an integrated development environment (IDE)
before, or want to know what kind of IDE \QC is, go to
\l{IDE Overview}.
\i \l{User Interface}
\o \bold {\l{User Interface}}
If you have not used \QC before, and want to become familiar
with the parts of the user interface, go to \l{User Interface}.
\i \l{Building and Running an Example Application}
\o \bold {\l{Building and Running an Example Application}}
To check that \l{glossary-development-target}{targets} were
successfully installed as part of the \QSDK installation, open
an example application and run it. If you have not done so
before, go to \l{Building and Running an Example Application}.
\i \l{Tutorials}
\o \bold {\l{Tutorials}}
Now you are ready to start developing your own applications.
Pick a tutorial to follow in \l{Tutorials}

4
doc/src/overview/creator-glossary.qdoc
View File

@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage technical-support.html
\previouspage creator-known-issues.html
\page creator-glossary.html
\nextpage creator-acknowledgements.html
\nextpage technical-support.html
\title Glossary

82
doc/src/overview/creator-help-overview.qdoc Normal file
View File

@@ -0,0 +1,82 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-task-lists.html
\page creator-help-overview.html
\nextpage creator-help.html
\title Getting Help
\image creator_gettinghelp.png
\list
\o \l{Using the Help Mode}
\QC comes fully integrated with Qt documentation and examples using
the Qt Help plugin. You can add external documentation to the
\gui Help mode and filter the documents displayed to find relevant
information faster. In addition, you can add bookmarks to help
pages.
\o \l{FAQ}
Contains answers to some frequently asked questions about \QC.
\o \l{Tips and Tricks}
Lists useful Qt Creator features.
\o \l{Known Issues}
Lists known issues in \QC version \qtcversion. The development team
is aware of them, and therefore, you do not need to report them as
bugs.
\o \l{Glossary}
Lists special terms used in \QC.
\endlist
\section1 Related Topics
\list
\o \l{Technical Support}
Lists Qt support sites and other useful sites.
\o \l{Acknowledgements}
Lists the third-party components in \QC.
\endlist
*/

2
doc/src/overview/creator-issues.qdoc
View File

@@ -29,7 +29,7 @@
\contentspage index.html
\previouspage creator-tips.html
\page creator-known-issues.html
\nextpage technical-support.html
\nextpage creator-glossary.html
\title Known Issues

81
doc/src/overview/creator-mobile-targets.qdoc Normal file
View File

@@ -0,0 +1,81 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-deployment-maemo.html
\page creator-connecting-mobile.html
\nextpage creator-developing-meego.html
\title Connecting Mobile Targets
You can connect mobile devices to the development PC to build, run, debug,
and analyze applications on them from \QC. When you install mobile targets
as part of the \QSDK, the build and run settings for the target devices are
set up automatically in \QC. Currently, the tool chain for building
applications for generic Linux devices is not included in \QSDK.
You can connect the device to the development PC using a USB connection.
Additionally, you can connect Linux-based devices by using a WLAN
connection.
\list
\o \l{Connecting Generic Linux Devices}
If you have the tool chain for building applications for generic
Linux devices (with no MADDE support) installed on the development
PC, you can add it to \QC. Create device configurations and select
them in the \QC run settings.
\o \l{Connecting MeeGo Harmattan Devices}
MeeGo Harmattan is a Linux-based software platform developed by
Nokia and preinstalled on Nokia N950 and Nokia N9. It enables
developers to create applications using the Qt framework.
Use the SDK Connectivity tool that is preinstalled on the device to
create the device-side end point for USB and WLAN connections.
\o \l{Connecting Maemo Devices}
Maemo 5 (Fremantle) is a Linux-based software platform developed by
Nokia and delivered on the Nokia N900. Use a connectivity tool (Mad
Developer) to create the device-side end point for USB and WLAN
connections.
\o \l{Connecting Symbian Devices}
You can run Qt applications on Symbian devices if the software
that Qt applications require (typically Qt, Qt Mobility, QtWebkit,
and Open C) is installed on the device. On Symbian Anna and later
devices, some version of Qt is pre-installed.
Install and launch the CODA on-device debugging agent on the
devices and connect the devices to the development PC.
\endlist
*/

384
doc/src/overview/creator-overview.qdoc
View File

@@ -41,324 +41,78 @@
application development life-cycle, from creating a project to deploying the
application on the target platforms.
\image qtcreator-overview.png "Overview"
\table
\row
\o \inlineimage creator_managingprojects.png
\o \inlineimage creator_designinguserinterface.png
\o \inlineimage creator_coding.png
\row
\o \bold {\l{Managing Projects}}
\section1 Cross-platform Development
To be able to build and run applications, \QC needs the same
information as a compiler would need. This information is
specified in the project settings.
One of the major advantages of \QC is that it allows a team of developers
to share a project across different development platforms with a common tool
for development and debugging.
Setting up a new project in \QC is aided by a wizard that guides
you step-by-step through the project creation process, creates
the necessary files, and specifies settings depending on the
choices you make. For more information, see
\l{Managing Projects}.
\o \bold {\l{Designing User Interfaces}}
The recommended way to build a project is to use a version control system.
Store and edit only project source files and build system configuration
files (for example, .pro and .pri files for qmake). Do not store files
generated by the build system or \QC, such as makefiles, .pro.user, and
object files. Other approaches are possible, but we recommend that you do
not use network resources, for example.
\QC allows you to specify separate build settings for each development
platform. By default, \l{glossary-shadow-build}{shadow builds} are used to
keep the build specific files separate from the source.
You can create separate versions of project files to keep platform-dependent
code separate. You can use qmake
\l{http://qt.nokia.com/doc/4.7/qmake-tutorial.html#adding-platform-specific-source-files}
{scopes} to select the file to process depending on which platform qmake is
run on.
Items such as open files, breakpoints, and evaluated expressions are stored
in sessions. They are not considered to be part of the information shared
across platforms.
\section1 Creating Projects
But why do you need projects? To be able to build and run applications,
\QC needs the same information as a compiler would need. This information
is specified in the project build and run settings.
Creating a project allows you to:
\list
\o Group files together
\o Add custom build steps
\o Include forms and resource files
\o Specify settings for running applications
\endlist
Setting up a new project in \QC is aided by a wizard that guides you
step-by-step through the project creation process. In the first step, you
select the type of the project. Next, you select a location for the project
and specify settings for it.
\image qtcreator-new-qt-quick-project-wizard.png
When you have completed the steps, \QC automatically generates the project
with required headers, source files, user interface descriptions and project
files, as defined by the wizard.
For example, if you choose to create a Qt Quick application, \QC generates a
QML file that you can modify with the integrated \QMLD.
\section2 Adding Libraries
In addition to Qt libraries, you can link your application to other
libraries, such as system libraries or your own libraries. Further, your
own libraries might link to other libraries. To be able to compile your
project, you must add the libraries to your project. This also enables
code completion and syntax highlighting for the libraries.
The procedure of adding a library to a project depends on the build
system that you use.
\section2 Version Control Systems
\QC uses the version control system's command line clients to access your
repositories. The following version control systems are supported:
\list
\o Git
\o Subversion
\o Perforce
\o CVS
\o Mercurial
\o Bazaar
\endlist
The functions available to you in \QC depend on the version control system.
Basic functions are available for all the supported systems. They include
comparing files with the latest versions stored in the repository and
displaying the differences, viewing versioning history and change details,
annotating files, and committing and reverting changes.
\section1 Designing User Interfaces
\if defined(qcmanual)
\QC provides two integrated visual editors, \QMLD and \QD.
\image qtcreator-ui-designers.png "Qt Quick Designer and Qt Designer"
\endif
Large high-resolution screens, touch input, and significant graphics power
are becoming common in portable consumer devices, such as mobile
phones, media players, set-top boxes, and netbooks. To fully benefit from
these features and to create intuitive, modern-looking, fluid user
interfaces, you can use \l {http://doc.qt.nokia.com/4.7/qtquick.html}
{Qt Quick}.
Qt Quick consists of a rich set of user interface elements, a declarative
language for describing user interfaces, and a language runtime. A
collection of C++ APIs is used to integrate these high level features with
classic Qt applications.
You can edit QML code in the code editor or in the integrated \QMLD.
The integration includes project management and code completion.
\if defined(qcmanual)
If you need a traditional user interface that is clearly structured and
enforces a platform look and feel, you can use the integrated \QD. You can
compose and customize your widgets or dialogs and test them using different
styles and resolutions.
\endif
\section1 Code Editor
As an IDE, \QC differs from a text editor in that it knows how to build and
run applications. It understands the C++ and QML languages as code, not just
as plain text. This allows it to:
\list
\o Enable you to write well formatted code
\o Anticipate what you are going to write and complete the code
\o Display inline error and warning messages
\o Enable you to semantically navigate to classes, functions, and
symbols
\o Provide you with context-sensitive help on classes, functions, and
symbols
\o Rename symbols in an intelligent way, so that other symbols with the
same name that belong to other scopes are not renamed
\o Show you the locations in code where a function is declared or
called
\endlist
You can use the code editor to write code in Qt C++ or in the QML
declarative programming language. QML is an extension to JavaScript, that
provides a mechanism to declaratively build an object tree of QML elements.
QML improves the integration between JavaScript and Qt's existing QObject
based type system, adds support for automatic property bindings and provides
network transparency at the language level.
\section1 Building
\QC is integrated with cross-platform systems for build automation: qmake
and CMake. In addition, you can import generic projects that do not use
qmake or CMake, and specify that \QC ignores your build system.
\if defined(qcmanual)
\QC provides support for building and running Qt applications for desktop
environment (Windows, Linux, and Mac OS) and mobile devices (Symbian, Maemo,
and MeeGo Harmattan). Build settings allow you to quickly switch between
build targets.
\endif
When you install tool chains for build targets as part of the \QSDK, the
build and run settings for mobile device targets are set up automatically.
However, you might need to install and configure some additional software on
the devices to be able to connect to them from the development PC.
\note The only supported build system for mobile applications in \QC is
qmake.
\section1 Testing
If you install \QC as part of \QSDK, the GNU Symbolic Debugger is installed
automatically and you should be ready to start debugging after you create a
new project. However, you can change the setup to use debugging tools for
Windows, for example. You can connect mobile devices to your development PC
and debug processes running on the devices.
You can use code analysis tools to detect memory leaks, profile cache usage,
and profile Qt Quick applications.
You can test applications that are intended for mobile devices in a
simulator or emulator, but you also need to test the applications on real
devices.
\section2 Debuggers
\QC is integrated to several external native debuggers:
\list
\o GNU Symbolic Debugger (GDB)
\o Microsoft Console Debugger (CDB)
\o internal JavaScript debugger
\endlist
You can use the \QC \gui Debug mode to inspect the state of your application
while debugging. You can interact with the debugger in several ways,
including the following:
\list
\o Go through a program line-by-line or instruction-by-instruction.
\o Interrupt running programs.
\o Set breakpoints.
\o Examine the contents of the call stack.
\o Examine and modify registers and memory contents of
the debugged program.
\o Examine and modify registers and memory contents of
local and global variables.
\o Examine the list of loaded shared libraries.
\o Create snapshots of the current state of the debugged program
and re-examine them later.
\endlist
\QC displays the raw information provided by the native debuggers in a clear
and concise manner with the goal to simplify the debugging process as much
as possible without losing the power of the native debuggers.
In addition to the generic IDE functionality provided by stack view, views
for locals and expressions, registers, and so on, \QC includes features to
make debugging Qt-based applications easy. The debugger plugin understands
the internal layout of several Qt classes, for example, QString, the Qt
containers, and most importantly QObject (and classes derived from it), as
well as most containers of the C++ Standard Library and some GCC extensions.
This deeper understanding is used to present objects of such classes in a
useful way.
\section3 QML Script Console
You can use the \QC \gui Debug mode to inspect the state of the application
while debugging JavaScript functions. You can set breakpoints, view call
stack trace, and examine locals and expressions.
When the application is interrupted by a breakpoint, you can use the
\gui {QML Script Console} to execute JavaScript expressions in the current
context. You can type JavaScript expressions and use them to get information
about the state of the application, such as property values.
If you change property values or add properties in the code editor, the
changes are updated in the running application when they are saved.
\section3 QML Inspector
While the application is running, you can use the \gui {QML Inspector} view
to explore the object structure, debug animations, and inspect colors. When
debugging complex applications, you can use the inspection mode to jump to
the position in code where an element is defined.
\section2 Code Analysis Tools
The memory available on devices is limited and you should use it carefully.
\QC integrates Valgrind code analysis tools for detecting memory
leaks and profiling function execution. These tools are only supported on
Linux and Mac OS, but you can run them remotely from Windows. You must
download and install them separately to use them from \QC.
The QML Profiler is installed as part of \QC. It allows you
to profile your Qt Quick applications and is available on all supported
development platforms.
\section2 Qt Simulator
You can use the Qt Simulator to test Qt applications that are intended
for mobile devices in an environment similar to that of the device. You
can change the information that the device has about its configuration
and environment.
Qt Simulator does not support any device specific APIs by design. Therefore,
applications that run well on Qt Simulator also run on any device that hosts
the Qt and Qt Mobility libraries. However, this means that you cannot use
Qt Simulator to test applications that use device specific libraries, such
as Symbian C++ APIs. To test such applications, use the device emulators or
real devices.
The Qt Simulator is installed as part of the \QSDK. After it is
installed, you can select it as a build target in \QC.
\if defined(qcmanual)
\input linux-mobile/madde-emulator-overview.qdocinc
\endif
\section1 Deploying
\QC deploy configurations handle the packaging of the application as an
executable and copying it to a location developers want to run the
executable at. The files can be copied to a location in the file system of
the development PC or to a mobile device.
\QC allows you to create installation packages for mobile devices that are
suitable for publishing to Nokia Store and other channels.
To create intuitive, modern-looking, fluid user interfaces, you
can use \l {http://doc.qt.nokia.com/4.7/qtquick.html}{Qt Quick}.
If you need a traditional user interface that is clearly
structured and enforces a platform look and feel, you can use
the integrated \QD. For more information, see
\l{Designing User Interfaces}.
\o \bold {\l{Coding}}
As an IDE, \QC differs from a text editor in that it knows how
to build and run applications. It understands the C++ and QML
languages as code, not just as plain text. This enables it to
provide you with useful features, such as semantic highlighting,
checking code syntax, code completion, and refactoring actions.
For more information, see \l{Coding}.
\row
\o \inlineimage creator_buildingrunning.png
\o \inlineimage creator_testing.png
\o \inlineimage creator_publishing.png
\row
\o \bold {\l{Building and Running}}
\QC is integrated with cross-platform systems for build
automation: qmake and CMake. In addition, you can import
projects as \e {generic projects} and fully control the steps
and commands used to build the project.
\QC provides support for building, running, and deploying Qt
applications for desktop environment and mobile devices. Build,
run, and deployment settings allow you to quickly switch between
targets.
For more information, see \l{Building and Running}.
\o \bold {\l{Debugging and Analyzing}}
\QC is integrated to several external native debuggers: GNU
Symbolic Debugger (GDB), Microsoft Console Debugger (CDB), and
and internal JavaScript debugger. In the \gui Debug mode, you
can inspect the state of your application while debugging.
The memory and CPU power available on devices are limited and
you should use them carefully. \QC integrates Valgrind code
analysis tools for detecting memory leaks and profiling function
execution. In addition, the QML Profiler enables you to profile
Qt Quick applications.
For more information, see \l{Debugging and Analyzing}.
\o \bold {\l{Publishing}}
\QC allows you to create installation packages for mobile
devices that are suitable for publishing to application stores
and other channels. For more information, see
\l{Publishing}.
\endtable
*/

2
doc/src/overview/creator-supported-platforms.qdoc
View File

@@ -30,7 +30,7 @@
\contentspage index.html
\previouspage creator-advanced.html
\page creator-os-supported-platforms.html
\nextpage creator-project-wizards.html
\nextpage creator-project-other.html
\title Supported Platforms

4
doc/src/overview/creator-tech-support.qdoc
View File

@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage creator-known-issues.html
\previouspage creator-glossary.html
\page technical-support.html
\nextpage creator-glossary.html
\nextpage creator-acknowledgements.html
\title Technical Support

59
doc/src/overview/creator-testing.qdoc Normal file
View File

@@ -0,0 +1,59 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-remote-compiler.html
\page creator-testing.html
\nextpage creator-debugging.html
\title Debugging and Analyzing
\image creator_testing.png
\list
\o \l{Debugging}
If you install \QC as part of \QSDK, the GNU Symbolic Debugger
is installed automatically and you should be ready to start
debugging after you create a new project. However, you can
change the setup to use debugging tools for Windows, for
example. You can connect mobile devices to your development PC
and debug processes running on the devices.
\o \l{Analyzing Code}
\QC integrates Valgrind code analysis tools for detecting memory
leaks and profiling function execution. You must download and
install them separately to use them from \QC. The QML Profiler is
installed as part of \QC. It enables you to profile your Qt Quick
applications.
\endlist
*/

23
doc/src/overview/creator-tutorials.qdoc
View File

@@ -33,30 +33,25 @@
\title Tutorials
\image creator-gs-04.png
You can use \QC to create applications for several platforms by using
several technologies. The tutorials in this manual explain how to create
some basic applications.
\table
\row
\i
\i
\i
\row
\list
\o \l{Creating a Qt Quick Application}
To learn about the basic Qt Quick concepts and QML elements, go
to \l{Creating a Qt Quick Application}.
Learn about the basic Qt Quick concepts and QML elements.
\o \l{Creating a Qt Quick Application Using Qt Quick Components}
To learn how to develop a Qt Quick application for mobile
devices, go to
\l{Creating a Qt Quick Application Using Qt Quick Components}.
Learn how to develop a Qt Quick application for mobile devices.
\o \l{Creating a Qt Widget Based Application}
To learn how to create a Qt widget based application for
the desktop, go to \l{Creating a Qt Widget Based Application}.
\endtable
Learn how to create a Qt widget based application for the desktop.
\endlist
*/

8
doc/src/overview/mobile-app-design.qdoc
View File

@@ -27,18 +27,16 @@
/*!
\contentspage index.html
\previouspage creator-using-qt-designer.html
\previouspage adding-plugins.html
\page creator-usability.html
\nextpage creator-building-running.html
\nextpage creator-coding.html
\title Optimizing Applications for Mobile Devices
Before starting application development, analyze and define the
requirements, scope, and functionality of the application to ensure
efficient functionality and a smooth user experience. Design the application
for a single purpose and analyze how it can best serve its users. Mobile
devices have been designed for use when mobile. Keep the characteristics
of mobile devices in mind when you create applications for them.
for a single purpose and analyze how it can best serve its users.
The following guidelines help you design and develop usable applications for
mobile devices with varying characteristics, such as screen size and support

94
doc/src/projects/creator-projects-building-running.qdoc
View File

@@ -27,44 +27,92 @@
/*!
\contentspage index.html
\previouspage creator-usability.html
\previouspage creator-mime-types.html
\page creator-building-running.html
\nextpage creator-building-targets.html
\title Building and Running Applications
\title Building and Running
\image creator_buildingrunning.png
\QC provides support for building, running, and deploying Qt applications
for different \l{glossary-development-target}{targets}.
You can set up the following configurations:
\list
\o \l{Building for Multiple Targets}
\o \e {Build configuration}, which contains everything you need to
compile the sources into binaries.
\e {Build configurations} contain everything you need to compile
the sources into binaries.
\o \e {Deploy configuration}, which handles the packaging and copying
of the necessary files to a location you want to run the executable
at. The files can be copied to a location in the file system of the
development PC or a mobile device.
\o \l{Running on Multiple Targets}
\o \e {Run configuration}, which starts the application in the location
where it was stored by the deploy configuration.
\e {Run configurations} start the application in the location
where it was copied by the \e{deploy configuration}. By default,
when you select the \gui Run function, \QC builds the project,
deploys it to the selected target, and runs it there. However,
if you have not made any changes to the project since you last
built and deployed it, \QC simply runs it again.
\o \l{Deploying to Mobile Devices}
\e {Deploy configurations} handle the packaging and copying of
the necessary files to a location you want to run the executable
at. The files can be copied to a location in the file system of
the development PC or a mobile device.
\o \l{Connecting Mobile Targets}
When you install tool chains for build targets as part of the \QSDK,
the build and run settings for mobile device targets are set up
automatically. However, you might need to install and configure some
additional software on the devices to be able to connect to them
from the development PC.
\endlist
By default, when you select the \gui Run function, \QC builds the project,
deploys it to the selected target, and runs it there. However, if you have
not made any changes to the project since you last built and deployed it,
\QC simply runs it again.
\section1 Related Topics
To specify the relationship between the release, build,
and deploy configurations, select \gui {Tools > Options > Project}. By
default, the \gui {Always build project before deploying it} and the
\gui {Always deploy project before running it} options are enabled.
Therefore, when you select the \gui Run function, \QC checks for changes in
the project files and also builds and deploys the project if necessary.
\list
\image qtcreator-project-options-deploy.png "Project General Options"
\o \l{Customizing the Build Process}
By default, running an application also builds it and deploys it to
a location from where it can be run on the target. You can change
the relationship between the build, run, and deploy configurations.
\o \l{http://doc.qt.nokia.com/qtsimulator/index.html}
{Using Qt Simulator}
You can use the Qt Simulator to test Qt applications that are
intended for mobile devices in an environment similar to that of
the device. You can change the information that the device has
about its configuration and environment.
Qt Simulator does not support any device specific APIs by design.
Therefore, applications that run well on Qt Simulator also run on
any device that hosts the Qt and Qt Mobility libraries.
The Qt Simulator is installed as part of the \QSDK. After it is
installed, you can select it as a build target in \QC.
\o \l{Using Maemo or MeeGo Harmattan Emulator}
You cannot use Qt Simulator to test applications that use device
specific libraries, such as native device APIs. To test such
applications, use the device emulators or real devices. With the
emulators, you can test how your application reacts to hardware
controls, such as the power button, and to the touch screen.
Usually, it is faster to test on a real device connected to the
development PC than to use the emulators. The emulator is installed
as part of the \QSDK.
\o \l{Building with Remote Compiler}
You can use a compilation service at Nokia Developer to build Qt
applications and create installation packages for mobile device
targets when you do not have the necessary tool chains and SDKs
installed or they are not supported on the development PC. You can
choose from a set of supported devices. You can install the Remote
Compiler target as part of the \QSDK.
\endlist
*/

2
doc/src/projects/creator-projects-building.qdoc
View File

@@ -31,7 +31,7 @@
\page creator-building-targets.html
\nextpage creator-running-targets.html
\title Building Applications for Multiple Targets
\title Building for Multiple Targets
You can build applications for multiple \l{glossary-development-target}
{targets}. By default, when you run the application on a target, you

45
doc/src/projects/creator-projects-builds-customizing.qdoc Normal file
View File

@@ -0,0 +1,45 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-developing-symbian.html
\page creator-build-process-customizing.html
\nextpage creator-maemo-emulator.html
\title Customizing the Build Process
To specify the relationship between the release, build,
and deploy configurations, select \gui {Tools > Options > Project}. By
default, the \gui {Always build project before deploying it} and the
\gui {Always deploy project before running it} options are enabled.
Therefore, when you select the \gui Run function, \QC checks for changes in
the project files and also builds and deploys the project if necessary.
\image qtcreator-project-options-deploy.png "Project General Options"
*/

2
doc/src/projects/creator-projects-cmake.qdoc
View File

@@ -27,7 +27,7 @@
/*!
\contentspage index.html
\previouspage creator-project-wizards.html
\previouspage creator-project-other.html
\page creator-project-cmake.html
\nextpage creator-projects-autotools.html

89
doc/src/projects/creator-projects-creating.qdoc
View File

@@ -33,7 +33,73 @@
\title Creating Projects
\image qtcreator-new-project.png
Creating a project enables you to:
\list
\o Group files together
\o Add custom build steps
\o Include forms and resource files
\o Specify settings for running applications
\endlist
Setting up a new project in \QC is aided by a wizard that guides you
step-by-step through the project creation process. The wizards prompt you
to enter the settings needed for that particular type of project and create
the necessary files for you. You can add your own custom wizards to
standardize the way subprojects and classes are added to a project.
The wizards create projects that use the Qt build tool, qmake. It is a
cross-platform system for build automation that helps simplify the build
process for development projects across different platforms. qmake
automates the generation of build configurations so that only a few lines
of information are needed to create each configuration. For more
information about qmake, see the
\l{http://qt.nokia.com/doc/4.7/qmake-manual.html}{qmake Manual}.
You can modify the build and run settings for qmake projects in the
\gui Projects mode.
Alternatively, you can use the CMake build automation system and set up the
projects manually. In addition, you can import projects as
\e {generic projects} that do not use qmake or CMake. This enables you to
use \QC as a code editor and to fully control the steps and commands used to
build the project.
\if defined(qcmanual)
To develop applications for Symbian devices, you use qmake and the local
Symbian compiler (on Windows) or qmake and a compilation service at
Nokia Developer (on Linux and Mac OS) to build the applications for the
Symbian devices target. The interface to the compilation service,
Remote Compiler, is installed as a part of the \QSDK. For more information,
see \l{Building with Remote Compiler}.
\endif
You can install mobile device \l{glossary-development-target}{targets}
as part of the \QSDK. The build and run settings for the
installed targets are set up automatically. However, you might need to
install and configure some additional software on the devices to be able to
connect to them from the development PC.
\section1 Using Project Wizards
In the first step, you
select the type of the project. Next, you select a location for the project
and specify settings for it.
\image qtcreator-new-qt-quick-project-wizard.png
When you have completed the steps, \QC automatically generates the project
with required headers, source files, user interface descriptions and project
files, as defined by the wizard.
For example, if you choose to create a Qt Quick application, \QC generates a
QML file that you can modify with the integrated \QMLD.
\section1 Selecting Project Type
You can use wizards to create following types of projects:
@@ -95,7 +161,7 @@
\gui {Target Setup} dialog. Follow the instructions of the wizard.
For examples of creating different types of projects, see
\l{Getting Started}.
\l{Tutorials}.
For more information about creating Qt Quick projects, see
\l {Creating Qt Quick Projects}.
@@ -197,6 +263,14 @@
\section1 Adding Subprojects to Projects
In addition to Qt libraries, you can link your application to other
libraries, such as system libraries or your own libraries. Further, your
own libraries might link to other libraries. To be able to compile your
project, you must add the libraries to your project. This also enables
code completion and syntax highlighting for the libraries.
The procedure of adding a library to a project depends on the build
system that you use.
When you create a new project, you can add it to another project as a
subproject in the \gui{Project Management} dialog. However, the root project
must specify that qmake uses the \c subdirs template to build the project.
@@ -220,4 +294,15 @@
To specify dependencies, use the \gui{Add Library} wizard. For more
information, see \l{Adding Libraries to Projects}.
\section1 Related Topics
\list
\o \l{Opening Projects}
\o \l{Adding Libraries to Projects}
\o \l{Adding New Custom Wizards}
\o \l{Setting Up a CMake Project}
\o \l{Setting Up a Generic Project}
\endlist
*/

4
doc/src/projects/creator-projects-custom-wizards.qdoc
View File

@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage creator-os-supported-platforms.html
\previouspage creator-project-qmake-libraries.html
\page creator-project-wizards.html
\nextpage creator-project-cmake.html
\nextpage creator-version-control.html
\title Adding New Custom Wizards

5
doc/src/projects/creator-projects-generic.qdoc
View File

@@ -29,13 +29,10 @@
\contentspage index.html
\previouspage creator-projects-autotools.html
\page creator-project-generic.html
\nextpage creator-version-control.html
\nextpage creator-cli.html
\title Setting Up a Generic Project
\QC supports generic projects, so you can import existing projects
that do not use qmake or CMake and \QC ignores your build system.
Generic project support allows you to use \QC as a code editor. You
can change the way your project is built by modifying the \c make command
in the \gui{Projects} mode under \gui{Build Settings}.

2
doc/src/projects/creator-projects-libraries.qdoc
View File

@@ -29,7 +29,7 @@
\contentspage index.html
\previouspage creator-project-opening.html
\page creator-project-qmake-libraries.html
\nextpage creator-configuring-projects.html
\nextpage creator-project-wizards.html
\title Adding Libraries to Projects

60
doc/src/projects/creator-projects-other.qdoc Normal file
View File

@@ -0,0 +1,60 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-os-supported-platforms.html
\page creator-project-other.html
\nextpage creator-project-cmake.html
\title Using Other Build Systems
\QC project wizards create projects that are configured to use qmake. Most
of the instructions in this manual apply to using qmake.
\list
\o \l{Setting Up a CMake Project}
CMake is an alternative to qmake for automating the generation of
build configurations.
\o \l{Setting Up an Autotools Project}
\QC can open projects that use the Autotools build system. You can
build and run the projects directly from \QC.
\o \l{Setting Up a Generic Project}
\QC supports generic projects, so you can import existing projects
that do not use qmake or CMake. This enables you to use \QC as a
code editor and to fully control the steps and commands used to
build the project.
\endlist
*/

122
doc/src/projects/creator-projects-overview.qdoc
View File

@@ -33,102 +33,52 @@
\title Managing Projects
To set up a project, you first have to decide what kind of an application
you want to develop. Do you want a user interface based on:
\image creator_managingprojects.png
One of the major advantages of \QC is that it allows a team of developers
to share a project across different development platforms with a common tool
for development and debugging.
\list
\o Qt Quick
\o HTML5
\if defined(qcmanual)
\o Qt widgets
\endif
\endlist
For a Qt Quick or HTML5 project, you also have a choice of the language to
implement the application logic: C++ or JavaScript.
You can also create other kinds of projects, such as Qt console
applications, shared or static C++ libraries, or subprojects.
You can use wizards to create and import projects. The wizards prompt you
to enter the settings needed for that particular type of project and create
the necessary files for you. You can add your own custom wizards to
standardize the way subprojects and classes are added to a project.
The wizards set up projects to use the Qt build tool, qmake. It is a
cross-platform system for build automation that helps simplify the build
process for development projects across different platforms. qmake
automates the generation of build configurations so that only a few lines
of information are needed to create each configuration. For more
information about qmake, see the
\l{http://qt.nokia.com/doc/4.7/qmake-manual.html}{qmake Manual}.
You can modify the build and run settings for qmake projects in the
\gui Projects mode.
Alternatively, you can use the CMake build automation system and set up the
projects manually. In addition, you can import generic projects that do not
use qmake or CMake. This allows you to use \QC as a code editor. For
generic projects, \QC ignores your build system.
\if defined(qcmanual)
To develop applications for Symbian devices, you use qmake and the local
Symbian compiler (on Windows) or qmake and a compilation service at
Nokia Developer (on Linux and Mac OS) to build the applications for the
Symbian devices target. The interface to the compilation service,
Remote Compiler, is installed as a part of the \QSDK. For more information,
see \l{Building with Remote Compiler}.
\endif
You can install mobile device \l{glossary-development-target}{targets}
as part of the \QSDK. The build and run settings for the
installed targets are set up automatically. However, you might need to
install and configure some additional software on the devices to be able to
connect to them from the development PC.
You can use sessions to store personal data, such as bookmarks and
breakpoints that are usually not of interest to other developers working on
the same projects. Sessions allow you to quickly switch between projects
when you work on several projects.
The following sections describe how to manage projects:
\list
\o \l{Creating Projects}
\o \l{Opening Projects}
\o \l{Adding Libraries to Projects}
To set up a project, you first have to decide what kind of an
application you want to develop: do you want a user interface based
on Qt Quick or HTML5 or Qt widgets. Second, you have to choose the
language to implement the application logic: C++ or JavaScript.
\o \l{Using Version Control Systems}
The recommended way to set up a project is to use a version control
system. Store and edit only project source files and build system
configuration files (for example, .pro and .pri files for qmake).
Do not store files generated by the build system or \QC, such as
makefiles, .pro.user, and object files.
\o \l{Configuring Projects}
\list
\o \l{Specifying Build Settings}
\list
\o \l{Adding Qt Versions}
\o \l{Adding Tool Chains}
\endlist
\o \l{Specifying Run Settings}
\o \l{Specifying Editor Settings}
\o \l{Specifying Code Style Settings}
\o \l{Specifying Dependencies}
\endlist
\if defined(qcmanual)
\o \l{Connecting Maemo Devices}
\o \l{Connecting MeeGo Harmattan Devices}
\o \l{Connecting Generic Linux Devices}
\o \l{Connecting Symbian Devices}
\endif
\QC allows you to specify separate build settings for each
development platform. By default, \l{glossary-shadow-build}
{shadow builds} are used to keep the build specific files separate
from the source. You can create separate versions of project files
to keep platform-dependent code separate. You can use qmake
\l{http://qt.nokia.com/doc/4.7/qmake-tutorial.html#adding-platform-specific-source-files}
{scopes} to select the file to process depending on which platform
qmake is run on.
\o \l{Managing Sessions}
Items such as open files, breakpoints, and evaluated expressions
are stored in sessions. They are not considered to be part of
the information shared across platforms.
\endlist
For advanced options, see the following topics:
\section1 Related Topics
\list
\o \l{Adding New Custom Wizards}
\o \l{Setting Up a CMake Project}
\o \l{Setting Up a Generic Project}
\o \l{Using Other Build Systems}
\endlist
*/

4
doc/src/projects/creator-projects-running.qdoc
View File

@@ -29,9 +29,9 @@
\contentspage index.html
\previouspage creator-building-targets.html
\page creator-running-targets.html
\nextpage creator-debugging.html
\nextpage creator-deployment.html
\title Running Applications on Multiple Targets
\title Running on Multiple Targets
By default, running an application also builds it and deploys it to a
location from where it can be run on the desktop, in Qt Simulator, or

4
doc/src/projects/creator-projects-settings-overview.qdoc
View File

@@ -27,7 +27,7 @@
/*!
\contentspage index.html
\previouspage creator-project-qmake-libraries.html
\previouspage creator-version-control.html
\page creator-configuring-projects.html
\nextpage creator-build-settings.html
@@ -56,7 +56,7 @@
\list
\o \l{Running Applications on Multiple Targets}{Targets}
\o \l{Running on Multiple Targets}{Targets}
(If you have installed the development environment for only one
target, the \gui Targets tab is replaced by a \gui Build tab and a
\gui Run tab.)

2
doc/src/projects/creator-projects-settings-sharing.qdoc
View File

@@ -29,7 +29,7 @@
\contentspage index.html
\previouspage creator-build-dependencies.html
\page creator-sharing-project-settings.html
\nextpage creator-developing-meego.html
\nextpage creator-project-managing-sessions.html
\title Sharing Project Settings

4
doc/src/projects/creator-remote-compiler.qdoc
View File

@@ -27,9 +27,9 @@
/*!
\contentspage index.html
\previouspage creator-publish-ovi-meego.html
\previouspage creator-maemo-emulator.html
\page creator-remote-compiler.html
\nextpage creator-help.html
\nextpage creator-testing.html
\title Building with Remote Compiler

212
doc/src/qtcreator.qdoc
View File

@@ -29,26 +29,102 @@
/*!
\contentspage{index.html}{Qt Creator}
\page index.html
\nextpage creator-getting-started.html
\nextpage creator-overview.html
\title Qt Creator Manual
\section1 Version \qtcversion
\QC provides a cross-platform, complete integrated development environment
(IDE) for application developers to create applications for multiple desktop
and mobile device platforms. It is available for Linux, Mac OS X and Windows
operating systems. For more information, see \l{Supported Platforms}.
\QC provides a cross-platform, complete integrated development
environment (IDE) for application developers to create applications for
multiple desktop and mobile device platforms. It is available for Linux,
Mac OS X and Windows operating systems. For more information, see
\l{Supported Platforms}.
\table
\row
\o \inlineimage creator_gettingstarted.png
\o \inlineimage creator_managingprojects.png
\o \inlineimage creator_designinguserinterface.png
\row
\o \bold {\l{Getting Started}}
\list
\o \l{IDE Overview}
\o \l{User Interface}
\o \l{Building and Running an Example Application}
\o \l{Tutorials}
\endlist
\o \bold {\l{Managing Projects}}
\list
\o \l{Creating Projects}
\o \l{Using Version Control Systems}
\o \l{Configuring Projects}
\o \l{Managing Sessions}
\endlist
\o \bold {\l{Designing User Interfaces}}
\list
\o \l{Developing Qt Quick Applications}
\o \l{Developing Widget Based Applications}
\o \l{Optimizing Applications for Mobile Devices}
\endlist
\row
\o \inlineimage creator_coding.png
\o \inlineimage creator_buildingrunning.png
\o \inlineimage creator_testing.png
\row
\o \bold {\l{Coding}}
\list
\o \l{Writing Code}
\o \l{Finding}
\o \l{Refactoring}
\o \l{Configuring the Editor}
\endlist
\o \bold {\l{Building and Running}}
\list
\o \l{Building for Multiple Targets}
\o \l{Running on Multiple Targets}
\o \l{Deploying to Mobile Devices}
\o \l{Connecting Mobile Targets}
\endlist
\o \bold {\l{Debugging and Analyzing}}
\list
\o \l{Debugging}
\o \l{Analyzing Code}
\endlist
\row
\o \inlineimage creator_publishing.png
\o \inlineimage creator_advanceduse.png
\o \inlineimage creator_gettinghelp.png
\row
\o \bold {\l{Publishing}}
\list
\o \l{Publishing Qt Content for Symbian Devices}
\o \l{Publishing Qt Content for MeeGo Harmattan Devices}
\o \l{Publishing Qt Content for Maemo Devices}
\o \l{Publishing Maemo Applications to Extras-devel}
\endlist
\o \bold {\l{Advanced Use}}
\list
\o \l{Supported Platforms}
\o \l{Using Other Build Systems}
\o \l{Using Command Line Options}
\o \l{Keyboard Shortcuts}
\o \l{Using External Tools}
\endlist
\o \bold {\l{Getting Help}}
\list
\o \l{Using the Help Mode}
\o \l{FAQ}
\o \l{Tips and Tricks}
\o \l{Known Issues}
\o \l{Glossary}
\endlist
\row
\o {3,1} \note To report bugs and suggestions to the Qt Bug
Tracker, select \gui {Help > Report Bug}.
\note To report bugs and suggestions to the Qt Bug Tracker, select
\gui {Help > Report Bug}.
You can also join the \QC mailing list at:
\l{http://lists.qt.nokia.com}{http://lists.qt.nokia.com}.
\endtable
\raw HTML
<img border="0" style="float:right;" src="images/qtcreator-screenshots.png" />
\endraw
\section1 Table Of Contents
\list
\o \l{Getting Started}
@@ -66,8 +142,12 @@
\o \l{Managing Projects}
\list
\o \l{Creating Projects}
\list
\o \l{Opening Projects}
\o \l{Adding Libraries to Projects}
\o \l{Adding New Custom Wizards}
\endlist
\o \l{Using Version Control Systems}
\o \l{Configuring Projects}
\list
\o \l{Specifying Build Settings}
@@ -81,29 +161,9 @@
\o \l{Specifying Dependencies}
\o \l{Sharing Project Settings}
\endlist
\o \l{Connecting MeeGo Harmattan Devices}
\o \l{Connecting Generic Linux Devices}
\o \l{Connecting Maemo Devices}
\o \l{Connecting Symbian Devices}
\o \l{Managing Sessions}
\endlist
\o \l{Coding}
\list
\o \l{Using the Editor}
\o \l{Semantic Highlighting}
\o \l{Checking Code Syntax}
\o \l{Completing Code}
\o \l{Indenting Code}
\o \l{Finding and Replacing}
\o \l{Refactoring}
\o \l{Using Qt Quick Toolbars}
\o \l{Searching with the Locator}
\o \l{Pasting and Fetching Code Snippets}
\o \l{Using Text Editing Macros}
\o \l{Configuring the Editor}
\o \l{Using FakeVim Mode}
\endlist
\o \l{Developing Application UI}
\o \l{Designing User Interfaces}
\list
\o \l{Developing Qt Quick Applications}
\list
@@ -120,13 +180,59 @@
\o \l {Using QML Modules with Plugins}
\endlist
\o \l{Developing Widget Based Applications}
\list
\o \l{Adding Qt Designer Plugins}
\endlist
\o \l{Optimizing Applications for Mobile Devices}
\endlist
\o \l{Building and Running Applications}
\o \l{Coding}
\list
\o \l{Building Applications for Multiple Targets}
\o \l{Running Applications on Multiple Targets}
\o \l{Writing Code}
\list
\o \l{Working in Edit Mode}
\o \l{Semantic Highlighting}
\o \l{Checking Code Syntax}
\o \l{Completing Code}
\o \l{Indenting Code}
\o \l{Using Qt Quick Toolbars}
\o \l{Pasting and Fetching Code Snippets}
\o \l{Using Text Editing Macros}
\endlist
\o \l{Finding}
\list
\o \l{Finding and Replacing}
\o \l{Searching with the Locator}
\endlist
\o \l{Refactoring}
\o \l{Configuring the Editor}
\list
\o \l{Specifying Text Editor Settings}
\o \l{Using FakeVim Mode}
\endlist
\o \l{Editing MIME Types}
\endlist
\o \l{Building and Running}
\list
\o \l{Building for Multiple Targets}
\o \l{Running on Multiple Targets}
\o \l{Deploying to Mobile Devices}
\list
\o \l{Deploying Applications to Symbian Devices}
\o \l{Deploying Applications to Maemo or MeeGo Harmattan Devices}
\endlist
\o \l{Connecting Mobile Targets}
\list
\o \l{Connecting MeeGo Harmattan Devices}
\o \l{Connecting Generic Linux Devices}
\o \l{Connecting Maemo Devices}
\o \l{Connecting Symbian Devices}
\endlist
\o \l{Customizing the Build Process}
\o \l{Using Maemo or MeeGo Harmattan Emulator}
\o \l{Building with Remote Compiler}
\endlist
\o \l{Debugging and Analyzing}
\list
\o \l{Debugging}
\list
\o \l{Debugging the Example Application}
@@ -140,45 +246,45 @@
\o \l{Analyzing Code}
\list
\o \l{Profiling QML Applications}
\o \l{Using Valgrind Code Analysis Tools}
\list
\o \l{Detecting Memory Leaks}
\o \l{Profiling Function Execution}
\o \l{Running Valgrind Tools Remotely}
\endlist
\o \l{Deploying Applications to Mobile Devices}
\list
\o \l{Deploying Applications to Symbian Devices}
\o \l{Deploying Applications to Maemo or MeeGo Harmattan Devices}
\o \l{Publishing Maemo Applications to Extras-devel}
\o \l{Publishing Applications to Nokia Store}
\endlist
\endlist
\o \l{Publishing}
\list
\o \l{Publishing Qt Content for Symbian Devices}
\o \l{Publishing Qt Content for Maemo Devices}
\o \l{Publishing Qt Content for MeeGo Harmattan Devices}
\o \l{Publishing Maemo Applications to Extras-devel}
\endlist
\o \l{Building with Remote Compiler}
\endlist
\o \l{Getting Help}
\o \l{Advanced Use}
\list
\o \l{Supported Platforms}
\o \l{Adding New Custom Wizards}
\o \l{Using Other Build Systems}
\list
\o \l{Setting Up a CMake Project}
\o \l{Setting Up an Autotools Project}
\o \l{Setting Up a Generic Project}
\o \l{Using Version Control Systems}
\o \l{Adding Qt Designer Plugins}
\o \l{Using External Tools}
\o \l{Using Maemo or MeeGo Harmattan Emulator}
\o \l{Editing MIME Types}
\o \l{Showing Task List Files in Issues Pane}
\endlist
\o \l{Using Command Line Options}
\o \l{Keyboard Shortcuts}
\o \l{Using External Tools}
\o \l{Showing Task List Files in Issues Pane}
\endlist
\o \l{Getting Help}
\list
\o \l{Using the Help Mode}
\o \l{FAQ}
\o \l{Tips and Tricks}
\o \l{Known Issues}
\o \l{Technical Support}
\o \l{Glossary}
\o \l{Technical Support}
\o \l{Acknowledgements}
\endlist
\endlist
*/

38
doc/src/qtquick/qtquick-app-development.qdoc
View File

@@ -37,26 +37,42 @@
You can either create Qt Quick projects from scratch or import existing
projects to \QC.
You can use the code editor (\l{Using the Editor}{Edit mode}) or the visual
editor (\l{Using Qt Quick Designer}{Design mode}) to develop Qt Quick
You can use the code editor (\l{Working in Edit Mode}{Edit mode}) or the
visual editor (\l{Using Qt Quick Designer}{Design mode}) to develop Qt Quick
applications.
\image qtcreator-qt-quick-editors.png "Edit mode and Design mode"
Typically, application development proceeds as follows:
The following sections describe typical tasks you can do with \QC.
\table
\row
\o \inlineimage creator_createproject.png
\o \inlineimage creator_createcomponents.png
\o \inlineimage creator_createscreen.png
\row
\o \l {Creating Qt Quick Projects}{Create or import projects.}
\o \l {Creating Components}{Create components.}
\o \l {Creating Screens}{Create screens.}
\row
\o \inlineimage creator_createanimation.png
\o \inlineimage creator_createuserinter.png
\o \inlineimage creator_createcode.png
\row
\o \l {Animating Screens}{Add animation to screens.}
\o \l {Adding User Interaction Methods}
{Add user interaction methods.}
\o \l {Implementing Application Logic}
{Implement the application logic.}
\endtable
\section1 Related Topics
\list
\o \l {Creating Qt Quick Projects}
\if defined(qcmanual)
\o \l {Using Qt Quick Designer}
\o \l {Creating Components}
\o \l {Creating Buttons}
\o \l {Creating Scalable Buttons and Borders}
\o \l {Creating Screens}
\o \l {Animating Screens}
\o \l {Adding User Interaction Methods}
\o \l {Exporting Designs from Graphics Software}
\o \l {Implementing Application Logic}
\endif
\o \l {Using QML Modules with Plugins}
\endlist

10
doc/src/qtquick/qtquick-toolbars.qdoc
View File

@@ -27,18 +27,12 @@
/*!
\contentspage index.html
\previouspage creator-editor-refactoring.html
\previouspage creator-indenting-code.html
\page qt-quick-toolbars.html
\nextpage creator-editor-locator.html
\nextpage creator-editor-codepasting.html
\title Using Qt Quick Toolbars
When you edit QML code in the code editor, you specify the properties
of QML components. For some properties, such as colors and font names,
this is not a trivial task. For example, few people can visualize the
color #18793f.
To easily edit these properties, you can use the Qt Quick Toolbars.
When you select a component in the code and a toolbar is available,
a light bulb icon appears:
\inlineimage qml-toolbar-indicator.png

2
doc/src/symbian/creator-deployment-symbian.qdoc
View File

@@ -179,7 +179,7 @@
\note If you use the Application Signing Services for Nokia Store, you can submit an unsigned
wrapper package to Nokia Publish. For more information, see
\l{Publishing Applications to Nokia Store}.
\l{Publishing Qt Content for Symbian Devices}.
You can either install the Nokia Smart Installer for Symbian as part of
the \QSDK, or download and install it from the

2
doc/src/symbian/symbiandev.qdoc
View File

@@ -28,7 +28,7 @@
\endif
\page creator-developing-symbian.html
\if defined(qcmanual)
\nextpage creator-project-managing-sessions.html
\nextpage creator-build-process-customizing.html
\else
\nextpage creator-developing-meego.html
\endif

9
doc/src/widgets/qtdesigner-overview.qdoc
View File

@@ -29,17 +29,10 @@
\contentspage index.html
\previouspage creator-qml-modules-with-plugins.html
\page creator-using-qt-designer.html
\nextpage creator-usability.html
\nextpage adding-plugins.html
\title Developing Widget Based Applications
Widgets and forms created with \QD are integrated seamlessly with programmed
code by using the Qt signals and slots mechanism that allows you to easily
assign behavior to graphical elements. All properties set in \QD can be
changed dynamically within the code. Furthermore, features such as widget
promotion and custom plugins allow you to use your own widgets with \QD. For
more information, see \l{Adding Qt Designer Plugins}.
\QC automatically opens all .ui files in the integrated \QD, in \gui Design
mode.

6
doc/src/widgets/qtdesigner-plugins.qdoc
View File

@@ -27,14 +27,14 @@
/*!
\contentspage index.html
\previouspage creator-version-control.html
\previouspage creator-using-qt-designer.html
\page adding-plugins.html
\nextpage creator-editor-external.html
\nextpage creator-usability.html
\title Adding Qt Designer Plugins
You can use Qt APIs to create plugins that extend Qt applications.
This allows you to add your own widgets to \QD.
This enables you to add your own widgets to \QD.
The most flexible way to include a plugin with an application is to compile
it into a dynamic library that is shipped separately, and detected and
loaded at runtime.