mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-15 00:02:52 -04:00
Remove some incorrect 'not available in Python bindings' notes
This commit is contained in:
parent
94cf3fc788
commit
4bb7f82fcb
@ -624,10 +624,6 @@ To create it, the geometry is default constructed and then the WKB is changed.
|
|||||||
.. seealso:: :py:func:`clone`
|
.. seealso:: :py:func:`clone`
|
||||||
|
|
||||||
.. versionadded:: 3.0
|
.. versionadded:: 3.0
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
Not available in Python bindings
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
|
@ -66,10 +66,7 @@ Remove subtree of embedded groups and replaces it with a custom property embedde
|
|||||||
|
|
||||||
static void updateEmbeddedGroupsProjectPath( QgsLayerTreeGroup *group, const QgsProject *project );
|
static void updateEmbeddedGroupsProjectPath( QgsLayerTreeGroup *group, const QgsProject *project );
|
||||||
%Docstring
|
%Docstring
|
||||||
|
Updates an embedded ``group`` from a ``project``.
|
||||||
.. note::
|
|
||||||
|
|
||||||
not available in Python bindings
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
static QStringList invisibleLayerList( QgsLayerTreeNode *node );
|
static QStringList invisibleLayerList( QgsLayerTreeNode *node );
|
||||||
|
@ -24,10 +24,6 @@ rather accessed through a QgsProject via :py:func:`QgsProject.layoutManager()`
|
|||||||
|
|
||||||
QgsLayoutManager retains ownership of all the layouts contained
|
QgsLayoutManager retains ownership of all the layouts contained
|
||||||
in the manager.
|
in the manager.
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
Not available in Python bindings
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
%TypeHeaderCode
|
%TypeHeaderCode
|
||||||
|
@ -745,10 +745,6 @@ Get the registry of available field formatters.
|
|||||||
%Docstring
|
%Docstring
|
||||||
Returns registry of available 3D renderers.
|
Returns registry of available 3D renderers.
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
not available in Python bindings
|
|
||||||
|
|
||||||
.. versionadded:: 3.0
|
.. versionadded:: 3.0
|
||||||
%End
|
%End
|
||||||
|
|
||||||
|
@ -514,10 +514,6 @@ Constructor for QgsPresetSchemeColorRamp.
|
|||||||
Constructor for :py:class:`QgsPresetColorRamp`.
|
Constructor for :py:class:`QgsPresetColorRamp`.
|
||||||
|
|
||||||
:param colors: list of named colors in ramp
|
:param colors: list of named colors in ramp
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
not available in Python bindings - use setColors instead
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
static QgsColorRamp *create( const QgsStringMap &properties = QgsStringMap() ) /Factory/;
|
static QgsColorRamp *create( const QgsStringMap &properties = QgsStringMap() ) /Factory/;
|
||||||
|
@ -142,10 +142,6 @@ which is referenced by the provided feature.
|
|||||||
:param attributes: An attribute vector containing the foreign key
|
:param attributes: An attribute vector containing the foreign key
|
||||||
|
|
||||||
:return: A request the referenced feature
|
:return: A request the referenced feature
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
not available in Python bindings
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
QgsFeatureRequest getReferencedFeatureRequest( const QgsFeature &feature ) const;
|
QgsFeatureRequest getReferencedFeatureRequest( const QgsFeature &feature ) const;
|
||||||
|
@ -164,10 +164,6 @@ Get access to buffered dash messages.
|
|||||||
Only will return something if you call enableDashBuffering( true ); before.
|
Only will return something if you call enableDashBuffering( true ); before.
|
||||||
|
|
||||||
:return: buffered dash messages
|
:return: buffered dash messages
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
not available in Python bindings
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
|
@ -132,19 +132,11 @@ Encodes a shape to its string representation.
|
|||||||
bool prepareMarkerShape( Shape shape );
|
bool prepareMarkerShape( Shape shape );
|
||||||
%Docstring
|
%Docstring
|
||||||
Prepares the layer for drawing the specified shape (QPolygonF version)
|
Prepares the layer for drawing the specified shape (QPolygonF version)
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
not available in Python bindings
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
bool prepareMarkerPath( Shape symbol );
|
bool prepareMarkerPath( Shape symbol );
|
||||||
%Docstring
|
%Docstring
|
||||||
Prepares the layer for drawing the specified shape (QPainterPath version)
|
Prepares the layer for drawing the specified shape (QPainterPath version)
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
not available in Python bindings
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
bool shapeToPolygon( Shape shape, QPolygonF &polygon ) const;
|
bool shapeToPolygon( Shape shape, QPolygonF &polygon ) const;
|
||||||
@ -155,10 +147,6 @@ Creates a polygon representing the specified shape.
|
|||||||
:param polygon: destination polygon for shape
|
:param polygon: destination polygon for shape
|
||||||
|
|
||||||
:return: true if shape was successfully stored in polygon
|
:return: true if shape was successfully stored in polygon
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
not available in Python bindings
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const;
|
double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const;
|
||||||
@ -169,10 +157,6 @@ Calculates the desired size of the marker, considering data defined size overrid
|
|||||||
:param hasDataDefinedSize: will be set to true if marker uses data defined sizes
|
:param hasDataDefinedSize: will be set to true if marker uses data defined sizes
|
||||||
|
|
||||||
:return: marker size, in original size units
|
:return: marker size, in original size units
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
not available in Python bindings
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle ) const;
|
void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle ) const;
|
||||||
@ -184,10 +168,6 @@ Calculates the marker offset and rotation.
|
|||||||
:param hasDataDefinedRotation: will be set to true if marker has data defined rotation
|
:param hasDataDefinedRotation: will be set to true if marker has data defined rotation
|
||||||
:param offset: will be set to calculated marker offset (in painter units)
|
:param offset: will be set to calculated marker offset (in painter units)
|
||||||
:param angle: will be set to calculated marker angle
|
:param angle: will be set to calculated marker angle
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
not available in Python bindings
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
|
|
||||||
@ -708,10 +688,6 @@ Calculates the marker aspect ratio between width and height.
|
|||||||
:param context: symbol render context
|
:param context: symbol render context
|
||||||
:param scaledSize: size of symbol to render
|
:param scaledSize: size of symbol to render
|
||||||
:param hasDataDefinedAspectRatio: will be set to true if marker has data defined aspectRatio
|
:param hasDataDefinedAspectRatio: will be set to true if marker has data defined aspectRatio
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
not available in Python bindings
|
|
||||||
%End
|
%End
|
||||||
|
|
||||||
|
|
||||||
|
@ -12,12 +12,6 @@
|
|||||||
|
|
||||||
class QgsRelationWidgetWrapper : QgsWidgetWrapper
|
class QgsRelationWidgetWrapper : QgsWidgetWrapper
|
||||||
{
|
{
|
||||||
%Docstring
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
not available in Python bindings
|
|
||||||
%End
|
|
||||||
|
|
||||||
%TypeHeaderCode
|
%TypeHeaderCode
|
||||||
#include "qgsrelationwidgetwrapper.h"
|
#include "qgsrelationwidgetwrapper.h"
|
||||||
|
@ -650,7 +650,6 @@ class CORE_EXPORT QgsAbstractGeometry
|
|||||||
* To create it, the geometry is default constructed and then the WKB is changed.
|
* To create it, the geometry is default constructed and then the WKB is changed.
|
||||||
* \see clone()
|
* \see clone()
|
||||||
* \since 3.0
|
* \since 3.0
|
||||||
* \note Not available in Python bindings
|
|
||||||
*/
|
*/
|
||||||
virtual QgsAbstractGeometry *createEmptyWithSameType() const = 0 SIP_FACTORY;
|
virtual QgsAbstractGeometry *createEmptyWithSameType() const = 0 SIP_FACTORY;
|
||||||
|
|
||||||
|
@ -64,7 +64,9 @@ class CORE_EXPORT QgsLayerTreeUtils
|
|||||||
//! Remove subtree of embedded groups and replaces it with a custom property embedded-visible-layers
|
//! Remove subtree of embedded groups and replaces it with a custom property embedded-visible-layers
|
||||||
static void replaceChildrenOfEmbeddedGroups( QgsLayerTreeGroup *group );
|
static void replaceChildrenOfEmbeddedGroups( QgsLayerTreeGroup *group );
|
||||||
|
|
||||||
//! \note not available in Python bindings
|
/**
|
||||||
|
* Updates an embedded \a group from a \a project.
|
||||||
|
*/
|
||||||
static void updateEmbeddedGroupsProjectPath( QgsLayerTreeGroup *group, const QgsProject *project );
|
static void updateEmbeddedGroupsProjectPath( QgsLayerTreeGroup *group, const QgsProject *project );
|
||||||
|
|
||||||
//! get invisible layers
|
//! get invisible layers
|
||||||
|
@ -37,7 +37,6 @@ class QgsPrintLayout;
|
|||||||
*
|
*
|
||||||
* QgsLayoutManager retains ownership of all the layouts contained
|
* QgsLayoutManager retains ownership of all the layouts contained
|
||||||
* in the manager.
|
* in the manager.
|
||||||
* \note Not available in Python bindings
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
class CORE_EXPORT QgsLayoutManager : public QObject
|
class CORE_EXPORT QgsLayoutManager : public QObject
|
||||||
|
@ -679,7 +679,6 @@ class CORE_EXPORT QgsApplication : public QApplication
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns registry of available 3D renderers.
|
* Returns registry of available 3D renderers.
|
||||||
* \note not available in Python bindings
|
|
||||||
* \since QGIS 3.0
|
* \since QGIS 3.0
|
||||||
*/
|
*/
|
||||||
static Qgs3DRendererRegistry *renderer3DRegistry();
|
static Qgs3DRendererRegistry *renderer3DRegistry();
|
||||||
|
@ -481,7 +481,6 @@ class CORE_EXPORT QgsPresetSchemeColorRamp : public QgsColorRamp, public QgsColo
|
|||||||
/**
|
/**
|
||||||
* Constructor for QgsPresetColorRamp.
|
* Constructor for QgsPresetColorRamp.
|
||||||
* \param colors list of named colors in ramp
|
* \param colors list of named colors in ramp
|
||||||
* \note not available in Python bindings - use setColors instead
|
|
||||||
*/
|
*/
|
||||||
QgsPresetSchemeColorRamp( const QgsNamedColorList &colors );
|
QgsPresetSchemeColorRamp( const QgsNamedColorList &colors );
|
||||||
|
|
||||||
|
@ -198,7 +198,6 @@ class CORE_EXPORT QgsRelation
|
|||||||
* \param attributes An attribute vector containing the foreign key
|
* \param attributes An attribute vector containing the foreign key
|
||||||
*
|
*
|
||||||
* \returns A request the referenced feature
|
* \returns A request the referenced feature
|
||||||
* \note not available in Python bindings
|
|
||||||
*/
|
*/
|
||||||
QgsFeatureRequest getReferencedFeatureRequest( const QgsAttributes &attributes ) const;
|
QgsFeatureRequest getReferencedFeatureRequest( const QgsAttributes &attributes ) const;
|
||||||
|
|
||||||
|
@ -169,7 +169,6 @@ class CORE_EXPORT QgsRenderChecker
|
|||||||
* Only will return something if you call enableDashBuffering( true ); before.
|
* Only will return something if you call enableDashBuffering( true ); before.
|
||||||
*
|
*
|
||||||
* \returns buffered dash messages
|
* \returns buffered dash messages
|
||||||
* \note not available in Python bindings
|
|
||||||
*/
|
*/
|
||||||
QVector<QgsDartMeasurement> dartMeasurements() const { return mDashMessages; }
|
QVector<QgsDartMeasurement> dartMeasurements() const { return mDashMessages; }
|
||||||
|
|
||||||
|
@ -135,13 +135,11 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Prepares the layer for drawing the specified shape (QPolygonF version)
|
* Prepares the layer for drawing the specified shape (QPolygonF version)
|
||||||
* \note not available in Python bindings
|
|
||||||
*/
|
*/
|
||||||
bool prepareMarkerShape( Shape shape );
|
bool prepareMarkerShape( Shape shape );
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Prepares the layer for drawing the specified shape (QPainterPath version)
|
* Prepares the layer for drawing the specified shape (QPainterPath version)
|
||||||
* \note not available in Python bindings
|
|
||||||
*/
|
*/
|
||||||
bool prepareMarkerPath( Shape symbol );
|
bool prepareMarkerPath( Shape symbol );
|
||||||
|
|
||||||
@ -150,7 +148,6 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer
|
|||||||
* \param shape shape to create
|
* \param shape shape to create
|
||||||
* \param polygon destination polygon for shape
|
* \param polygon destination polygon for shape
|
||||||
* \returns true if shape was successfully stored in polygon
|
* \returns true if shape was successfully stored in polygon
|
||||||
* \note not available in Python bindings
|
|
||||||
*/
|
*/
|
||||||
bool shapeToPolygon( Shape shape, QPolygonF &polygon ) const;
|
bool shapeToPolygon( Shape shape, QPolygonF &polygon ) const;
|
||||||
|
|
||||||
@ -159,7 +156,6 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer
|
|||||||
* \param context symbol render context
|
* \param context symbol render context
|
||||||
* \param hasDataDefinedSize will be set to true if marker uses data defined sizes
|
* \param hasDataDefinedSize will be set to true if marker uses data defined sizes
|
||||||
* \returns marker size, in original size units
|
* \returns marker size, in original size units
|
||||||
* \note not available in Python bindings
|
|
||||||
*/
|
*/
|
||||||
double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const;
|
double calculateSize( QgsSymbolRenderContext &context, bool &hasDataDefinedSize ) const;
|
||||||
|
|
||||||
@ -170,7 +166,6 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer
|
|||||||
* \param hasDataDefinedRotation will be set to true if marker has data defined rotation
|
* \param hasDataDefinedRotation will be set to true if marker has data defined rotation
|
||||||
* \param offset will be set to calculated marker offset (in painter units)
|
* \param offset will be set to calculated marker offset (in painter units)
|
||||||
* \param angle will be set to calculated marker angle
|
* \param angle will be set to calculated marker angle
|
||||||
* \note not available in Python bindings
|
|
||||||
*/
|
*/
|
||||||
void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle ) const;
|
void calculateOffsetAndRotation( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle ) const;
|
||||||
|
|
||||||
@ -618,7 +613,6 @@ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer
|
|||||||
* \param context symbol render context
|
* \param context symbol render context
|
||||||
* \param scaledSize size of symbol to render
|
* \param scaledSize size of symbol to render
|
||||||
* \param hasDataDefinedAspectRatio will be set to true if marker has data defined aspectRatio
|
* \param hasDataDefinedAspectRatio will be set to true if marker has data defined aspectRatio
|
||||||
* \note not available in Python bindings
|
|
||||||
*/
|
*/
|
||||||
double calculateAspectRatio( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedAspectRatio ) const;
|
double calculateAspectRatio( QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedAspectRatio ) const;
|
||||||
|
|
||||||
|
@ -25,7 +25,6 @@ class QgsRelationEditorWidget;
|
|||||||
/**
|
/**
|
||||||
* \ingroup gui
|
* \ingroup gui
|
||||||
* \class QgsRelationWidgetWrapper
|
* \class QgsRelationWidgetWrapper
|
||||||
* \note not available in Python bindings
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
class GUI_EXPORT QgsRelationWidgetWrapper : public QgsWidgetWrapper
|
class GUI_EXPORT QgsRelationWidgetWrapper : public QgsWidgetWrapper
|
||||||
|
Loading…
x
Reference in New Issue
Block a user