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

Doc: move misc howto topics to a separate folder

Browse Source 
Change-Id: I586e3abfbfd578157fc41e3e82fa174494dfdfe9
Reviewed-on: http://codereview.qt-project.org/5609
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Eike Ziller <eike.ziller@nokia.com>
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
This commit is contained in:
Leena Miettinen
2011-09-27 11:53:38 +02:00
parent c2430dd6a7
commit 76b59d0300
10 changed files with 2336 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

131
doc/src/howto/creator-cli.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 (info@qt.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 info@qt.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-cli.html
\nextpage creator-keyboard-shortcuts.html
\title Using Command Line Options
You can start \QC and specify some options from the command line.
For example, you can open a file to any line.
To specify command line options, enter the following command in the \QC
installation or build directory:
\c {qtcreator [option] [filename[:line_number]]}
\note You can use either a colon (:) or a plus sign (+) as a separator
between the filename and line number. You can also use a space between the
separator and the line number.
For example:
\list
\o \c {C:\qtcreator\bin>qtcreator -help}
\o \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp:100}
\o \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp +100}
\endlist
The following table summarizes the available options:
\table
\header
\o Option
\o Description
\row
\o -help
\o Display help on command line options.
\row
\o -version
\o Display \QC version.
\row
\o -client
\o Attempt to connect to an already running instance of \QC.
\row
\o -noload <plugin>
\o Do not load the specified plugin.
\row
\o -profile
\o Output plugin start up and shut down profiling data.
\row
\o -settingspath <path>
\o Override the default path where user settings are stored.
\row
\o -color <color>
\o Core plugin: override the selected UI color.
\row
\o -disable-cdb
\o Debugger plugin: disable the Microsoft Console Debugger (CDB)
engine. For more information, see \l{Debugging}.
\row
\o -disable-gdb
\o Debugger plugin: disable the GNU Symbolic Debugger (GDB) engine.
\row
\o -disable-sdb
\o Debugger plugin: disable the Qt Script debugger engine.
\row
\o -debug <PID-or-corefile>
\o Debugger plugin: attach to process ID or core file.
\row
\o -wincrashevent <event-handle>
\o Debugger plugin: Attach to crashed processes by using the specified
event handle.
\row
\o -customwizard-verbose
\o ProjectExplorer plugin: display additional information when loading
custom wizards. For more information about custom wizards, see
\l{Adding New Custom Wizards}
\row
\o -lastsession
\o ProjectExplorer plugin: load the last session when \QC starts.
Open the projects and files that were open when you last exited \QC.
For more information about managing sessions, see \l{Managing Sessions}.
\endtable
*/

150
doc/src/howto/creator-external-tools.qdoc Normal file
View File

@@ -0,0 +1,150 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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 adding-plugins.html
\page creator-editor-external.html
\nextpage creator-maemo-emulator.html
\title 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.
\section1 Using Qt Linguist
You can use the Qt Linguist release manager tools, lupdate and lrelease,
directly from \QC. The lupdate tool is used to synchronize source
code and translations. The lrelease tool is used to create run-time
translation files for use by the released application.
To synchronize ts files from a translator with the application code,
select \gui {Tools > External > Text > Linguist > Update Translations
(lupdate)}.
To generate from the ts files qm translation files that can be used by an
application, select \gui {Tools > External > Text > Linguist > Release
Translations (lrelease)}.
By default, the project .pro file is passed to the tools as an argument. To
specify other command line arguments for the tools, select \gui {Tools >
External > Configure}.
For more information about Qt Linguist, see
\l{http://doc.qt.nokia.com/4.7/linguist-manual.html}{Qt Linguist Manual}.
\section1 Using QML Viewer
You can preview the current QML document in the QML Viewer. The QML Viewer
invokes the QML runtime to load QML documents and also includes additional
features useful for the development of QML-based applications.
To preview the currently active QML file, select \gui {Tools > External >
Qt Quick > Preview (qmlviewer)}.
\section1 Using External Text Editors
You can open files for editing in the default text editor for your system:
Notepad on Windows and vi on Linux and Mac OS.
To open the file you are currently viewing in an external editor, select
\gui {Tools > External > Text > Notepad} or \gui vi, depending on your
system.
\QC looks for the editor path in the PATH environment variable
of your operating system.
\section1 Sorting Text Alphabetically
To sort selected text alphabetically, select \gui {Tools > External > Text
> Sort Selection}. The \c sort tool takes the selected text as input and
returns it in alphabetic order. By default, the output replaces the
original selection in the code editor.
To change the default configuration, select \gui {Tools > External >
Configure}.
\section1 Configuring External Tools
You can change the configuration of preconfigured tools and configure
additional tools in \QC \gui Options.
You can use \QC variables in the fields that you can select from
lists of available \QC variables.
\image qtcreator-external-tools.png "External Tools options"
To configure external tools:
\list 1
\o Select \gui {Tools > External > Configure}.
\o Select \gui {Add > Add Tool}
to add a new tool. You can also select \gui {Add Category} to add a
new category.
\o In the \gui Executable field, specify the executable to run. If the
executable is found in your system PATH variable, do not specify
the path to it.
\o In the \gui Arguments field, specify optional arguments for running
the executable.
\o In the \gui {Working directory} field, specify the path to the
working directory.
\o In the \gui {Output pane}, select how to handle output from the
tool. You can ignore the output, view it in the \gui {General
Messages} output pane, or replace the selected text with the
output in the code editor.
\o In the \gui {Error output pane}, select how to handle error messages
from the tool.
\o In the \gui Input field, specify text that is passed as standard
input to the tool.
\endlist
The category and tool are added to the \gui {Tools > External} menu.
If you change the configuration of preconfigured tools, you can later
revert the changes by selecting the \gui Revert button.
The tool configurations that you add and modify are stored in XML format in
the user configuration folder. For example,
\c {~/config/Nokia/qtcreator/externaltools}
on Linux and Mac OS and
\c {C:\Users\username\AppData\Roaming\Nokia\qtcreator\externaltools}
in Windows. To share a configuration with other users, copy an XML
configuration file to the folder.
*/

187
doc/src/howto/creator-help.qdoc Normal file
View File

@@ -0,0 +1,187 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-help.html
\nextpage creator-advanced.html
\title Getting Help
\QC comes fully integrated with Qt documentation and examples using the Qt
Help plugin.
\list
\o To view documentation, switch to \gui Help mode.
\o To obtain context sensitive help, move the text cursor to a Qt class
or function and press \key F1. The documentation is displayed in a
pane next to the code editor, or, if there is not enough vertical
space, in the fullscreen \gui Help mode.
\o To select and configure how the documentation is displayed in the
\gui Help mode, select \gui Tools > \gui Options > \gui Help.
\endlist
The following image displays the \gui Search pane in the \gui Help mode.
\image qtcreator-help-search.png
The following image displays the context sensitive help in the \gui Edit
mode.
\image qtcreator-context-sensitive-help.png
\section1 Finding Information in Qt Documentation
\QC, \QSDK and other Qt deliverables contain documentation
as .qch files. All the documentation is accessible in the \gui Help mode.
To find information in the documentation, select:
\list
\o \gui Bookmarks to view a list of pages on which you have added
bookmarks.
\o \gui Contents to see all the documentation installed on the
development PC and to browse the documentation contents.
\o \gui Index to find information based on a list of keywords in all
the installed documents.
\o \gui {Open Pages} to view a list of currently open documentation
pages.
\o \gui Search to search from all the installed documents.
\endlist
\section2 Adding Bookmarks to Help Pages
You can add bookmarks to useful help pages to easily find them later
in the \gui Bookmarks view. You can either use the page title as the
bookmark or change it to any text. You can organize the bookmarks in
folders in the view.
\image qtcreator-help-add-bookmark-dlg.png "Add Bookmark dialog"
To add a bookmark to an open help page:
\list 1
\o Click the
\inlineimage qtcreator-help-add-bookmark.png
(\gui {Add Bookmark}) button on the toolbar.
\o In the \gui {Add Bookmark} dialog, click \gui OK to save the
page title as a bookmark in the \gui Bookmarks folder.
\endlist
To import and export bookmarks, select \gui {Tools > Options > Help >
General Settings > Import} or \gui Export.
\section1 Adding External Documentation
You can display external documentation in the \gui Help mode.
To augment or replace the documentation that ships with \QC and Qt:
\list 1
\o Create a .qch file from your documentation.
For information on how to prepare your documentation and create a
.qch file, see
\l{http://doc.qt.nokia.com/4.7/qthelp-framework.html}
{The Qt Help Framework}.
\o To add the .qch file to \QC, select \gui Tools > \gui Options >
\gui Help > \gui Documentation > \gui Add.
\endlist
\section1 Detaching the Help Window
By default, context-sensitive help is opened in a window next to the
code editor when you press \key F1. If there is not enough vertical
space, the help opens in the full-screen help mode.
You can specify that the help always opens in full-screen mode or
is detached to an external window. Select \gui {Tools > Options > Help >
General Settings} and specify settings for displaying context-sensitive help
in the \gui {On context help} field. To detach the help window, select
\gui {Always Show Help in External Window}.
You can select the help page to open upon startup in the \gui {Home Page}
field.
\section1 Using Documentation Filters
You can filter the documents displayed in the \gui Help mode to find
relevant information faster. Select from a list of filters in the
\gui {Filtered by} field. The contents of the \gui Index and \gui Contents
pane in the sidebar change accordingly.
\image qtcreator-help-filters.png "Help filters"
You can modify the filters to include external documentation, for example,
or you can define your own filters. To construct filters, you can use the
filter attributes that are specified in the documentation. Each document
contains at least one filter attribute. If several documents contain the
same filter attribute, such as \c tools, you can use that attribute to
include all those documents.
To add filters:
\list 1
\o Select \gui {Tools > Options > Help > Filters > Add}.
\o Enter a name for the filter and press \gui {OK}.
\o In \gui Attributes, select the documents that you want to include
in the filter.
\image qtcreator-help-filter-attributes.png "Help filter attributes"
\o Click \gui OK.
\o In the \gui Help mode, select the filter in the \gui {Filtered by}
field to see the filtered documentation in the sidebar.
\endlist
To modify filters, select a filter in \gui Filters, select the attributes,
and then click \gui Apply.
To remove filters, select them in \gui Filters, and click \gui Remove.
*/

544
doc/src/howto/creator-keyboard-shortcuts.qdoc Normal file
View File

@@ -0,0 +1,544 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-cli.html
\page creator-keyboard-shortcuts.html
\nextpage creator-faq.html
\title Keyboard Shortcuts
\QC provides various keyboard shortcuts to speed up your development
process.
\section1 Configuring Keyboard Shortcuts
To customize a keyboard shortcut:
\list 1
\o Select \gui Tools > \gui Options > \gui Environment > \gui Keyboard.
\o Select an action from the list.
\o In \gui{Key Sequence} enter the shortcut key you want to associate
with the selected action.
\endlist
\QC allows you to use different keyboard shortcut mapping schemes:
\list
\o To import a keyboard shortcut mapping scheme, click \gui Import
and select the kms file containing keyboard shortcut mapping scheme
you want to import.
\o To export the current keyboard shortcut mapping scheme, click
\gui Export and select the location where you want to save the
exported kms file.
\endlist
\section1 Default Keyboard Shortcuts
The following tables list the default keyboard shortcuts. They are
categorized by actions.
\section2 General Keyboard Shortcuts
\table
\header
\o Action
\o Keyboard shortcut
\row
\o Open file or project
\o Ctrl+O
\row
\o New file or project
\o Ctrl+N
\row
\o Open in external editor
\o Alt+V, Alt+I
\row
\o Cut
\o Ctrl+X
\row
\o Copy
\o Ctrl+C
\row
\o Paste
\o Ctrl+V
\row
\o Redo
\o Ctrl+Y
\row
\o Save
\o Ctrl+S
\row
\o Save all
\o Ctrl+A
\row
\o Close window
\o Ctrl+W
\row
\o Close all
\o Ctrl+Shift+W
\row
\o Go back
\o Alt+Left
\row
\o Go forward
\o Alt+Right
\row
\o Go to line
\o Ctrl+L
\row
\o Next open document in history
\o Ctrl+Shift+Tab
\row
\o Goto other split
\o Ctrl+E, O
\row
\o Previous open document in history
\o Ctrl+Tab
\row
\o Activate \gui Locator
\o Ctrl+K
\row
\o Switch to \gui Welcome mode
\o Ctrl+1
\row
\o Switch to \gui Edit mode
\o Ctrl+2
\row
\o Switch to \gui Design mode
\o Ctrl+3
\row
\o Switch to \gui Debug mode
\o Ctrl+4
\row
\o Switch to \gui Projects mode
\o Ctrl+5
\row
\o Switch to \gui Help mode
\o Ctrl+6
\row
\o Toggle \gui{Build Issues} pane
\o Alt+1 (Cmd+1 on Mac OS X)
\row
\o Toggle \gui{Search Results} pane
\o Alt+2 (Cmd+2 on Mac OS X)
\row
\o Toggle \gui{Application Output} pane
\o Alt+3 (Cmd+3 on Mac OS X)
\row
\o Toggle \gui{Compile Output} pane
\o Alt+4 (Cmd+4 on Mac OS X)
\row
\o Activate \gui Bookmarks pane
\o Alt+M
\row
\o Activate \gui{File System} pane
\o Alt+Y
\row
\o Activate \gui{Open Documents} pane
\o Alt+O
\row
\o Activate \gui Projects pane
\o Alt+X
\row
\o Full screen
\o Ctrl+Shift+F11
\row
\o Toggle the sidebar
\o Alt+0 (Cmd+0 on Mac OS X)
\row
\o Undo
\o Ctrl+Z
\row
\o Move to \gui Edit mode
In \gui Edit mode:
\list
\o The first press moves focus to the editor
\o The second press closes secondary windows
\endlist
\o Esc
\endtable
\section2 Editing Keyboard Shortcuts
\table
\header
\o Action
\o Keyboard shortcut
\row
\o Auto-indent selection
\o Ctrl+I
\row
\o Collapse
\o Ctrl+<
\row
\o Expand
\o Ctrl+>
\row
\o Trigger a completion in this scope
\o Ctrl+Space
\row
\o Copy line down
\o Ctrl+Alt+Down
\row
\o Copy line up
\o Ctrl+Alt+Up
\row
\o Cut line
\o Shift+Del
\row
\o Join lines
\o Ctrl+J
\row
\o Decrease font size
\o Ctrl+- (Ctrl+Roll mouse wheel down)
\row
\o Increase font size
\o Ctrl++ (Ctrl+Roll mouse wheel up)
\row
\o Toggle Vim-style editing
\o Alt+V, Alt+V
\row
\o Split
\o Ctrl+E, 2
\row
\o Split side by side
\o Ctrl+E, 3
\row
\o Remove all splits
\o Ctrl+E, 1
\row
\o Remove current split
\o Ctrl+E, 0
\row
\o Select all
\o Ctrl+A
\row
\o Go to block end
\o Ctrl+]
\row
\o Go to block start
\o Ctrl+[
\row
\o Go to block end with selection
\o Ctrl+}
\row
\o Go to block start with selection
\o Ctrl+{
\row
\o Move current line down
\o Ctrl+Shift+Down
\row
\o Move current line up
\o Ctrl+Shift+Up
\row
\o Trigger a quick fix in this scope
\o Alt+Return
\row
\o Rewrap paragraph
\o Ctrl+E, R
\row
\o Select the current block
The second press extends the selection to the parent block
\o Ctrl+U
\row
\o Enable text wrapping
\o Ctrl+E, Ctrl+W
\row
\o Toggle comment for selection
\o Ctrl+/
\row
\o Visualize whitespace
\o Ctrl+E, Ctrl+V
\row
\o Delete
\o Del
\row
\o Adjust size
\o Ctrl+J
\row
\o Lay out in a grid
\o Ctrl+G
\row
\o Lay out horizontally
\o Ctrl+H
\row
\o Lay out vertically
\o Ctrl+L
\row
\o Preview
\o Alt+Shift+R
\row
\o Edit signals and slots
\o F4
\row
\o Edit widgets
\o F3
\row
\o Toggle bookmark
\o Ctrl+M
\row
\o Go to next bookmark
\o Ctrl+.
\row
\o Go to previous bookmark
\o Ctrl+,
\row
\o Fetch snippet
\o Alt+C, Alt+F
\row
\o Paste snippet
\o Alt+C, Alt+P
\row
\o Find usages
\o Ctrl+Shift+U
\row
\o Follow symbol under cursor
Works with namespaces, classes, methods, variables, include
statements and macros
\o F2
\row
\o Rename symbol under cursor
\o Ctrl+Shift+R
\row
\o Switch between method declaration and definition
\o Shift+F2
\row
\o Open type hierarchy
\o Ctrl+Shift+T
\row
\o Switch between header and source file
\o F4
\row
\o Turn selected text into lowercase
\o Alt+U
\row
\o Turn selected text into uppercase
\o Alt+Shift+U
\endtable
\section2 Debugging Keyboard Shortcuts
\table
\header
\o Action
\o Keyboard shortcut
\row
\o Start debugging
\o F5
\row
\o Stop or interrupt debugger
\o Shift+F5
\row
\o Reset debugger
\o Ctrl+Shift+F5
\row
\o Step over
\o F10
\row
\o Step into
\o F11
\row
\o Step out
\o Shift+F11
\row
\o Toggle breakpoint
\o F9
\row
\o Run to selected function
\o Ctrl+F6
\endtable
\section2 Project Keyboard Shortcuts
\table
\header
\o Action
\o Keyboard shortcut
\row
\o Build project
\o Ctrl+B
\row
\o Build all
\o Ctrl+Shift+B
\row
\o New project
\o Ctrl+Shift+N
\row
\o Run
\o Ctrl+R
\endtable
\section2 Help Keyboard Shortcuts
\table
\header
\o Action
\o Keyboard shortcut
\row
\o View context-sensitive help
\o F1
\row
\o Activate contents in \gui Help mode
\o Ctrl+T
\row
\o Add bookmark in \gui Help mode
\o Ctrl+M
\row
\o Activate index in \gui Help mode
\o Ctrl+I
\row
\o Reset font size in \gui Help mode
\o Ctrl+0
\row
\o Activate search in \gui Help mode
\o Ctrl+S
\endtable
\section2 Version Control Keyboard Shortcuts
\table
\header
\o {1,2} Action
\o {5,1} Version control system
\header
\o CVS
\o Git
\o Perforce
\o Subversion
\o Mercurial
\row
\o Add
\o Alt+C, Alt+A
\o Alt+G, Alt+A
\o
\o Alt+S, Alt+A
\o
\row
\o Commit
\o Alt+C, Alt+C
\o Alt+G, Alt+C
\o
\o
\o Alt+H, Alt+C
\row
\o Diff
\o Alt+C, Alt+D
\o Alt+G, Alt+D
\o
\o Alt+S, Alt+D
\o Alt+H, Alt+D
\row
\o Diff project
\o
\o Alt+G, Alt+Shift+D
\o Alt+P, Alt+D
\o
\o
\row
\o Blame
\o
\o Alt+G, Alt+B
\o
\o
\o
\row
\o Log
\o
\o Alt+G, Alt+L
\o Alt+P, Alt+F
\o
\o Alt+H, Alt+L
\row
\o Log project
\o
\o Alt+G, Alt+K
\o
\o
\o
\row
\o Status
\o
\o Alt+G, Alt+S
\o
\o
\o Alt+H, Alt+S
\row
\o Undo changes
\o
\o Alt+G, Alt+U
\o
\o
\o
\row
\o Diff project
\o
\o Alt+G, Alt+Shift+D
\o Alt+P, Alt+D
\o
\o
\row
\o Edit
\o
\o
\o Alt+P, Alt+E
\o
\o
\row
\o Opened
\o
\o
\o Alt+P, Alt+O
\o
\o
\row
\o Revert
\o
\o
\o Alt+P, Alt+R
\o
\o
\row
\o Submit
\o
\o
\o Alt+P, Alt+S
\o
\o
\endtable
*/

77
doc/src/howto/creator-sessions.qdoc Normal file
View File

@@ -0,0 +1,77 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-project-managing-sessions.html
\nextpage creator-coding.html
\title Managing Sessions
When you exit \QC, a snapshot of your current workspace is stored as a
\e session. To restore the session automatically when you start \QC,
select \gui {File > Session Manager > Restore last session on startup}.
A session is an arbitrary collection of:
\list
\o Open projects with their dependencies (including SUBDIRS projects)
\o Open editors
\o Breakpoints and expressions
\o Bookmarks
\endlist
A session is personal, that is, not meant to be shared. It is not supposed
to reflect the project structure. It contains personal data, such as
bookmarks and breakpoints that are usually not of interest to other
developers working on the same projects.
For example, if you work on a project and need to switch to another project
for a while, you can save your workspace as a session. This makes it easier
to return to working on the first project later.
To create a new session or remove existing sessions, select \gui File >
\gui{Session Manager}.
\image qtcreator-session-manager.png
To switch between sessions, choose \gui {File > Session Manager}. If you do
not create or select a session, \QC always uses the default session, which
was created the last time you exited \QC.
When you launch \QC, a list of existing sessions is displayed on the
\gui{Welcome screen}.
\image qtcreator-welcome-session.png
*/

96
doc/src/howto/creator-task-lists.qdoc Normal file
View File

@@ -0,0 +1,96 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-mime-types.html
\page creator-task-lists.html
\nextpage creator-cli.html
\title Showing Task List Files in the Build Issues Pane
Code scanning and analysis tools create report files in ASCII format.
Usually, the report files consist of lines that contain a file name, a line
number, and an error message. A similar format is used for stack traces
obtained from crash reports. Traditionally, you would fix the errors by
manually navigating to them and correcting them, which is tedious.
\QC makes this very easy by providing a way to load these files into
the \gui{Build Issues} pane. You can navigate to the corresponding source
code by clicking the error message. But first you must convert the files to
the \l{Task List File Format} by using conversion scripts that based on
standard text processing tools of the operating system.
In addition, you can generate task list files from code. For an example of a
script that checks new lines of code and matches them against regular
expressions to generate a task list, see \c{scripts\mytasks.pl} in the \QC
repository.
To open task list files, choose \gui{File} > \gui{Open}.
\section1 Task List File Format
The filename extension must be .tasks for \QC to recognize a file as a
task list file.
Each line in a task list file is treated as a tab-separated list of strings
with \c{\t}, \c{\n}, and \c{\\} used as escape characters. The strings are
used to create one task per line. The lines can have one of the following
formats:
\list
\o \c description
\o \c{type\tdescription}
\o \c{file\ttype\tdescription}
\o \c{file\tline\ttype\tdescription}
\endlist
The task type can have one of the following values:
\list
\o A string starting with \c err, which displays the error icon in the
beginning of the line
\o A string starting with \c warn, which displays the warning icon
\o Any other value, which sets the task type to Unknown and does not
display an icon
\endlist
The values are not case sensitive.
Lines starting with the hash mark character (#) in the first column are
ignored.
*/

242
doc/src/howto/creator-tips.qdoc Normal file
View File

@@ -0,0 +1,242 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-faq.html
\page creator-tips.html
\nextpage creator-known-issues.html
\title Tips and Tricks
\section1 Switching Between Modes
\QC uses different modes for different purposes. You can quickly
switch between these modes with the following keyboard shortcuts:
\list
\o \gui Welcome mode \key Ctrl+1
\o \gui Edit mode \key Ctrl+2
\o \gui Design mode \key Ctrl+3
\o \gui Debug mode \key Ctrl+4
\o \gui Projects mode \key Ctrl+5
\o \gui Help mode \key Ctrl+6
\endlist
For more information about \QC modes, see \l {Modes}.
\section1 Moving Between Open Files
To quickly move between currently open files, press
\key Ctrl+Tab.
To move forward in the location history, press \key {Alt+Right}
(\key {Cmd+Opt+Right} on Mac OS). To move backward, press \key {Alt+Left}
(\key {Cmd+Opt+Left} on Mac OS). For example, if you use the \gui Locator
to jump to a symbol in the same file, you can jump back to your original
location in that file by pressing \key {Alt+Left}.
\section1 Moving To the Edit Mode
To move to the \gui Edit mode and currently active file, press
\key Esc.
If you already are in the \gui Edit mode:
\list
\o The first press moves focus to the editor
\o The second press closes secondary windows
\endlist
\section1 Using the Filter in Options Dialog
To find specific settings you require in \gui{Tools} > \gui{Options}
use the filter located at the top left of the \gui Options dialog box.
\section1 Opening Output Panes
The output panes provide a list of errors and warnings encountered during
a build, detailed output from the compiler, status of a program when it is
executed and debug output, as well as search results.
To open output panes, use the following shortcuts:
\list
\o \gui{Build Issues} pane Alt+1 (Cmd+1 on Mac OS X)
\o \gui{Search Results} pane Alt+2 (Cmd+2 on Mac OS X)
\o \gui{Application Output} pane Alt+3 (Cmd+3 on Mac OS X)
\o \gui{Compile Output} pane Alt+4 (Cmd+4 on Mac OS X)
\endlist
For more information about output panes, see \l{Viewing Output}.
\section1 Using Keyboard Shortcuts
\QC provides \l{Keyboard Shortcuts}{many useful keyboard shortcuts}.
You can see the keyboard shortcut for a menu command in the menu
or the tooltip for a button.
To customize, import or export keyboard shortcuts, select \gui Tools >
\gui Options > \gui Environment > \gui Keyboard.
\section1 Running \QC From Command Line
You can launch \QC from command line using the name of an
existing session or \c .pro file by giving the name as the command
argument.
For example, running \tt{qtcreator somesession}, launches \QC and
loads session somesession.
\note Make sure \QC is included in the PATH environment variable.
This can be done by typing the following in the command line:
\code
set PATH=c:\qtsdk\mingw\bin;c:\qtsdk\qt\bin;%PATH%
\endcode
\section1 Showing and Hiding the Sidebar
To toggle the sidebar in the \gui Edit and \gui Debug modes, click
\inlineimage qtcreator-togglebutton.png
or press \key Alt+0 (\key Cmd+0 on Mac OS X).
For more information on using the sidebar, see
\l {Browsing Project Contents}.
\section1 Moving To Symbols
To move straight to a symbol used in a project, select the symbol in the
\gui Editor toolbar drop-down menu. For more information on the editor
toolbar, see \l {Using the Editor Toolbar}.
To jump to a symbol in the current file, press \key {Ctrl+K} to open the
\gui Locator, enter a period (.), and start typing the symbol name. Then
select the symbol in the list. For more information on using the locator,
see \l{Searching With the Locator}.
Press \key Ctrl (\key Cmd on Mac OS) and click a symbol to move directly to
the definition or the declaration of the symbol. You can also move the
on the symbol and press \key {F2}. For more information, see
cursor \l{Moving to Symbol Definition or Declaration}.
\section1 Displaying Signals and Slots
If an instance of a class is derived from QObject, and you would like to
find all other objects connected to one of your object's slots using
Qt's signals and slots mechanism, select \gui Tools > \gui Options
> \gui{Debugger} > \gui{Debugging Helper} > \gui{Use Debugging Helper}.
In the \gui{Locals and Expressions} view, expand the object's entry and open
the slot in the \e slots subitem. The objects connected to this slot are
shown as children of the slot. This method works with signals too.
For more information about the \gui{Locals and Expressions} view, see
\l{Locals and Expressions}.
\section1 Displaying Low Level Data
If special debugging of Qt objects fails due to data corruption within the
debugged objects, you can switch off the debugging helpers. When debugging
helpers are switched off low-level structures become visible.
To switch off the debugging helpers:
\list 1
\o Select \gui Tools > \gui Options > \gui Debugger >
\gui{Debugging Helper}.
\o Uncheck the \gui{Use Debugging Helper} checkbox.
\endlist
\section1 Showing Tooltips in Debug Mode
To inspect the value of variables from the editor, you can turn
on tooltips. Tooltips are hidden by default for performance reasons.
\list 1
\o Select \gui Tools > \gui Options > \gui Debugger > \gui General.
\o Select the \gui {Use tooltips in main editor while debugging} check
box.
\endlist
When you hover over a variable in the code editor in \gui Debug mode, a
tooltip is displayed. To keep the tooltip visible, click the pin button.
You can expand pinned tooltips to view their full content.
\image qtcreator-pin-tooltip.png
Pinned tooltips are stored in the session. To close all pinned tooltips,
select \gui {Close Editor Tooltips} in the context menu in the \gui {Locals
and Expressions} view.
\section1 Locating Files
The \gui Locator provides one of the easiest ways in \QC to browse
through projects, files, classes, methods, documentation and file systems.
To quickly access files not directly mentioned in your project, you can
create your own locator filters. That way you can locate files in a
directory structure you have defined.
To create locator filters, select \gui {Tools > Options > Locator > Add}.
For more information, see \l{Creating Locator Filters}.
\section1 Adding a License Header Template for C++ Code
A file containing a license header for C++ can be specified under
\gui{Tools > Options > C++ > License Template}. It may contain special
placeholders enclosed in \c{%%} that are replaced when generating a
new file:
\list 1
\o \c %YEAR%: Year
\o \c %MONTH%: Month
\o \c %DAY%: Day of the month
\o \c %DATE%: Date
\o \c %USER%: User name
\o \c %FILENAME%: File name
\o \c %CLASS%: Class name (if applicable)
\o \c %$VARIABLE%: Contents of environment variable \c{VARIABLE}.
\endlist
*/

316
doc/src/howto/creator-ui.qdoc Normal file
View File

@@ -0,0 +1,316 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-overview.html
\page creator-quick-tour.html
\nextpage creator-getting-started.html
\title User Interface
\image qtcreator-breakdown.png
When you start \QC, it opens to the \gui Welcome mode, where you can:
\list
\o Read news from the Qt labs
\o Open tutorials and example projects
\o Create and open projects
\o Send feedback to the development team
\o Open recent sessions and projects
\endlist
You can use the mode selector to change to another \QC mode.
The following image displays an example application in \gui Edit mode
and \gui Design mode.
\image qtcreator-qt-quick-editors.png "Edit mode and Design mode"
\QC has been localized into several languages. If the system language is one
of the supported languages, it is automatically selected. To change the
language, select \gui {Tools > Options > Environment} and select a language
in the \gui Language field. The change takes effect after you restart \QC.
\section1 Modes
The mode selector allows you to quickly switch between tasks such as editing
project and source files, designing application UIs, configuring how
projects are built and executed, and debugging your applications. To change
modes, click the icons, or use the \l{keyboard-shortcuts}
{corresponding keyboard shortcut}.
You can use \QC in the following modes:
\list
\o \gui Welcome mode for opening projects.
\o \gui{\l{Using the Editor}{Edit}} mode for editing project and source
files.
\o \gui{\l{Developing Application UI}{Design}} mode for designing and
developing application user interfaces. This mode is available for
UI files.
\o \gui{\l{Debugging}{Debug}} mode for inspecting the state of your
application while debugging.
\o \gui{\l{Specifying Build Settings}{Projects}} mode for configuring
project building and execution. This mode is available when a
project is open.
\o \gui{\l{Analyzing Code}{Analyze}} mode for using code analysis tools
to detect memory leaks and profile C++ or QML code.
\o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
\endlist
Certain actions in \QC trigger a mode change. Clicking on \gui {Debug} >
\gui {Start Debugging} > \gui {Start Debugging} automatically switches to
\gui {Debug} mode.
\section1 Browsing Project Contents
The sidebar is available in the \gui Edit and \gui Debug modes. Use the
sidebar to browse projects, files, and bookmarks, and to view the class
hierarchy.
\image qtcreator-sidebar.png
You can select the content of the sidebar in the sidebar menu:
\list
\o \gui Projects shows a list of projects open in the current
session.
\o \gui{Open Documents} shows currently open files.
\o \gui Bookmarks shows all bookmarks for the current session.
\o \gui{File System} shows all files in the currently selected
directory.
\o \gui {Class View} shows the class hierarchy of the currently
open projects.
\o \gui Outline shows the symbol hierachy of a C++ file and the element
hierarchy of a QML file.
\o \gui {Type Hierarchy} shows the base classes of a class.
\endlist
You can change the view of the sidebar in the following ways:
\list
\o To toggle the sidebar, click \inlineimage qtcreator-togglebutton.png
or press \key Alt+0 (\key Cmd+0 on Mac OS X).
\o To split the sidebar, click \inlineimage qtcreator-splitbar.png
. Select new content to view in the split view.
\o To close a sidebar view, click
\inlineimage qtcreator-closesidebar.png
.
\endlist
The additional options in each view are described in the following
sections.
\section2 Viewing Project Files
The sidebar displays projects in a project tree. The project tree contains
a list of all projects open in the current session. The files for each
project are grouped according to their file type.
You can use the project tree in the following ways:
\list
\o To bring up a context menu containing the actions most commonly
needed right-click an item in the project tree. For example, through
the menu of the project root directory you can, among other actions,
build, re-build, clean and run the project.
\o To hide the categories and sort project files alphabetically, click
\inlineimage qtcreator-filter.png
and select \gui{Simplify Tree}.
\o To hide source files which are automatically generated by the build
system, during a build, click \inlineimage qtcreator-filter.png
and select \gui{Hide Generated Files}.
\o To keep the position in the project tree synchronized with the file
currently opened in the editor, click
\inlineimage qtcreator-synchronizefocus.png
.
\o To see the absolute path of a file, move the mouse pointer over the
file name.
\endlist
\section2 Viewing the File System
If you cannot see a file in the \gui Projects view, switch to the
\gui {File System} view, which shows all the files in the file system.
To keep the position in the tree synchronized with the file
opened in the editor, click
\inlineimage qtcreator-synchronizefocus.png
.
\section2 Viewing the Class Hierarchy
The \gui {Class View} shows the class hierarchy of the currently
open projects. To organize the view by subprojects, click
\inlineimage qtcreator-show-subprojects.png
.
\section2 Viewing QML Elements
The \gui Outline view shows the element hierarchy in a QML file.
\list
\o To see a complete list of all bindings, click
\inlineimage qtcreator-filter.png
and select \gui{Show All Bindings}.
\o To keep the position in the view synchronized with the element
selected in the editor, click
\inlineimage qtcreator-synchronizefocus.png
.
\endlist
\section2 Viewing Type Hierarchy
To view the base classes of a class, right-click the class and select
\gui {Open Type Hierarchy} or press \key {Ctrl+Shift+T}.
\section1 Viewing Output
The task pane in \QC can display one of the following panes:
\list
\o \gui{Build Issues}
\o \gui{Search Results}
\o \gui{Application Output}
\o \gui{Compile Output}
\o \gui{General Messages}
\o \gui{Version Control}
\endlist
Output panes are available in all \l{Modes}{modes}. Click the name of an
output pane to open the pane. To maximize an open output pane, click the
\gui {Maximize Output Pane} button or press \key {Alt+9}.
To search within the \gui{Application Output} and \gui{Compile Output}
panes, press \key {Ctrl+F} when the pane is active. Enter search criteria in
the \gui Find field and click the left and right arrows to search down and
up in the pane.
To open the \gui{General Messages} and \gui{Version Control} panes, select
\gui {Window > Output Panes}.
\section2 Build Issues
The \gui{Build Issues} pane provides a list of errors and warnings
encountered during a build. The pane filters out irrelevant output from
the build tools and presents the issues in an organized way.
Right-clicking on a line brings up a context menu with options to copy
the contents and to show a version control annotation view of the line
that causes the error message.
\image qtcreator-build-issues.png
To view task lists in the \gui{Build Issues} pane, click
\inlineimage qtcreator-filter.png
and select \gui{My Tasks}. Entries from a task list file (.tasks) are
imported to the pane. Press \key F6 and \key Shift+F6 to jump from one issue
to the next.
For more information about creating task files, see
\l{Showing Task List Files in the Build Issues Pane}.
\section2 Search Results
The \gui{Search Results} pane displays the results for global searches,
for example, searching within a current document, files on disk, or all
projects.
The figure below shows an example search result for all
occurrences of \c textfinder within the \c "/TextFinder" directory.
\image qtcreator-search-pane.png
\section2 Application Output
The \gui{Application Output} pane displays the status of a program when
it is executed, and the debug output.
The figure below shows an example output from qDebug().
\image qtcreator-application-output.png
\section2 Compile Output
The \gui{Compile Output} pane provides all output from the compiler.
The \gui{Compile Output} is a more detailed version of information
displayed in the \gui{Build Issues} pane.
\image qtcreator-compile-pane.png
\section1 Navigating with Keyboard
\QC caters not only to developers who are used to using the mouse,
but also to developers who are more comfortable with the keyboard. A wide
range of \l{keyboard-shortcuts}{keyboard} and
\l{Searching With the Locator}{navigation} shortcuts are available to help
speed up the process of developing your application.
*/

563
doc/src/howto/creator-vcs.qdoc Normal file
View File

@@ -0,0 +1,563 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.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-project-generic.html
\page creator-version-control.html
\nextpage adding-plugins.html
\title Using Version Control Systems
Version control systems supported by \QC are:
\table
\header
\i Version Control System
\i Address
\i Notes
\row
\i Bazaar
\i \l{http://bazaar.canonical.com/}
\i \QC 2.2 and later
\row
\i CVS
\i \l{http://www.cvshome.org}
\i
\row
\i Git
\i \l{http://git-scm.com/}
\i
\row
\i Mercurial
\i \l{http://mercurial.selenic.com/}
\i \QC 2.0 and later
\row
\i Perforce
\i \l{http://www.perforce.com}
\i Server version 2006.1 and later
\row
\i Subversion
\i \l{http://subversion.apache.org/}
\i
\endtable
\section1 Setting Up Version Control Systems
\QC uses the version control system's command line clients to access your
repositories. To allow access, make sure that the command line clients can
be located using the \c{PATH} environment variable or specify the path to
the command line client executables in \gui{Tools} > \gui{Options} >
\gui {Version Control}.
After you set up the version control system, use the command line to check
that everything works (for example, use the status command). If no issues
arise, you should be ready to use the system also from \QC.
\section2 Using msysGit on Windows
If you configure Git for use with \c {git bash}, only, and use SSH
authorization, Git looks for the SSH keys in the directory where the
\c HOME environment points to. The variable is always set by \c {git bash}.
However, the variable is typically not set in a Windows command prompt. When
you run Git from a Windows command prompt, it looks for the SSH keys in its
installation directory, and therefore, the authorization fails.
You can set the \c HOME environment variable from \QC. Select \gui {Tools >
Options > Version Control > Git}. Select the \gui {Environment Variables}
and the \gui {Set "HOME" environment variable} check boxes. \c HOME is set
to \c %HOMEDRIVE%%HOMEPATH% when the Git executable is run and authorization
works as it would with \c {git bash}.
\section1 Setting Up Common Options
Select \gui{Tools} > \gui{Options} > \gui{Version Control} > \gui{Common}
to specify settings for submit messages:
\list
\o \gui{Submit message check script} is a script or program that
can be used to perform checks on the submit message before
submitting. The submit message is passed in as the script's first
parameter. If there is an error, the script should output a
message on standard error and return a non-zero exit code.
\o \gui{User/alias configuration file} takes a file in mailmap format
that lists user names and aliases. For example:
\code
Jon Doe <Jon.Doe@company.com>
Hans Mustermann <Hans.Mustermann@company.com> hm <info@company.com>
\endcode
\note The second line above specifies the alias \e{hm} and the
corresponding email address for \e{Hans Mustermann}. If the
user/alias configuration file is present, the submit editor
displays a context menu with \gui{Insert name} that pops up a
dialog letting the user select a name.
\o \gui{User fields configuration file} is a simple text file
consisting of lines specifying submit message fields that take
user names, for example:
\code
Reviewed-by:
Signed-off-by:
\endcode
The fields above appear below the submit message. They provide
completion for the aliases/public user names specified in the
\e{User/alias configuration file} as well as a button that opens the
aforementioned user name dialog.
\o \gui{SSH prompt command} specifies an ssh-askpass command that you
can use (on Linux) to prompt the user for a password when using SSH.
For example, \c ssh-askpass or \c x11-ssh-askpass, depending on the
ssh-askpass implementation that you use.
\endlist
\section1 Creating VCS Repositories for New Projects
\QC allows you to create repositories for version control systems that
support local repository creation, such as Git, Mercurial, or Bazaar.
When creating a new project by selecting \gui File > \gui{New File or
Project}, you can choose a version control system on the final wizard page.
You can also select \gui Tools and then select \gui {Create Repository}
in the submenu for the version control system.
To import a project that is under version control, choose \gui {File >
New File or Project > Project from Version Control} and select the
version control system that you use. Follow the instructions of the
wizard to import the project.
\section1 Using Version Control Systems
The \gui{Tools} menu contains a submenu for each supported version
control system.
The \gui{Version Control} output pane displays the commands that are
executed, a timestamp, and the relevant output. Select \gui {Window > Output
Panes > Version Control} to open the pane.
\image qtcreator-vcs-pane.png
\section2 Adding Files
When you create a new file or a new project, the wizard displays a page
asking whether the files should be added to a version control system.
This happens when the parent directory or the project is already
under version control and the system supports the concept of adding files,
for example, Perforce and Subversion. Alternatively, you can
add files later by using the version control tool menus.
With Git, there is no concept of adding files. Instead, all modified
files must be staged for a commit.
\section2 Viewing Diff Output
All version control systems provide menu options to \e{diff} the current
file or project: to compare it with the latest version stored in the
repository and to display the differences. In \QC, a diff is displayed in a
read-only editor. If the file is accessible, you can double-click on a
selected diff chunk and \QC opens an editor displaying the file, scrolled to
the line in question.
\image qtcreator-vcs-diff.png
\section2 Viewing Versioning History and Change Details
Display the versioning history of a file by selecting \gui{Log}
or \gui{Filelog}. Typically, the log output contains the date, the commit
message, and a change or revision identifier. Click on the identifier to
display a description of the change including the diff.
Right-clicking on an identifier brings up a context menu that lets you
show annotation views of previous versions (see \l{Annotating Files}).
\image qtcreator-vcs-log.png
\section2 Annotating Files
Annotation views are obtained by selecting \gui{Annotate} or \gui{Blame}.
Selecting \gui{Annotate} or \gui{Blame} displays the lines of the file
prepended by the change identifier they originate from. Clicking on the
change identifier shows a detailed description of the change.
To show the annotation of a previous version, right-click on the
version identifier at the beginning of a line and choose one of the
revisions shown at the bottom of the context menu. This allows you to
navigate through the history of the file and obtain previous versions of
it. It also works for Git and Mercurial using SHA's.
The same context menu is available when right-clicking on a version
identifier in the file log view of a single file.
\section2 Committing Changes
Once you have finished making changes, submit them to the version control
system by choosing \gui{Commit} or \gui{Submit}. \QC displays a
commit page containing a text editor where you can enter your commit
message and a checkable list of modified files to be included.
\image qtcreator-vcs-commit.png
When you have finished filling out the commit page information, click on
\gui{Commit} to start committing.
The \gui{Diff Selected Files} button brings up a diff view of the
files selected in the file list. Since the commit page is just another
editor, you can go back to it by closing the diff view. You can also check
a diff view from the editor combo box showing the \gui{Opened files}.
\section2 Reverting Changes
All supported version control system support reverting your project to
known states. This functionality is generally called \e reverting.
The changes discarded depend on the version control system.
A version control system can replace the \gui Revert menu option with other
options.
\section3 Reverting Changes Using Git
The Git version control system has an index that is used to stage
changes. The index is commited on the next commit. Git allows you to revert
back to the state of the last commit as well as to the state staged in the
index.
\list
\o \gui{Undo Unstaged Changes} reverts all changes and resets the
working directory to the state of the index.
\o \gui{Undo Uncommitted Changes} reverts all changes, discarding the
index. This returns your working copy to the state it was in right
after the last commit.
\endlist
\section2 Viewing Status
You can select \gui{Status} to view the status of the project or
repository.
\section2 Updating the Working Tree
You can select \gui Update to update your working tree with the latest
changes from the branch. Some version control systems allow you to choose
between updating the current project and updating all projects.
With Git, you stash your changes and then pull the changes from the
repository.
\section2 Deleting Files
You can select \gui Delete to delete obsolete files from the repository.
With Git, you delete the files from the working tree and then stage the
deleted files for a commit.
\section2 Using Additional Bazaar Functions
Bazaar is a free version control system sponsored by Canonical.
The \gui Bazaar submenu contains the following additional items:
\table
\header
\o Menu Item
\o Description
\row
\i \gui{Pull}
\i Turn the branch into a mirror of another branch.
\row
\i \gui{Push}
\i Update a mirror of the branch.
\endtable
\section2 Using Additional CVS Functions
CVS is an open source version control system.
The \gui CVS submenu contains the following additional items:
\table
\header
\o Menu Item
\o Description
\row
\i \gui{Edit}
\i Open a file for editing.
\row
\i \gui{Push}
\i Push changes to the remote repository.
\row
\i \gui{Unedit}
\i Discard the changes that you made in a file.
\endtable
\section2 Using Additional Git Functions
Git is a fast decentralized version control system. Git is available
for Windows, Linux and Mac.
The \gui Git submenu contains the following additional items:
\table
\header
\o Menu Item
\o Description
\row
\i \gui {Patch > Apply from Editor/Apply from File}
\i Patches are rewriting instructions that can be applied to a set
of files. You can either apply a patch file that is open in \QC
or select the patch file to apply from the file system.
\row
\i \gui{Pull}
\i Pull changes from the remote repository. If there are locally
modified files, you are prompted to stash those changes. Select
\gui{Tools > Options > Version Control > Git} and select the
\gui {Pull with rebase} check box to perform a rebase operation
while pulling.
\row
\i \gui{Clean/Clean Project}
\i All files that are not under version control (with the exception
of patches and project files) are displayed in the \gui {Clean
Repository} dialog. Select the files to delete and click
\gui Delete. This allows you to clean a build completely.
\row
\i \gui{Launch gitk}
\i Start the commit viewer for Git, gitk.
\row
\i \gui{Branches}
\i Manage local and remote branches.
\row
\i \gui Remotes
\i Manage remote repositories available in Git.
\row
\i \gui {Stage File for Commit}
\i Mark new or modified files for committing to the repository.
To undo this function, select \gui {Unstage File from Commit}.
\row
\i \gui{Show Commit}
\i Select a commit to view. Enter the SHA of the commit
in the \gui Change field.
\row
\i \gui Stash
\i Store local changes temporarily.
\row
\i \gui{Amend Last Commit}
\i Revert the last commit.
\endtable
\section3 Working with Branches
To work with Git branches, select \gui{Branches}. The checked out branch
is shown in bold and underlined in the list of branches. Double-click branch
names to edit them.
\image qtcreator-vcs-gitbranch.png "Branches dialog"
The following operations are supported:
\table
\header
\o Menu Item
\o Description
\row
\i \gui{Add}
\i Create new tracking and non-tracking branches.
\row
\i \gui{Checkout}
\i Check out the selected branch and make it current.
\row
\i \gui{Remove}
\i Remove a local branch. You cannot delete remote branches.
\row
\i \gui{Diff}
\i Show the differences between the selected and the current
branch.
\row
\i \gui{Log}
\i Show the changes in a branch.
\row
\i \gui{Refresh}
\i Refresh the list of branches.
\endtable
\section3 Working with Remote Repositories
To manage remote repositories available in Git, select \gui{Remotes}.
Double-click the names and URLs of the remote repositories to edit them.
The following operations are supported:
\table
\header
\o Menu Item
\o Description
\row
\i \gui{Add}
\i Add a new remote repository.
\row
\i \gui{Fetch}
\i Fetch all the branches and change information from a remote
repository.
\row
\i \gui{Remove}
\i Remove a remote repository.
\row
\i \gui{Refresh}
\i Refresh the list of remote repositories.
\endtable
\section3 Using Stashes
With Git, you can put your current set of changes onto a virtual shelf
called a \e stash. Stashes are useful, for example, to put aside a set of
changes to work on higher priority tasks or to pull in new chages from
another repository.
\QC exposes this functionality in the \gui{Tools > Git > Stash} menu.
\table
\header
\o Menu Item
\o Description
\row
\i \gui{Stashes}
\i Display a dialog that shows all known stashes with options to
restore, display or delete them.
\row
\i \gui{Stash}
\i Stash all local changes. The working copy is then reset to
the state it had right after the last commit.
\row
\i \gui{Stash Snapshot}
\i Save a snapshot of your current work under a name for later
reference. The working copy is unchanged.
For example, if you want to try something and find out later
that it does not work, you can discard it and return to the
state of the snapshot.
\row
\i \gui{Stash Pop}
\i Remove a single stashed state from the stash list and apply it
on top of the current working tree state.
\endtable
\section2 Using Additional Mercurial Functionality
Mercurial is a free, distributed source control management tool.
The \gui Mercurial submenu contains the following additional items:
\table
\header
\o Menu Item
\o Description
\row
\i \gui{Import}
\i Apply changes from a patch file.
\row
\i \gui{Incoming}
\i Monitor the status of a remote repository by listing
the changes that will be pulled.
\row
\i \gui{Outgoing}
\i Monitor the status of a remote repository by listing
the changes that will be pushed.
\row
\i \gui{Pull}
\i Pull changes from the remote repository.
\row
\i \gui{Push}
\i Push changes to the remote repository.
\endtable
\section2 Using Additional Perforce Functions
Perforce is a fast software configuration management system developed by
Perforce Software.
When you start \QC, it looks for the executable specified
in the \gui{P4 command} field in \gui{Tools > Options > Version
Control > Perforce}. If the file is not found, the following error
message is displayed in the \gui {Version Control} output pane:
\gui {Perforce: Unable to determine the repository: "p4.exe"
terminated with exit code 1}. If you use Perforce, check that the
path to the executable is specified correctly in the \gui{P4 command}
field.
If you do not use Perforce, you can disable the Perforce plugin to
get rid of the error message. Choose \gui {Help > About Plugins} and
deselect the \gui Load check box for the \gui Perforce plugin in the
\gui {Version Control} group.
The \gui Perforce submenu contains the following additional items:
\table
\header
\o Menu Item
\o Description
\row
\i \gui{Describe}
\i View information about changelists and the files in them.
\row
\i \gui{Edit File}
\i Open a file for editing.
\row
\i \gui{Opened}
\i List files that are open for editing.
\row
\i \gui{Pending Changes}
\i Group files for commit.
\endtable
\section2 Using Additional Subversion Functions
Subversion is an open source version control system.
The \gui Subversion submenu contains the following additional items:
\table
\header
\o Menu Item
\o Description
\row
\i \gui{Describe}
\i Display commit log messages for a revision.
\endtable
*/

307
doc/src/howto/qtcreator-faq.qdoc Normal file
View File

@@ -0,0 +1,307 @@
/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (info@qt.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 info@qt.nokia.com.
**
****************************************************************************/
/*!
\contentspage index.html
\if defined(qcmanual)
\previouspage creator-keyboard-shortcuts.html
\else
\endif
\page creator-faq.html
\if defined(qcmanual)
\nextpage creator-tips.html
\else
\endif
\title FAQ
This section contains answers to some frequently asked questions about \QC.
You might also find answers to your questions in the
\l{Known Issues} and \l{Tips and Tricks} sections, or the Troubleshooting
sections for a special area, such as
\l{Troubleshooting Debugger}{debugging}.
\section1 General Questions
\bold {How do I reset all \QC settings?}
\QC creates two files and a directory:
\list
\o QtCreator.db
\o QtCreator.ini
\o qtcreator
\endlist
The location depends on the platform. On Linux, Unix, and Mac OS, the files
are located in \c{~/.config/Nokia}.
On Windows XP, the files are located in
\c{<drive>:\Documents and Settings\<username>\Application Data\Nokia}, and
on Windows Vista and Windows 7 in
\c {<drive>:\Users\<username>\AppData\Roaming\Nokia}.
For all versions, try the path \c{APPDATA\Nokia}.
\bold {\QC comes with MinGW, should I use this version with Qt?}
Use the version that was built against the Qt version.
\bold {\QC does not find a helper application, such as Git or a
compiler. What should I do?}
Make sure that the application is in your system PATH when starting \QC.
Also select \gui {Tools > Options} to check the settings specified
for the application. Many plugins specify either the path to the tool they
need or the environment they run in.
This is especially relevant for the Mac OS where \c {/usr/local/bin} might
not be in the path when \QC is started.
\bold {How do I change the interface language for \QC?}
\QC has been localized into several languages. If the system
language is one of the supported languages, it is automatically selected.
To change the language, select \gui {Tools > Options > Environment} and
select a language in the \gui Language field. The change takes effect after
you restart \QC.
\bold {Has a reported issue been addressed?}
You can look up any issue in the
\l{https://bugreports.qt.nokia.com/}{Qt bug tracker}.
\if defined(qcmanual)
\input widgets/creator-faq-qtdesigner.qdocinc
\endif
\section1 Help Questions
\bold {The Qt API Reference Documentation is missing and context help does
not find topics. What can I do?}
\QC comes fully integrated with Qt documentation and examples using
the Qt Help plugin. The integrated Qt Reference Documentation is available
for Qt 4.4 and later. \QC, \QSDK, and other Qt deliverables contain
documentation as .qch files. All the documentation is accessible in the
\gui Help mode.
To view the documentation that is available and to add documentation,
select \gui {Tools > Options > Help > Documentation}. For more
information, see \l{Adding External Documentation}.
\section1 Debugger Questions
For information on troubleshooting debugger, see
\l{Troubleshooting Debugger}.
\bold {If I have a choice of GDB versions, which should I use?}
On Linux and Windows, use the Python-enabled GDB versions that are
installed when you install \QC and Qt SDK. On Mac OS X, use the GDB
provided with Xcode. For a custom target, you can build your own
Python-enabled GDB. Follow the instructions in
\l{http://developer.qt.nokia.com/wiki/QtCreatorBuildGdb}{Building GDB}.
You must use at least Python version 2.5, but we recommend that you use
version 2.6.
For more information on setting up debugger, see \l{Setting Up Debugger}.
\bold {How do I generate a core file in \QC?}
To trigger the GDB command that generates a core file while debugging,
select \gui {Window > Views > Debugger Log}. In the \gui Command field,
type \c gcore and press \key Enter. The core file is created in the
current working directory. You can specify another location for the file,
including a relative or absolute path, as an argument of the command.
To generate a temporary core file, select \gui {Create Snapshot} in the
context menu in the \gui Snapshot view. The core file is deleted when you
stop debugging.
\section1 Code Editor Questions
\bold {How can I get code-completion to work on the standard headers and
phonon?}
Install a build from March 31, 2009, or later.
\section1 Compiler Questions
\bold {How can I make use of my multi-core CPU with \QC?}
On Linux and Mac OS X, go to \gui Project mode, select your configuration
in the \gui {Build Settings}, locate the \gui {Build Steps}, and add the
following value, where \c{<num>} is the amount of cores in your CPU:
\c{-j <num>}
On Windows, nmake does not support the \c{-j} parameter. Instead, we
provide a drop-in replacement called jom. You can download a precompiled
version of jom from \l{ftp://ftp.qt.nokia.com/jom/}{Qt FTP server}.
Put jom.exe in a location in the %PATH%. Go to the \gui {Build Settings}
and set jom.exe as the make command.
\note: Unlike GNU make, jom automatically detects your cores and spawns as
many parallel processes as your CPU has cores. You can override this
behavior by using the \c{-j} parameter as described above.
\section1 Qt SDK Questions
\bold {I cannot use QSslSocket with the SDK. What should I do?}
The Qt build in the SDK is built with QT_NO_OPENSSL defined. Rebuilding it
is possible. For more information, see
\l{http://www.qtcentre.org/forum/f-qt-programming-2/t-qssl-19222-post94842.html}.
\bold {Which development packages from the distribution are needed on
Ubuntu or Debian?}
\code
sudo apt-get install libglib2.0-dev libSM-dev libxrender-dev libfontconfig1-dev libxext-dev
\endcode
If you use QtOpenGL, you also need:
\code
sudo apt-get install libgl-dev libglu-dev
\endcode
\section1 Platform Releated Questions
\bold {Where is application output shown in \QC?}
\bold {On Unix (Linux and Mac OS):} \c qDebug() and related functions use
the standard output and error output. When you run or debug the
application, you can view the output in the \gui{Application Output} pane.
For console applications that require input, select \gui {Projects > Run
Settings > Run in terminal}.
\bold {On Windows:} Output is displayed differently for \e{console
applications} and \e{GUI applications}.
The setting \c {CONFIG += console} in the .pro file specifies that the
application is built as a console application using some other runtime.
When you run a console application, you can view the output in the console
window of the calling application. If the
calling application is a GUI application (for example, a release-built
version of \QC), a new console window is opened. For this
type of application, \c qDebug() and related functions use standard output
and error output.
We recommend that you select \gui {Projects > Run Settings > Run in
terminal} for console applications.
For GUI applications, \c qDebug() and related functions use the Windows API
function \c OutputDebugString(). The output is displayed in the
\gui{Application Output} pane. However, only one output pane tab may be
open at a time or the output is not displayed correctly. You can use an
external debug output viewer, such as the
\l{http://technet.microsoft.com/en-us/sysinternals/bb896647}{DebugView for Windows}
to display output from GUI applications.
\if defined(qcmanual)
\input symbian/creator-faq-debug-output-symbian.qdocinc
\endif
\section1 Questions about New Features
\bold {Will a requested feature be implemented?}
If it is a scheduled feature, you can see this in the task tracker. If a
feature already has been implemented, it is mentioned in the
\l{http://qt.gitorious.org/qt-creator/qt-creator/trees/master/dist}{changes file}
for the upcoming release.
\bold {Why does \QC not use tabs for editors?}
This question comes up from time to time, so we have considered it
carefully. Here are our main reasons for not using tabs:
\list
\o Tabs do not scale. They work fine if you have 5 to 6 editors open,
they become cumbersome with 10, and if you need more horizontal
space than the tab bar, the interface does not work at all.
\o Tabs do not adapt to your working set.
\o The common solution is to give the user the ability to reorder
tabs. Now user has to manage tabs instead of writing code.
\o Tabs force you to limit the amount of open editors, because
otherwise you get confused.
\endlist
Consider the following use case: \e {Developers want to switch editors.}
In fact, developers do not want to switch editors, but might have to do so
to accomplish their tasks. We need to figure out what the tasks are to
provide developers with better ways to navigate while performing the tasks.
One common factor in many use cases is switching editors while working on a
set of open files. While working on files A and B, users sometimes need to
look at file C. They can press \key Ctrl+Tab to move between the files and
have the files open in the correct editor according to file type. The list
is sorted by last used.
Typically, users also work on multiple classes or functions that are
related, even though they are defined or declared in different files.
\QC provides two shortcuts for that: \key F2 to follow the symbol
and \key Ctrl+Shift+U to find usages.
In addition, developers can:
\list
\o Press \key F4 to switch between header and source.
\o Press \key Alt+Left to move backwards in the navigation history.
\o Use the locator (Ctrl+K) to simply tell \QC where to go.
\endlist
The locator can be used to open files, but opening files is also just a
step on the way to accomplish a task. For example, consider the following
use case: \e {Fix AMethod in SomeClass which comes from
someclass.cpp/someclass.h}.
With a tabbed user interface, developers would search for someclass.cpp in
the tab bar, and then search for \c {::AMethod}, only to find out that the
method is not located in that file. They would then search for someclass.h
in the tab bar, find our that the function is inline, fix the problem, and
forget where they came from.
With \QC, developers can type \c {Ctrl+K m AMet} to find the method.
Typically, they only need to type 3 to 4 characters of the method name.
They can then fix the problem and press \key Alt+Back to go back to where
they were.
Other locator filters include \c c for classes, \c : for all symbols, and
(thanks to a community contribution) \c . for symbols in the current file.
*/