Dox and spelling

This commit is contained in:
Nyall Dawson 2017-12-31 14:53:14 +10:00
parent 43aff9b2e3
commit ea4f61f024
7 changed files with 40 additions and 11 deletions

View File

@ -11,14 +11,9 @@
class QgsAbstractLayoutIterator
{
%Docstring
*************************************************************************
*
This program is free software; you can redistribute it and/or modify *
it under the terms of the GNU General Public License as published by *
the Free Software Foundation; either version 2 of the License, or *
(at your option) any later version. *
*
**************************************************************************
An abstract base class for QgsLayout based classes which can be exported by QgsLayoutExporter.
.. versionadded:: 3.0
%End
%TypeHeaderCode

View File

@ -292,6 +292,8 @@ Iterates to the previous feature, returning false if no previous feature exists.
.. seealso:: :py:func:`last()`
.. seealso:: :py:func:`first()`
.. seealso:: :py:func:`seekTo()`
%End
bool last();
@ -303,6 +305,8 @@ Seeks to the last feature, returning false if no feature was found.
.. seealso:: :py:func:`previous()`
.. seealso:: :py:func:`first()`
.. seealso:: :py:func:`seekTo()`
%End
bool first();
@ -314,9 +318,22 @@ Seeks to the first feature, returning false if no feature was found.
.. seealso:: :py:func:`previous()`
.. seealso:: :py:func:`last()`
.. seealso:: :py:func:`seekTo()`
%End
bool seekTo( int feature );
%Docstring
Seeks to the specified ``feature`` number.
.. seealso:: :py:func:`first()`
.. seealso:: :py:func:`previous()`
.. seealso:: :py:func:`next()`
.. seealso:: :py:func:`last()`
%End
void refreshCurrentFeature();
%Docstring

View File

@ -490,7 +490,8 @@ Returns the legend's renderer settings object.
public slots:
void refresh();
virtual void refresh();
virtual void refreshDataDefinedProperty( const QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::AllProperties );

View File

@ -21,6 +21,12 @@
class QgsLayout;
/**
* \ingroup core
* \class QgsAbstractLayoutIterator
* \brief An abstract base class for QgsLayout based classes which can be exported by QgsLayoutExporter.
* \since QGIS 3.0
*/
class CORE_EXPORT QgsAbstractLayoutIterator
{

View File

@ -258,6 +258,7 @@ class CORE_EXPORT QgsLayoutAtlas : public QObject, public QgsAbstractLayoutItera
* \see next()
* \see last()
* \see first()
* \see seekTo()
*/
bool previous();
@ -266,6 +267,7 @@ class CORE_EXPORT QgsLayoutAtlas : public QObject, public QgsAbstractLayoutItera
* \see next()
* \see previous()
* \see first()
* \see seekTo()
*/
bool last();
@ -274,9 +276,17 @@ class CORE_EXPORT QgsLayoutAtlas : public QObject, public QgsAbstractLayoutItera
* \see next()
* \see previous()
* \see last()
* \see seekTo()
*/
bool first();
/**
* Seeks to the specified \a feature number.
* \see first()
* \see previous()
* \see next()
* \see last()
*/
bool seekTo( int feature );
/**

View File

@ -446,7 +446,7 @@ class CORE_EXPORT QgsLayoutItemLegend : public QgsLayoutItem
public slots:
void refresh();
void refresh() override;
void refreshDataDefinedProperty( const QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::AllProperties ) override;
protected:

View File

@ -62,7 +62,7 @@ class TestQgsReport(unittest.TestCase):
self.assertIsNone(r.childSection(1))
self.assertIsNone(r.childSection(0))
# try deleting non-existant childSections
# try deleting non-existent childSections
r.removeChildAt(-1)
r.removeChildAt(0)
r.removeChildAt(100)