CopperSpice API  1.7.2
QLinearGradient Class Reference

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

Inheritance diagram for QLinearGradient:
QGradient

Public Methods

 QLinearGradient ()
 
 QLinearGradient (const QPointF &start, const QPointF &finalStop)
 
 QLinearGradient (qreal x1, qreal y1, qreal x2, qreal y2)
 
QPointF finalStop () const
 
void setFinalStop (const QPointF &stop)
 
void setFinalStop (qreal x, qreal y)
 
void setStart (const QPointF &start)
 
void setStart (qreal x, qreal y)
 
QPointF start () const
 
- Public Methods inherited from QGradient
CoordinateMode coordinateMode () const
 
InterpolationMode interpolationMode () const
 
bool operator!= (const QGradient &gradient) const
 
bool operator== (const QGradient &gradient) const
 
void setColorAt (qreal position, const QColor &color)
 
void setCoordinateMode (CoordinateMode mode)
 
void setInterpolationMode (InterpolationMode mode)
 
void setSpread (Spread spread)
 
void setStops (const QGradientStops &stops)
 
Spread spread () const
 
QGradientStops stops () const
 
Type type () const
 

Additional Inherited Members

- Public Types inherited from QGradient
enum  CoordinateMode
 
enum  Spread
 
enum  Type
 

Detailed Description

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)ReflectSpreadRepeatSpread

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.

See also
QRadialGradient, QConicalGradient

Constructor & Destructor Documentation

QLinearGradient::QLinearGradient ( )

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

See also
QGradient::setColorAt(), setStart(), setFinalStop()
QLinearGradient::QLinearGradient ( const QPointF start,
const QPointF finalStop 
)

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(), QGradient::setStops()
QLinearGradient::QLinearGradient ( qreal  x1,
qreal  y1,
qreal  x2,
qreal  y2 
)

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(), QGradient::setStops()

Method Documentation

QPointF QLinearGradient::finalStop ( ) const

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

See also
setFinalStop(), QGradient::stops()
void QLinearGradient::setFinalStop ( const QPointF stop)

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

See also
finalStop()
void QLinearGradient::setFinalStop ( qreal  x,
qreal  y 
)
inline

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

See also
start()
void QLinearGradient::setStart ( const QPointF start)

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

See also
start()
void QLinearGradient::setStart ( qreal  x,
qreal  y 
)
inline

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

See also
start()
QPointF QLinearGradient::start ( ) const

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

See also
setStart(), QGradient::stops()