Skip to content
Permalink
Browse files

add missing docstring

with sip_include.sh
  • Loading branch information
olivierdalang committed May 15, 2019
1 parent 4163be6 commit 5b6dd73949279dc0ecacc0cb456bb5c180952c14
@@ -0,0 +1,70 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsadvanceddigitizingfloater.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/





class QgsAdvancedDigitizingFloater : QWidget
{
%Docstring
The QgsAdvancedDigitizingFloater class is widget that floats
next to the mouse pointer, and allow interaction with the AdvancedDigitizing
feature. It proxies display and actions to QgsMapToolAdvancedDigitizingDockWidget.

.. note::

This class is a technology preview and unstable API.

.. versionadded:: 3.8
%End

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

explicit QgsAdvancedDigitizingFloater( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget );
%Docstring
Create an advanced digitizing floater widget

:param canvas: The map canvas on which the widget operates
:param cadDockWidget: The cadDockWidget to which the floater belongs

.. versionadded:: 3.8
%End

bool active();
%Docstring
Whether the floater is active or not.
Note that the floater may be active but not visible (e.g. if the mouse is not over the canvas).

.. versionadded:: 3.8
%End

public slots:

void setActive( bool active );
%Docstring
Set whether the floater should be active or not.
Note that the floater may be active but not visible (e.g. if the mouse is not over the canvas).

:param active:

.. versionadded:: 3.8
%End

};

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsadvanceddigitizingfloater.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
@@ -54,6 +54,7 @@
%Include auto_generated/qgisinterface.sip
%Include auto_generated/qgsactionmenu.sip
%Include auto_generated/qgsadvanceddigitizingdockwidget.sip
%Include auto_generated/qgsadvanceddigitizingfloater.sip
%Include auto_generated/qgsaggregatetoolbutton.sip
%Include auto_generated/qgsattributedialog.sip
%Include auto_generated/qgsattributeform.sip
@@ -41,6 +41,12 @@ class GUI_EXPORT QgsAdvancedDigitizingFloater : public QWidget, private Ui::QgsA

public:

/**
* Create an advanced digitizing floater widget
* \param canvas The map canvas on which the widget operates
* \param cadDockWidget The cadDockWidget to which the floater belongs
* \since QGIS 3.8
*/
explicit QgsAdvancedDigitizingFloater( QgsMapCanvas *canvas, QgsAdvancedDigitizingDockWidget *cadDockWidget );

/**

0 comments on commit 5b6dd73

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