Skip to content
Permalink
Browse files

Make doxygen_space script convert multiline //! comments

Because:
- the /** format is much more prevalent throughout QGIS
- sipify works correctly with /**
  • Loading branch information
nyalldawson committed Oct 5, 2017
1 parent d9952b6 commit 49b426d951a8c04ca711eaeb0ab486bce7836c28
Showing with 2,553 additions and 1,144 deletions.
  1. +33 −9 python/analysis/raster/qgsalignraster.sip
  2. +1 −0 python/analysis/raster/qgsrastermatrix.sip
  3. +8 −0 python/core/composer/qgscomposerlegend.sip
  4. +21 −0 python/core/dxf/qgsdxfexport.sip
  5. +7 −2 python/core/expression/qgsexpression.sip
  6. +2 −0 python/core/expression/qgsexpressionnode.sip
  7. +45 −4 python/core/layertree/qgslayertreemodel.sip
  8. +1 −0 python/core/layertree/qgslayertreemodellegendnode.sip
  9. +17 −1 python/core/layertree/qgslayertreenode.sip
  10. +4 −1 python/core/layertree/qgslayertreeregistrybridge.sip
  11. +5 −1 python/core/layertree/qgslayertreeutils.sip
  12. +17 −3 python/core/qgis.sip
  13. +6 −3 python/core/qgsapplication.sip
  14. +3 −1 python/core/qgsbrowsermodel.sip
  15. +3 −1 python/core/qgsdatadefinedsizelegend.sip
  16. +5 −1 python/core/qgsdataitem.sip
  17. +4 −2 python/core/qgsdataitemprovider.sip
  18. +2 −0 python/core/qgsdatasourceuri.sip
  19. +5 −1 python/core/qgsfeaturerequest.sip
  20. +4 −1 python/core/qgsfields.sip
  21. +3 −1 python/core/qgsmaphittest.sip
  22. +1 −0 python/core/qgsmaplayerrenderer.sip
  23. +17 −6 python/core/qgsmaplayerstylemanager.sip
  24. +14 −5 python/core/qgsmaprendererjob.sip
  25. +26 −6 python/core/qgsmapsettings.sip
  26. +2 −1 python/core/qgsmessageoutput.sip
  27. +5 −1 python/core/qgsmimedatautils.sip
  28. +1 −0 python/core/qgspallabeling.sip
  29. +22 −7 python/core/qgspointlocator.sip
  30. +1 −0 python/core/qgsrendercontext.sip
  31. +7 −2 python/core/qgssqlstatement.sip
  32. +15 −5 python/core/qgstaskmanager.sip
  33. +13 −3 python/core/qgstracer.sip
  34. +2 −1 python/core/qgsvectorlayerfeatureiterator.sip
  35. +8 −1 python/core/qgsvectorlayerjoinbuffer.sip
  36. +2 −1 python/core/qgsvectorlayerlabeling.sip
  37. +15 −2 python/core/qgsvirtuallayerdefinition.sip
  38. +9 −1 python/core/raster/qgsrasterinterface.sip
  39. +4 −1 python/core/symbology/qgscategorizedsymbolrenderer.sip
  40. +3 −1 python/core/symbology/qgsgeometrygeneratorsymbollayer.sip
  41. +23 −1 python/core/symbology/qgsgraduatedsymbolrenderer.sip
  42. +8 −2 python/core/symbology/qgslegendsymbolitem.sip
  43. +3 −0 python/core/symbology/qgsmarkersymbollayer.sip
  44. +6 −0 python/core/symbology/qgsrenderer.sip
  45. +14 −4 python/core/symbology/qgsrendererregistry.sip
  46. +7 −1 python/core/symbology/qgsrulebasedrenderer.sip
  47. +3 −1 python/core/symbology/qgssinglesymbolrenderer.sip
  48. +6 −0 python/core/symbology/qgssymbol.sip
  49. +2 −1 python/gui/editorwidgets/qgsrelationreferencewidget.sip
  50. +3 −1 python/gui/layertree/qgslayertreeembeddedwidgetregistry.sip
  51. +5 −1 python/gui/layertree/qgslayertreemapcanvasbridge.sip
  52. +4 −1 python/gui/layertree/qgslayertreeview.sip
  53. +4 −0 python/gui/layertree/qgslayertreeviewdefaultactions.sip
  54. +3 −1 python/gui/qgisinterface.sip
  55. +7 −1 python/gui/qgsadvanceddigitizingdockwidget.sip
  56. +2 −1 python/gui/qgsattributeformeditorwidget.sip
  57. +2 −0 python/gui/qgsidentifymenu.sip
  58. +40 −3 python/gui/qgsmapcanvas.sip
  59. +5 −2 python/gui/qgsmapcanvastracer.sip
  60. +1 −0 python/gui/qgsmaplayeractionregistry.sip
  61. +2 −0 python/gui/qgsmaptool.sip
  62. +2 −1 python/gui/qgsmaptoolidentify.sip
  63. +2 −1 python/gui/qgssourceselectproviderregistry.sip
  64. +6 −0 python/gui/qgssublayersdialog.sip
  65. +5 −1 python/gui/symbology/qgsdatadefinedsizelegendwidget.sip
  66. +2 −0 python/gui/symbology/qgsrendererwidget.sip
  67. +8 −2 python/gui/symbology/qgssymbolselectordialog.sip
  68. +3 −1 python/server/qgsserver.sip
  69. +59 −4 scripts/doxygen_space.pl
  70. +4 −2 src/3d/chunks/qgschunklist_p.h
  71. +4 −2 src/3d/chunks/qgschunkloader_p.h
  72. +5 −3 src/3d/chunks/qgschunkqueuejob_p.h
  73. +46 −25 src/3d/qgs3dmapsettings.h
  74. +15 −11 src/3d/qgs3dutils.cpp
  75. +8 −4 src/3d/qgscameracontroller.h
  76. +5 −2 src/3d/terrain/qgsdemterraintilegeometry_p.h
  77. +5 −2 src/3d/terrain/qgsdemterraintileloader_p.h
  78. +4 −2 src/3d/terrain/qgsterraintexturegenerator_p.h
  79. +4 −2 src/3d/terrain/qgsterraintileentity_p.h
  80. +4 −2 src/analysis/openstreetmap/qgsosmdatabase.h
  81. +65 −34 src/analysis/raster/qgsalignraster.h
  82. +9 −4 src/analysis/raster/qgsrastermatrix.h
  83. +8 −4 src/app/composer/qgscomposer.h
  84. +4 −2 src/app/nodetool/qgsnodetool.cpp
  85. +51 −24 src/app/nodetool/qgsnodetool.h
  86. +1 −1 src/app/qgisapp.cpp
  87. +10 −4 src/app/qgisapp.h
  88. +4 −2 src/app/qgisappinterface.h
  89. +1 −1 src/app/qgsdiscoverrelationsdlg.cpp
  90. +4 −2 src/app/qgsmapthemes.h
  91. +8 −4 src/app/qgsmaptooloffsetpointsymbol.h
  92. +4 −2 src/app/qgspluginregistry.h
  93. +1 −1 src/app/qgsrasterlayerproperties.cpp
  94. +6 −2 src/app/qgsrasterlayerproperties.h
  95. +32 −16 src/core/auth/qgsauthmanager.h
  96. +4 −2 src/core/composer/qgscomposeritemcommand.h
  97. +23 −12 src/core/composer/qgscomposerlegend.h
  98. +29 −17 src/core/dxf/qgsdxfexport.h
  99. +15 −9 src/core/expression/qgsexpression.h
  100. +13 −7 src/core/expression/qgsexpressionnode.h
  101. +2 −2 src/core/geometry/qgsgeos.cpp
  102. +124 −67 src/core/layertree/qgslayertreemodel.h
  103. +4 −2 src/core/layertree/qgslayertreemodellegendnode.h
  104. +52 −25 src/core/layertree/qgslayertreenode.h
  105. +9 −4 src/core/layertree/qgslayertreeregistrybridge.h
  106. +7 −5 src/core/layertree/qgslayertreeutils.h
  107. +8 −4 src/core/pal/feature.h
  108. +29 −19 src/core/qgis.h
  109. +4 −2 src/core/qgsaggregatecalculator.h
  110. +12 −6 src/core/qgsapplication.h
  111. +5 −2 src/core/qgsbrowsermodel.h
  112. +11 −7 src/core/qgsconnectionpool.h
  113. +8 −4 src/core/qgscoordinatereferencesystem.h
  114. +4 −2 src/core/qgscoordinatetransform_p.h
  115. +5 −3 src/core/qgsdatadefinedsizelegend.h
  116. +7 −4 src/core/qgsdataitem.h
  117. +8 −4 src/core/qgsdataitemprovider.h
  118. +8 −4 src/core/qgsdatasourceuri.h
  119. +5 −3 src/core/qgsdiagramrenderer.h
  120. +4 −2 src/core/qgsfeatureiterator.h
  121. +13 −6 src/core/qgsfeaturerequest.h
  122. +9 −5 src/core/qgsfields.h
  123. +4 −2 src/core/qgsjsonutils.h
  124. +40 −18 src/core/qgslabelfeature.h
  125. +5 −3 src/core/qgslabelingengine.h
  126. +4 −2 src/core/qgslabelingenginesettings.h
  127. +8 −4 src/core/qgslogger.h
  128. +5 −3 src/core/qgsmaphittest.h
  129. +4 −2 src/core/qgsmaplayerrenderer.h
  130. +29 −13 src/core/qgsmaplayerstylemanager.h
  131. +24 −14 src/core/qgsmaprendererjob.h
  132. +50 −25 src/core/qgsmapsettings.h
  133. +4 −2 src/core/qgsmapthemecollection.h
  134. +8 −4 src/core/qgsmessageoutput.h
  135. +10 −5 src/core/qgsmimedatautils.h
  136. +8 −4 src/core/qgspallabeling.h
  137. +6 −6 src/core/qgspointlocator.cpp
  138. +52 −25 src/core/qgspointlocator.h
  139. +4 −2 src/core/qgsproject.h
  140. +4 −2 src/core/qgsproviderregistry.h
  141. +12 −6 src/core/qgsrendercontext.h
  142. +16 −8 src/core/qgsrulebasedlabeling.h
  143. +1 −1 src/core/qgssettings.h
  144. +11 −8 src/core/qgssnappingutils.h
  145. +1 −1 src/core/qgssqlstatement.cpp
  146. +11 −7 src/core/qgssqlstatement.h
  147. +48 −26 src/core/qgstaskmanager.h
  148. +5 −2 src/core/qgstextrenderer.h
  149. +32 −17 src/core/qgstracer.h
  150. +1 −1 src/core/qgsvectorlayer.cpp
  151. +4 −2 src/core/qgsvectorlayer.h
  152. +4 −2 src/core/qgsvectorlayerfeatureiterator.h
  153. +25 −12 src/core/qgsvectorlayerjoinbuffer.h
  154. +8 −4 src/core/qgsvectorlayerlabeling.h
  155. +9 −4 src/core/qgsvectorlayerrenderer.h
  156. +19 −15 src/core/qgsvirtuallayerdefinition.h
  157. +28 −13 src/core/raster/qgsrasterinterface.h
  158. +2 −2 src/core/raster/qgsrasterlayer.cpp
  159. +9 −5 src/core/symbology/qgscategorizedsymbolrenderer.h
  160. +5 −3 src/core/symbology/qgsgeometrygeneratorsymbollayer.h
  161. +50 −28 src/core/symbology/qgsgraduatedsymbolrenderer.h
  162. +22 −10 src/core/symbology/qgslegendsymbolitem.h
  163. +13 −6 src/core/symbology/qgsmarkersymbollayer.h
  164. +24 −12 src/core/symbology/qgsrenderer.h
  165. +33 −19 src/core/symbology/qgsrendererregistry.h
  166. +22 −11 src/core/symbology/qgsrulebasedrenderer.h
  167. +5 −3 src/core/symbology/qgssinglesymbolrenderer.h
  168. +19 −11 src/core/symbology/qgssymbol.h
  169. +12 −6 src/gui/attributetable/qgsfeatureselectionmodel.h
  170. +2 −2 src/gui/editorwidgets/core/qgseditorwidgetautoconf.cpp
  171. +4 −2 src/gui/editorwidgets/core/qgssearchwidgetwrapper.h
  172. +1 −1 src/gui/editorwidgets/qgscolorwidgetfactory.cpp
  173. +4 −2 src/gui/editorwidgets/qgsrelationreferencewidget.h
  174. +1 −1 src/gui/editorwidgets/qgsuuidwidgetfactory.cpp
  175. +5 −3 src/gui/layertree/qgslayertreeembeddedwidgetregistry.h
  176. +13 −6 src/gui/layertree/qgslayertreemapcanvasbridge.h
  177. +12 −6 src/gui/layertree/qgslayertreeview.h
  178. +10 −4 src/gui/layertree/qgslayertreeviewdefaultactions.h
  179. +8 −4 src/gui/qgisinterface.h
  180. +38 −20 src/gui/qgsadvanceddigitizingdockwidget.h
  181. +4 −2 src/gui/qgsattributeformeditorwidget.h
  182. +2 −2 src/gui/qgscodeeditorsql.h
  183. +16 −8 src/gui/qgsdatasourcemanagerdialog.h
  184. +12 −6 src/gui/qgsidentifymenu.h
  185. +1 −1 src/gui/qgsmapcanvas.cpp
  186. +134 −69 src/gui/qgsmapcanvas.h
  187. +10 −8 src/gui/qgsmapcanvasitem.h
  188. +9 −5 src/gui/qgsmapcanvastracer.h
  189. +4 −2 src/gui/qgsmaplayeractionregistry.h
  190. +4 −2 src/gui/qgsmapmouseevent.h
  191. +20 −10 src/gui/qgsmaptool.h
  192. +4 −2 src/gui/qgsmaptoolidentify.h
  193. +4 −2 src/gui/qgsowssourceselect.h
  194. +1 −1 src/gui/qgsprojectionselectiontreewidget.h
  195. +1 −1 src/gui/qgssearchquerybuilder.cpp
  196. +9 −4 src/gui/qgssourceselectproviderregistry.h
  197. +32 −16 src/gui/qgssublayersdialog.h
  198. +7 −4 src/gui/symbology/qgsdatadefinedsizelegendwidget.h
  199. +5 −3 src/gui/symbology/qgsrendererwidget.h
  200. +8 −4 src/gui/symbology/qgssmartgroupeditordialog.h
  201. +18 −8 src/gui/symbology/qgssymbolselectordialog.h
  202. +2 −2 src/providers/gdal/qgsgdalprovider.cpp
  203. +5 −2 src/providers/ogr/qgsogrdbconnection.h
  204. +2 −2 src/providers/ogr/qgsogrprovider.cpp
  205. +1 −1 src/providers/oracle/qgsoraclesourceselect.cpp
  206. +13 −9 src/providers/virtual/qgsvirtuallayerblob.h
  207. +14 −10 src/providers/virtual/qgsvirtuallayerqueryparser.h
  208. +4 −2 src/providers/wms/qgstilecache.h
  209. +12 −6 src/providers/wms/qgswmscapabilities.h
  210. +16 −8 src/python/qgspythonutils.h
  211. +18 −10 src/python/qgspythonutilsimpl.h
  212. +4 −2 src/server/qgshttptransaction.h
  213. +5 −2 src/server/qgsserver.h
@@ -148,9 +148,12 @@ used for rescaling of values (if necessary)

struct ProgressHandler
{

virtual bool progress( double complete ) = 0;
%Docstring
:return: false if the execution should be canceled, true otherwise
Method to be overridden for progress reporting.
\param complete Overall progress of the alignment operation
:return: false if the execution should be canceled, true otherwise
:rtype: bool
%End

@@ -209,44 +212,63 @@ Get the output CRS in WKT format

void setClipExtent( double xmin, double ymin, double xmax, double ymax );
%Docstring
No extra clipping is done if the rectangle is null
Configure clipping extent (region of interest).
No extra clipping is done if the rectangle is null
%End

void setClipExtent( const QgsRectangle &extent );
%Docstring
No extra clipping is done if the rectangle is null
Configure clipping extent (region of interest).
No extra clipping is done if the rectangle is null
%End

QgsRectangle clipExtent() const;
%Docstring
No extra clipping is done if the rectangle is null
Get clipping extent (region of interest).
No extra clipping is done if the rectangle is null
:rtype: QgsRectangle
%End

bool setParametersFromRaster( const RasterInfo &rasterInfo, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) );
%Docstring
:return: true on success (may fail if it is not possible to reproject raster to given CRS)
Set destination CRS, cell size and grid offset from a raster file.
The user may provide custom values for some of the parameters - in such case
only the remaining parameters are calculated.

If default CRS is used, the parameters are set according to the raster file's geo-transform.
If a custom CRS is provided, suggested reprojection is calculated first (using GDAL) in order
to determine suitable defaults for cell size and grid offset.

:return: true on success (may fail if it is not possible to reproject raster to given CRS)
:rtype: bool
%End

bool setParametersFromRaster( const QString &filename, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) );
%Docstring
See the other variant for details.
Overridden variant for convenience, taking filename instead RasterInfo object.
See the other variant for details.
:rtype: bool
%End

bool checkInputParameters();
%Docstring
:return: true on success, sets error on error (see errorMessage())
Determine destination extent from the input rasters and calculate derived values
:return: true on success, sets error on error (see errorMessage())
:rtype: bool
%End

QSize alignedRasterSize() const;
%Docstring
Return expected size of the resulting aligned raster
.. note::

first need to run checkInputParameters() which returns with success
:rtype: QSize
%End

QgsRectangle alignedRasterExtent() const;
%Docstring
Return expected extent of the resulting aligned raster
.. note::

first need to run checkInputParameters() which returns with success
@@ -255,13 +277,15 @@ See the other variant for details.

bool run();
%Docstring
:return: true on success, sets error on error (see errorMessage())
Run the alignment process
:return: true on success, sets error on error (see errorMessage())
:rtype: bool
%End

QString errorMessage() const;
%Docstring
Error message is empty if run() succeeded (returned true)
Return error from a previous run() call.
Error message is empty if run() succeeded (returned true)
:rtype: str
%End

@@ -67,6 +67,7 @@ Returns true if matrix is 1x1 (=scalar number)
%End



void setData( int cols, int rows, double *data, double nodataValue );

int nColumns() const;
@@ -108,26 +108,34 @@ Sets item box to the whole content

void setLegendFilterByMapEnabled( bool enabled );
%Docstring
Set whether legend items should be filtered to show just the ones visible in the associated map
.. versionadded:: 2.6
%End

bool legendFilterByMapEnabled() const;
%Docstring
Find out whether legend items are filtered to show just the ones visible in the associated map
.. versionadded:: 2.6
:rtype: bool
%End

virtual void updateItem();
%Docstring
Update() overloading. Use it rather than update()
.. versionadded:: 2.12
%End

void setLegendFilterOutAtlas( bool doFilter );
%Docstring
When set to true, during an atlas rendering, it will filter out legend elements
where features are outside the current atlas feature.
.. versionadded:: 2.14
%End

bool legendFilterOutAtlas() const;
%Docstring
Whether to filter out legend elements outside of the current atlas feature
.. seealso:: setLegendFilterOutAtlas()
.. versionadded:: 2.14
:rtype: bool
%End
@@ -257,31 +257,52 @@ class QgsDxfExport

void writeLine( const QgsPoint &pt1, const QgsPoint &pt2, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 );
%Docstring
Write line (as a polyline)
.. versionadded:: 2.15
%End

void writePoint( const QString &layer, const QColor &color, const QgsPoint &pt ) /PyName=writePointV2/;
%Docstring
Write point
.. note::

available in Python bindings as writePointV2
.. versionadded:: 2.15
%End

void writeFilledCircle( const QString &layer, const QColor &color, const QgsPoint &pt, double radius ) /PyName=writeFillCircleV2/;
%Docstring
Write filled circle (as hatch)
.. note::

available in Python bindings as writePointV2
.. versionadded:: 2.15
%End

void writeCircle( const QString &layer, const QColor &color, const QgsPoint &pt, double radius, const QString &lineStyleName, double width ) /PyName=writeCircleV2/;
%Docstring
Write circle (as polyline)
.. note::

available in Python bindings as writeCircleV2
.. versionadded:: 2.15
%End

void writeText( const QString &layer, const QString &text, const QgsPoint &pt, double size, double angle, const QColor &color ) /PyName=writeTextV2/;
%Docstring
Write text (TEXT)
.. note::

available in Python bindings as writeTextV2
.. versionadded:: 2.15
%End

void writeMText( const QString &layer, const QString &text, const QgsPoint &pt, double width, double angle, const QColor &color );
%Docstring
Write mtext (MTEXT)
.. note::

available in Python bindings as writeMTextV2
.. versionadded:: 2.15
%End

@@ -245,13 +245,18 @@ Set evaluation error (used internally by evaluation functions)

QString expression() const;
%Docstring
API calls, dump() will be used to create one instead.
Return the original, unmodified expression string.
If there was none supplied because it was constructed by sole
API calls, dump() will be used to create one instead.
:rtype: str
%End

QString dump() const;
%Docstring
expression() instead.
Return an expression string, constructed from the internal
abstract syntax tree. This does not contain any nice whitespace
formatting or comments. In general it is preferable to use
expression() instead.
:rtype: str
%End

@@ -113,6 +113,7 @@ Takes ownership of the provided node

bool hasNamedNodes() const;
%Docstring
Returns true if list contains any named nodes
.. versionadded:: 2.16
:rtype: bool
%End
@@ -133,6 +134,7 @@ Takes ownership of the provided node

QStringList names() const;
%Docstring
Returns a list of names for nodes. Unnamed nodes will be indicated by an empty string in the list.
.. versionadded:: 2.16
:rtype: list of str
%End
@@ -38,9 +38,11 @@ class QgsLayerTreeModel : QAbstractItemModel
sipType = 0;
%End
public:

explicit QgsLayerTreeModel( QgsLayerTree *rootNode, QObject *parent /TransferThis/ = 0 );
%Docstring
The root node is not transferred by the model.
Construct a new tree model with given layer tree (root node must not be null pointer).
The root node is not transferred by the model.
%End

~QgsLayerTreeModel();
@@ -112,45 +114,62 @@ Check whether a flag is enabled

QgsLayerTreeNode *index2node( const QModelIndex &index ) const;
%Docstring
Returns null pointer if index does not refer to a layer tree node (e.g. it is a legend node)
Return layer tree node for given index. Returns root node for invalid index.
Returns null pointer if index does not refer to a layer tree node (e.g. it is a legend node)
:rtype: QgsLayerTreeNode
%End
QModelIndex node2index( QgsLayerTreeNode *node ) const;
%Docstring
Return index for a given node. If the node does not belong to the layer tree, the result is undefined
:rtype: QModelIndex
%End

QList<QgsLayerTreeNode *> indexes2nodes( const QModelIndexList &list, bool skipInternal = false ) const;
%Docstring
@arg skipInternal If true, a node is included in the output list only if no parent node is in the list
Convert a list of indexes to a list of layer tree nodes.
Indices that do not represent layer tree nodes are skipped.
\param skipInternal If true, a node is included in the output list only if no parent node is in the list
:rtype: list of QgsLayerTreeNode
%End

static QgsLayerTreeModelLegendNode *index2legendNode( const QModelIndex &index );
%Docstring
Return legend node for given index. Returns null for invalid index
.. versionadded:: 2.6
:rtype: QgsLayerTreeModelLegendNode
%End

QModelIndex legendNode2index( QgsLayerTreeModelLegendNode *legendNode );
%Docstring
Return index for a given legend node. If the legend node does not belong to the layer tree, the result is undefined.
If the legend node is belongs to the tree but it is filtered out, invalid model index is returned.
.. versionadded:: 2.6
:rtype: QModelIndex
%End

QList<QgsLayerTreeModelLegendNode *> layerLegendNodes( QgsLayerTreeLayer *nodeLayer, bool skipNodeEmbeddedInParent = false );
%Docstring
Return filtered list of active legend nodes attached to a particular layer node
(by default it returns also legend node embedded in parent layer node (if any) unless skipNodeEmbeddedInParent is true)
.. versionadded:: 2.6
.. note::

Parameter skipNodeEmbeddedInParent added in QGIS 2.18
.. seealso:: layerOriginalLegendNodes()
:rtype: list of QgsLayerTreeModelLegendNode
%End

QList<QgsLayerTreeModelLegendNode *> layerOriginalLegendNodes( QgsLayerTreeLayer *nodeLayer );
%Docstring
Return original (unfiltered) list of legend nodes attached to a particular layer node
.. versionadded:: 2.14
.. seealso:: layerLegendNodes()
:rtype: list of QgsLayerTreeModelLegendNode
%End

QgsLayerTreeModelLegendNode *legendNodeEmbeddedInParent( QgsLayerTreeLayer *nodeLayer ) const;
%Docstring
Return legend node that may be embedded in parent (i.e. its icon will be used for layer's icon).
.. versionadded:: 2.18
:rtype: QgsLayerTreeModelLegendNode
%End
@@ -171,14 +190,17 @@ Return index for a given node. If the node does not belong to the layer tree, th
Return pointer to the root node of the layer tree. Always a non-null pointer.
:rtype: QgsLayerTree
%End

void setRootGroup( QgsLayerTree *newRootGroup );
%Docstring
Reset the model and use a new root group node
.. versionadded:: 2.6
%End

void refreshLayerLegend( QgsLayerTreeLayer *nodeLayer );
%Docstring
Not necessary to call when layer's renderer is changed as the model listens to these events.
Force a refresh of legend nodes of a layer node.
Not necessary to call when layer's renderer is changed as the model listens to these events.
%End

QModelIndex currentIndex() const;
@@ -232,36 +254,53 @@ Return at what number of legend nodes the layer node should be collapsed. -1 mea

void setLegendFilterByMap( const QgsMapSettings *settings );
%Docstring
Force only display of legend nodes which are valid for given map settings.
Setting null pointer or invalid map settings will disable the functionality.
Ownership of map settings pointer does not change, a copy is made.
.. versionadded:: 2.6
%End

void setLegendFilter( const QgsMapSettings *settings, bool useExtent = true, const QgsGeometry &polygon = QgsGeometry(), bool useExpressions = true );
%Docstring
Filter display of legend nodes for given map settings
\param settings Map settings. Setting a null pointer or invalid settings will disable any filter. Ownership is not changed, a copy is made
\param useExtent Whether to use the extent of the map settings as a first spatial filter on legend nodes
\param polygon If not empty, this polygon will be used instead of the map extent to filter legend nodes
\param useExpressions Whether to use legend node filter expressions
.. versionadded:: 2.14
%End

const QgsMapSettings *legendFilterMapSettings() const;
%Docstring
Returns the current map settings used for the current legend filter (or null if none is enabled)
.. versionadded:: 2.14
:rtype: QgsMapSettings
%End

void setLegendMapViewData( double mapUnitsPerPixel, int dpi, double scale );
%Docstring
Give the layer tree model hints about the currently associated map view
so that legend nodes that use map units can be scaled currectly
.. versionadded:: 2.6
%End

void legendMapViewData( double *mapUnitsPerPixel /Out/, int *dpi /Out/, double *scale /Out/ ) const;
%Docstring
Get hints about map view - to be used in legend nodes. Arguments that are not null will receive values.
If there are no valid map view data (from previous call to setLegendMapViewData()), returned values are zeros.
.. versionadded:: 2.6
%End

QMap<QString, QString> layerStyleOverrides() const;
%Docstring
Get map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one
.. versionadded:: 2.10
:rtype: QMap<str, QString>
%End

void setLayerStyleOverrides( const QMap<QString, QString> &overrides );
%Docstring
Set map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one
.. versionadded:: 2.10
%End

@@ -272,8 +311,10 @@ Return at what number of legend nodes the layer node should be collapsed. -1 mea
void nodeRemovedChildren();

void nodeVisibilityChanged( QgsLayerTreeNode *node );

void nodeNameChanged( QgsLayerTreeNode *node, const QString &name );
%Docstring
Updates model when node's name has changed
.. versionadded:: 3.0
%End

0 comments on commit 49b426d

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