forked from qt-creator/qt-creator
Doc: Add screenshots for QML code completion
Use defines to hide C++-specific info from Qt Design Studio Manual. Change-Id: Ia1a0f730f8999e5b6f1dfe69779729bb90c46a1d Reviewed-by: Marco Benelli <marco.benelli@qt.io> Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
This commit is contained in:
BIN
doc/images/qml-code-completion.png
Normal file
BIN
doc/images/qml-code-completion.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 24 KiB |
BIN
doc/images/qml-code-snippet.png
Normal file
BIN
doc/images/qml-code-snippet.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 31 KiB |
BIN
doc/images/qml-snippet-editor.png
Normal file
BIN
doc/images/qml-snippet-editor.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 47 KiB |
@@ -36,7 +36,15 @@
|
|||||||
the statement currently under your cursor. Press \key Tab
|
the statement currently under your cursor. Press \key Tab
|
||||||
or \key Enter to accept the selected suggestion and complete the code.
|
or \key Enter to accept the selected suggestion and complete the code.
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
|
The following image displays suggestions for completing C++ code:
|
||||||
|
|
||||||
\image qtcreator-codecompletion.png
|
\image qtcreator-codecompletion.png
|
||||||
|
\endif
|
||||||
|
|
||||||
|
The following image displays suggestions for completing QML code:
|
||||||
|
|
||||||
|
\image qml-code-completion.png
|
||||||
|
|
||||||
To open the list of suggestions at any time, press \key {Ctrl+Space}.
|
To open the list of suggestions at any time, press \key {Ctrl+Space}.
|
||||||
If only one option is available, \QC inserts it automatically.
|
If only one option is available, \QC inserts it automatically.
|
||||||
@@ -61,6 +69,7 @@
|
|||||||
\header
|
\header
|
||||||
\li Icon
|
\li Icon
|
||||||
\li Description
|
\li Description
|
||||||
|
\if defined(qtcreator)
|
||||||
\row
|
\row
|
||||||
\li \inlineimage completion/class.png
|
\li \inlineimage completion/class.png
|
||||||
\li A class
|
\li A class
|
||||||
@@ -106,18 +115,21 @@
|
|||||||
\row
|
\row
|
||||||
\li \inlineimage completion/snippet.png
|
\li \inlineimage completion/snippet.png
|
||||||
\li A C++ code snippet
|
\li A C++ code snippet
|
||||||
|
\endif
|
||||||
\row
|
\row
|
||||||
\li \inlineimage completion/element.png
|
\li \inlineimage completion/element.png
|
||||||
\li A QML type
|
\li A QML type
|
||||||
\row
|
\row
|
||||||
\li \inlineimage completion/qmlsnippet.png
|
\li \inlineimage completion/qmlsnippet.png
|
||||||
\li A QML code snippet
|
\li A QML code snippet
|
||||||
|
\if defined(qtcreator)
|
||||||
\row
|
\row
|
||||||
\li \inlineimage completion/macro.png
|
\li \inlineimage completion/macro.png
|
||||||
\li A macro
|
\li A macro
|
||||||
\row
|
\row
|
||||||
\li \inlineimage completion/namespace.png
|
\li \inlineimage completion/namespace.png
|
||||||
\li A namespace
|
\li A namespace
|
||||||
|
\endif
|
||||||
\endtable
|
\endtable
|
||||||
|
|
||||||
\section2 Completing Code Snippets
|
\section2 Completing Code Snippets
|
||||||
@@ -128,16 +140,32 @@
|
|||||||
them. When you specify a value for a variable, all instances of the variable
|
them. When you specify a value for a variable, all instances of the variable
|
||||||
within the snippet are renamed.
|
within the snippet are renamed.
|
||||||
|
|
||||||
\image qmldesigner-code-completion.png "Completing QML code"
|
\if defined(qtcreator)
|
||||||
|
The following image shows a C++ code snippet:
|
||||||
|
|
||||||
|
\image qmldesigner-code-completion.png "Completing C++ code"
|
||||||
|
\endif
|
||||||
|
|
||||||
|
The following image shows a QML code snippet:
|
||||||
|
|
||||||
|
\image qml-code-snippet.png
|
||||||
|
|
||||||
\section2 Editing Code Snippets
|
\section2 Editing Code Snippets
|
||||||
|
|
||||||
Code snippets specify C++ or QML code constructs. You can add, modify,
|
Code snippets specify code constructs. You can add, modify,
|
||||||
and remove snippets in the snippet editor. To open the editor, select
|
and remove snippets in the snippet editor. To open the editor, select
|
||||||
\uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} >
|
\uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} >
|
||||||
\uicontrol Snippets.
|
\uicontrol Snippets.
|
||||||
|
|
||||||
\image qtcreator-edit-code-snippets.png "Snippet options"
|
\if defined(qtcreator)
|
||||||
|
The following image shows built-in C++ code snippets:
|
||||||
|
|
||||||
|
\image qtcreator-edit-code-snippets.png "C++ snippet options"
|
||||||
|
\endif
|
||||||
|
|
||||||
|
The following image shows built-in QML code snippets:
|
||||||
|
|
||||||
|
\image qml-snippet-editor.png
|
||||||
|
|
||||||
\QC provides you with built-in snippets in the following categories:
|
\QC provides you with built-in snippets in the following categories:
|
||||||
|
|
||||||
@@ -146,14 +174,18 @@
|
|||||||
\li Text snippets, which can contain any text string. For example, code
|
\li Text snippets, which can contain any text string. For example, code
|
||||||
comments
|
comments
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
\li C++ code snippets, which specify C++ code constructs
|
\li C++ code snippets, which specify C++ code constructs
|
||||||
|
|
||||||
\li CMake code snippets that you can use when editing \c CMakeLists.txt
|
\li CMake code snippets that you can use when editing \c CMakeLists.txt
|
||||||
files in the CMake editor
|
files in the CMake editor
|
||||||
|
\endif
|
||||||
|
|
||||||
\li QML code snippets, which specify QML code constructs
|
\li QML code snippets, which specify QML code constructs
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
\li Nim code snippets, which specify Nim code constructs
|
\li Nim code snippets, which specify Nim code constructs
|
||||||
|
\endif
|
||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
@@ -162,9 +194,15 @@
|
|||||||
Select a snippet in the list to edit it in the snippet editor. To add a new
|
Select a snippet in the list to edit it in the snippet editor. To add a new
|
||||||
snippet, select \uicontrol Add. Specify a trigger and, if the trigger is
|
snippet, select \uicontrol Add. Specify a trigger and, if the trigger is
|
||||||
already in use, an optional variant, which appear in the list of suggestions
|
already in use, an optional variant, which appear in the list of suggestions
|
||||||
when you write code. Also specify a text string or C++ or QML code construct
|
when you write code.
|
||||||
|
\if defined(qtcreator)
|
||||||
|
Also specify a text string or C++ or QML code construct
|
||||||
in the snippet editor, depending on the snippet category. You can use
|
in the snippet editor, depending on the snippet category. You can use
|
||||||
\l{Using Qt Creator Variables}{predefined variables} in snippets.
|
\l{Using Qt Creator Variables}{predefined variables} in snippets.
|
||||||
|
\else
|
||||||
|
Also specify a text string or QML code in the snippet editor, depending on
|
||||||
|
the snippet category.
|
||||||
|
\endif
|
||||||
|
|
||||||
The snippet editor provides you with:
|
The snippet editor provides you with:
|
||||||
|
|
||||||
@@ -186,6 +224,7 @@
|
|||||||
$variable$
|
$variable$
|
||||||
\endcode
|
\endcode
|
||||||
|
|
||||||
|
\if defined(qtcreator)
|
||||||
Specify \QC variables in the following format:
|
Specify \QC variables in the following format:
|
||||||
|
|
||||||
\code
|
\code
|
||||||
@@ -220,6 +259,7 @@
|
|||||||
\endcode
|
\endcode
|
||||||
|
|
||||||
\image qtcreator-snippet-modifiers.png
|
\image qtcreator-snippet-modifiers.png
|
||||||
|
\endif
|
||||||
|
|
||||||
The snippet editor does not check the syntax of the snippets that you edit
|
The snippet editor does not check the syntax of the snippets that you edit
|
||||||
or add. However, when you use the snippets, the code editor marks any
|
or add. However, when you use the snippets, the code editor marks any
|
||||||
|
Reference in New Issue
Block a user