\inmodule QtCore More...

#include <qmargins.h>

Inheritance diagram for QMargins:

Collaboration diagram for QMargins:

Public Member Functions
constexpr	QMargins () noexcept
	Constructs a margins object with all margins set to 0.

constexpr	QMargins (int left, int top, int right, int bottom) noexcept
	Constructs margins with the given left, top, right, and bottom.

constexpr bool	isNull () const noexcept
	Returns `true` if all margins are is 0; otherwise returns false.

constexpr int	left () const noexcept
	Returns the left margin.

constexpr int	top () const noexcept
	Returns the top margin.

constexpr int	right () const noexcept
	Returns the right margin.

constexpr int	bottom () const noexcept
	Returns the bottom margin.

constexpr void	setLeft (int left) noexcept
	Sets the left margin to left.

constexpr void	setTop (int top) noexcept
	Sets the Top margin to Top.

constexpr void	setRight (int right) noexcept
	Sets the right margin to right.

constexpr void	setBottom (int bottom) noexcept
	Sets the bottom margin to bottom.

constexpr QMargins &	operator+= (const QMargins &margins) noexcept
	Add each component of margins to the respective component of this object and returns a reference to it.

constexpr QMargins &	operator-= (const QMargins &margins) noexcept
	Subtract each component of margins from the respective component of this object and returns a reference to it.

constexpr QMargins &	operator+= (int) noexcept
	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.

constexpr QMargins &	operator-= (int) noexcept
	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.

constexpr QMargins &	operator*= (int) noexcept
	Multiplies each component of this object by factor and returns a reference to it.

constexpr QMargins &	operator/= (int)
	Divides each component of this object by divisor and returns a reference to it.

constexpr QMargins &	operator*= (qreal) noexcept
	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.

constexpr QMargins &	operator/= (qreal)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

constexpr QMarginsF	toMarginsF () const noexcept

Friends
constexpr QMargins	operator+ (const QMargins &m1, const QMargins &m2)
	Returns a QMargins object that is the sum of the given margins, m1 and m2; each component is added separately.

constexpr QMargins	operator- (const QMargins &m1, const QMargins &m2)
	Returns a QMargins object that is formed by subtracting m2 from m1; each component is subtracted separately.

constexpr QMargins	operator+ (const QMargins &lhs, int rhs)
	Returns a QMargins object that is formed by adding rhs to lhs.

constexpr QMargins	operator+ (int lhs, const QMargins &rhs)
	Returns a QMargins object that is formed by adding lhs to rhs.

constexpr QMargins	operator- (const QMargins &lhs, int rhs)
	Returns a QMargins object that is formed by subtracting rhs from lhs.

constexpr QMargins	operator* (const QMargins &margins, int factor)
	Returns a QMargins object that is formed by multiplying each component of the given margins by factor.

constexpr QMargins	operator* (int factor, const QMargins &margins)
	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.

constexpr QMargins	operator* (const QMargins &margins, qreal factor)
	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.

constexpr QMargins	operator* (qreal factor, const QMargins &margins)
	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.

constexpr QMargins	operator/ (const QMargins &margins, int divisor)
	Returns a QMargins object that is formed by dividing the components of the given margins by the given divisor.

constexpr QMargins	operator/ (const QMargins &margins, qreal divisor)
	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.

constexpr QMargins	operator\| (const QMargins &m1, const QMargins &m2)
	Returns a QMargins object that is formed from the maximum of each component of m2 and m1.

constexpr bool	comparesEqual (const QMargins &lhs, const QMargins &rhs) noexcept

template<std::size_t I, typename M, std::enable_if_t<(I< 4), bool > = true, std::enable_if_t< std::is_same_v< q20::remove_cvref_t< M >, QMargins >, bool > = true>
constexpr decltype(auto)	get (M &&m) noexcept

Related Symbols
(Note that these are not member symbols.)
QMargins	operator+ (const QMargins &margins)
	Returns a QMargin object that is formed from all components of margins.

QMargins	operator- (const QMargins &margins)
	Returns a QMargin object that is formed by negating all components of margins.

QDataStream &	operator<< (QDataStream &stream, const QMargins &m)
	Writes margin m to the given stream and returns a reference to the stream.

QDataStream &	operator>> (QDataStream &stream, QMargins &m)
	Reads a margin from the given stream into margin m and returns a reference to the stream.

Detailed Description

\inmodule QtCore

Since: 4.6

\compares equality \compareswith equality QMarginsF \endcompareswith

The QMargins class defines the four margins of a rectangle.

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 25 of file qmargins.h.

Constructor & Destructor Documentation

◆ QMargins() [1/2]

QMargins::QMargins ( )

inlineconstexprnoexcept

Constructs a margins object with all margins set to 0.

See also: isNull()

Definition at line 123 of file qmargins.h.

◆ QMargins() [2/2]

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 125 of file qmargins.h.

References QMargins().

Referenced by QMargins(), and QSGDefaultGlyphNode::update().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ bottom()

int QMargins::bottom ( ) const

inlineconstexprnoexcept

Returns the bottom margin.

Definition at line 140 of file qmargins.h.

◆ isNull()

bool QMargins::isNull ( ) const

inlineconstexprnoexcept

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

Definition at line 128 of file qmargins.h.

◆ left()

int QMargins::left ( ) const

inlineconstexprnoexcept

Returns the left margin.

See also: setLeft()

Definition at line 131 of file qmargins.h.

◆ operator*=() [1/2]

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 264 of file qmargins.h.

◆ operator*=() [2/2]

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 274 of file qmargins.h.

◆ operator+=() [1/2]

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 236 of file qmargins.h.

References operator+.

Here is the call graph for this function:

◆ operator+=() [2/2]

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 246 of file qmargins.h.

◆ operator-=() [1/2]

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 241 of file qmargins.h.

References operator-.

Here is the call graph for this function:

◆ operator-=() [2/2]

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 255 of file qmargins.h.

◆ operator/=() [1/2]

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 269 of file qmargins.h.

◆ operator/=() [2/2]

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 279 of file qmargins.h.

◆ right()

int QMargins::right ( ) const

inlineconstexprnoexcept

Returns the right margin.

Definition at line 137 of file qmargins.h.

◆ setBottom()

void QMargins::setBottom ( int bottom )

inlineconstexprnoexcept

Sets the bottom margin to bottom.

Definition at line 153 of file qmargins.h.

Referenced by operator>>(), and QSGDefaultGlyphNode::update().

Here is the caller graph for this function:

◆ setLeft()

void QMargins::setLeft ( int left )

inlineconstexprnoexcept

Sets the left margin to left.

Definition at line 144 of file qmargins.h.

Referenced by operator>>().

Here is the caller graph for this function:

◆ setRight()

void QMargins::setRight ( int right )

inlineconstexprnoexcept

Sets the right margin to right.

Definition at line 150 of file qmargins.h.

Referenced by operator>>().

Here is the caller graph for this function:

◆ setTop()

void QMargins::setTop ( int top )

inlineconstexprnoexcept

Sets the Top margin to Top.

Definition at line 147 of file qmargins.h.

Referenced by operator>>(), and QSGDefaultGlyphNode::update().

Here is the caller graph for this function:

◆ toMarginsF()

QMarginsF QMargins::toMarginsF ( ) const

inlinenodiscardconstexprnoexcept

Since: 6.4

Returns these margins as margins with floating point accuracy.

See also: QMarginsF::toMargins()

Definition at line 538 of file qmargins.h.

◆ top()

int QMargins::top ( ) const

inlineconstexprnoexcept

Returns the top margin.

See also: setTop()

Definition at line 134 of file qmargins.h.

Friends And Related Symbol Documentation

◆ comparesEqual

bool comparesEqual	(	const QMargins &	lhs,
		const QMargins &	rhs )

friend

Definition at line 83 of file qmargins.h.

◆ get

template<std::size_t I, typename M, std::enable_if_t<(I< 4), bool > = true, std::enable_if_t< std::is_same_v< q20::remove_cvref_t< M >, QMargins >, bool > = true>

decltype(auto) get ( M && m )

friend

Definition at line 96 of file qmargins.h.

◆ operator* [1/4]

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

friend

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 186 of file qmargins.h.

◆ operator* [2/4]

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

friend

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.

◆ operator* [3/4]

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

friend

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 192 of file qmargins.h.

◆ operator* [4/4]

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

friend

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 207 of file qmargins.h.

◆ operator+ [1/4]

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

friend

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

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

Since: 5.3

Definition at line 168 of file qmargins.h.

◆ operator+ [2/4]

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

friend

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 156 of file qmargins.h.

Referenced by operator+=().

◆ operator+() [3/4]

QMargins operator+ ( const QMargins & margins )

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

Since: 5.3

Definition at line 284 of file qmargins.h.

◆ operator+ [4/4]

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

friend

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

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

Since: 5.3

Definition at line 174 of file qmargins.h.

◆ operator- [1/3]

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

friend

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

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

Since: 5.3

Definition at line 180 of file qmargins.h.

◆ operator- [2/3]

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

friend

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 162 of file qmargins.h.

Referenced by operator-=().

◆ operator-() [3/3]

QMargins operator- ( const QMargins & margins )

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

Since: 5.1

Definition at line 289 of file qmargins.h.

◆ operator/ [1/2]

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

friend

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 215 of file qmargins.h.

◆ operator/ [2/2]

QMargins operator/	(	const QMargins &	margins,
		qreal	divisor )

friend

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 221 of file qmargins.h.

◆ operator<<()

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

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

See also: {Serializing Qt Data Types}

Definition at line 400 of file qmargins.cpp.

◆ operator>>()

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

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 416 of file qmargins.cpp.

References setBottom(), setLeft(), setRight(), and setTop().

Here is the call graph for this function:

◆ operator|

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

friend

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 230 of file qmargins.h.

The documentation for this class was generated from the following files:

qtbase/src/corelib/tools/qmargins.h (c5608c675a61a413b4a32c6c99721a1bb2f41e71)
qtbase/src/corelib/tools/qmargins.cpp (473d06970d224b202e7a8ee8feaa2a2d98d5b257)

Public Member Functions

Friends

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ QMargins() [1/2]

◆ QMargins() [2/2]

Member Function Documentation

◆ bottom()

◆ isNull()

◆ left()

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ right()

◆ setBottom()

◆ setLeft()

◆ setRight()

◆ setTop()

◆ toMarginsF()

◆ top()

Friends And Related Symbol Documentation

◆ comparesEqual

◆ get

◆ operator* [1/4]

◆ operator* [2/4]

◆ operator* [3/4]

◆ operator* [4/4]

◆ operator+ [1/4]

◆ operator+ [2/4]

◆ operator+() [3/4]

◆ operator+ [4/4]

◆ operator- [1/3]

◆ operator- [2/3]

◆ operator-() [3/3]

◆ operator/ [1/2]

◆ operator/ [2/2]

◆ operator<<()

◆ operator>>()

◆ operator|