QGIS/python/core/qgsmargins.sip

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsmargins.h                                                *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/





class QgsMargins
{

%TypeHeaderCode
#include "qgsmargins.h"
%End
  public:

    QgsMargins();
%Docstring
 Constructs a margins object with all margins set to 0.
%End

    QgsMargins( double left, double top, double right, double bottom );
%Docstring
 Constructs margins with the given ``left``, ``top``, ``right``, ``bottom``
.. seealso:: setLeft()
.. seealso:: setRight()
.. seealso:: setTop()
.. seealso:: setBottom()
%End

    bool isNull() const;
%Docstring
 Returns \c true if all margins are is 0; otherwise returns false.
 :rtype: bool
%End

    double left() const;
%Docstring
 Returns the left margin.
.. seealso:: setLeft()
 :rtype: float
%End

    double top() const;
%Docstring
 Returns the top margin.
.. seealso:: setTop()
 :rtype: float
%End

    double right() const;
%Docstring
 Returns the right margin.
.. seealso:: setRight()
 :rtype: float
%End

    double bottom() const;
%Docstring
 Returns the bottom margin.
.. seealso:: setBottom()
 :rtype: float
%End

    void setLeft( double left );
%Docstring
 Sets the left margin to ``left``.
.. seealso:: left()
%End

    void setTop( double top );
%Docstring
 Sets the top margin to ``top``.
.. seealso:: top()
%End

    void setRight( double right );
%Docstring
 Sets the right margin to ``right``.
.. seealso:: right()
%End

    void setBottom( double bottom );
%Docstring
 Sets the bottom margin to ``bottom``.
.. seealso:: bottom()
%End

    QgsMargins &operator+=( const QgsMargins &margins );
%Docstring
 Add each component of ``margins`` to the respective component of this object
 and returns a reference to it.
 :rtype: QgsMargins
%End

    QgsMargins &operator-=( const QgsMargins &margins );
%Docstring
 Subtract each component of ``margins`` from the respective component of this object
 and returns a reference to it.
 :rtype: QgsMargins
%End

    QgsMargins &operator+=( double addend );
%Docstring
 Adds the ``addend`` to each component of this object and returns a reference to it.
 :rtype: QgsMargins
%End

    QgsMargins &operator-=( double subtrahend );
%Docstring
 Subtracts the ``subtrahend`` from each component of this object
 and returns a reference to it.
 :rtype: QgsMargins
%End

    QgsMargins &operator*=( double factor );
%Docstring
 Multiplies each component of this object by ``factor``
 and returns a reference to it.
 :rtype: QgsMargins
%End

    QgsMargins &operator/=( double divisor );
%Docstring
 Multiplies each component of this object by ``factor``
 and returns a reference to it.
 :rtype: QgsMargins
%End

    QString toString() const;
%Docstring
 Returns the margins encoded to a string.
.. seealso:: fromString()
 :rtype: str
%End

    static QgsMargins fromString( const QString &string );
%Docstring
 Returns a QgsMargins object decoded from a string, or a null QgsMargins
 if the string could not be interpreted as margins.
.. seealso:: toString()
 :rtype: QgsMargins
%End

};


/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsmargins.h                                                *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/