sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-13 00:03:09 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add warning to QgsLayerTreeLayer::layer() dox

Browse Source 
Because the returned pointer must ALWAYS be tested before
being dereferenced
This commit is contained in:
Nyall Dawson 2018-10-26 11:05:48 +10:00
parent 694424000c
commit d1e2978314
2 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
python/core/auto_generated/layertree/qgslayertreelayer.sip.in
View File

@ -39,14 +39,32 @@ Constructor for QgsLayerTreeLayer using weak references to layer ID, ``name``, p
%End
QString layerId() const;
%Docstring
Returns the ID for the map layer associated with this node.
.. seealso:: :py:func:`layer`
%End
QgsMapLayer *layer() const;
%Docstring
Returns the map layer associated with this node.
.. warning::
This can be (and often is!) a None, e.g. in the case of a layer node representing a layer
which has not yet been fully loaded into a project, or a layer node representing a layer
with an invalid data source. The returned pointer must ALWAYS be checked to avoid dereferencing a None.
.. seealso:: :py:func:`layerId`
%End
virtual QString name() const;
%Docstring
Returns the layer's name.
.. seealso:: :py:func:`setName`
.. versionadded:: 3.0
%End
@ -55,6 +73,8 @@ Returns the layer's name.
%Docstring
Sets the layer's name.
.. seealso:: :py:func:`name`
.. versionadded:: 3.0
%End

20
src/core/layertree/qgslayertreelayer.h
View File

@ -54,18 +54,38 @@ class CORE_EXPORT QgsLayerTreeLayer : public QgsLayerTreeNode
*/
explicit QgsLayerTreeLayer( const QString &layerId, const QString &name = QString(), const QString &source = QString(), const QString &provider = QString() );
/**
* Returns the ID for the map layer associated with this node.
*
* \see layer()
*/
QString layerId() const { return mRef.layerId; }
/**
* Returns the map layer associated with this node.
*
* \warning This can be (and often is!) a nullptr, e.g. in the case of a layer node representing a layer
* which has not yet been fully loaded into a project, or a layer node representing a layer
* with an invalid data source. The returned pointer must ALWAYS be checked to avoid dereferencing a nullptr.
*
* \see layerId()
*/
QgsMapLayer *layer() const { return mRef.get(); }
/**
* Returns the layer's name.
*
* \see setName()
*
* \since QGIS 3.0
*/
QString name() const override;
/**
* Sets the layer's name.
*
* \see name()
*
* \since QGIS 3.0
*/
void setName( const QString &n ) override;