mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-16 00:03:12 -04:00
Add warning to QgsLayerTreeLayer::layer() dox
Because the returned pointer must ALWAYS be tested before being dereferenced
This commit is contained in:
parent
694424000c
commit
d1e2978314
@ -39,14 +39,32 @@ Constructor for QgsLayerTreeLayer using weak references to layer ID, ``name``, p
|
|||||||
%End
|
%End
|
||||||
|
|
||||||
QString layerId() const;
|
QString layerId() const;
|
||||||
|
%Docstring
|
||||||
|
Returns the ID for the map layer associated with this node.
|
||||||
|
|
||||||
|
.. seealso:: :py:func:`layer`
|
||||||
|
%End
|
||||||
|
|
||||||
QgsMapLayer *layer() const;
|
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;
|
virtual QString name() const;
|
||||||
|
|
||||||
%Docstring
|
%Docstring
|
||||||
Returns the layer's name.
|
Returns the layer's name.
|
||||||
|
|
||||||
|
.. seealso:: :py:func:`setName`
|
||||||
|
|
||||||
.. versionadded:: 3.0
|
.. versionadded:: 3.0
|
||||||
%End
|
%End
|
||||||
|
|
||||||
@ -55,6 +73,8 @@ Returns the layer's name.
|
|||||||
%Docstring
|
%Docstring
|
||||||
Sets the layer's name.
|
Sets the layer's name.
|
||||||
|
|
||||||
|
.. seealso:: :py:func:`name`
|
||||||
|
|
||||||
.. versionadded:: 3.0
|
.. versionadded:: 3.0
|
||||||
%End
|
%End
|
||||||
|
|
||||||
|
@ -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() );
|
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; }
|
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(); }
|
QgsMapLayer *layer() const { return mRef.get(); }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the layer's name.
|
* Returns the layer's name.
|
||||||
|
*
|
||||||
|
* \see setName()
|
||||||
|
*
|
||||||
* \since QGIS 3.0
|
* \since QGIS 3.0
|
||||||
*/
|
*/
|
||||||
QString name() const override;
|
QString name() const override;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the layer's name.
|
* Sets the layer's name.
|
||||||
|
*
|
||||||
|
* \see name()
|
||||||
|
*
|
||||||
* \since QGIS 3.0
|
* \since QGIS 3.0
|
||||||
*/
|
*/
|
||||||
void setName( const QString &n ) override;
|
void setName( const QString &n ) override;
|
||||||
|
Loading…
x
Reference in New Issue
Block a user