From 7ae91977c3bea806ffe962fdf5582252cd10e43a Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 14 May 2019 16:00:06 +0200 Subject: Doc: Use [QtQuick] as module identifier for QDoc instead of [QML] The latter does not seem to work, after all. Change-Id: Icade96a0810b73a85d35532d394c09f6f703a3a8 Reviewed-by: Martin Smith --- doc/src/qtquick/qtquick-components.qdoc | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) (limited to 'doc/src') diff --git a/doc/src/qtquick/qtquick-components.qdoc b/doc/src/qtquick/qtquick-components.qdoc index 36190f81060..4cee65201f9 100644 --- a/doc/src/qtquick/qtquick-components.qdoc +++ b/doc/src/qtquick/qtquick-components.qdoc @@ -92,24 +92,24 @@ You can use the following QML types to create components: \list - \li \l [QML]{AnimatedImage}{Animated Image} provides a way to play + \li \l [QtQuick]{AnimatedImage}{Animated Image} provides a way to play animations stored as images containing a series of frames, such as those stored in GIF files. - \li \l [QML]{BorderImage}{Border Image} uses an image as a border or + \li \l [QtQuick]{BorderImage}{Border Image} uses an image as a border or background. - \li \l [QML]{Image} adds a bitmap to the scene. You can stretch and + \li \l [QtQuick]{Image} adds a bitmap to the scene. You can stretch and tile images. - \li \l [QML]{Item} is the most basic of all visual types in QML. Even + \li \l [QtQuick]{Item} is the most basic of all visual types in QML. Even though it has no visual appearance, it defines all the properties that are common across visual types, such as the x and y position, width and height, anchoring, and key handling. - \li \l [QML]{Rectangle} adds a rectangle that is painted with a solid + \li \l [QtQuick] {Rectangle} adds a rectangle that is painted with a solid fill color and an optional border. You can use the radius property to create rounded rectangles. - \li \l [QML]{Text} adds formatted read-only text. - \li \l [QML]{TextEdit}{Text Edit} adds a single line of editable + \li \l [QtQuick]{Text} adds formatted read-only text. + \li \l [QtQuick]{TextEdit}{Text Edit} adds a single line of editable formatted text that can be validated. - \li \l [QML]{TextInput}{Text Input} adds a single line of editable + \li \l [QtQuick]{TextInput}{Text Input} adds a single line of editable plain text that can be validated. \endlist @@ -267,12 +267,12 @@ You can use the following positioners to arrange items in UIs: \list - \li \l[QML] {Column} arranges its child items vertically. - \li \l[QML] {Row} arranges its child items horizontally. - \li \l[QML] {Grid} + \li \l[QtQuick] {Column} arranges its child items vertically. + \li \l[QtQuick] {Row} arranges its child items horizontally. + \li \l[QtQuick] {Grid} arranges its child items so that they are aligned in a grid and are not overlapping. - \li \l[QML] {Flow} + \li \l[QtQuick] {Flow} arranges its child items side by side, wrapping as necessary. \endlist @@ -365,7 +365,7 @@ \li \l{FocusScope}{Focus Scope} assists in keyboard focus handling when building reusable QML components. - \li \l [QML]{MouseArea}{Mouse Area} enables simple mouse handling. + \li \l [QtQuick]{MouseArea}{Mouse Area} enables simple mouse handling. \endlist Since Qt 5.7, you can also use the following \l{Qt Quick Controls} types -- cgit v1.2.3 From 14504441cf06c556d95552f99e4160f94b9d3f2f Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 13 May 2019 13:37:31 +0200 Subject: Doc: Make "Browsing ISO 7000 Icons" topic creator-only While this works in Qt Design Studio, it is easier to use a dedicated Qt Quick Studio component called Iso for this purpose. Change-Id: I6f2d430ae050b7e0a204077f92ae54987c47f6b7 Reviewed-by: Thomas Hartmann --- .../creator-only/qtquick-iso-icon-browser.qdoc | 78 ++++++++++++++++++++ doc/src/qtquick/qtquick-iso-icon-browser.qdoc | 83 ---------------------- doc/src/qtquick/qtquick-pathview-editor.qdoc | 4 +- doc/src/qtquick/qtquick-ui-forms.qdoc | 3 +- 4 files changed, 83 insertions(+), 85 deletions(-) create mode 100644 doc/src/qtquick/creator-only/qtquick-iso-icon-browser.qdoc delete mode 100644 doc/src/qtquick/qtquick-iso-icon-browser.qdoc (limited to 'doc/src') diff --git a/doc/src/qtquick/creator-only/qtquick-iso-icon-browser.qdoc b/doc/src/qtquick/creator-only/qtquick-iso-icon-browser.qdoc new file mode 100644 index 00000000000..c84529b2982 --- /dev/null +++ b/doc/src/qtquick/creator-only/qtquick-iso-icon-browser.qdoc @@ -0,0 +1,78 @@ +/**************************************************************************** +** +** Copyright (C) 2019 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. +** +****************************************************************************/ + +/*! + \contentspage index.html + \page qtquick-iso-icon-browser.html + \previouspage qmldesigner-pathview-editor.html + \nextpage creator-quick-ui-forms.html + + \title Browsing ISO 7000 Icons + + \commercial + + You can add icons from an ISO 7000 icon library that is installed with \QC + to Qt Quick applications (commercial only). You can use the + \uicontrol {ISO Icon Browser} to add a \l {Picture} type and select the + icon to use for the type. You can change the default color of the icon. + + \image qtcreator-iso-icon-browser.png + + \section1 Using ISO Icons in Applications + + \list 1 + + \li Create a new Qt Quick Application or open an application in \QC. + + \li Open the Qt Quick UI form in the \uicontrol Design mode. + + \li In the \uicontrol Library, select \uicontrol Imports > + \uicontrol {Add Import} > \uicontrol {QtQuick.Extras} to import the + \l {Qt Quick Extras} module. + + \li Drag and drop a \uicontrol Picture element from the library to the + canvas. + + \li Right-click the picture element and select \uicontrol {Choose Icon} + to open the \uicontrol {ISO Icon Browser}. + + \li To find icons, select a criterion for filtering icons and enter a + search string. + + \li Select an icon in the list, and then select \uicontrol OK to add + the icon. + + \li To view the icon you added, press \key {Ctrl+R} (or \key {Cmd+R}) + to run the application. + + \li To adjust the icon color, select the icon on the canvas, and then + select \uicontrol {Edit Color} in the context menu. + + \endlist + + \QC generates a Qt resource file called \c iso-icons.qrc that adds the + icons as a part of your project for delivery with your application. + + */ diff --git a/doc/src/qtquick/qtquick-iso-icon-browser.qdoc b/doc/src/qtquick/qtquick-iso-icon-browser.qdoc deleted file mode 100644 index efc216a7f6c..00000000000 --- a/doc/src/qtquick/qtquick-iso-icon-browser.qdoc +++ /dev/null @@ -1,83 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2018 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. -** -****************************************************************************/ - -/*! - \contentspage index.html - \page qtquick-iso-icon-browser.html - \if defined(qtdesignstudio) - \previouspage qmldesigner-pathview-editor.html - \nextpage creator-quick-ui-forms.html - \else - \previouspage quick-states.html - \nextpage quick-export-to-qml.html - \endif - - \title Browsing ISO 7000 Icons - - \commercial - - You can add icons from an ISO 7000 icon library that is installed with \QC - to Qt Quick applications (commercial only). You can use the - \uicontrol {ISO Icon Browser} to add a \l {Picture} type and select the - icon to use for the type. You can change the default color of the icon. - - \image qtcreator-iso-icon-browser.png - - \section1 Using ISO Icons in Applications - - \list 1 - - \li Create a new Qt Quick Application or open an application in \QC. - - \li Open the Qt Quick UI form in the \uicontrol Design mode. - - \li In the \uicontrol Library, select \uicontrol Imports > - \uicontrol {Add Import} > \uicontrol {QtQuick.Extras} to import the - \l {Qt Quick Extras} module. - - \li Drag and drop a \uicontrol Picture element from the library to the - canvas. - - \li Right-click the picture element and select \uicontrol {Choose Icon} - to open the \uicontrol {ISO Icon Browser}. - - \li To find icons, select a criterion for filtering icons and enter a - search string. - - \li Select an icon in the list, and then select \uicontrol OK to add - the icon. - - \li To view the icon you added, press \key {Ctrl+R} (or \key {Cmd+R}) - to run the application. - - \li To adjust the icon color, select the icon on the canvas, and then - select \uicontrol {Edit Color} in the context menu. - - \endlist - - \QC generates a Qt resource file called \c iso-icons.qrc that adds the - icons as a part of your project for delivery with your application. - - */ diff --git a/doc/src/qtquick/qtquick-pathview-editor.qdoc b/doc/src/qtquick/qtquick-pathview-editor.qdoc index bd4f4bd8519..745ebc1b553 100644 --- a/doc/src/qtquick/qtquick-pathview-editor.qdoc +++ b/doc/src/qtquick/qtquick-pathview-editor.qdoc @@ -28,10 +28,12 @@ \page qmldesigner-pathview-editor.html \if defined(qtdesignstudio) \previouspage studio-fonts.html + \nextpage creator-quick-ui-forms.html \else \previouspage quick-states.html - \endif \nextpage qtquick-iso-icon-browser.html + \endif + \title Editing PathView Properties diff --git a/doc/src/qtquick/qtquick-ui-forms.qdoc b/doc/src/qtquick/qtquick-ui-forms.qdoc index 16ce57a7e72..6ec6313ccf3 100644 --- a/doc/src/qtquick/qtquick-ui-forms.qdoc +++ b/doc/src/qtquick/qtquick-ui-forms.qdoc @@ -33,10 +33,11 @@ \contentspage index.html \page creator-quick-ui-forms.html - \previouspage qtquick-iso-icon-browser.html \if defined(qtdesignstudio) + \previouspage qmldesigner-pathview-editor.html \nextpage studio-live-preview.html \else + \previouspage qtquick-iso-icon-browser.html \nextpage quick-export-to-qml.html \endif -- cgit v1.2.3 From 3b83b7299422fd0a5c1ccc303cf8e34ec23d8ef2 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 13 May 2019 14:02:36 +0200 Subject: Doc: Refer to the SvgPath component from the PathView component docs Qt Design Studio -specific. Change-Id: I172c94c69dcdc321c2dc8d1e37d229861966ffb2 Reviewed-by: Thomas Hartmann --- doc/src/qtquick/qtquick-pathview-editor.qdoc | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/src') diff --git a/doc/src/qtquick/qtquick-pathview-editor.qdoc b/doc/src/qtquick/qtquick-pathview-editor.qdoc index 745ebc1b553..16cfad2e790 100644 --- a/doc/src/qtquick/qtquick-pathview-editor.qdoc +++ b/doc/src/qtquick/qtquick-pathview-editor.qdoc @@ -66,4 +66,8 @@ initiates mouse dragging and what is the rate at which a flick will decelerate. + \if defined(qtdesignstudio) + \note You can also use the \l SvgPath Qt Quick Studio Component to + specify an SVG path data string that draws a path. + \endif */ -- cgit v1.2.3 From bbfef062de6b8057875bc145d576fc926952c3a6 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 15 May 2019 15:23:04 +0200 Subject: Doc: Edit docs for the Connections view - You have to double-click the values of columns to edit them - For properties and bindings, the values are set for the currently selected item and the item column displays the item id (read-only) - Add links to examples of using the view Change-Id: I8c27dbbcbbf269f52102ca2af37f872c86e56155 Reviewed-by: Thomas Hartmann --- .../qtquick/qtquick-connection-editor-bindings.qdoc | 20 ++++++++++---------- .../qtquick-connection-editor-properties.qdoc | 19 +++++++++++-------- .../qtquick/qtquick-connection-editor-signals.qdoc | 21 ++++++++++++++------- doc/src/qtquick/qtquick-connection-editor.qdoc | 5 ++++- 4 files changed, 39 insertions(+), 26 deletions(-) (limited to 'doc/src') diff --git a/doc/src/qtquick/qtquick-connection-editor-bindings.qdoc b/doc/src/qtquick/qtquick-connection-editor-bindings.qdoc index 2f5c1ec54b3..daee35732c6 100644 --- a/doc/src/qtquick/qtquick-connection-editor-bindings.qdoc +++ b/doc/src/qtquick/qtquick-connection-editor-bindings.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -56,14 +56,14 @@ \li In the \uicontrol {Connections} view, select the \uicontrol {Bindings} tab. \li Select the \inlineimage plus.png - (\uicontrol Add) button to add a binding. - \li Select \uicontrol Item to select the target object whose property - you want to change dynamically. - \li Select \uicontrol Property to select the property to bind to a - source property. - \li Select \uicontrol {Source Item} to select the object whose property - you want to use to determine the behavior of the target object. - \li Select \uicontrol {Source Property} to select the property to bind - the target property to. + (\uicontrol Add) button to add a binding for the currently selected + item. The ID is displayed in the \uicontrol Item column. + \li Double-click the value in the \uicontrol Property column to select + the property to bind to a source property. + \li Double-click the value in the \uicontrol {Source Item} column to + select the object whose property you want to use to determine the + behavior of the target object. + \li Double-click the value in the \uicontrol {Source Property} column + to select the property to bind the target property to. \endlist */ diff --git a/doc/src/qtquick/qtquick-connection-editor-properties.qdoc b/doc/src/qtquick/qtquick-connection-editor-properties.qdoc index 22881283277..7b6168dc788 100644 --- a/doc/src/qtquick/qtquick-connection-editor-properties.qdoc +++ b/doc/src/qtquick/qtquick-connection-editor-properties.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -46,13 +46,16 @@ \list 1 \li In the \uicontrol {Connections} view, select the \uicontrol {Properties} tab. - \li Select \uicontrol Item to select the object to specify the property - for. - \li Select \uicontrol Property to give a name to the property. - \li Select \uicontrol {Property Type} to specify the type of the - property. - \li Select \uicontrol {Property Value} to specify the value of the - property. + \li Select the \inlineimage plus.png + (\uicontrol Add) button to add a dynamic property for the currently + selected item. The item ID is displayed in the \uicontrol Item + column. + \li Double-click the value in the \uicontrol Property column to give a + name to the property. + \li Double-click the value in the \uicontrol {Property Type} column to + specify the type of the property. + \li Double-click the value in the \uicontrol {Property Value} column + to specify the value of the property. \endlist */ diff --git a/doc/src/qtquick/qtquick-connection-editor-signals.qdoc b/doc/src/qtquick/qtquick-connection-editor-signals.qdoc index 010ab17847b..a9e221ce73e 100644 --- a/doc/src/qtquick/qtquick-connection-editor-signals.qdoc +++ b/doc/src/qtquick/qtquick-connection-editor-signals.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -61,11 +61,18 @@ \uicontrol {Connections} tab. \li Select the \inlineimage plus.png (\uicontrol Add) button to add a connection. - \li Select \uicontrol Target to add the object to connect to a signal. - \li Select \uicontrol {Signal Handler} to select the signal that the - connection will listen to from a list of all signals available for - the object. - \li Select \uicontrol Actions to specify the action to perform when - the signal is emitted. You use JavaScript to specify the actions. + \li Double-click the value in the \uicontrol Target column to add the + object to connect to a signal. + \li Double-click the value in the \uicontrol {Signal Handler} column to + select the signal that the connection will listen to from a list of + all signals available for the object. + \li Double-click the value in the \uicontrol Actions column to specify + the action to perform when the signal is emitted. You use JavaScript + to specify the actions. \endlist + + \if defined(qtdesignstudio) + For an example of connecting the \c clicked signal of a button to a + \l{Adding States}{state}, see \l {Log In UI - Part 3}. + \endif */ diff --git a/doc/src/qtquick/qtquick-connection-editor.qdoc b/doc/src/qtquick/qtquick-connection-editor.qdoc index 57953505654..ad781ab5d4b 100644 --- a/doc/src/qtquick/qtquick-connection-editor.qdoc +++ b/doc/src/qtquick/qtquick-connection-editor.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -70,4 +70,7 @@ \li \l{Managing C++ Backend Objects} \endif \endlist + + For an example of using properties, bindings, and connections to create a + scalable push button, see \l{Creating Scalable Buttons and Borders}. */ -- cgit v1.2.3 From 0a08b041add4bfdb85a996eb28f47f0907e993c8 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 15 May 2019 17:23:31 +0200 Subject: Doc: Add a link from "Adding States" to "Binding Animations to States" Change-Id: I49a28ed75a2bade67a4f550ccf303b409f9600d3 Reviewed-by: Thomas Hartmann --- doc/src/qtquick/qtquick-states.qdoc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'doc/src') diff --git a/doc/src/qtquick/qtquick-states.qdoc b/doc/src/qtquick/qtquick-states.qdoc index 2cf02445210..975e1f09598 100644 --- a/doc/src/qtquick/qtquick-states.qdoc +++ b/doc/src/qtquick/qtquick-states.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -161,4 +161,8 @@ You can use the \uicontrol {Text Editor} to specify transitions. For more information, see \l{Transition}. + + Alternatively, you can use the \uicontrol Timeline view to animate the + properties of UI components and to bind the animations to states. For more + information, see \l {Binding Animations to States}. */ -- cgit v1.2.3 From 9cf336b4bce0744ad146f8c3a5f9fe02638461bd Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 14 May 2019 16:32:35 +0200 Subject: Doc: Add links to Qt Quick Studio Components' documentation Depends on a change that adds the docs to the Qt Design Studio Manual. Change-Id: I8ef7d9085d0672daba9d0d2a3f64f473d8e8e9cf Reviewed-by: Thomas Hartmann --- doc/src/qtquick/qtquick-timeline.qdoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'doc/src') diff --git a/doc/src/qtquick/qtquick-timeline.qdoc b/doc/src/qtquick/qtquick-timeline.qdoc index 0904fd908da..3462330208d 100644 --- a/doc/src/qtquick/qtquick-timeline.qdoc +++ b/doc/src/qtquick/qtquick-timeline.qdoc @@ -312,11 +312,11 @@ You can use the Studio components to animate the following shapes: \list - \li Arc - \li Border - \li Pie - \li Rectangle - \li Triangle + \li \l Arc + \li \l Border + \li \l Pie + \li \l Rectangle + \li \l Triangle \endlist \endif */ -- cgit v1.2.3