forked from qt-creator/qt-creator
8f53c02296
Users can now use the code editor within the Qt Quick Designer. Change-Id: I2ad30bafc4b61ce9c1115c9a8b1c019d2b21151e Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
119 lines
4.0 KiB
Plaintext
119 lines
4.0 KiB
Plaintext
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of the Qt Creator documentation.
|
|
**
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU Free Documentation License Usage
|
|
** 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. Please review the following information to ensure
|
|
** the GNU Free Documentation License version 1.3 requirements
|
|
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
|
|
**
|
|
****************************************************************************/
|
|
|
|
// **********************************************************************
|
|
// 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 {Qt Creator Manual}
|
|
\previouspage quick-projects.html
|
|
\page creator-quick-ui-forms.html
|
|
\nextpage creator-using-qt-quick-designer.html
|
|
|
|
\title Qt Quick UI Forms
|
|
|
|
You can use \QC wizards to create UI forms that have the filename extension
|
|
\e .ui.qml. The UI forms contain a purely declarative subset of the QML
|
|
language. It is recommended that you edit the forms in the \uicontrol Design mode.
|
|
\QC enforces the use of the supported QML features by displaying error
|
|
messages.
|
|
|
|
The following features are not supported:
|
|
|
|
\list
|
|
\li JavaScript blocks
|
|
\li Function definitions
|
|
\li Function calls (except \c qsTr)
|
|
\li Other bindings than pure expressions
|
|
\li Signal handlers
|
|
\li States in other items than the root item
|
|
\li Root items that are not derived from \l QQuickItem or \l [QML]{Item}
|
|
\endlist
|
|
|
|
The following types are not supported:
|
|
|
|
\list
|
|
\li Behavior
|
|
\li Binding
|
|
\li Canvas
|
|
\li Component
|
|
\li Shader Effect
|
|
\li Timer
|
|
\li Transform
|
|
\li Transition
|
|
\endlist
|
|
|
|
\section1 Using Qt Quick UI Forms
|
|
|
|
You can edit the forms in the \uicontrol {Form Editor} and
|
|
\uicontrol {Text Editor} tabs in the \uicontrol Design mode. Items that are
|
|
supposed to be used in QML code have to be exported as properties:
|
|
|
|
\code
|
|
Item {
|
|
width: 640
|
|
height: 480
|
|
|
|
property alias button: button
|
|
|
|
Button {
|
|
anchors.centerIn: parent
|
|
id: button
|
|
text: qsTr("Press Me")
|
|
}
|
|
}
|
|
\endcode
|
|
|
|
The property alias exports the button to the QML code that uses the form.
|
|
You can use the
|
|
\inlineimage export_checked.png
|
|
(\uicontrol Export) button in the \uicontrol Navigator to export an item as
|
|
a property:
|
|
|
|
\image qmldesigner-export-item.png
|
|
|
|
In the QML file that uses the form, you can use the \c button property alias
|
|
to implement signal handlers, for example. In the following code snippet,
|
|
the UI form is called \e MainForm.ui.qml:
|
|
|
|
\code
|
|
MainForm {
|
|
anchors.fill: parent
|
|
button.onClicked: messageDialog.show(qsTr("Button pressed"))
|
|
}
|
|
\endcode
|
|
|
|
You can also assign properties or define behavior or transitions.
|
|
|
|
To move from the \uicontrol Design mode directly to the implementation of a
|
|
type in the .qml file, right-click the type in the \uicontrol Navigator and
|
|
select \uicontrol {Go to Implementation} in the context menu.
|
|
|
|
*/
|