PySide6.QtCore.QSize¶

class QSize¶

The QSize class defines the size of a two-dimensional object using integer point precision. More…

Synopsis¶

Methods¶

def __init__()
def __reduce__()
def __repr__()
def boundedTo()
def expandedTo()
def grownBy()
def height()
def isEmpty()
def isNull()
def isValid()
def __ne__()
def __mul__()
def __imul__()
def __add__()
def __iadd__()
def __sub__()
def __isub__()
def __div__()
def operator/=()
def __eq__()
def scale()
def scaled()
def setHeight()
def setWidth()
def shrunkBy()
def toSizeF()
def toTuple()
def transpose()
def transposed()
def width()

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.

QSize objects can be streamed as well as compared.

See also

QSizeF QPoint QRect

__init__()¶

Constructs a size with an invalid width and height (i.e., isValid() returns false).

See also

isValid()

__init__(w, h)

Parameters:

w – int
h – int

Constructs a size with the given width and height.

See also

setWidth() setHeight()

__reduce__()¶

Return type:: str

__repr__()¶

Return type:: str

boundedTo(otherSize)¶

Parameters:: otherSize – QSize
Return type:: QSize

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

See also

expandedTo() scale()

expandedTo(otherSize)¶

Parameters:: otherSize – QSize
Return type:: QSize

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

See also

boundedTo() scale()

grownBy(m)¶

Parameters:: m – QMargins
Return type:: QSize

height()¶

Return type:: int

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 is 0; otherwise returns false.

See also

isValid() isEmpty()

isValid()¶

Return type:: bool

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

See also

isNull() isEmpty()

__ne__(rhs)¶

Parameters:: rhs – QSize
Return type:: bool

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

__ne__(rhs)

Parameters:: rhs – QSizeF
Return type:: bool

__mul__(c)¶

Parameters:: c – float
Return type:: QSize

This is an overloaded function.

Multiplies the given size by the given factor, and returns the result rounded to the nearest integer.

__mul__(c)

Parameters:: c – float
Return type:: QSize

Multiplies the given size by the given factor, and returns the result rounded to the nearest integer.

See also

scale()

__imul__(c)¶

Parameters:: c – float
Return type:: QSize

This is an overloaded function.

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

Note that the result is rounded to the nearest integer.

See also

scale()

__add__(s2)¶

Parameters:: s2 – QSize
Return type:: QSize

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

__iadd__(size)¶

Parameters:: size – QSize
Return type:: QSize

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 = QSize( 3, 7)
r = QSize(-1, 4)
s += r
# s becomes (2,11)

__sub__(s2)¶

Parameters:: s2 – QSize
Return type:: QSize

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

__isub__(size)¶

Parameters:: size – QSize
Return type:: QSize

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 = QSize( 3, 7)
r = QSize(-1, 4)
s -= r
# s becomes (4,3)

__div__(c)¶

Parameters:: c – float
Return type:: QSize

This is an overloaded function.

Divides the given size by the given divisor, and returns the result rounded to the nearest integer.

See also

scale()

operator/=(c)

Parameters:: c – float
Return type:: QSize

This is an overloaded function.

Divides both the width and height by the given divisor, and returns a reference to the size.

Note that the result is rounded to the nearest integer.

See also

scale()

__eq__(rhs)¶

Parameters:: rhs – QSize
Return type:: bool

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

__eq__(rhs)

Parameters:: rhs – QSizeF
Return type:: bool

scale(s, mode)¶

Parameters:

s – QSize
mode – AspectRatioMode

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:

w – int
h – int
mode – AspectRatioMode

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 = QSize(10, 12)
t1.scale(60, 60, Qt.IgnoreAspectRatio)
# t1 is (60, 60)
t2 = QSize(10, 12)
t2.scale(60, 60, Qt.KeepAspectRatio)
# t2 is (50, 60)
t3 = QSize(10, 12)
t3.scale(60, 60, Qt.KeepAspectRatioByExpanding)
# t3 is (60, 72)