Skip to content
Permalink
Browse files

Dox updates

  • Loading branch information
nyalldawson committed Jul 18, 2017
1 parent 7f06667 commit 4e0e038aabbef9ad91227556741598e922fb75aa
@@ -64,6 +64,9 @@ class QgsLayoutItemRectangularShape : QgsLayoutItemShape

static QgsLayoutItemRectangularShape *create( QgsLayout *layout, const QVariantMap &settings ) /Factory/;
%Docstring
Returns a new rectangular item for the specified ``layout``.

The caller takes responsibility for deleting the returned object.
:rtype: QgsLayoutItemRectangularShape
%End

@@ -107,6 +110,9 @@ class QgsLayoutItemEllipseShape : QgsLayoutItemShape

static QgsLayoutItemEllipseShape *create( QgsLayout *layout, const QVariantMap &settings ) /Factory/;
%Docstring
Returns a new ellipse item for the specified ``layout``.

The caller takes responsibility for deleting the returned object.
:rtype: QgsLayoutItemEllipseShape
%End

@@ -137,6 +143,9 @@ class QgsLayoutItemTriangleShape : QgsLayoutItemShape

static QgsLayoutItemTriangleShape *create( QgsLayout *layout, const QVariantMap &settings ) /Factory/;
%Docstring
Returns a new triangle item for the specified ``layout``.

The caller takes responsibility for deleting the returned object.
:rtype: QgsLayoutItemTriangleShape
%End

@@ -26,7 +26,7 @@ class QgsFeature;
class QgsVectorLayer;

/**
* \ingroup Layout
* \ingroup core
* \class QgsLayoutContext
* \brief Stores information relating to the current context and rendering settings for a layout.
* \since QGIS 3.0
@@ -79,6 +79,11 @@ class CORE_EXPORT QgsLayoutItemRectangularShape : public QgsLayoutItemShape
explicit QgsLayoutItemRectangularShape( QgsLayout *layout );
virtual int type() const override { return QgsLayoutItemRegistry::LayoutRectangle; }

/**
* Returns a new rectangular item for the specified \a layout.
*
* The caller takes responsibility for deleting the returned object.
*/
static QgsLayoutItemRectangularShape *create( QgsLayout *layout, const QVariantMap &settings ) SIP_FACTORY;

/**
@@ -120,6 +125,11 @@ class CORE_EXPORT QgsLayoutItemEllipseShape : public QgsLayoutItemShape
explicit QgsLayoutItemEllipseShape( QgsLayout *layout );
virtual int type() const override { return QgsLayoutItemRegistry::LayoutEllipse; }

/**
* Returns a new ellipse item for the specified \a layout.
*
* The caller takes responsibility for deleting the returned object.
*/
static QgsLayoutItemEllipseShape *create( QgsLayout *layout, const QVariantMap &settings ) SIP_FACTORY;

protected:
@@ -147,6 +157,11 @@ class CORE_EXPORT QgsLayoutItemTriangleShape : public QgsLayoutItemShape
explicit QgsLayoutItemTriangleShape( QgsLayout *layout );
virtual int type() const override { return QgsLayoutItemRegistry::LayoutTriangle; }

/**
* Returns a new triangle item for the specified \a layout.
*
* The caller takes responsibility for deleting the returned object.
*/
static QgsLayoutItemTriangleShape *create( QgsLayout *layout, const QVariantMap &settings ) SIP_FACTORY;

protected:

0 comments on commit 4e0e038

Please sign in to comment.
You can’t perform that action at this time.