PySide6.QtGui.QGradient

class QGradient

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

Inherited by: QRadialGradient, QLinearGradient, QConicalGradient

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

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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 :

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:

linearGrad = QLinearGradient(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:

radialGrad = QRadialGradient(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 specifying 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 Spread enum defines three different methods:

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() .

See also

QBrush

class Type

Specifies the type of gradient.

Constant

Description

QGradient.LinearGradient

Interpolates colors between start and end points ( QLinearGradient ).

QGradient.RadialGradient

Interpolate colors between a focal point and end points on a circle surrounding it ( QRadialGradient ).

QGradient.ConicalGradient

Interpolate colors around a center point ( QConicalGradient ).

QGradient.NoGradient

No gradient is used.

See also

type()

class Spread

Specifies how the area outside the gradient area should be filled.

Constant

Description

QGradient.PadSpread

The area is filled with the closest stop color. This is the default.

QGradient.RepeatSpread

The gradient is repeated outside the gradient area.

QGradient.ReflectSpread

The gradient is reflected outside the gradient area.

See also

spread() setSpread()

class CoordinateMode

This enum specifies how gradient coordinates map to the paint device on which the gradient is used.

Constant

Description

QGradient.LogicalMode

This is the default mode. The gradient coordinates are specified logical space just like the object coordinates.

QGradient.ObjectMode

In this mode the gradient coordinates are relative to the bounding rectangle of the object being drawn, with (0,0) in the top left corner, and (1,1) in the bottom right corner of the object’s bounding rectangle. This value was added in Qt 5.12.

QGradient.StretchToDeviceMode

In this mode the gradient coordinates are relative to the bounding rectangle of the paint device, with (0,0) in the top left corner, and (1,1) in the bottom right corner of the paint device.

QGradient.ObjectBoundingMode

This mode is the same as ObjectMode, except that the { transform() } {brush transform}, if any, is applied relative to the logical space instead of the object space. This enum value is deprecated and should not be used in new code.
class InterpolationMode
class Preset

This enum specifies a set of predefined presets for QGradient , based on the gradients from https://webgradients.com/ .

Constant

Description

QGradient.WarmFlame

QGradient.NightFade

QGradient.SpringWarmth

QGradient.JuicyPeach

QGradient.YoungPassion

QGradient.LadyLips

QGradient.SunnyMorning

QGradient.RainyAshville

QGradient.FrozenDreams

QGradient.WinterNeva

QGradient.DustyGrass

QGradient.TemptingAzure

QGradient.HeavyRain

QGradient.AmyCrisp

QGradient.MeanFruit

QGradient.DeepBlue

QGradient.RipeMalinka

QGradient.CloudyKnoxville

QGradient.MalibuBeach

QGradient.NewLife

QGradient.TrueSunset

QGradient.MorpheusDen

QGradient.RareWind

QGradient.NearMoon

QGradient.WildApple

QGradient.SaintPetersburg

QGradient.PlumPlate

QGradient.EverlastingSky

QGradient.HappyFisher

QGradient.Blessing

QGradient.SharpeyeEagle

QGradient.LadogaBottom

QGradient.LemonGate

QGradient.ItmeoBranding

QGradient.ZeusMiracle

QGradient.OldHat

QGradient.StarWine

QGradient.HappyAcid

QGradient.AwesomePine

QGradient.NewYork

QGradient.ShyRainbow

QGradient.MixedHopes

QGradient.FlyHigh

QGradient.StrongBliss

QGradient.FreshMilk

QGradient.SnowAgain

QGradient.FebruaryInk

QGradient.KindSteel

QGradient.SoftGrass

QGradient.GrownEarly

QGradient.SharpBlues

QGradient.ShadyWater

QGradient.DirtyBeauty

QGradient.GreatWhale

QGradient.TeenNotebook

QGradient.PoliteRumors

QGradient.SweetPeriod

QGradient.WideMatrix

QGradient.SoftCherish

QGradient.RedSalvation

QGradient.BurningSpring

QGradient.NightParty

QGradient.SkyGlider

QGradient.HeavenPeach

QGradient.PurpleDivision

QGradient.AquaSplash

QGradient.SpikyNaga

QGradient.LoveKiss

QGradient.CleanMirror

QGradient.PremiumDark

QGradient.ColdEvening

QGradient.CochitiLake

QGradient.SummerGames

QGradient.PassionateBed

QGradient.MountainRock

QGradient.DesertHump

QGradient.JungleDay

QGradient.PhoenixStart

QGradient.OctoberSilence

QGradient.FarawayRiver

QGradient.AlchemistLab

QGradient.OverSun

QGradient.PremiumWhite

QGradient.MarsParty

QGradient.EternalConstance

QGradient.JapanBlush

QGradient.SmilingRain

QGradient.CloudyApple

QGradient.BigMango

QGradient.HealthyWater

QGradient.AmourAmour

QGradient.RiskyConcrete

QGradient.StrongStick

QGradient.ViciousStance

QGradient.PaloAlto

QGradient.HappyMemories

QGradient.MidnightBloom

QGradient.Crystalline

QGradient.PartyBliss

QGradient.ConfidentCloud

QGradient.LeCocktail

QGradient.RiverCity

QGradient.FrozenBerry

QGradient.ChildCare

QGradient.FlyingLemon

QGradient.NewRetrowave

QGradient.HiddenJaguar

QGradient.AboveTheSky

QGradient.Nega

QGradient.DenseWater

QGradient.Seashore

QGradient.MarbleWall

QGradient.CheerfulCaramel

QGradient.NightSky

QGradient.MagicLake

QGradient.YoungGrass

QGradient.ColorfulPeach

QGradient.GentleCare

QGradient.PlumBath

QGradient.HappyUnicorn

QGradient.AfricanField

QGradient.SolidStone

QGradient.OrangeJuice

QGradient.GlassWater

QGradient.NorthMiracle

QGradient.FruitBlend

QGradient.MillenniumPine

QGradient.HighFlight

QGradient.MoleHall

QGradient.SpaceShift

QGradient.ForestInei

QGradient.RoyalGarden

QGradient.RichMetal

QGradient.JuicyCake

QGradient.SmartIndigo

QGradient.SandStrike

QGradient.NorseBeauty

QGradient.AquaGuidance

QGradient.SunVeggie

QGradient.SeaLord

QGradient.BlackSea

QGradient.GrassShampoo

QGradient.LandingAircraft

QGradient.WitchDance

QGradient.SleeplessNight

QGradient.AngelCare

QGradient.CrystalRiver

QGradient.SoftLipstick

QGradient.SaltMountain

QGradient.PerfectWhite

QGradient.FreshOasis

QGradient.StrictNovember

QGradient.MorningSalad

QGradient.DeepRelief

QGradient.SeaStrike

QGradient.NightCall

QGradient.SupremeSky

QGradient.LightBlue

QGradient.MindCrawl

QGradient.LilyMeadow

QGradient.SugarLollipop

QGradient.SweetDessert

QGradient.MagicRay

QGradient.TeenParty

QGradient.FrozenHeat

QGradient.GagarinView

QGradient.FabledSunset

QGradient.PerfectBlue
__init__()
__init__(preset)
Parameters:

preset – Preset

Constructs a gradient based on a predefined preset.

The coordinate mode of the resulting gradient is ObjectMode , allowing the preset to be applied to arbitrary object sizes.

coordinateMode()
Return type:

CoordinateMode

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

interpolationMode()
Return type:

InterpolationMode

__ne__(other)
Parameters:

other – QGradient

Return type:

bool

Returns true if the gradient is the same as the other gradient specified; otherwise returns false.

See also

operator==()

__eq__(gradient)
Parameters:

gradient – QGradient

Return type:

bool

Returns true if the gradient is the same as the other gradient specified; otherwise returns false.

See also

operator!=()

setColorAt(pos, color)
Parameters:

  • pos – float

  • color – QColor

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() stops()

setCoordinateMode(mode)
Parameters:

mode – CoordinateMode

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

See also

coordinateMode()

setInterpolationMode(mode)
Parameters:

mode – InterpolationMode

setSpread(spread)
Parameters:

spread – Spread

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

setStops(stops)
Parameters:

stops – .list of std.pairqreal,QColor

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.

spread()
Return type:

Spread

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

See also

setSpread()

stops()
Return type:

.list of std.pairqreal,QColor

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.

type()
Return type:

Type

Returns the type of gradient.