From fdb560019478fe1379d186b75f9e43b500c97893 Mon Sep 17 00:00:00 2001 From: Vikas Pachdha Date: Mon, 7 Aug 2023 10:38:17 +0200 Subject: [PATCH] Docs: Add docs for removing properties through Qt Bridge plugin Improve the properties docs across all Qt Bridge plugins as well Task-number: QDS-8602 Change-Id: Ia48000053f793b08648e0b092195de8a443142b8 Reviewed-by: Pranta Ghosh Dastider Reviewed-by: Vikas Pachdha Reviewed-by: Qt CI Patch Build Bot --- .../src/qtbridge/qtbridge-figma-using.qdoc | 10 ++++++++-- .../src/qtbridge/qtbridge-ps-using.qdoc | 18 ++++++++++++++++-- .../src/qtbridge/qtbridge-sketch-using.qdoc | 18 ++++++++++++++++-- .../src/qtbridge/qtbridge-xd-using.qdoc | 10 ++++++++-- 4 files changed, 48 insertions(+), 8 deletions(-) diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-using.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-using.qdoc index 8874186c6f4..5dd5f6d8bdf 100644 --- a/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-using.qdoc +++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-figma-using.qdoc @@ -172,15 +172,21 @@ an \e alias. \row \li \uicontrol {Properties} - \li Specify new properties or assign value to the existing properties of + \li Specify new properties or assign values to the existing properties of the component. You can also add and modify properties in \QDS. - Following are few examples of properties: + The following are a few examples of the properties: \code property int counter: 5 property string label: "ok" antialiasing : true width: parent.width / 2 \endcode + To remove a property, write a "dash" (-) followed by the "property name". + For example: + \code + - width + \endcode + will remove the property \e width from the generated code. \row \li \uicontrol {Snippet} \li Specify component to be added as child under this component. diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc index e3b634a05d6..ed046b416fc 100644 --- a/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc +++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-ps-using.qdoc @@ -187,8 +187,22 @@ Components 1.0, you need the import statement \c {QtQuick.Studio.Components 1.0}. You can also import a module as an alias. - \li In the \uicontrol {Properties} field, specify properties for - the component. You can add and modify properties in \QDS. + \li In the \uicontrol {Properties} field, specify new properties or assign + values to the existing properties of the component. You can also add and modify + properties in \QDS. + The following are a few examples of the properties: + \code + property int counter: 5 + property string label: "ok" + antialiasing : true + width: parent.width / 2 + \endcode + To remove a property, write a "dash" (-) followed by the "property name". + For example: + \code + - width + \endcode + will remove the property \e width from the generated code. \li Select the \uicontrol {Clip Contents} check box to enable clipping in the type generated from the layer. The generated type will clip its own painting, as well as the painting of its children, to its diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc index 50bfff87060..27b1e0e8b96 100644 --- a/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc +++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-sketch-using.qdoc @@ -209,8 +209,22 @@ \c {QtQuick.Controls 2.3} and to use Qt Quick Studio Components 1.0, you need the import statement \c {QtQuick.Studio.Components 1.0}. You can also import a module as an alias. - \li In the \uicontrol {Properties} field, specify properties for the - component. You can add and modify properties in \QDS. + \li In the \uicontrol {Properties} field, specify new properties or assign + values to the existing properties of the component. You can also add and modify + properties in \QDS. + The following are a few examples of the properties: + \code + property int counter: 5 + property string label: "ok" + antialiasing : true + width: parent.width / 2 + \endcode + To remove a property, write a "dash" (-) followed by the "property name". + For example: + \code + - width + \endcode + will remove the property \e width from the generated code. \li Select the \uicontrol Alias check box to export the item generated from this layer as an alias in the parent component. \li Select the \uicontrol Clip check box to enable clipping in the diff --git a/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-using.qdoc b/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-using.qdoc index 0f16df676d3..3a10de0147d 100644 --- a/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-using.qdoc +++ b/doc/qtdesignstudio/src/qtbridge/qtbridge-xd-using.qdoc @@ -114,15 +114,21 @@ you need the import statement \c {QtQuick.Studio.Components 1.0}. You can also import a module as an alias. \li In the \uicontrol {Properties} field, specify new properties or assign - value to the existing properties of the component. You can also add and modify + values to the existing properties of the component. You can also add and modify properties in \QDS. - Following are few examples of properties: + The following are a few examples of the properties: \code property int counter: 5 property string label: "ok" antialiasing : true width: parent.width / 2 \endcode + To remove a property, write a "dash" (-) followed by the "property name". + For example: + \code + - width + \endcode + will remove the property \e width from the generated code. \li In the \uicontrol {Snippet} field, specify component to be added as child under this component. Following example adds a Connection component: