Update documentation and sip binding

qgis · Oct 9, 2017 · c2b8290 · c2b8290
1 parent 7483c6e
commit c2b8290
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 3 deletions.
diff --git a/python/gui/gui_auto.sip b/python/gui/gui_auto.sip
@@ -153,6 +153,7 @@
 %Include qgsmessageviewer.sip
 %Include qgsmetadatawidget.sip
 %Include qgsnewauxiliarylayerdialog.sip
+%Include qgsnewauxiliaryfielddialog.sip
 %Include qgsnewhttpconnection.sip
 %Include qgsnewmemorylayerdialog.sip
 %Include qgsnewnamedialog.sip

diff --git a/python/gui/qgsnewauxiliaryfielddialog.sip b/python/gui/qgsnewauxiliaryfielddialog.sip
@@ -0,0 +1,54 @@
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsnewauxiliaryfielddialog.h                                 *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
+
+
+
+
+class QgsNewAuxiliaryFieldDialog: QDialog
+{
+%Docstring
+
+ A dialog to create a new auxiliary field
+
+.. versionadded:: 3.0
+%End
+
+%TypeHeaderCode
+#include "qgsnewauxiliaryfielddialog.h"
+%End
+  public:
+
+    QgsNewAuxiliaryFieldDialog( const QgsPropertyDefinition &definition, QgsVectorLayer *layer, bool nameOnly = true, QWidget *parent = 0 );
+%Docstring
+ Constructor.
+
+ \param definition The property definition to use to create the auxiliary field
+ \param layer The vector layer for which the auxiliary layer has to be created
+ \param nameOnly True to indicate that only the name widget is enabled
+ \param parent Parent window
+%End
+
+    QgsPropertyDefinition propertyDefinition() const;
+%Docstring
+ Returns the underlying property definition.
+ :rtype: QgsPropertyDefinition
+%End
+
+  protected:
+    virtual void accept();
+
+
+};
+
+/************************************************************************
+ * This file has been generated automatically from                      *
+ *                                                                      *
+ * src/gui/qgsnewauxiliaryfielddialog.h                                 *
+ *                                                                      *
+ * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
+ ************************************************************************/
diff --git a/src/gui/qgsnewauxiliaryfielddialog.h b/src/gui/qgsnewauxiliaryfielddialog.h
@@ -40,12 +40,12 @@ class GUI_EXPORT QgsNewAuxiliaryFieldDialog: public QDialog, private Ui::QgsNewA
     /**
      * Constructor.
      *
-     * \param def The property definition to use to create the auxiliary field
+     * \param definition The property definition to use to create the auxiliary field
      * \param layer The vector layer for which the auxiliary layer has to be created
-     * \param customOnly True to indicate that only the name widget is enabled
+     * \param nameOnly True to indicate that only the name widget is enabled
      * \param parent Parent window
      */
-    QgsNewAuxiliaryFieldDialog( const QgsPropertyDefinition &def, QgsVectorLayer *layer, bool nameOnly = true, QWidget *parent = nullptr );
+    QgsNewAuxiliaryFieldDialog( const QgsPropertyDefinition &definition, QgsVectorLayer *layer, bool nameOnly = true, QWidget *parent = nullptr );
 
     /**
      * Returns the underlying property definition.