PySide6.QtCore.QMargins

class QMargins

The QMargins class defines the four margins of a rectangle. More

Added in version 4.6.

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

QMargin defines a set of four margins; left, top, right, and bottom, that describe the size of the borders surrounding a rectangle.

The isNull() function returns true only if all margins are set to zero.

QMargin objects can be streamed as well as compared.

__init__()

Constructs a margins object with all margins set to 0.

See also

isNull()

__init__(left, top, right, bottom)
Parameters:
  • left – int

  • top – int

  • right – int

  • bottom – int

Constructs margins with the given left, top, right, and bottom

bottom()
Return type:

int

Returns the bottom margin.

See also

setBottom()

isNull()
Return type:

bool

Returns true if all margins are is 0; otherwise returns false.

left()
Return type:

int

Returns the left margin.

See also

setLeft()

__ne__(rhs)
Parameters:

rhsQMargins

Return type:

bool

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

__ne__(rhs)
Parameters:

rhsQMarginsF

Return type:

bool

__mul__(factor)
Parameters:

factor – int

Return type:

QMargins

This is an overloaded function.

Returns a QMargins object that is formed by multiplying each component of the given margins by factor.

See also

operator*=() operator/=()

__mul__(factor)
Parameters:

factor – int

Return type:

QMargins

Returns a QMargins object that is formed by multiplying each component of the given margins by factor.

See also

operator*=() operator/=()

__mul__(factor)
Parameters:

factor – float

Return type:

QMargins

This is an overloaded function.

Returns a QMargins object that is formed by multiplying each component of the given margins by factor.

See also

operator*=() operator/=()

__mul__(factor)
Parameters:

factor – float

Return type:

QMargins

This is an overloaded function.

Returns a QMargins object that is formed by multiplying each component of the given margins by factor.

See also

operator*=() operator/=()

__imul__(factor)
Parameters:

factor – int

Return type:

QMargins

Multiplies each component of this object by factor and returns a reference to it.

See also

operator/=()

__imul__(factor)
Parameters:

factor – float

Return type:

QMargins

This is an overloaded function.

Multiplies each component of this object by factor and returns a reference to it.

See also

operator/=()

__add__()
Return type:

QMargins

Returns a QMargin object that is formed from all components of margins.

__add__(m2)
Parameters:

m2QMargins

Return type:

QMargins

Returns a QMargins object that is the sum of the given margins, m1 and m2; each component is added separately.

See also

operator+=() operator-=()

__add__(lhs)
Parameters:

lhs – int

Return type:

QMargins

Returns a QMargins object that is formed by adding lhs to rhs.

See also

operator+=() operator-=()

__add__(rhs)
Parameters:

rhs – int

Return type:

QMargins

Returns a QMargins object that is formed by adding rhs to lhs.

See also

operator+=() operator-=()

__iadd__(margins)
Parameters:

marginsQMargins

Return type:

QMargins

Add each component of margins to the respective component of this object and returns a reference to it.

See also

operator-=()

__iadd__(addend)
Parameters:

addend – int

Return type:

QMargins

This is an overloaded function.

Adds the addend to each component of this object and returns a reference to it.

See also

operator-=()

__sub__()
Return type:

QMargins

Returns a QMargin object that is formed by negating all components of margins.

__sub__(m2)
Parameters:

m2QMargins

Return type:

QMargins

Returns a QMargins object that is formed by subtracting m2 from m1; each component is subtracted separately.

See also

operator+=() operator-=()

__sub__(rhs)
Parameters:

rhs – int

Return type:

QMargins

Returns a QMargins object that is formed by subtracting rhs from lhs.

See also

operator+=() operator-=()

__isub__(margins)
Parameters:

marginsQMargins

Return type:

QMargins

Subtract each component of margins from the respective component of this object and returns a reference to it.

See also

operator+=()

__isub__(subtrahend)
Parameters:

subtrahend – int

Return type:

QMargins

This is an overloaded function.

Subtracts the subtrahend from each component of this object and returns a reference to it.

See also

operator+=()

__div__(divisor)
Parameters:

divisor – int

Return type:

QMargins

Returns a QMargins object that is formed by dividing the components of the given margins by the given divisor.

See also

operator*=() operator/=()

__div__(divisor)
Parameters:

divisor – float

Return type:

QMargins

This is an overloaded function.

Returns a QMargins object that is formed by dividing the components of the given margins by the given divisor.

See also

operator*=() operator/=()

operator/=(divisor)
Parameters:

divisor – int

Return type:

QMargins

Divides each component of this object by divisor and returns a reference to it.

See also

operator*=()

operator/=(divisor)
Parameters:

divisor – float

Return type:

QMargins

This is an overloaded function.

See also

operator*=()

__eq__(rhs)
Parameters:

rhsQMargins

Return type:

bool

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

__eq__(rhs)
Parameters:

rhsQMarginsF

Return type:

bool

__or__(m2)
Parameters:

m2QMargins

Return type:

QMargins

Returns a QMargins object that is formed from the maximum of each component of m2 and m1.

See also

operator+=() operator-=()

right()
Return type:

int

Returns the right margin.

See also

setRight()

setBottom(bottom)
Parameters:

bottom – int

Sets the bottom margin to bottom.

See also

bottom()

setLeft(left)
Parameters:

left – int

Sets the left margin to left.

See also

left()

setRight(right)
Parameters:

right – int

Sets the right margin to right.

See also

right()

setTop(top)
Parameters:

top – int

Sets the Top margin to Top.

See also

top()

toMarginsF()
Return type:

QMarginsF

Returns these margins as margins with floating point accuracy.

See also

toMargins()

top()
Return type:

int

Returns the top margin.

See also

setTop()