class QLinearGradient#

The QLinearGradient class is used in combination with QBrush to specify a linear gradient brush. More

Inheritance diagram of PySide6.QtGui.QLinearGradient

Synopsis#

Methods#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Linear gradients interpolate colors between start and end points. Outside these points the gradient is either padded, reflected or repeated depending on the currently set spread method:

The colors in a gradient is defined using stop points of the QGradientStop type, i.e. a position and a color. Use the setColorAt() or the setStops() function to define the stop points. It is the gradient’s complete set of stop points that describes how the gradient area should be filled. If no stop points have been specified, a gradient of black at 0 to white at 1 is used.

In addition to the functions inherited from QGradient , the QLinearGradient class provides the finalStop() function which returns the final stop point of the gradient, and the start() function returning the start point of the gradient.

See also

QRadialGradient QConicalGradient The Gradients Example

__init__()#

Constructs a default linear gradient with interpolation area between (0, 0) and (1, 1).

__init__(start, finalStop)
Parameters:

Constructs a linear gradient with interpolation area between the given start point and finalStop.

Note

The expected parameter values are in pixels.

__init__(xStart, yStart, xFinalStop, yFinalStop)
Parameters:
  • xStart – float

  • yStart – float

  • xFinalStop – float

  • yFinalStop – float

Constructs a linear gradient with interpolation area between (x1, y1) and (x2, y2).

Note

The expected parameter values are in pixels.

finalStop()#
Return type:

QPointF

Returns the final stop point of this linear gradient in logical coordinates.

setFinalStop(stop)#
Parameters:

stopQPointF

Sets the final stop point of this linear gradient in logical coordinates to stop.

See also

finalStop()

setFinalStop(x, y)
Parameters:
  • x – float

  • y – float

This is an overloaded function.

Sets the final stop point of this linear gradient in logical coordinates to x, y.

See also

start()

setStart(start)#
Parameters:

startQPointF

Sets the start point of this linear gradient in logical coordinates to start.

See also

start()

setStart(x, y)
Parameters:
  • x – float

  • y – float

This is an overloaded function.

Sets the start point of this linear gradient in logical coordinates to x, y.

See also

start()

start()#
Return type:

QPointF

Returns the start point of this linear gradient in logical coordinates.

See also

setStart() stops()