Skip to content
Permalink
Browse files

Added SIP_DEPRECATED and added forgotten \since docs

  • Loading branch information
suricactus committed Dec 30, 2020
1 parent 51cd712 commit b1dad1d3ef0feab309ceb9eb67a1a4a9c09c0afb
@@ -425,7 +425,7 @@ Determines if the "Save child layer edits" button should be shown
use visibleButtons() instead
%End

void setVisibleButtons( const QgsAttributeEditorRelation::Buttons &buttons );
void setVisibleButtons( const QgsAttributeEditorRelation::Buttons &buttons ) /Deprecated/;
%Docstring
Defines the buttons which are shown

@@ -435,14 +435,14 @@ Defines the buttons which are shown
use setConfig() instead
%End

QgsAttributeEditorRelation::Buttons visibleButtons() const;
QgsAttributeEditorRelation::Buttons visibleButtons() const /Deprecated/;
%Docstring
Returns the buttons which are shown

.. versionadded:: 3.16

.. deprecated:: QGIS 3.18
use setConfig() instead
use config() instead
%End

bool forceSuppressFormPopup() const;
@@ -494,11 +494,15 @@ If it's empty it takes the relation id as label
QString relationWidgetTypeId() const;
%Docstring
Returns the current relation widget type id

.. versionadded:: 3.18
%End

void setRelationWidgetTypeId( const QString &relationWidgetTypeId );
%Docstring
Sets the relation widget type

.. versionadded:: 3.18
%End

};
@@ -115,22 +115,24 @@ Determines if the "Save child layer edits" button should be shown
use visibleButtons() instead
%End

void setVisibleButtons( const QgsAttributeEditorRelation::Buttons &buttons );
void setVisibleButtons( const QgsAttributeEditorRelation::Buttons &buttons ) /Deprecated/;
%Docstring
Defines the buttons which are shown

.. versionadded:: 3.16

.. deprecated:: QGIS 3.18
use setWidgetConfig() instead
%End

QgsAttributeEditorRelation::Buttons visibleButtons() const;
QgsAttributeEditorRelation::Buttons visibleButtons() const /Deprecated/;
%Docstring
Returns the buttons which are shown

.. versionadded:: 3.16

.. deprecated:: QGIS 3.18
use widgetConfig() instead
%End


@@ -139,11 +141,15 @@ Returns the buttons which are shown
Will set the config of this widget wrapper to the specified config.

:param config: The config for this wrapper

.. versionadded:: 3.18
%End

QVariantMap widgetConfig() const;
%Docstring
Returns the whole widget config

.. versionadded:: 3.18
%End

bool forceSuppressFormPopup() const;
@@ -475,14 +475,14 @@ class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement
* \since QGIS 3.16
* \deprecated since QGIS 3.18 use setConfig() instead
*/
Q_DECL_DEPRECATED void setVisibleButtons( const QgsAttributeEditorRelation::Buttons &buttons );
Q_DECL_DEPRECATED void setVisibleButtons( const QgsAttributeEditorRelation::Buttons &buttons ) SIP_DEPRECATED;

/**
* Returns the buttons which are shown
* \since QGIS 3.16
* \deprecated since QGIS 3.18 use setConfig() instead
* \deprecated since QGIS 3.18 use config() instead
*/
Q_DECL_DEPRECATED QgsAttributeEditorRelation::Buttons visibleButtons() const {return mButtons;}
Q_DECL_DEPRECATED QgsAttributeEditorRelation::Buttons visibleButtons() const SIP_DEPRECATED {return mButtons;}

/**
* Determines the force suppress form popup status.
@@ -526,11 +526,13 @@ class CORE_EXPORT QgsAttributeEditorRelation : public QgsAttributeEditorElement

/**
* Returns the current relation widget type id
* \since QGIS 3.18
*/
QString relationWidgetTypeId() const;

/**
* Sets the relation widget type
* \since QGIS 3.18
*/
void setRelationWidgetTypeId( const QString &relationWidgetTypeId );

@@ -111,27 +111,29 @@ class GUI_EXPORT QgsRelationWidgetWrapper : public QgsWidgetWrapper
/**
* Defines the buttons which are shown
* \since QGIS 3.16
* \deprecated since QGIS 3.18
* \deprecated since QGIS 3.18 use setWidgetConfig() instead
*/
Q_DECL_DEPRECATED void setVisibleButtons( const QgsAttributeEditorRelation::Buttons &buttons );
Q_DECL_DEPRECATED void setVisibleButtons( const QgsAttributeEditorRelation::Buttons &buttons ) SIP_DEPRECATED;

/**
* Returns the buttons which are shown
* \since QGIS 3.16
* \deprecated since QGIS 3.18
* \deprecated since QGIS 3.18 use widgetConfig() instead
*/
Q_DECL_DEPRECATED QgsAttributeEditorRelation::Buttons visibleButtons() const;
Q_DECL_DEPRECATED QgsAttributeEditorRelation::Buttons visibleButtons() const SIP_DEPRECATED;


/**
* Will set the config of this widget wrapper to the specified config.
*
* \param config The config for this wrapper
* \since QGIS 3.18
*/
void setWidgetConfig( const QVariantMap &config );

/**
* Returns the whole widget config
* \since QGIS 3.18
*/
QVariantMap widgetConfig() const;

0 comments on commit b1dad1d

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