QtBase  v6.3.1
Public Member Functions | Friends | Related Functions | List of all members
QMargins Class Reference

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

#include <qmargins.h>

Public Member Functions

constexpr QMargins () noexcept
 
constexpr QMargins (int left, int top, int right, int bottom) noexcept
 
constexpr bool isNull () const noexcept
 
constexpr int left () const noexcept
 
constexpr int top () const noexcept
 
constexpr int right () const noexcept
 
constexpr int bottom () const noexcept
 
constexpr void setLeft (int left) noexcept
 
constexpr void setTop (int top) noexcept
 
constexpr void setRight (int right) noexcept
 
constexpr void setBottom (int bottom) noexcept
 
constexpr QMargins & operator+= (const QMargins &margins) noexcept
 
constexpr QMargins & operator-= (const QMargins &margins) noexcept
 
constexpr QMargins & operator+= (int) noexcept
 
constexpr QMargins & operator-= (int) noexcept
 
constexpr QMargins & operator*= (int) noexcept
 
constexpr QMargins & operator/= (int)
 
constexpr QMargins & operator*= (qreal) noexcept
 
constexpr QMargins & operator/= (qreal)
 

Friends

constexpr friend bool operator== (const QMargins &m1, const QMargins &m2) noexcept
 
constexpr friend bool operator!= (const QMargins &m1, const QMargins &m2) noexcept
 

Related Functions

(Note that these are not member functions.)

QMargins operator+ (const QMargins &m1, const QMargins &m2)
 
QMargins operator- (const QMargins &m1, const QMargins &m2)
 
QMargins operator+ (const QMargins &lhs, int rhs)
 
QMargins operator+ (int lhs, const QMargins &rhs)
 
QMargins operator- (const QMargins &lhs, int rhs)
 
QMargins operator* (const QMargins &margins, int factor)
 
QMargins operator* (int factor, const QMargins &margins)
 
QMargins operator* (const QMargins &margins, qreal factor)
 
QMargins operator* (qreal factor, const QMargins &margins)
 
QMargins operator/ (const QMargins &margins, int divisor)
 
QMargins operator/ (const QMargins &, qreal)
 
QMargins operator+ (const QMargins &margins)
 
QMargins operator- (const QMargins &margins)
 
QMargins operator| (const QMargins &m1, const QMargins &m2)
 
QDataStream & operator<< (QDataStream &stream, const QMargins &m)
 
QDataStream & operator>> (QDataStream &stream, QMargins &m)
 

Detailed Description

The QMargins class defines the four margins of a rectangle.

\inmodule QtCore

Since
4.6

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.

Definition at line 51 of file qmargins.h.

Constructor & Destructor Documentation

◆ QMargins() [1/2]

constexpr QMargins::QMargins ( )
inlineconstexprnoexcept

Constructs a margins object with all margins set to 0.

See also
isNull()

Definition at line 129 of file qmargins.h.

Here is the caller graph for this function:

◆ QMargins() [2/2]

constexpr QMargins::QMargins ( int  left,
int  top,
int  right,
int  bottom 
)
inlineconstexprnoexcept

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

See also
setLeft(), setRight(), setTop(), setBottom()

Definition at line 131 of file qmargins.h.

Member Function Documentation

◆ bottom()

constexpr int QMargins::bottom ( ) const
inlineconstexprnoexcept

Returns the bottom margin.

Definition at line 146 of file qmargins.h.

Here is the caller graph for this function:

◆ isNull()

constexpr bool QMargins::isNull ( ) const
inlineconstexprnoexcept

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

Definition at line 134 of file qmargins.h.

Here is the caller graph for this function:

◆ left()

constexpr int QMargins::left ( ) const
inlineconstexprnoexcept

Returns the left margin.

See also
setLeft()

Definition at line 137 of file qmargins.h.

Here is the caller graph for this function:

◆ operator*=() [1/2]

constexpr QMargins & QMargins::operator*= ( int  factor)
inlineconstexprnoexcept

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

See also
operator/=()
Since
5.1

Definition at line 262 of file qmargins.h.

◆ operator*=() [2/2]

constexpr QMargins & QMargins::operator*= ( qreal  factor)
inlineconstexprnoexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

See also
operator/=()
Since
5.1

Definition at line 272 of file qmargins.h.

◆ operator+=() [1/2]

constexpr QMargins & QMargins::operator+= ( const QMargins &  margins)
inlineconstexprnoexcept

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

See also
operator-=()
Since
5.1

Definition at line 234 of file qmargins.h.

◆ operator+=() [2/2]

constexpr QMargins & QMargins::operator+= ( int  addend)
inlineconstexprnoexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

See also
operator-=()

Definition at line 244 of file qmargins.h.

◆ operator-=() [1/2]

constexpr QMargins & QMargins::operator-= ( const QMargins &  margins)
inlineconstexprnoexcept

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

See also
operator+=()
Since
5.1

Definition at line 239 of file qmargins.h.

◆ operator-=() [2/2]

constexpr QMargins & QMargins::operator-= ( int  subtrahend)
inlineconstexprnoexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

See also
operator+=()

Definition at line 253 of file qmargins.h.

◆ operator/=() [1/2]

constexpr QMargins & QMargins::operator/= ( int  divisor)
inlineconstexpr

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

See also
operator*=()
Since
5.1

Definition at line 267 of file qmargins.h.

◆ operator/=() [2/2]

constexpr QMargins & QMargins::operator/= ( qreal  divisor)
inlineconstexpr

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

See also
operator*=()
Since
5.1

Definition at line 277 of file qmargins.h.

◆ right()

constexpr int QMargins::right ( ) const
inlineconstexprnoexcept

Returns the right margin.

Definition at line 143 of file qmargins.h.

Here is the caller graph for this function:

◆ setBottom()

constexpr void QMargins::setBottom ( int  bottom)
inlineconstexprnoexcept

Sets the bottom margin to bottom.

Definition at line 159 of file qmargins.h.

Here is the caller graph for this function:

◆ setLeft()

constexpr void QMargins::setLeft ( int  left)
inlineconstexprnoexcept

Sets the left margin to left.

Definition at line 150 of file qmargins.h.

Here is the caller graph for this function:

◆ setRight()

constexpr void QMargins::setRight ( int  right)
inlineconstexprnoexcept

Sets the right margin to right.

Definition at line 156 of file qmargins.h.

Here is the caller graph for this function:

◆ setTop()

constexpr void QMargins::setTop ( int  Top)
inlineconstexprnoexcept

Sets the Top margin to Top.

Definition at line 153 of file qmargins.h.

Here is the caller graph for this function:

◆ top()

constexpr int QMargins::top ( ) const
inlineconstexprnoexcept

Returns the top margin.

See also
setTop()

Definition at line 140 of file qmargins.h.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator!=

bool QMargins::operator!= ( const QMargins &  m1,
const QMargins &  m2 
)
friend

Returns true if m1 and m2 are different; otherwise returns false.

Definition at line 93 of file qmargins.h.

◆ operator*() [1/4]

QMargins operator* ( const QMargins &  margins,
int  factor 
)
related

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

See also
QMargins::operator*=(), QMargins::operator/=()
Since
5.1

Definition at line 192 of file qmargins.h.

Here is the call graph for this function:

◆ operator*() [2/4]

QMargins operator* ( const QMargins &  margins,
qreal  factor 
)
related

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

See also
QMargins::operator*=(), QMargins::operator/=()
Since
5.1

Definition at line 204 of file qmargins.h.

Here is the call graph for this function:

◆ operator*() [3/4]

QMargins operator* ( int  factor,
const QMargins &  margins 
)
related

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

See also
QMargins::operator*=(), QMargins::operator/=()
Since
5.1

Definition at line 198 of file qmargins.h.

Here is the call graph for this function:

◆ operator*() [4/4]

QMargins operator* ( qreal  factor,
const QMargins &  margins 
)
related

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

See also
QMargins::operator*=(), QMargins::operator/=()
Since
5.1

Definition at line 210 of file qmargins.h.

Here is the call graph for this function:

◆ operator+() [1/4]

QMargins operator+ ( const QMargins &  lhs,
int  rhs 
)
related

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

See also
QMargins::operator+=(), QMargins::operator-=()
Since
5.3

Definition at line 174 of file qmargins.h.

Here is the call graph for this function:

◆ operator+() [2/4]

QMargins operator+ ( const QMargins &  m1,
const QMargins &  m2 
)
related

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

See also
QMargins::operator+=(), QMargins::operator-=()
Since
5.1

Definition at line 162 of file qmargins.h.

Here is the call graph for this function:

◆ operator+() [3/4]

QMargins operator+ ( const QMargins &  margins)
related

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

Since
5.3

Definition at line 282 of file qmargins.h.

◆ operator+() [4/4]

QMargins operator+ ( int  lhs,
const QMargins &  rhs 
)
related

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

See also
QMargins::operator+=(), QMargins::operator-=()
Since
5.3

Definition at line 180 of file qmargins.h.

Here is the call graph for this function:

◆ operator-() [1/3]

QMargins operator- ( const QMargins &  lhs,
int  rhs 
)
related

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

See also
QMargins::operator+=(), QMargins::operator-=()
Since
5.3

Definition at line 186 of file qmargins.h.

Here is the call graph for this function:

◆ operator-() [2/3]

QMargins operator- ( const QMargins &  m1,
const QMargins &  m2 
)
related

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

See also
QMargins::operator+=(), QMargins::operator-=()
Since
5.1

Definition at line 168 of file qmargins.h.

Here is the call graph for this function:

◆ operator-() [3/3]

QMargins operator- ( const QMargins &  margins)
related

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

Since
5.1

Definition at line 287 of file qmargins.h.

Here is the call graph for this function:

◆ operator/() [1/2]

QMargins operator/ ( const QMargins &  ,
qreal   
)
related

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

See also
QMargins::operator*=(), QMargins::operator/=()
Since
5.1

Definition at line 222 of file qmargins.h.

Here is the call graph for this function:

◆ operator/() [2/2]

QMargins operator/ ( const QMargins &  margins,
int  divisor 
)
related

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

See also
QMargins::operator*=(), QMargins::operator/=()
Since
5.1

Definition at line 216 of file qmargins.h.

Here is the call graph for this function:

◆ operator<<()

QDataStream & operator<< ( QDataStream &  stream,
const QMargins &  m 
)
related

Writes margin m to the given stream and returns a reference to the stream.

See also
{Serializing Qt Data Types}

Definition at line 423 of file qmargins.cpp.

◆ operator==

bool QMargins::operator== ( const QMargins &  m1,
const QMargins &  m2 
)
friend

Returns true if m1 and m2 are equal; otherwise returns false.

Definition at line 84 of file qmargins.h.

◆ operator>>()

QDataStream & operator>> ( QDataStream &  stream,
QMargins &  m 
)
related

Reads a margin from the given stream into margin m and returns a reference to the stream.

See also
{Serializing Qt Data Types}

Definition at line 439 of file qmargins.cpp.

◆ operator|()

QMargins operator| ( const QMargins &  m1,
const QMargins &  m2 
)
related

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

See also
QMargins::operator+=(), QMargins::operator-=()
Since
6.0

Definition at line 228 of file qmargins.h.

Here is the call graph for this function:
The documentation for this class was generated from the following files:
Generated by doxygen 1.9.1