Struct qt_gui::QLinearGradient

#[repr(C)]
pub struct QLinearGradient { /* private fields */ }

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

C++ class: QLinearGradient.

C++ documentation:

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

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:

PadSpread (default)	ReflectSpread	RepeatSpread

The colors in a gradient is defined using stop points of the QGradientStop type, i.e. a position and a color. Use the QGradient::setColorAt() or the QGradient::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.

Implementations

impl QLinearGradient

pub unsafe fn copy_from( &self, other: impl CastInto<Ref<QLinearGradient>> ) -> Ref<QLinearGradient>

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

Calls C++ function: QLinearGradient& QLinearGradient::operator=(const QLinearGradient& other).

C++ documentation:

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

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:

PadSpread (default)	ReflectSpread	RepeatSpread

The colors in a gradient is defined using stop points of the QGradientStop type, i.e. a position and a color. Use the QGradient::setColorAt() or the QGradient::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.

pub unsafe fn final_stop(&self) -> CppBox<QPointF>

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

Calls C++ function: QPointF QLinearGradient::finalStop() const.

C++ documentation:

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

See also setFinalStop() and QGradient::stops().

pub unsafe fn new_0a() -> CppBox<QLinearGradient>

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

Calls C++ function: [constructor] void QLinearGradient::QLinearGradient().

C++ documentation:

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

See also QGradient::setColorAt(), setStart(), and setFinalStop().

pub unsafe fn new_2a( start: impl CastInto<Ref<QPointF>>, final_stop: impl CastInto<Ref<QPointF>> ) -> CppBox<QLinearGradient>

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

Calls C++ function: [constructor] void QLinearGradient::QLinearGradient(const QPointF& start, const QPointF& finalStop).

C++ documentation:

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

Note: The expected parameter values are in pixels.

See also QGradient::setColorAt() and QGradient::setStops().

pub unsafe fn new_4a( x_start: c_double, y_start: c_double, x_final_stop: c_double, y_final_stop: c_double ) -> CppBox<QLinearGradient>

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

Calls C++ function: [constructor] void QLinearGradient::QLinearGradient(double xStart, double yStart, double xFinalStop, double yFinalStop).

C++ documentation:

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

Note: The expected parameter values are in pixels.

See also QGradient::setColorAt() and QGradient::setStops().

pub unsafe fn new_copy( other: impl CastInto<Ref<QLinearGradient>> ) -> CppBox<QLinearGradient>

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

Calls C++ function: [constructor] void QLinearGradient::QLinearGradient(const QLinearGradient& other).

C++ documentation:

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

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:

PadSpread (default)	ReflectSpread	RepeatSpread

The colors in a gradient is defined using stop points of the QGradientStop type, i.e. a position and a color. Use the QGradient::setColorAt() or the QGradient::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.

pub unsafe fn set_final_stop_1a(&self, stop: impl CastInto<Ref<QPointF>>)

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

Calls C++ function: void QLinearGradient::setFinalStop(const QPointF& stop).

C++ documentation:

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

This function was introduced in Qt 4.2.

See also finalStop().

pub unsafe fn set_final_stop_2a(&self, x: c_double, y: c_double)

This is an overloaded function.

Calls C++ function: void QLinearGradient::setFinalStop(double x, double y).

C++ documentation:

This is an overloaded function.

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

This function was introduced in Qt 4.2.

See also start().

pub unsafe fn set_start_1a(&self, start: impl CastInto<Ref<QPointF>>)

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

Calls C++ function: void QLinearGradient::setStart(const QPointF& start).

C++ documentation:

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

This function was introduced in Qt 4.2.

See also start().

pub unsafe fn set_start_2a(&self, x: c_double, y: c_double)

This is an overloaded function.

Calls C++ function: void QLinearGradient::setStart(double x, double y).

C++ documentation:

This is an overloaded function.

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

This function was introduced in Qt 4.2.

See also start().

pub unsafe fn start(&self) -> CppBox<QPointF>

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

Calls C++ function: QPointF QLinearGradient::start() const.

C++ documentation:

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

See also setStart() and QGradient::stops().

Methods from Deref<Target = QGradient>

pub unsafe fn coordinate_mode(&self) -> CoordinateMode

Returns the coordinate mode of this gradient. The default mode is LogicalMode.

Calls C++ function: QGradient::CoordinateMode QGradient::coordinateMode() const.

C++ documentation:

Returns the coordinate mode of this gradient. The default mode is LogicalMode.

This function was introduced in Qt 4.4.

See also setCoordinateMode().

pub unsafe fn copy_from( &self, other: impl CastInto<Ref<QGradient>> ) -> Ref<QGradient>

The QGradient class is used in combination with QBrush to specify gradient fills.

Calls C++ function: QGradient& QGradient::operator=(const QGradient& other).

C++ documentation:

The QGradient class is used in combination with QBrush to specify gradient fills.

Qt currently supports three types of gradient fills:

• Linear gradients interpolate colors between start and end points.
• Simple radial gradients interpolate colors between a focal point and end points on a circle surrounding it.
• Extended radial gradients interpolate colors between a center and a focal circle.
• Conical gradients interpolate colors around a center point.

A gradient's type can be retrieved using the type() function. Each of the types is represented by a subclass of QGradient:

QLinearGradient	QRadialGradient	QConicalGradient

The colors in a gradient are defined using stop points of the QGradientStop type; i.e., a position and a color. Use the setColorAt() function to define a single stop point. Alternatively, use the setStops() function to define several stop points in one go. Note that the latter function replaces the current set of stop points.

It is the gradient's complete set of stop points (accessible through the stops() function) 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.

A diagonal linear gradient from black at (100, 100) to white at (200, 200) could be specified like this:

      QLinearGradient linearGrad(QPointF(100, 100), QPointF(200, 200));
      linearGrad.setColorAt(0, Qt::black);
      linearGrad.setColorAt(1, Qt::white);

A gradient can have an arbitrary number of stop points. The following would create a radial gradient starting with red in the center, blue and then green on the edges:

      QRadialGradient radialGrad(QPointF(100, 100), 100);
      radialGrad.setColorAt(0, Qt::red);
      radialGrad.setColorAt(0.5, Qt::blue);
      radialGrad.setColorAt(1, Qt::green);

It is possible to repeat or reflect the gradient outside its area by specifiying the spread method using the setSpread() function. The default is to pad the outside area with the color at the closest stop point. The currently set spread method can be retrieved using the spread() function. The QGradient::Spread enum defines three different methods:

PadSpread	RepeatSpread	ReflectSpread

Note that the setSpread() function only has effect for linear and radial gradients. The reason is that the conical gradient is closed by definition, i.e. the conical gradient fills the entire circle from 0 - 360 degrees, while the boundary of a radial or a linear gradient can be specified through its radius or final stop points, respectively.

The gradient coordinates can be specified in logical coordinates, relative to device coordinates, or relative to object bounding box coordinates. The coordinate mode can be set using the setCoordinateMode() function. The default is LogicalMode, where the gradient coordinates are specified in the same way as the object coordinates. To retrieve the currently set coordinate mode use coordinateMode().

pub unsafe fn interpolation_mode(&self) -> InterpolationMode

Calls C++ function: QGradient::InterpolationMode QGradient::interpolationMode() const.

pub unsafe fn set_color_at( &self, pos: c_double, color: impl CastInto<Ref<QColor>> )

Creates a stop point at the given position with the given color. The given position must be in the range 0 to 1.

Calls C++ function: void QGradient::setColorAt(double pos, const QColor& color).

C++ documentation:

Creates a stop point at the given position with the given color. The given position must be in the range 0 to 1.

See also setStops() and stops().

pub unsafe fn set_coordinate_mode(&self, mode: CoordinateMode)

Sets the coordinate mode of this gradient to mode. The default mode is LogicalMode.

Calls C++ function: void QGradient::setCoordinateMode(QGradient::CoordinateMode mode).

C++ documentation:

Sets the coordinate mode of this gradient to mode. The default mode is LogicalMode.

This function was introduced in Qt 4.4.

See also coordinateMode().

pub unsafe fn set_interpolation_mode(&self, mode: InterpolationMode)

Calls C++ function: void QGradient::setInterpolationMode(QGradient::InterpolationMode mode).

pub unsafe fn set_spread(&self, spread: Spread)

Specifies the spread method that should be used for this gradient.

Calls C++ function: void QGradient::setSpread(QGradient::Spread spread).

C++ documentation:

Specifies the spread method that should be used for this gradient.

Note that this function only has effect for linear and radial gradients.

See also spread().

pub unsafe fn set_stops( &self, stops: impl CastInto<Ref<QVectorOfQPairOfDoubleQColor>> )

Replaces the current set of stop points with the given stopPoints. The positions of the points must be in the range 0 to 1, and must be sorted with the lowest point first.

Calls C++ function: void QGradient::setStops(const QVector<QPair<double, QColor>>& stops).

C++ documentation:

Replaces the current set of stop points with the given stopPoints. The positions of the points must be in the range 0 to 1, and must be sorted with the lowest point first.

See also setColorAt() and stops().

pub unsafe fn spread(&self) -> Spread

Returns the spread method use by this gradient. The default is PadSpread.

Calls C++ function: QGradient::Spread QGradient::spread() const.

C++ documentation:

Returns the spread method use by this gradient. The default is PadSpread.

See also setSpread().

pub unsafe fn stops(&self) -> CppBox<QVectorOfQPairOfDoubleQColor>

Returns the stop points for this gradient.

Calls C++ function: QVector<QPair<double, QColor>> QGradient::stops() const.

C++ documentation:

Returns the stop points for this gradient.

If no stop points have been specified, a gradient of black at 0 to white at 1 is used.

See also setStops() and setColorAt().

pub unsafe fn type_(&self) -> Type

Returns the type of gradient.

Calls C++ function: QGradient::Type QGradient::type() const.

C++ documentation:

Returns the type of gradient.

Trait Implementations

impl CppDeletable for QLinearGradient

unsafe fn delete(&self)

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

Calls C++ function: [destructor] void QLinearGradient::~QLinearGradient().

C++ documentation:

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

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:

PadSpread (default)	ReflectSpread	RepeatSpread

The colors in a gradient is defined using stop points of the QGradientStop type, i.e. a position and a color. Use the QGradient::setColorAt() or the QGradient::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.

impl Deref for QLinearGradient

fn deref(&self) -> &QGradient

Calls C++ function: QGradient* static_cast<QGradient*>(QLinearGradient* ptr).

type Target = QGradient

The resulting type after dereferencing.

impl StaticDowncast<QLinearGradient> for QGradient

unsafe fn static_downcast(ptr: Ptr<QGradient>) -> Ptr<QLinearGradient>

Calls C++ function: QLinearGradient* static_cast<QLinearGradient*>(QGradient* ptr).

impl StaticUpcast<QGradient> for QLinearGradient

unsafe fn static_upcast(ptr: Ptr<QLinearGradient>) -> Ptr<QGradient>

Calls C++ function: QGradient* static_cast<QGradient*>(QLinearGradient* ptr).