Skip to content

Commit

Permalink
Dox++
Browse files Browse the repository at this point in the history
  • Loading branch information
nyalldawson committed Nov 12, 2018
1 parent 92f34a9 commit 2819a07
Show file tree
Hide file tree
Showing 48 changed files with 294 additions and 53 deletions.
5 changes: 5 additions & 0 deletions src/gui/editorwidgets/qgsbinarywidgetfactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ SIP_NO_FILE
class GUI_EXPORT QgsBinaryWidgetFactory : public QgsEditorWidgetFactory
{
public:

/**
* Constructor for QgsBinaryWidgetFactory, where \a name is a human-readable
* name for the factory.
*/
explicit QgsBinaryWidgetFactory( const QString &name );

// QgsEditorWidgetFactory interface
Expand Down
4 changes: 2 additions & 2 deletions src/gui/editorwidgets/qgsbinarywidgetwrapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
#include <QMenu>
#include <QMessageBox>

QgsBinaryWidgetWrapper::QgsBinaryWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( vl, fieldIdx, editor, parent )
QgsBinaryWidgetWrapper::QgsBinaryWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( layer, fieldIdx, editor, parent )

{
}
Expand Down
14 changes: 12 additions & 2 deletions src/gui/editorwidgets/qgsbinarywidgetwrapper.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,22 @@ SIP_NO_FILE
* \note not available in Python bindings
* \since QGIS 3.6
*/

class GUI_EXPORT QgsBinaryWidgetWrapper : public QgsEditorWidgetWrapper
{
Q_OBJECT
public:
explicit QgsBinaryWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

/**
* Constructor for QgsBinaryWidgetWrapper.
*
* The \a layer and \a fieldIdx arguments specify the vector layer field associated with the wrapper.
*
* The \a editor argument indicates the editor widget to use with the wrapper. This can be a nullptr if a
* new widget should be autogenerated.
*
* A \a parent widget for this widget wrapper and the created widget can also be specified.
*/
explicit QgsBinaryWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

// QgsEditorWidgetWrapper interface
public:
Expand Down
5 changes: 5 additions & 0 deletions src/gui/editorwidgets/qgscheckboxwidgetfactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ SIP_NO_FILE
class GUI_EXPORT QgsCheckboxWidgetFactory : public QgsEditorWidgetFactory
{
public:

/**
* Constructor for QgsCheckboxWidgetFactory, where \a name is a human-readable
* name for the factory.
*/
explicit QgsCheckboxWidgetFactory( const QString &name );

// QgsEditorWidgetFactory interface
Expand Down
4 changes: 2 additions & 2 deletions src/gui/editorwidgets/qgscheckboxwidgetwrapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@

#include "qgscheckboxwidgetwrapper.h"

QgsCheckboxWidgetWrapper::QgsCheckboxWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( vl, fieldIdx, editor, parent )
QgsCheckboxWidgetWrapper::QgsCheckboxWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( layer, fieldIdx, editor, parent )

{
}
Expand Down
13 changes: 12 additions & 1 deletion src/gui/editorwidgets/qgscheckboxwidgetwrapper.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,18 @@ class GUI_EXPORT QgsCheckboxWidgetWrapper : public QgsEditorWidgetWrapper
{
Q_OBJECT
public:
explicit QgsCheckboxWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

/**
* Constructor for QgsCheckboxWidgetWrapper.
*
* The \a layer and \a fieldIdx arguments specify the vector layer field associated with the wrapper.
*
* The \a editor argument indicates the editor widget to use with the wrapper. This can be a nullptr if a
* new widget should be autogenerated.
*
* A \a parent widget for this widget wrapper and the created widget can also be specified.
*/
explicit QgsCheckboxWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

// QgsEditorWidgetWrapper interface
public:
Expand Down
4 changes: 2 additions & 2 deletions src/gui/editorwidgets/qgsclassificationwidgetwrapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
#include "qgscategorizedsymbolrenderer.h"
#include "qgsvectorlayer.h"

QgsClassificationWidgetWrapper::QgsClassificationWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( vl, fieldIdx, editor, parent )
QgsClassificationWidgetWrapper::QgsClassificationWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( layer, fieldIdx, editor, parent )

{
}
Expand Down
13 changes: 12 additions & 1 deletion src/gui/editorwidgets/qgsclassificationwidgetwrapper.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,18 @@ class GUI_EXPORT QgsClassificationWidgetWrapper : public QgsEditorWidgetWrapper
{
Q_OBJECT
public:
explicit QgsClassificationWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

/**
* Constructor for QgsClassificationWidgetWrapper.
*
* The \a layer and \a fieldIdx arguments specify the vector layer field associated with the wrapper.
*
* The \a editor argument indicates the editor widget to use with the wrapper. This can be a nullptr if a
* new widget should be autogenerated.
*
* A \a parent widget for this widget wrapper and the created widget can also be specified.
*/
explicit QgsClassificationWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

// QgsEditorWidgetWrapper interface
public:
Expand Down
5 changes: 5 additions & 0 deletions src/gui/editorwidgets/qgsclassificationwidgetwrapperfactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ SIP_NO_FILE
class GUI_EXPORT QgsClassificationWidgetWrapperFactory : public QgsEditorWidgetFactory
{
public:

/**
* Constructor for QgsClassificationWidgetWrapperFactory, where \a name is a human-readable
* name for the factory.
*/
explicit QgsClassificationWidgetWrapperFactory( const QString &name );

// QgsEditorWidgetFactory interface
Expand Down
5 changes: 5 additions & 0 deletions src/gui/editorwidgets/qgscolorwidgetfactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ SIP_NO_FILE
class GUI_EXPORT QgsColorWidgetFactory : public QgsEditorWidgetFactory
{
public:

/**
* Constructor for QgsColorWidgetFactory, where \a name is a human-readable
* name for the factory.
*/
QgsColorWidgetFactory( const QString &name );

// QgsEditorWidgetFactory interface
Expand Down
4 changes: 2 additions & 2 deletions src/gui/editorwidgets/qgscolorwidgetwrapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
#include <QLayout>


QgsColorWidgetWrapper::QgsColorWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( vl, fieldIdx, editor, parent )
QgsColorWidgetWrapper::QgsColorWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( layer, fieldIdx, editor, parent )

{
}
Expand Down
13 changes: 12 additions & 1 deletion src/gui/editorwidgets/qgscolorwidgetwrapper.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,18 @@ class GUI_EXPORT QgsColorWidgetWrapper : public QgsEditorWidgetWrapper
{
Q_OBJECT
public:
explicit QgsColorWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

/**
* Constructor for QgsColorWidgetWrapper.
*
* The \a layer and \a fieldIdx arguments specify the vector layer field associated with the wrapper.
*
* The \a editor argument indicates the editor widget to use with the wrapper. This can be a nullptr if a
* new widget should be autogenerated.
*
* A \a parent widget for this widget wrapper and the created widget can also be specified.
*/
explicit QgsColorWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

// QgsEditorWidgetWrapper interface
public:
Expand Down
5 changes: 5 additions & 0 deletions src/gui/editorwidgets/qgsdatetimeeditfactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ SIP_NO_FILE
class GUI_EXPORT QgsDateTimeEditFactory : public QgsEditorWidgetFactory
{
public:

/**
* Constructor for QgsDateTimeEditFactory, where \a name is a human-readable
* name for the factory.
*/
QgsDateTimeEditFactory( const QString &name );

QgsEditorWidgetWrapper *create( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent ) const override;
Expand Down
4 changes: 2 additions & 2 deletions src/gui/editorwidgets/qgsdatetimeeditwrapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
#include <QTextCharFormat>
#include <QCalendarWidget>

QgsDateTimeEditWrapper::QgsDateTimeEditWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( vl, fieldIdx, editor, parent )
QgsDateTimeEditWrapper::QgsDateTimeEditWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( layer, fieldIdx, editor, parent )

{
}
Expand Down
13 changes: 12 additions & 1 deletion src/gui/editorwidgets/qgsdatetimeeditwrapper.h
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,18 @@ class GUI_EXPORT QgsDateTimeEditWrapper : public QgsEditorWidgetWrapper
{
Q_OBJECT
public:
explicit QgsDateTimeEditWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent = nullptr );

/**
* Constructor for QgsDateTimeEditWrapper.
*
* The \a layer and \a fieldIdx arguments specify the vector layer field associated with the wrapper.
*
* The \a editor argument indicates the editor widget to use with the wrapper. This can be a nullptr if a
* new widget should be autogenerated.
*
* A \a parent widget for this widget wrapper and the created widget can also be specified.
*/
explicit QgsDateTimeEditWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor, QWidget *parent = nullptr );

private slots:
void dateTimeChanged( const QDateTime &dateTime );
Expand Down
5 changes: 5 additions & 0 deletions src/gui/editorwidgets/qgsenumerationwidgetfactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ SIP_NO_FILE
class GUI_EXPORT QgsEnumerationWidgetFactory : public QgsEditorWidgetFactory
{
public:

/**
* Constructor for QgsEnumerationWidgetFactory, where \a name is a human-readable
* name for the factory.
*/
explicit QgsEnumerationWidgetFactory( const QString &name );

// QgsEditorWidgetFactory interface
Expand Down
4 changes: 2 additions & 2 deletions src/gui/editorwidgets/qgsenumerationwidgetwrapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
#include "qgsvectorlayer.h"
#include "qgsvectordataprovider.h"

QgsEnumerationWidgetWrapper::QgsEnumerationWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( vl, fieldIdx, editor, parent )
QgsEnumerationWidgetWrapper::QgsEnumerationWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( layer, fieldIdx, editor, parent )

{
}
Expand Down
13 changes: 12 additions & 1 deletion src/gui/editorwidgets/qgsenumerationwidgetwrapper.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,18 @@ class GUI_EXPORT QgsEnumerationWidgetWrapper : public QgsEditorWidgetWrapper
{
Q_OBJECT
public:
explicit QgsEnumerationWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

/**
* Constructor for QgsEnumerationWidgetWrapper.
*
* The \a layer and \a fieldIdx arguments specify the vector layer field associated with the wrapper.
*
* The \a editor argument indicates the editor widget to use with the wrapper. This can be a nullptr if a
* new widget should be autogenerated.
*
* A \a parent widget for this widget wrapper and the created widget can also be specified.
*/
explicit QgsEnumerationWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

// QgsEditorWidgetWrapper interface
public:
Expand Down
5 changes: 5 additions & 0 deletions src/gui/editorwidgets/qgsexternalresourcewidgetfactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ SIP_NO_FILE
class GUI_EXPORT QgsExternalResourceWidgetFactory : public QgsEditorWidgetFactory
{
public:

/**
* Constructor for QgsExternalResourceWidgetFactory, where \a name is a human-readable
* name for the factory.
*/
QgsExternalResourceWidgetFactory( const QString &name );

// QgsEditorWidgetFactory interface
Expand Down
4 changes: 2 additions & 2 deletions src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
#include "qgsfilterlineedit.h"


QgsExternalResourceWidgetWrapper::QgsExternalResourceWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( vl, fieldIdx, editor, parent )
QgsExternalResourceWidgetWrapper::QgsExternalResourceWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( layer, fieldIdx, editor, parent )

{
}
Expand Down
13 changes: 12 additions & 1 deletion src/gui/editorwidgets/qgsexternalresourcewidgetwrapper.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,18 @@ class GUI_EXPORT QgsExternalResourceWidgetWrapper : public QgsEditorWidgetWrappe
{
Q_OBJECT
public:
explicit QgsExternalResourceWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

/**
* Constructor for QgsExternalResourceWidgetWrapper.
*
* The \a layer and \a fieldIdx arguments specify the vector layer field associated with the wrapper.
*
* The \a editor argument indicates the editor widget to use with the wrapper. This can be a nullptr if a
* new widget should be autogenerated.
*
* A \a parent widget for this widget wrapper and the created widget can also be specified.
*/
explicit QgsExternalResourceWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

// QgsEditorWidgetWrapper interface
public:
Expand Down
5 changes: 5 additions & 0 deletions src/gui/editorwidgets/qgshiddenwidgetfactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ SIP_NO_FILE
class GUI_EXPORT QgsHiddenWidgetFactory : public QgsEditorWidgetFactory
{
public:

/**
* Constructor for QgsHiddenWidgetFactory, where \a name is a human-readable
* name for the factory.
*/
QgsHiddenWidgetFactory( const QString &name );

// QgsEditorWidgetFactory interface
Expand Down
4 changes: 2 additions & 2 deletions src/gui/editorwidgets/qgshiddenwidgetwrapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@

#include <QWidget>

QgsHiddenWidgetWrapper::QgsHiddenWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( vl, fieldIdx, editor, parent )
QgsHiddenWidgetWrapper::QgsHiddenWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor, QWidget *parent )
: QgsEditorWidgetWrapper( layer, fieldIdx, editor, parent )
{
}

Expand Down
13 changes: 12 additions & 1 deletion src/gui/editorwidgets/qgshiddenwidgetwrapper.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,18 @@ class GUI_EXPORT QgsHiddenWidgetWrapper : public QgsEditorWidgetWrapper
{
Q_OBJECT
public:
explicit QgsHiddenWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

/**
* Constructor for QgsHiddenWidgetWrapper.
*
* The \a layer and \a fieldIdx arguments specify the vector layer field associated with the wrapper.
*
* The \a editor argument indicates the editor widget to use with the wrapper. This can be a nullptr if a
* new widget should be autogenerated.
*
* A \a parent widget for this widget wrapper and the created widget can also be specified.
*/
explicit QgsHiddenWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

// QgsEditorWidgetWrapper interface
public:
Expand Down
3 changes: 2 additions & 1 deletion src/gui/editorwidgets/qgskeyvaluewidgetfactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ class GUI_EXPORT QgsKeyValueWidgetFactory : public QgsEditorWidgetFactory
public:

/**
* Constructor.
* Constructor for QgsKeyValueWidgetFactory, where \a name is a human-readable
* name for the factory.
*/
QgsKeyValueWidgetFactory( const QString &name );

Expand Down
4 changes: 2 additions & 2 deletions src/gui/editorwidgets/qgskeyvaluewidgetwrapper.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
#include "qgskeyvaluewidget.h"
#include "qgsattributeform.h"

QgsKeyValueWidgetWrapper::QgsKeyValueWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor, QWidget *parent ):
QgsEditorWidgetWrapper( vl, fieldIdx, editor, parent )
QgsKeyValueWidgetWrapper::QgsKeyValueWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor, QWidget *parent ):
QgsEditorWidgetWrapper( layer, fieldIdx, editor, parent )
{
}

Expand Down
11 changes: 9 additions & 2 deletions src/gui/editorwidgets/qgskeyvaluewidgetwrapper.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,16 @@ class GUI_EXPORT QgsKeyValueWidgetWrapper : public QgsEditorWidgetWrapper
public:

/**
* Constructor.
* Constructor for QgsKeyValueWidgetWrapper.
*
* The \a layer and \a fieldIdx arguments specify the vector layer field associated with the wrapper.
*
* The \a editor argument indicates the editor widget to use with the wrapper. This can be a nullptr if a
* new widget should be autogenerated.
*
* A \a parent widget for this widget wrapper and the created widget can also be specified.
*/
explicit QgsKeyValueWidgetWrapper( QgsVectorLayer *vl, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );
explicit QgsKeyValueWidgetWrapper( QgsVectorLayer *layer, int fieldIdx, QWidget *editor = nullptr, QWidget *parent = nullptr );

// QgsEditorWidgetWrapper interface
public:
Expand Down
3 changes: 2 additions & 1 deletion src/gui/editorwidgets/qgslistwidgetfactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ class GUI_EXPORT QgsListWidgetFactory : public QgsEditorWidgetFactory
public:

/**
* Constructor.
* Constructor for QgsListWidgetFactory, where \a name is a human-readable
* name for the factory.
*/
QgsListWidgetFactory( const QString &name );

Expand Down
Loading

0 comments on commit 2819a07

Please sign in to comment.