Documents > BPS V2 C++ API
bpsmargins.h File Reference

Public include file for BpsMargins class. More...

#include "bpscore_global.h"
#include <QMetaType>
#include <QVariant>

Go to the source code of this file.

Classes

class  BpsMargins
 This class is used to store margins top, right, bottom and left. More...

Functions

bool operator!= (const BpsMargins &aFirst, const BpsMargins &aSecond)
 Compare two margin objects.
const BpsMargins operator* (const BpsMargins &aMargins, qreal aFactor)
 Multiply a margin object by a qreal.
const BpsMargins operator* (qreal aFactor, const BpsMargins &aMargins)
 Multiply a qreal with a margin object.
const BpsMargins operator/ (const BpsMargins &aMargins, qreal aDivisor)
 Divide a margin object by a qreal.
BPSCORE_EXPORT QDataStream & operator<< (QDataStream &aStream, const BpsMargins &aMargins)
 Write the margins to a stream.
BPSCORE_EXPORT QDebug operator<< (QDebug aDebug, const BpsMargins &aMargins)
 Write the margins to a debug stream.
bool operator== (const BpsMargins &aFirst, const BpsMargins &aSecond)
 Compare two margin objects.
BPSCORE_EXPORT QDataStream & operator>> (QDataStream &aStream, BpsMargins &aMargins)
 Read the margins from a stream.

Detailed Description

Public include file for BpsMargins class.


Function Documentation

bool operator!= ( const BpsMargins aFirst,
const BpsMargins aSecond 
) [inline]

Compare two margin objects.

Parameters:
[in]aFirstThe first object.
[in]aSecondThe second object.
Returns:
True if both are not equal.
const BpsMargins operator* ( const BpsMargins aMargins,
qreal  aFactor 
) [inline]

Multiply a margin object by a qreal.

Parameters:
[in]aMarginsThe margin object.
[in]aFactorThe multiply factor.
Returns:
New margin object with the result.
const BpsMargins operator* ( qreal  aFactor,
const BpsMargins aMargins 
) [inline]

Multiply a qreal with a margin object.

Parameters:
[in]aFactorThe multiply factor.
[in]aMarginsThe margin object.
Returns:
New margin object with the result.
const BpsMargins operator/ ( const BpsMargins aMargins,
qreal  aDivisor 
) [inline]

Divide a margin object by a qreal.

Parameters:
[in]aMarginsThe margin object.
[in]aDivisorThe divisor.
Returns:
New margin object with the result.
BPSCORE_EXPORT QDataStream& operator<< ( QDataStream &  aStream,
const BpsMargins aMargins 
)

Write the margins to a stream.

Parameters:
[in]aStreamThe stream to write to.
[in]aMarginsThe margins object.
Returns:
Stream reference.
BPSCORE_EXPORT QDebug operator<< ( QDebug  aDebug,
const BpsMargins aMargins 
)

Write the margins to a debug stream.

Parameters:
[in]aDebugThe stream to write to.
[in]aMarginsThe margins object.
Returns:
Stream reference.
bool operator== ( const BpsMargins aFirst,
const BpsMargins aSecond 
) [inline]

Compare two margin objects.

Parameters:
[in]aFirstThe first object.
[in]aSecondThe second object.
Returns:
True if both are equal.
BPSCORE_EXPORT QDataStream& operator>> ( QDataStream &  aStream,
BpsMargins aMargins 
)

Read the margins from a stream.

Parameters:
[in]aStreamThe stream to read from.
[in]aMarginsThe margins object.
Returns:
Stream reference.