feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Update Studio component docs

Browse Source 
- The antialiasing property was removed, because it is
  inherited from Item. Keep reference to the inherited
  value.
- Fix default values.

Change-Id: I8d63801b15422de0bd78fdd82fb518a556088cfb
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
This commit is contained in:
Leena Miettinen
2020-09-23 14:39:04 +02:00
parent 4dc9d92b1e
commit c61b2dcdff
6 changed files with 49 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/qtdesignstudio/src/qtquickdesigner-components/components/qqs-components-arc.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Design Studio documentation. ** This file is part of the Qt Design Studio documentation.
@@ -59,8 +59,8 @@
have an outline, the \l capStyle property specifies whether the line ends have an outline, the \l capStyle property specifies whether the line ends
are square or rounded. are square or rounded.
Because an arc has curves, it may be appropriate to set the \l antialiasing Because an arc has curves, it may be appropriate to set the \c antialiasing
property to improve its appearance. property that is inherited from \l Item to improve its appearance.
\section2 Example Usage \section2 Example Usage
@@ -207,7 +207,7 @@
When set to \c transparent, no line is drawn. When set to \c transparent, no line is drawn.
The default value is \c white. The default value is \c red.
\sa QColor \sa QColor
*/ */
@@ -233,7 +233,7 @@
When set to a negative value, no line is drawn. When set to a negative value, no line is drawn.
The default value is 1. The default value is 4.
The total width of an arc that has an outline (that is, the outline and the The total width of an arc that has an outline (that is, the outline and the
fill) is specified by \l arcWidth. fill) is specified by \l arcWidth.
@@ -255,6 +255,8 @@
The position in degrees where the arc ends. The position in degrees where the arc ends.
The default value is 90.
To create a circle, set the value of this property to 360 and the value of To create a circle, set the value of this property to 360 and the value of
the \l begin property to 0. the \l begin property to 0.
*/ */
@@ -265,6 +267,8 @@
The total width of an arc that has an outline, including the outline and The total width of an arc that has an outline, including the outline and
fill. fill.
The default value is 10.
\sa arcWidthBegin, arcWidthEnd, strokeWidth \sa arcWidthBegin, arcWidthEnd, strokeWidth
*/ */
@@ -306,14 +310,6 @@
The area between the \l begin and \l end points of the arc. The area between the \l begin and \l end points of the arc.
*/ */
/*!
\qmlproperty bool Arc::antialiasing
Whether the arc should be antialiased.
Antialiasing might require more memory and slow down drawing the type.
*/
/*! /*!
\qmlproperty bool Arc::outlineArc \qmlproperty bool Arc::outlineArc

19
doc/qtdesignstudio/src/qtquickdesigner-components/components/qqs-components-border.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Design Studio documentation. ** This file is part of the Qt Design Studio documentation.
@@ -43,7 +43,8 @@
The \l radius property specifies whether the border corners are rounded. The \l radius property specifies whether the border corners are rounded.
The radius can also be specified separately for each corner. Because this The radius can also be specified separately for each corner. Because this
introduces curved edges to the corners, it may be appropriate to set the introduces curved edges to the corners, it may be appropriate to set the
\l antialiasing property to improve the appearance of the border. \c antialiasing property that is inherited from \l Item to improve the
appearance of the border.
The \l joinStyle property specifies how to connect two border line segments. The \l joinStyle property specifies how to connect two border line segments.
@@ -108,6 +109,8 @@
The radius used to draw rounded corners. The radius used to draw rounded corners.
The default value is 10.
If radius is non-zero, the corners will be rounded, otherwise they will If radius is non-zero, the corners will be rounded, otherwise they will
be sharp. The radius can also be specified separately for each corner by be sharp. The radius can also be specified separately for each corner by
using the \l bottomLeftRadius, \l bottomRightRadius, \l topLeftRadius, and using the \l bottomLeftRadius, \l bottomRightRadius, \l topLeftRadius, and
@@ -226,7 +229,7 @@
When set to \c transparent, no line is drawn. When set to \c transparent, no line is drawn.
The default value is \c white. The default value is \c red.
\sa QColor \sa QColor
*/ */
@@ -252,7 +255,7 @@
When set to a negative value, no line is drawn. When set to a negative value, no line is drawn.
The default value is 1. The default value is 4.
*/ */
/*! /*!
@@ -287,14 +290,6 @@
The border segment is drawn if this property is set to \c true. The border segment is drawn if this property is set to \c true.
*/ */
/*!
\qmlproperty bool Border::antialiasing
Whether the border should be antialiased.
Antialiasing might require more memory and slow down drawing the type.
*/
/*! /*!
\qmlproperty enumeration Border::borderMode \qmlproperty enumeration Border::borderMode

18
doc/qtdesignstudio/src/qtquickdesigner-components/components/qqs-components-pie.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Design Studio documentation. ** This file is part of the Qt Design Studio documentation.
@@ -49,7 +49,8 @@
rounded. rounded.
Because a pie has curved edges, it may be appropriate to set the Because a pie has curved edges, it may be appropriate to set the
\l antialiasing property to improve its appearance. \c antialiasing property that is inherited from \l Item to improve
its appearance.
\section2 Example Usage \section2 Example Usage
@@ -184,7 +185,7 @@
When set to \c transparent, no line is drawn. When set to \c transparent, no line is drawn.
The default value is \c white. The default value is \c red.
\sa QColor \sa QColor
*/ */
@@ -210,7 +211,7 @@
When set to a negative value, no line is drawn. When set to a negative value, no line is drawn.
The default value is 1. The default value is 4.
*/ */
/*! /*!
@@ -229,6 +230,8 @@
The position in degrees where the pie ends. The position in degrees where the pie ends.
The default value is 90.
To create a circle, set the value of this property to 360 and the value of To create a circle, set the value of this property to 360 and the value of
the \l begin property to 0. the \l begin property to 0.
*/ */
@@ -239,13 +242,6 @@
The area between \l begin and \l end. The area between \l begin and \l end.
*/ */
/*!
\qmlproperty bool Pie::antialiasing
Whether the pie should be antialiased.
Antialiasing might require more memory and slow down drawing the type.
*/
/*! /*!
\qmlproperty bool Pie::hideLine \qmlproperty bool Pie::hideLine

18
doc/qtdesignstudio/src/qtquickdesigner-components/components/qqs-components-rectangle.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Design Studio documentation. ** This file is part of the Qt Design Studio documentation.
@@ -47,7 +47,8 @@
Rounded rectangles can be drawn using the \l radius property. The radius Rounded rectangles can be drawn using the \l radius property. The radius
can also be specified separately for each corner. Because this introduces can also be specified separately for each corner. Because this introduces
curved edges to the corners of a rectangle, it may be appropriate to set curved edges to the corners of a rectangle, it may be appropriate to set
the \l antialiasing property to improve the appearance of the rectangle. the \c antialiasing property that is inherited from \l Item to improve the
appearance of the rectangle.
\section2 Example Usage \section2 Example Usage
@@ -143,6 +144,8 @@
The radius used to draw rounded corners. The radius used to draw rounded corners.
The default value is 10.
If radius is non-zero, the corners will be rounded, otherwise they will If radius is non-zero, the corners will be rounded, otherwise they will
be sharp. The radius can also be specified separately for each corner by be sharp. The radius can also be specified separately for each corner by
using the \l bottomLeftRadius, \l bottomRightRadius, \l topLeftRadius, and using the \l bottomLeftRadius, \l bottomRightRadius, \l topLeftRadius, and
@@ -241,7 +244,7 @@
When set to \c transparent, no line is drawn. When set to \c transparent, no line is drawn.
The default value is \c white. The default value is \c red.
\sa QColor \sa QColor
*/ */
@@ -265,6 +268,8 @@
The width of the border of the rectangle. The width of the border of the rectangle.
The default value is 4.
A width of 1 creates a thin line. For no line, use a negative value or a A width of 1 creates a thin line. For no line, use a negative value or a
transparent color. transparent color.
@@ -274,10 +279,3 @@
The border is rendered within the rectangle's boundaries. The border is rendered within the rectangle's boundaries.
*/ */
/*!
\qmlproperty bool Rectangle::antialiasing
Whether the Rectangle should be antialiased. Antialiasing might
require more memory and slow down drawing the type.
*/

18
doc/qtdesignstudio/src/qtquickdesigner-components/components/qqs-components-svgPath.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Design Studio documentation. ** This file is part of the Qt Design Studio documentation.
@@ -48,8 +48,8 @@
using the \l gradient property. If both a color and a gradient are using the \l gradient property. If both a color and a gradient are
specified, the gradient is used. specified, the gradient is used.
If the path has curves, it may be appropriate to set the \l antialiasing If the path has curves, it may be appropriate to set the \c antialiasing
property to improve its appearance. property that is inherited from \l Item to improve its appearance.
\note Mixing SvgPath with other types of elements is not always supported. \note Mixing SvgPath with other types of elements is not always supported.
For example, when \l Shape is backed by \c GL_NV_path_rendering, a For example, when \l Shape is backed by \c GL_NV_path_rendering, a
@@ -165,7 +165,7 @@
When set to \c transparent, no line is drawn. When set to \c transparent, no line is drawn.
The default value is \c white. The default value is \c red.
\sa QColor \sa QColor
*/ */
@@ -191,7 +191,7 @@
When set to a negative value, no line is drawn. When set to a negative value, no line is drawn.
The default value is 1. The default value is 4.
*/ */
/*! /*!
@@ -202,11 +202,3 @@
For more information, see \l{https://www.w3.org/TR/SVG/paths.html#PathData} For more information, see \l{https://www.w3.org/TR/SVG/paths.html#PathData}
{W3C SVG Path Data}. {W3C SVG Path Data}.
*/ */
/*!
\qmlproperty bool SvgPath::antialising
Whether the path should be antialiased.
Antialiasing might require more memory and slow down drawing the type.
*/

25
doc/qtdesignstudio/src/qtquickdesigner-components/components/qqs-components-triangle.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Design Studio documentation. ** This file is part of the Qt Design Studio documentation.
@@ -177,7 +177,7 @@
When set to \c transparent, no line is drawn. When set to \c transparent, no line is drawn.
The default value is \c white. The default value is \c red.
\sa QColor \sa QColor
*/ */
@@ -201,6 +201,8 @@
The width of the border of the rectangle. The width of the border of the rectangle.
The default value is 4.
A width of 1 creates a thin line. For no line, use a negative value or a A width of 1 creates a thin line. For no line, use a negative value or a
transparent color. transparent color.
@@ -214,9 +216,14 @@
/*! /*!
\qmlproperty int Triangle::radius \qmlproperty int Triangle::radius
Defines the rotation of the triangle in degrees. The default value is 0. The radius used to draw rounded corners.
This property can be used together with the \l radius property to The default value is 5.
If radius is non-zero, the corners will be rounded, otherwise they will
be sharp.
This property can be used together with the \l arcRadius property to
determine the shape of the triangle. determine the shape of the triangle.
\sa arcRadius \sa arcRadius
@@ -227,6 +234,8 @@
The radius used to draw rounded corners. The radius used to draw rounded corners.
The default value is 5.
If radius is non-zero, the corners will be rounded, otherwise they will If radius is non-zero, the corners will be rounded, otherwise they will
be sharp. be sharp.
@@ -277,11 +286,3 @@
\sa topMargin, leftMargin, rightMargin \sa topMargin, leftMargin, rightMargin
*/ */
/*!
\qmlproperty bool Triangel::antialiasing
Whether the triangle should be antialiased.
Antialiasing might require more memory and slow down drawing the type.
*/