PySide6.QtCore.QSizeF

class QSizeF

The QSizeF class defines the size of a two-dimensional object using floating point precision. More

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

A size is specified by a width() and a height() . It can be set in the constructor and changed using the setWidth() , setHeight() , or scale() functions, or using arithmetic operators. A size can also be manipulated directly by retrieving references to the width and height using the rwidth() and rheight() functions. Finally, the width and height can be swapped using the transpose() function.

The isValid() function determines if a size is valid. A valid size has both width and height greater than or equal to zero. The isEmpty() function returns true if either of the width and height is less than (or equal to) zero, while the isNull() function returns true only if both the width and the height is zero.

Use the expandedTo() function to retrieve a size which holds the maximum height and width of this size and a given size. Similarly, the boundedTo() function returns a size which holds the minimum height and width of this size and a given size.

The QSizeF class also provides the toSize() function returning a QSize copy of this size, constructed by rounding the width and height to the nearest integers.

QSizeF objects can be streamed as well as compared.

See also

QSize QPointF QRectF

__init__()

Constructs an invalid size.

See also

isValid()

__init__(sz)
Parameters:

szQSize

Constructs a size with floating point accuracy from the given size.

See also

toSize() toSizeF()

__init__(w, h)
Parameters:
  • w – float

  • h – float

Constructs a size with the given finite width and height.

__reduce__()
Return type:

str

__repr__()
Return type:

str

boundedTo(otherSize)
Parameters:

otherSizeQSizeF

Return type:

QSizeF

Returns a size holding the minimum width and height of this size and the given otherSize.

expandedTo(otherSize)
Parameters:

otherSizeQSizeF

Return type:

QSizeF

Returns a size holding the maximum width and height of this size and the given otherSize.

See also

boundedTo() scale()

grownBy(m)
Parameters:

mQMarginsF

Return type:

QSizeF

height()
Return type:

float

Returns the height.

See also

width() setHeight()

isEmpty()
Return type:

bool

Returns true if either of the width and height is less than or equal to 0; otherwise returns false.

See also

isNull() isValid()

isNull()
Return type:

bool

Returns true if both the width and height are 0.0 (ignoring the sign); otherwise returns false.

See also

isValid() isEmpty()

isValid()
Return type:

bool

Returns true if both the width and height are equal to or greater than 0; otherwise returns false.

See also

isNull() isEmpty()

__ne__(rhs)
Parameters:

rhsQSize

Return type:

bool

__ne__(rhs)
Parameters:

rhsQSizeF

Return type:

bool

Returns true if lhs and rhs are sufficiently different; otherwise returns false.

Warning

This function does not check for strict inequality; instead, it uses a fuzzy comparison to compare the sizes’ extents.

__mul__(c)
Parameters:

c – float

Return type:

QSizeF

This is an overloaded function.

Multiplies the given size by the given finite factor and returns the result.

__mul__(c)
Parameters:

c – float

Return type:

QSizeF

This is an overloaded function.

Multiplies the given size by the given finite factor and returns the result.

See also

scale()

__imul__(c)
Parameters:

c – float

Return type:

QSizeF

This is an overloaded function.

Multiplies both the width and height by the given finite factor and returns a reference to the size.

See also

scale()

__add__(s2)
Parameters:

s2QSizeF

Return type:

QSizeF

Returns the sum of s1 and s2; each component is added separately.

__iadd__(size)
Parameters:

sizeQSizeF

Return type:

QSizeF

Warning

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

Adds the given size to this size and returns a reference to this size. For example:

s = QSizeF( 3, 7)
r = QSizeF(-1, 4)
s += r
# s becomes (2,11)
__sub__(s2)
Parameters:

s2QSizeF

Return type:

QSizeF

Returns s2 subtracted from s1; each component is subtracted separately.

__isub__(size)
Parameters:

sizeQSizeF

Return type:

QSizeF

Warning

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

Subtracts the given size from this size and returns a reference to this size. For example:

s = QSizeF( 3, 7)
r = QSizeF(-1, 4)
s -= r
# s becomes (4,3)
__div__(c)
Parameters:

c – float

Return type:

QSizeF

This is an overloaded function.

Divides the given size by the given divisor and returns the result. The divisor must not be either zero or NaN.

See also

scale()

operator/=(c)
Parameters:

c – float

Return type:

QSizeF

This is an overloaded function.

Divides both the width and height by the given divisor and returns a reference to the size. The divisor must not be either zero or NaN.

See also

scale()

__eq__(rhs)
Parameters:

rhsQSize

Return type:

bool

__eq__(rhs)
Parameters:

rhsQSizeF

Return type:

bool

Returns true if lhs and rhs are approximately equal; otherwise returns false.

Warning

This function does not check for strict equality; instead, it uses a fuzzy comparison to compare the sizes’ extents.

See also

qFuzzyCompare

scale(s, mode)
Parameters:

This is an overloaded function.

Scales the size to a rectangle with the given size, according to the specified mode.

scale(w, h, mode)
Parameters:

Warning

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

Scales the size to a rectangle with the given width and height, according to the specified mode.

  • If mode is IgnoreAspectRatio , the size is set to (width, height).

  • If mode is KeepAspectRatio , the current size is scaled to a rectangle as large as possible inside (width, height), preserving the aspect ratio.

  • If mode is KeepAspectRatioByExpanding , the current size is scaled to a rectangle as small as possible outside (width, height), preserving the aspect ratio.

Example:

t1 = QSizeF(10, 12)
t1.scale(60, 60, Qt.IgnoreAspectRatio)
# t1 is (60, 60)
t2 = QSizeF(10, 12)
t2.scale(60, 60, Qt.KeepAspectRatio)
# t2 is (50, 60)
t3 = QSizeF(10, 12)
t3.scale(60, 60, Qt.KeepAspectRatioByExpanding)
# t3 is (60, 72)
scaled(s, mode)
Parameters:
Return type:

QSizeF

This is an overloaded function.

Returns a size scaled to a rectangle with the given size s, according to the specified mode.

scaled(w, h, mode)
Parameters:
Return type:

QSizeF

Returns a size scaled to a rectangle with the given width and height, according to the specified mode.

See also

scale()

setHeight(h)
Parameters:

h – float

Sets the height to the given finite height.

See also

height() rheight() setWidth()

setWidth(w)
Parameters:

w – float

Sets the width to the given finite width.

See also

width() rwidth() setHeight()

shrunkBy(m)
Parameters:

mQMarginsF

Return type:

QSizeF

toSize()
Return type:

QSize

Returns an integer based copy of this size.

Note that the coordinates in the returned size will be rounded to the nearest integer.

See also

QSizeF() toSizeF()

toTuple()
Return type:

object

transpose()

Swaps the width and height values.

transposed()
Return type:

QSizeF

Returns the size with width and height values swapped.

See also

transpose()

width()
Return type:

float

Returns the width.

See also

height() setWidth()