Skip to content

Commit

Permalink
Update documentation and sip binding
Browse files Browse the repository at this point in the history
  • Loading branch information
pblottiere committed Oct 9, 2017
1 parent 97ee342 commit e14c5a2
Show file tree
Hide file tree
Showing 17 changed files with 366 additions and 9 deletions.
1 change: 0 additions & 1 deletion python/core/qgsauxiliarystorage.sip
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,6 @@ class QgsAuxiliaryLayer : QgsVectorLayer
activate this this property in settings.

\param property The property to create
\param providerId The id of the provider to use
\param vlayer The vector layer

:return: The index of the auxiliary field or -1
Expand Down
1 change: 1 addition & 0 deletions python/gui/gui_auto.sip
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@
%Include qgsmessagelogviewer.sip
%Include qgsmessageviewer.sip
%Include qgsmetadatawidget.sip
%Include qgsnewauxiliarylayerdialog.sip
%Include qgsnewhttpconnection.sip
%Include qgsnewmemorylayerdialog.sip
%Include qgsnewnamedialog.sip
Expand Down
46 changes: 46 additions & 0 deletions python/gui/qgsnewauxiliarylayerdialog.sip
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsnewauxiliarylayerdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/




class QgsNewAuxiliaryLayerDialog: QDialog
{
%Docstring

A dialog to create a new auxiliary layer

.. versionadded:: 3.0
%End

%TypeHeaderCode
#include "qgsnewauxiliarylayerdialog.h"
%End
public:

QgsNewAuxiliaryLayerDialog( QgsVectorLayer *layer, QWidget *parent = 0 );
%Docstring
Constructor.

\param layer The vector layer for which the auxiliary layer has to be created
\param parent Parent window
%End

protected:
virtual void accept();


};

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsnewauxiliarylayerdialog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
8 changes: 8 additions & 0 deletions python/gui/symbology/qgsellipsesymbollayerwidget.sip
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,18 @@ class QgsEllipseSymbolLayerWidget: QgsSymbolLayerWidget
#include "qgsellipsesymbollayerwidget.h"
%End
public:

QgsEllipseSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsEllipseSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand Down
8 changes: 8 additions & 0 deletions python/gui/symbology/qgslayerpropertieswidget.sip
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,15 @@ class QgsLayerPropertiesWidget : QgsPanelWidget, QgsExpressionContextGenerator
#include "qgslayerpropertieswidget.h"
%End
public:

QgsLayerPropertiesWidget( QgsSymbolLayer *layer, const QgsSymbol *symbol, QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsLayerPropertiesWidget.
\param layer the symbol layer
\param symbol the symbol
\param vl associated vector layer
\param parent parent widget
%End

void setContext( const QgsSymbolWidgetContext &context );
%Docstring
Expand Down
119 changes: 117 additions & 2 deletions python/gui/symbology/qgssymbollayerwidget.sip
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,13 @@ class QgsSymbolLayerWidget : QWidget, protected QgsExpressionContextGenerator
#include "qgssymbollayerwidget.h"
%End
public:

QgsSymbolLayerWidget( QWidget *parent /TransferThis/, QgsVectorLayer *vl = 0 );
%Docstring
Constructor for QgsSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

virtual void setSymbolLayer( QgsSymbolLayer *layer ) = 0;
virtual QgsSymbolLayer *symbolLayer() = 0;
Expand Down Expand Up @@ -79,8 +85,6 @@ class QgsSymbolLayerWidget : QWidget, protected QgsExpressionContextGenerator
protected slots:
void updateDataDefinedProperty();

void createAuxiliaryField();

};


Expand All @@ -93,10 +97,18 @@ class QgsSimpleLineSymbolLayerWidget : QgsSymbolLayerWidget
#include "qgssymbollayerwidget.h"
%End
public:

QgsSimpleLineSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsSimpleLineSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsSimpleLineSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand All @@ -119,10 +131,18 @@ class QgsSimpleMarkerSymbolLayerWidget : QgsSymbolLayerWidget
#include "qgssymbollayerwidget.h"
%End
public:

QgsSimpleMarkerSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsSimpleMarkerSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsSimpleMarkerSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand All @@ -148,10 +168,18 @@ class QgsSimpleFillSymbolLayerWidget : QgsSymbolLayerWidget
#include "qgssymbollayerwidget.h"
%End
public:

QgsSimpleFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsSimpleFillSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsSimpleFillSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand Down Expand Up @@ -213,10 +241,18 @@ class QgsGradientFillSymbolLayerWidget : QgsSymbolLayerWidget
#include "qgssymbollayerwidget.h"
%End
public:

QgsGradientFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsGradientFillSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsGradientFillSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand Down Expand Up @@ -249,10 +285,18 @@ class QgsShapeburstFillSymbolLayerWidget : QgsSymbolLayerWidget
#include "qgssymbollayerwidget.h"
%End
public:

QgsShapeburstFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsShapeburstFillSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsShapeburstFillSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand All @@ -277,10 +321,18 @@ class QgsMarkerLineSymbolLayerWidget : QgsSymbolLayerWidget
#include "qgssymbollayerwidget.h"
%End
public:

QgsMarkerLineSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsMarkerLineSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsMarkerLineSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand Down Expand Up @@ -308,10 +360,18 @@ class QgsSvgMarkerSymbolLayerWidget : QgsSymbolLayerWidget
#include "qgssymbollayerwidget.h"
%End
public:

QgsSvgMarkerSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsSvgMarkerSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsSvgMarkerSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand All @@ -336,10 +396,18 @@ class QgsRasterFillSymbolLayerWidget : QgsSymbolLayerWidget
#include "qgssymbollayerwidget.h"
%End
public:

QgsRasterFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsRasterFillSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsRasterFillSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand All @@ -360,10 +428,18 @@ class QgsSVGFillSymbolLayerWidget : QgsSymbolLayerWidget
#include "qgssymbollayerwidget.h"
%End
public:

QgsSVGFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsSVGFillSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsSVGFillSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand Down Expand Up @@ -395,8 +471,16 @@ class QgsLinePatternFillSymbolLayerWidget : QgsSymbolLayerWidget
public:

QgsLinePatternFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsLinePatternFillSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsLinePatternFillSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand All @@ -417,9 +501,18 @@ class QgsPointPatternFillSymbolLayerWidget: QgsSymbolLayerWidget
#include "qgssymbollayerwidget.h"
%End
public:

QgsPointPatternFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsPointPatternFillSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsPointPatternFillSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand All @@ -440,10 +533,18 @@ class QgsFontMarkerSymbolLayerWidget : QgsSymbolLayerWidget
#include "qgssymbollayerwidget.h"
%End
public:

QgsFontMarkerSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsFontMarkerSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsFontMarkerSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand Down Expand Up @@ -478,10 +579,18 @@ class QgsCentroidFillSymbolLayerWidget : QgsSymbolLayerWidget
#include "qgssymbollayerwidget.h"
%End
public:

QgsCentroidFillSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsCentroidFillSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Creates a new QgsCentroidFillSymbolLayerWidget.
\param vl associated vector layer
:rtype: QgsSymbolLayerWidget
%End

Expand All @@ -502,7 +611,13 @@ class QgsGeometryGeneratorSymbolLayerWidget : QgsSymbolLayerWidget
#include "qgssymbollayerwidget.h"
%End
public:

QgsGeometryGeneratorSymbolLayerWidget( QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsGeometryGeneratorSymbolLayerWidget.
\param vl associated vector layer
\param parent parent widget
%End

static QgsSymbolLayerWidget *create( QgsVectorLayer *vl ) /Factory/;
%Docstring
Expand Down
10 changes: 10 additions & 0 deletions python/gui/symbology/qgssymbolselectordialog.sip
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,17 @@ class QgsSymbolSelectorDialog : QDialog
#include "qgssymbolselectordialog.h"
%End
public:

QgsSymbolSelectorDialog( QgsSymbol *symbol, QgsStyle *style, QgsVectorLayer *vl, QWidget *parent /TransferThis/ = 0, bool embedded = false );
%Docstring
Constructor for QgsSymbolSelectorDialog.

\param symbol The symbol
\param style The style
\param vl Associated vector layer
\param parent Parent widget
\param embedded True to embed in renderer properties dialog, false otherwise
%End
~QgsSymbolSelectorDialog();

QMenu *advancedMenu();
Expand Down
Loading

0 comments on commit e14c5a2

Please sign in to comment.