diff options
author | con <qtc-committer@nokia.com> | 2010-06-30 14:25:09 +0200 |
---|---|---|
committer | con <qtc-committer@nokia.com> | 2010-06-30 14:25:09 +0200 |
commit | ede2a7c97599886aa0ce7d36502b8d7966d78a77 (patch) | |
tree | 194495903d59c542d5db00c8bcc18710fdc7b3eb /doc/qtcreator.qdoc | |
parent | 82cc4b430209bbdfccc4acecc4253327870fb161 (diff) | |
parent | 21b211fed0ae36de57dbfb9ca60239dd259b9a60 (diff) | |
download | qt-creator-ede2a7c97599886aa0ce7d36502b8d7966d78a77.tar.gz |
Merge remote branch 'origin/2.0'
Conflicts:
doc/qtcreator.qdoc
share/qtcreator/gdbmacros/dumper.py
src/libs/qmljs/qmljs-lib.pri
src/plugins/debugger/breakhandler.cpp
src/plugins/projectexplorer/projectexplorer.h
src/plugins/qt4projectmanager/qt-maemo/maemopackagecreationstep.cpp
src/plugins/qt4projectmanager/qt-maemo/maemopackagecreationstep.h
Diffstat (limited to 'doc/qtcreator.qdoc')
-rw-r--r-- | doc/qtcreator.qdoc | 315 |
1 files changed, 251 insertions, 64 deletions
diff --git a/doc/qtcreator.qdoc b/doc/qtcreator.qdoc index 7352be4e5a..07b9397f59 100644 --- a/doc/qtcreator.qdoc +++ b/doc/qtcreator.qdoc @@ -47,7 +47,7 @@ \list \o \l{Introducing Qt Creator} \o \l{Operating Systems and Supported Platforms} - \o \l{Quick Tour} + \o \l{Qt Creator User Interface} \o \l{Getting Started} \list \o \l{Building and Running an Example Application} @@ -55,16 +55,6 @@ \o \l{Creating a Mobile Application with Nokia Qt SDK} \o \l{Creating a Qt Quick Application} \endlist - \o \l{Using the Editor} - \list - \o \l{Finding and Replacing} - \o \l{Refactoring} - \o \l{Searching With the Locator} - \o \l{Pasting and Fetching Code Snippets} - \o \l{Configuring the Editor} - \o \l{Using FakeVim Mode} - \o \l{Using an External Editor} - \endlist \o \l{Managing Projects} \list \o \l{Creating a Project} @@ -75,6 +65,36 @@ \o \l{Setting Up Development Environment for Symbian} \o \l{Managing Sessions} \endlist + \o \l{Using the Editor} + \list + \o \l{Finding and Replacing} + \o \l{Refactoring} + \o \l{Searching With the Locator} + \o \l{Pasting and Fetching Code Snippets} + \o \l{Configuring the Editor} + \o \l{Using FakeVim Mode} + \o \l{Using an External Editor} + \endlist + \o \l{Developing Application UI} + \list + \o \l{Optimizing Applications for Mobile Devices} + \o \l{Adding Qt Designer Plugins} + \if defined(qtquick) + \o \l{Developing Qt Quick Applications} + \list + \o \l {Creating Qt Quick Projects} + \o \l {Designing Application UI} + \o \l {Creating Components} + \o \l {Creating Buttons} + \o \l {Creating Scalable Buttons and Borders} + \o \l {Creating Screens} + \o \l {Creating List Views} + \o \l {Animating Screens} + \o \l {Adding User Interaction Methods} + \o \l {Implementing Application Logic} + \endlist + \endif + \endlist \o \l{Building and Running Applications} \list \o \l{Building for Multiple Targets} @@ -86,6 +106,7 @@ \o \l{Developing Qt Quick Applications} \o \l{Optimizing Applications for Mobile Devices} \o \l{Using the Maemo Emulator} + \o \l{Debugging} \list \o \l {Debugging Qt Applications} @@ -100,8 +121,10 @@ \o \l{Using the QML Inspector} \endlist \endlist + \o \l{Using the Maemo Emulator} \o \l{Using Version Control Systems} - \o \l{Adding Qt Designer Plugins} + + \o \l{Getting Help} \o \l{Tips and Tricks} \o \l{Keyboard Shortcuts} \o \l{Known Issues} @@ -296,13 +319,32 @@ \page creator-quick-tour.html \nextpage creator-getting-started.html - \title Quick Tour - - The figure below shows some of the components of Qt Creator in - \gui{Edit} mode. + \title Qt Creator User Interface \image qtcreator-breakdown.png + When you start Qt Creator, it opens to the \gui Welcome mode, where you can: + + \list + + \o Open tutorials and example projects + + \o View tips and hints on using Qt Creator + + \o Create and open projects + + \o Send feedback to the development team + + \o Open recent sessions and projects + + \o Read news from the Qt labs + + \o Ask for support + + \endlist + + You can use the mode selector to change to another Qt Creator mode. + Qt Creator 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 @@ -316,15 +358,22 @@ executed, and debugging your applications. To change modes, click the icons, or use the \l{keyboard-shortcuts}{corresponding keyboard shortcut}. + You can use Qt Creator in the following modes: + \list - \o \gui Welcome mode for opening recent sessions and projects. \o \gui{\l{Using the Editor}{Edit}} mode for editing project and source files. + \if defined(qtquick) \o \gui{\l{Developing Application UI}{Design}} mode for designing and developing + application user interfaces. This mode is available for UI files (.ui or + .qml). + \else + \o \gui{\l{Using Qt Designer}{Design}} mode for designing and developing application user interfaces. + \endif \o \gui{\l{Debugging}{Debug}} mode for inspecting the state of your program while debugging. \o \gui{\l{Managing Projects}{Projects}} mode for configuring project building and - execution. + execution. This mode is available when a project is open. \o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation. \endlist @@ -335,6 +384,7 @@ \section1 Browsing Project Contents + The sidebar is available in the \gui Edit and \gui Debug modes. Use the sidebar to browse files, projects and bookmarks. \image qtcreator-sidebar.png @@ -451,8 +501,24 @@ \image qtcreator-compile-pane.png + \section1 Navigating with Keyboard + + Qt Creator caters not only to developers who are used to using the mouse, + but also to developers who are more comfortable with the keyboard. A wide + range of \l{keyboard-shortcuts}{keyboard} and + \l{Searching With the Locator}{navigation} shortcuts are available to help + speed up the process of developing your application. + +*/ + + +/*! + \contentspage index.html + \previouspage creator-version-control.html + \page creator-help.html + \nextpage creator-tips.html - \section1 Getting Help + \title Getting Help Qt Creator comes fully integrated with Qt documentation and examples using the Qt Help plugin. @@ -469,7 +535,7 @@ \gui Help mode, select \gui Tools > \gui Options... > \gui Help. \endlist - \section2 Adding External Documentation + \section1 Adding External Documentation You can display external documentation in the \gui Help mode. To augment or replace the documentation that ships with Qt Creator and Qt: @@ -483,7 +549,7 @@ \gui Options... > \gui Help > \gui Documentation > \gui Add. \endlist - \section2 Using Documentation Filters + \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 @@ -524,15 +590,16 @@ To remove filters, select them in \gui Filters, and click \gui Remove. - \section1 Navigating with Keyboard +*/ - Qt Creator caters not only to developers who are used to using the mouse, - but also to developers who are more comfortable with the keyboard. A wide - range of \l{keyboard-shortcuts}{keyboard} and - \l{Searching With the Locator}{navigation} shortcuts are available to help - speed up the process of developing your application. - \section1 Developing Application UI +/*! + \contentspage index.html + \previouspage creator-editor-external.html + \page creator-design-mode.html + \nextpage creator-usability.html + + \title Developing Application UI To help you design the user interface of your application, two visual editors are integrated into Qt Creator: @@ -622,12 +689,17 @@ \endlist + For more information on using the \QMLD visual editor, see + \l{Developing Qt Quick Applications}. + + \endif + */ /*! \contentspage index.html - \previouspage creator-qml-application.html + \previouspage creator-project-managing-sessions.html \page creator-editor-using.html \nextpage creator-editor-finding.html @@ -945,7 +1017,7 @@ \contentspage index.html \previouspage creator-editor-fakevim.html \page creator-editor-external.html - \nextpage creator-project-managing.html + \nextpage creator-design-mode.html \title Using an External Editor @@ -1301,7 +1373,7 @@ /*! \contentspage index.html - \previouspage creator-editor-external.html + \previouspage creator-qml-application.html \page creator-project-managing.html \nextpage creator-project-creating.html @@ -1404,7 +1476,8 @@ \title Creating a Project You use wizards to create and import several types of projects and files, such - as Qt GUI or console applications and Qt Quick applications. You can also use + as Qt GUI or console applications and Qt Quick applications. + You can also use wizards to add individual files to your projects. For example, you can create the following types of files: @@ -1864,7 +1937,7 @@ /*! \contentspage index.html - \previouspage creator-project-managing-sessions.html + \previouspage quick-application-logic.html \page creator-building-running.html \nextpage creator-building-targets.html @@ -2446,7 +2519,7 @@ \contentspage index.html \previouspage creator-editor-settings.html \page creator-build-dependencies.html - \nextpage creator-visual-editor.html + \nextpage creator-debugging.html \title Specifying Dependencies @@ -2799,7 +2872,7 @@ \contentspage index.html \previouspage creator-mobile-example.html \page creator-qml-application.html - \nextpage creator-editor-using.html + \nextpage creator-project-managing.html \title Creating a Qt Quick Application @@ -2830,7 +2903,7 @@ \image qmldesigner-new-project-location.png "Introduction and Project Location dialog" - \o In the \gui{Name} field, type \bold {Hello World}. + \o In the \gui{Name} field, type \bold {HelloWorld}. \o In the \gui {Create in} field, enter the path for the project files. For example, \c {C:\Qt\examples}, and then click \gui{Next}. @@ -3266,9 +3339,9 @@ /*! \contentspage index.html - \previouspage creator-qml-inspector.html + \previouspage creator-maemo-emulator.html \page creator-version-control.html - \nextpage adding-plugins.html + \nextpage creator-help.html \title Using Version Control Systems @@ -3777,7 +3850,7 @@ \contentspage index.html \previouspage creator-developing-symbian.html \page creator-project-managing-sessions.html - \nextpage creator-building-running.html + \nextpage creator-editor-using.html \title Managing Sessions @@ -3808,7 +3881,7 @@ /*! \contentspage index.html - \previouspage creator-maemo-emulator.html + \previouspage creator-build-dependencies.html \page creator-debugging.html \nextpage creator-debugging-cpp.html @@ -3909,7 +3982,7 @@ \contentspage index.html \previouspage creator-debugging-qml.html \page creator-qml-inspector.html - \nextpage creator-version-control.html + \nextpage creator-maemo-emulator.html \title Using the QML Inspector @@ -4400,14 +4473,10 @@ \note Populating the cache might take a long time on a slow network connection. - - \omit In v2.1 and later: - \note The first time you start debugging by using the Debugging tools for Windows, Qt Creator prompts you to add the Symbol Server. - \endomit */ /*! @@ -5228,9 +5297,9 @@ /*! \contentspage index.html - \previouspage creator-build-dependencies.html + \previouspage adding-plugins.html \page creator-visual-editor.html - \nextpage creator-usability.html + \nextpage quick-projects.html \title Developing Qt Quick Applications @@ -5245,6 +5314,22 @@ You can use the code editor (\gui Edit mode) or the visual editor (\gui Design mode) to develop Qt Quick applications. + The following sections describe typical tasks you can do with Qt Creator. + + \list + + \o \l {Creating Qt Quick Projects} + \o \l {Designing Application UI} + \o \l {Creating Components} + \o \l {Creating Buttons} + \o \l {Creating Scalable Buttons and Borders} + \o \l {Creating Screens} + \o \l {Creating List Views} + \o \l {Animating Screens} + \o \l {Adding User Interaction Methods} + \o \l {Implementing Application Logic} + + \endlist \note The \QMLD visual editor is provided as an experimental plugin that you must enable to be able to edit QML files in the \gui Design mode. Enabling the @@ -5254,7 +5339,17 @@ \gui {Help > About Plugins... > Qt Quick > QmlDesigner}. You must restart Qt Creator to enable or disable the visual editor. - \section1 Creating Qt Quick Projects +*/ + + +/*! + + \contentspage index.html + \previouspage creator-visual-editor.html + \page quick-projects.html + \nextpage quick-ui.html + + \title Creating Qt Quick Projects Select \gui {File > New File or Project > Qt Quick Project > Qt QML Application}. @@ -5282,11 +5377,31 @@ To import a QML project to Qt Creator, select \gui {File > New File or Project > Qt Quick Project > Import Existing Qt QML Directory}. - \section1 Designing Application UI +*/ + + +/*! + + \contentspage index.html + \previouspage quick-projects.html + \page quick-ui.html + \nextpage quick-components.html + + \title Designing Application UI One .qml file can define a component, screen, or the whole application. - \section2 Creating Components +*/ + + +/*! + + \contentspage index.html + \previouspage quick-ui.html + \page quick-components.html + \nextpage quick-buttons.html + + \title Creating Components A QML component provides a way of defining a new type that you can re-use in other QML files. A component is like a black box; it interacts with the outside world @@ -5322,7 +5437,17 @@ The following sections describe some use cases for the QML elements. - \section3 Creating Buttons +*/ + + +/*! + + \contentspage index.html + \previouspage quick-components.html + \page quick-buttons.html + \nextpage quick-scalable-image.html + + \title Creating Buttons To create a button component: @@ -5387,7 +5512,17 @@ use the \l{http://doc.qt.nokia.com/4.7-snapshot/qml-borderimage.html}{Border Image} element. - \section3 Creating Scalable Buttons and Borders +*/ + + +/*! + + \contentspage index.html + \previouspage quick-buttons.html + \page quick-scalable-image.html + \nextpage quick-screens.html + + \title Creating Scalable Buttons and Borders You can use the \l{http://doc.qt.nokia.com/4.7-snapshot/qml-borderimage.html}{Border Image} element to display an image, such as a PNG file, as a border and a background. @@ -5538,7 +5673,17 @@ \endlist - \section2 Creating Screens +*/ + + +/*! + + \contentspage index.html + \previouspage quick-scalable-image.html + \page quick-screens.html + \nextpage quick-list-views.html + + \title Creating Screens You can use the \gui Library items and your own components to create screens. @@ -5574,7 +5719,17 @@ \endlist - \section3 Creating List Views +*/ + + +/*! + + \contentspage index.html + \previouspage quick-screens.html + \page quick-list-views.html + \nextpage quick-animations.html + + \title Creating List Views You use list views and list models to create lists. You use delegates to handle list items. Typically, the list model is provided by a QAbstractListModel C++ model object, @@ -5684,7 +5839,17 @@ \endlist - \section2 Navigating Between Screens +*/ + + +/*! + + \contentspage index.html + \previouspage quick-list-views.html + \page quick-animations.html + \nextpage quick-user-interaction.html + + \title Animating Screens To make movement between states smooth, you can specify transitions. You can use different types of animated transitions. For example, you can animate changes @@ -5695,9 +5860,21 @@ You can use the \c ParallelAnimation element to start several animations at the same time. Or use the \c SequentialAnimation element to run them one after another. + You can use the code editor to specify transitions. For more information, see + \l{http://doc.qt.nokia.com/4.7-snapshot/qml-transition.html}{QML Transition Element}. + +*/ + + +/*! + + \contentspage index.html + \previouspage quick-animations.html + \page quick-user-interaction.html + \nextpage quick-application-logic.html - \section2 Adding User Interaction Methods + \title Adding User Interaction Methods You can add the following basic interaction methods to scenes: @@ -5721,7 +5898,17 @@ For instance, the \gui {MouseArea} element has signal handlers to handle mouse press, release, and click. - \section1 Implementing Application Logic +*/ + + +/*! + + \contentspage index.html + \previouspage quick-user-interaction.html + \page quick-application-logic.html + \nextpage creator-building-running.html + + \title Implementing Application Logic A user interface is only a part of an application, and not really useful by itself. You can use Qt or JavaScript to implement the application logic. For more information on @@ -6191,9 +6378,9 @@ /*! \contentspage index.html - \previouspage creator-usability.html + \previouspage creator-qml-inspector.html \page creator-maemo-emulator.html - \nextpage creator-debugging.html + \nextpage creator-version-control.html \title Using the Maemo Emulator @@ -6434,9 +6621,9 @@ /*! \contentspage index.html - \previouspage creator-version-control.html + \previouspage creator-usability.html \page adding-plugins.html - \nextpage creator-tips.html + \nextpage creator-visual-editor.html \title Adding Qt Designer Plugins @@ -6489,9 +6676,9 @@ /*! \contentspage index.html - \previouspage creator-visual-editor.html + \previouspage creator-design-mode.html \page creator-usability.html - \nextpage creator-maemo-emulator.html + \nextpage adding-plugins.html \title Optimizing Applications for Mobile Devices @@ -6580,7 +6767,7 @@ /*! \contentspage index.html - \previouspage adding-plugins.html + \previouspage creator-help.html \page creator-tips.html \nextpage creator-keyboard-shortcuts.html |