Skip to content
Permalink
Browse files
fix doxymentation
  • Loading branch information
3nids committed Apr 25, 2017
1 parent 1577091 commit a60b31d3b38aa6101c95e82f506f1e86ba93ff16
Showing with 68 additions and 7 deletions.
  1. +34 −1 python/core/layertree/qgslayertreemodellegendnode.sip
  2. +34 −2 src/core/layertree/qgslayertreemodellegendnode.h
  3. +0 −4 tests/src/python/acceptable_missing_doc.py
@@ -10,6 +10,8 @@





class QgsLayerTreeModelLegendNode : QObject
{
%Docstring
@@ -166,7 +168,14 @@ class QgsSymbolLegendNode : QgsLayerTreeModelLegendNode
#include "qgslayertreemodellegendnode.h"
%End
public:

QgsSymbolLegendNode( QgsLayerTreeLayer *nodeLayer, const QgsLegendSymbolItem &item, QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsSymbolLegendNode.
\param nodeLayer layer node
\param item the legend symbol item
\param parent attach a parent QObject to the legend node.
%End

virtual Qt::ItemFlags flags() const;
virtual QVariant data( int role ) const;
@@ -260,7 +269,16 @@ class QgsSimpleLegendNode : QgsLayerTreeModelLegendNode
#include "qgslayertreemodellegendnode.h"
%End
public:

QgsSimpleLegendNode( QgsLayerTreeLayer *nodeLayer, const QString &label, const QIcon &icon = QIcon(), QObject *parent /TransferThis/ = 0, const QString &key = QString() );
%Docstring
Constructor for QgsSimpleLegendNode.
\param nodeLayer layer node
\param label label
\param icon icon
\param parent attach a parent QObject to the legend node.
\param key the rule key
%End

virtual QVariant data( int role ) const;

@@ -279,7 +297,14 @@ class QgsImageLegendNode : QgsLayerTreeModelLegendNode
#include "qgslayertreemodellegendnode.h"
%End
public:

QgsImageLegendNode( QgsLayerTreeLayer *nodeLayer, const QImage &img, QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsImageLegendNode.
\param nodeLayer layer node
\param img the image
\param parent attach a parent QObject to the legend node.
%End

virtual QVariant data( int role ) const;

@@ -300,7 +325,15 @@ class QgsRasterSymbolLegendNode : QgsLayerTreeModelLegendNode
#include "qgslayertreemodellegendnode.h"
%End
public:

QgsRasterSymbolLegendNode( QgsLayerTreeLayer *nodeLayer, const QColor &color, const QString &label, QObject *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsRasterSymbolLegendNode.
\param nodeLayer layer node
\param color color
\param label label
\param parent attach a parent QObject to the legend node.
%End

virtual QVariant data( int role ) const;

@@ -327,7 +360,7 @@ class QgsWmsLegendNode : QgsLayerTreeModelLegendNode
%Docstring
Constructor for QgsWmsLegendNode.
\param nodeLayer layer node
\param parent parent object
\param parent attach a parent QObject to the legend node.
%End

virtual QVariant data( int role ) const;
@@ -150,6 +150,13 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode
Q_OBJECT

public:

/**
* Constructor for QgsSymbolLegendNode.
* \param nodeLayer layer node
* \param item the legend symbol item
* \param parent attach a parent QObject to the legend node.
*/
QgsSymbolLegendNode( QgsLayerTreeLayer *nodeLayer, const QgsLegendSymbolItem &item, QObject *parent SIP_TRANSFERTHIS = nullptr );

virtual Qt::ItemFlags flags() const override;
@@ -250,6 +257,15 @@ class CORE_EXPORT QgsSimpleLegendNode : public QgsLayerTreeModelLegendNode
Q_OBJECT

public:

/**
* Constructor for QgsSimpleLegendNode.
* \param nodeLayer layer node
* \param label label
* \param icon icon
* \param parent attach a parent QObject to the legend node.
* \param key the rule key
*/
QgsSimpleLegendNode( QgsLayerTreeLayer *nodeLayer, const QString &label, const QIcon &icon = QIcon(), QObject *parent SIP_TRANSFERTHIS = nullptr, const QString &key = QString() );

virtual QVariant data( int role ) const override;
@@ -272,6 +288,13 @@ class CORE_EXPORT QgsImageLegendNode : public QgsLayerTreeModelLegendNode
Q_OBJECT

public:

/**
* Constructor for QgsImageLegendNode.
* \param nodeLayer layer node
* \param img the image
* \param parent attach a parent QObject to the legend node.
*/
QgsImageLegendNode( QgsLayerTreeLayer *nodeLayer, const QImage &img, QObject *parent SIP_TRANSFERTHIS = nullptr );

virtual QVariant data( int role ) const override;
@@ -292,6 +315,14 @@ class CORE_EXPORT QgsRasterSymbolLegendNode : public QgsLayerTreeModelLegendNode
Q_OBJECT

public:

/**
* Constructor for QgsRasterSymbolLegendNode.
* \param nodeLayer layer node
* \param color color
* \param label label
* \param parent attach a parent QObject to the legend node.
*/
QgsRasterSymbolLegendNode( QgsLayerTreeLayer *nodeLayer, const QColor &color, const QString &label, QObject *parent SIP_TRANSFERTHIS = nullptr );

virtual QVariant data( int role ) const override;
@@ -316,9 +347,10 @@ class CORE_EXPORT QgsWmsLegendNode : public QgsLayerTreeModelLegendNode

public:

/** Constructor for QgsWmsLegendNode.
/**
* Constructor for QgsWmsLegendNode.
* \param nodeLayer layer node
* \param parent parent object
* \param parent attach a parent QObject to the legend node.
*/
QgsWmsLegendNode( QgsLayerTreeLayer *nodeLayer, QObject *parent SIP_TRANSFERTHIS = nullptr );

@@ -67,7 +67,6 @@
"QgsFieldValidator": ["QgsFieldValidator(QObject *parent, const QgsField &field, const QString &defaultValue, const QString &dateFormat=\"yyyy-MM-dd\")", "dateFormat() const "],
"QgsProviderCountCalcEvent": ["QgsProviderCountCalcEvent(long featuresCounted)", "featuresCounted() const "],
"QgsFeatureListViewDelegate": ["editButtonClicked(QModelIndex &index)", "positionToElement(QPoint pos)", "QgsFeatureListViewDelegate(QgsFeatureListModel *listModel, QObject *parent=nullptr)", "setCurrentFeatureEdited(bool state)", "setFeatureSelectionModel(QgsFeatureSelectionModel *featureSelectionModel)", "Element", "setEditSelectionModel(QItemSelectionModel *editSelectionModel)"],
"QgsImageLegendNode": ["QgsImageLegendNode(QgsLayerTreeLayer *nodeLayer, const QImage &img, QObject *parent=nullptr)"],
"QgsVectorLayerRenderer": ["QgsVectorLayerRenderer(QgsVectorLayer *layer, QgsRenderContext &context)"],
"QgsQueryBuilder": ["sql()", "clear()", "setSql(const QString &sqlStatement)", "setDatasourceDescription(const QString &uri)"],
"QgsPalLabeling": ["dataDefinedTextStyle(QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)", "setShowingPartialsLabels(bool showing)", "setDrawingOutlineLabels(bool outline)", "setNumCandidatePositions(int candPoint, int candLine, int candPolygon)", "isShowingAllLabels() const ", "isShowingShadowRectangles() const ", "numCandidatePositions(int &candPoint, int &candLine, int &candPolygon)", "drawLabelShadow(QgsRenderContext &context, const QgsLabelComponent &component, const QgsPalLayerSettings &tmpLyr)", "setShowingCandidates(bool showing)", "drawLabelBuffer(QgsRenderContext &context, const QgsLabelComponent &component, const QgsPalLayerSettings &tmpLyr)", "isShowingCandidates() const ", "dataDefinedTextBuffer(QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)", "setShowingShadowRectangles(bool showing)", "Search", "dataDefinedTextFormatting(QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)", "setSearchMethod(Search s)", "DrawLabelType", "isShowingPartialsLabels() const ", "drawLabelBackground(QgsRenderContext &context, QgsLabelComponent component, const QgsPalLayerSettings &tmpLyr)", "dataDefinedDropShadow(QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)", "dataDefinedShapeBackground(QgsPalLayerSettings &tmpLyr, const QMap< QgsPalLayerSettings::DataDefinedProperties, QVariant > &ddValues)", "clearEngineSettings()", "searchMethod() const ", "deleteTemporaryData()", "setShowingAllLabels(bool showing)", "staticWillUseLayer(const QString &layerID)", "saveEngineSettings()"],
@@ -91,7 +90,6 @@
"QgsProviderMetadata": ["QgsProviderMetadata(const QString &_key, const QString &_description, const QString &_library)"],
"QgsAbstractFeatureIteratorFromSource": ["QgsAbstractFeatureIteratorFromSource(T *source, bool ownSource, const QgsFeatureRequest &request)"],
"pal::PolygonCostCalculator": ["PolygonCostCalculator(LabelPosition *lp)", "update(pal::PointSet *pset)", "getCost()", "getLabel()"],
"QgsSimpleLegendNode": ["QgsSimpleLegendNode(QgsLayerTreeLayer *nodeLayer, const QString &label, const QIcon &icon=QIcon(), QObject *parent=nullptr, const QString &key=QString())"],
"QgsDataSourceUri": ["SSLmode"],
"HalfEdge": ["HalfEdge(int dual, int next, int point, bool mbreak, bool forced)"],
"QgsTransactionGroup": ["QgsTransactionGroup(QObject *parent=0)"],
@@ -243,7 +241,6 @@
"QgsExpression::NodeCondition": ["NodeCondition(const WhenThenList &conditions, Node *elseExp=nullptr)", "NodeCondition(WhenThenList *conditions, Node *elseExp=nullptr)"],
"QgsComposerEffect": ["setCompositionMode(QPainter::CompositionMode compositionMode)"],
"QgsHighlight": ["QgsHighlight(QgsMapCanvas *mapCanvas, const QgsGeometry *geom, QgsMapLayer *layer)", "layer() const ", "QgsHighlight(QgsMapCanvas *mapCanvas, const QgsGeometry *geom, QgsVectorLayer *layer)"],
"QgsRasterSymbolLegendNode": ["QgsRasterSymbolLegendNode(QgsLayerTreeLayer *nodeLayer, const QColor &color, const QString &label, QObject *parent=nullptr)"],
"QgsExternalResourceWidgetFactory": ["QgsExternalResourceWidgetFactory(const QString &name)"],
"QgsComposerTableV2": ["QgsComposerTableV2(QgsComposition *composition, bool createUndoCommands)"],
"QgsVectorDataProvider": ["convertValue(QVariant::Type type, const QString &value)", "clearMinMaxCache()", "pushError(const QString &msg)", "fillMinMaxCache()"],
@@ -656,7 +653,6 @@
"QgsDataDefinedWidthDialog": ["QgsDataDefinedWidthDialog(const QList< QgsSymbol * > &symbolList, QgsVectorLayer *layer)"],
"QgsDoubleBoxScaleBarStyle": ["QgsDoubleBoxScaleBarStyle(const QgsComposerScaleBar *bar)"],
"QgsAddRemoveItemCommand": ["QgsAddRemoveItemCommand(State s, QgsComposerItem *item, QgsComposition *c, const QString &text, QUndoCommand *parent=nullptr)", "State", "itemRemoved(QgsComposerItem *item)", "itemAdded(QgsComposerItem *item)"],
"QgsSymbolLegendNode": ["QgsSymbolLegendNode(QgsLayerTreeLayer *nodeLayer, const QgsLegendSymbolItem &item, QObject *parent=nullptr)"],
"QgsFeatureIteratorDataStream": ["readNextEntry()"],
"QgsWkbTypes": ["GeometryType", "Type"],
"QgsExpression::NodeBinaryOperator": ["computeDouble(double x, double y)", "computeInt(int x, int y)", "op() const ", "opLeft() const ", "compare(double diff)", "NodeBinaryOperator(BinaryOperator op, Node *opLeft, Node *opRight)", "opRight() const ", "precedence() const ", "computeDateTimeFromInterval(const QDateTime &d, QgsExpression::Interval *i)", "leftAssociative() const "],

0 comments on commit a60b31d

Please sign in to comment.