Skip to content
Permalink
Browse files

Remove some incorrect 'not available in Python bindings' notes

  • Loading branch information
nyalldawson committed May 26, 2018
1 parent 94cf3fc commit 4bb7f82fcb61c7a9e5260fa3b547f3f8656e7192
@@ -624,10 +624,6 @@ To create it, the geometry is default constructed and then the WKB is changed.
.. seealso:: :py:func:`clone`

.. versionadded:: 3.0

.. note::

Not available in Python bindings
%End

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 );
%Docstring

.. note::

not available in Python bindings
Updates an embedded ``group`` from a ``project``.
%End

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
in the manager.

.. note::

Not available in Python bindings
%End

%TypeHeaderCode
@@ -745,10 +745,6 @@ Get the registry of available field formatters.
%Docstring
Returns registry of available 3D renderers.

.. note::

not available in Python bindings

.. versionadded:: 3.0
%End

@@ -514,10 +514,6 @@ Constructor for QgsPresetSchemeColorRamp.
Constructor for :py:class:`QgsPresetColorRamp`.

:param colors: list of named colors in ramp

.. note::

not available in Python bindings - use setColors instead
%End

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

:return: A request the referenced feature

.. note::

not available in Python bindings
%End

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.

:return: buffered dash messages

.. note::

not available in Python bindings
%End

protected:
@@ -132,19 +132,11 @@ Encodes a shape to its string representation.
bool prepareMarkerShape( Shape shape );
%Docstring
Prepares the layer for drawing the specified shape (QPolygonF version)

.. note::

not available in Python bindings
%End

bool prepareMarkerPath( Shape symbol );
%Docstring
Prepares the layer for drawing the specified shape (QPainterPath version)

.. note::

not available in Python bindings
%End

bool shapeToPolygon( Shape shape, QPolygonF &polygon ) const;
@@ -155,10 +147,6 @@ Creates a polygon representing the specified shape.
:param polygon: destination polygon for shape

:return: true if shape was successfully stored in polygon

.. note::

not available in Python bindings
%End

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

:return: marker size, in original size units

.. note::

not available in Python bindings
%End

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 offset: will be set to calculated marker offset (in painter units)
:param angle: will be set to calculated marker angle

.. note::

not available in Python bindings
%End


@@ -708,10 +688,6 @@ Calculates the marker aspect ratio between width and height.
:param context: symbol render context
:param scaledSize: size of symbol to render
:param hasDataDefinedAspectRatio: will be set to true if marker has data defined aspectRatio

.. note::

not available in Python bindings
%End


@@ -12,12 +12,6 @@

class QgsRelationWidgetWrapper : QgsWidgetWrapper
{
%Docstring

.. note::

not available in Python bindings
%End

%TypeHeaderCode
#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.
* \see clone()
* \since 3.0
* \note Not available in Python bindings
*/
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
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 );

//! get invisible layers
@@ -37,7 +37,6 @@ class QgsPrintLayout;
*
* QgsLayoutManager retains ownership of all the layouts contained
* in the manager.
* \note Not available in Python bindings
*/

class CORE_EXPORT QgsLayoutManager : public QObject
@@ -679,7 +679,6 @@ class CORE_EXPORT QgsApplication : public QApplication

/**
* Returns registry of available 3D renderers.
* \note not available in Python bindings
* \since QGIS 3.0
*/
static Qgs3DRendererRegistry *renderer3DRegistry();
@@ -481,7 +481,6 @@ class CORE_EXPORT QgsPresetSchemeColorRamp : public QgsColorRamp, public QgsColo
/**
* Constructor for QgsPresetColorRamp.
* \param colors list of named colors in ramp
* \note not available in Python bindings - use setColors instead
*/
QgsPresetSchemeColorRamp( const QgsNamedColorList &colors );

@@ -198,7 +198,6 @@ class CORE_EXPORT QgsRelation
* \param attributes An attribute vector containing the foreign key
*
* \returns A request the referenced feature
* \note not available in Python bindings
*/
QgsFeatureRequest getReferencedFeatureRequest( const QgsAttributes &attributes ) const;

@@ -169,7 +169,6 @@ class CORE_EXPORT QgsRenderChecker
* Only will return something if you call enableDashBuffering( true ); before.
*
* \returns buffered dash messages
* \note not available in Python bindings
*/
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)
* \note not available in Python bindings
*/
bool prepareMarkerShape( Shape shape );

/**
* Prepares the layer for drawing the specified shape (QPainterPath version)
* \note not available in Python bindings
*/
bool prepareMarkerPath( Shape symbol );

@@ -150,7 +148,6 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer
* \param shape shape to create
* \param polygon destination polygon for shape
* \returns true if shape was successfully stored in polygon
* \note not available in Python bindings
*/
bool shapeToPolygon( Shape shape, QPolygonF &polygon ) const;

@@ -159,7 +156,6 @@ class CORE_EXPORT QgsSimpleMarkerSymbolLayerBase : public QgsMarkerSymbolLayer
* \param context symbol render context
* \param hasDataDefinedSize will be set to true if marker uses data defined sizes
* \returns marker size, in original size units
* \note not available in Python bindings
*/
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 offset will be set to calculated marker offset (in painter units)
* \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;

@@ -618,7 +613,6 @@ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer
* \param context symbol render context
* \param scaledSize size of symbol to render
* \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;

@@ -25,7 +25,6 @@ class QgsRelationEditorWidget;
/**
* \ingroup gui
* \class QgsRelationWidgetWrapper
* \note not available in Python bindings
*/

class GUI_EXPORT QgsRelationWidgetWrapper : public QgsWidgetWrapper

0 comments on commit 4bb7f82

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