QGIS/python/gui/auto_generated/qgsrelationeditorwidget.sip.in
Alessandro Pasotti e3b65a4f0e Sipify
2020-03-31 14:23:55 +10:00

178 lines
4.6 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsrelationeditorwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
%ModuleHeaderCode
// fix to allow compilation with sip that for some reason
// doesn't add this include to the file where the code from
// ConvertToSubClassCode goes.
#include <qgsrelationeditorwidget.h>
%End
class QgsRelationEditorWidget : QgsCollapsibleGroupBox
{
%TypeHeaderCode
#include "qgsrelationeditorwidget.h"
%End
%ConvertToSubClassCode
if ( qobject_cast<QgsRelationEditorWidget *>( sipCpp ) )
sipType = sipType_QgsRelationEditorWidget;
else
sipType = NULL;
%End
public:
QgsRelationEditorWidget( QWidget *parent /TransferThis/ = 0 );
%Docstring
:param parent: parent widget
%End
void setViewMode( QgsDualView::ViewMode mode );
%Docstring
Define the view mode for the dual view
%End
QgsDualView::ViewMode viewMode();
%Docstring
Gets the view mode for the dual view
%End
void setRelationFeature( const QgsRelation &relation, const QgsFeature &feature );
%Docstring
Sets the ``relation`` and the ``feature``
%End
void setRelations( const QgsRelation &relation, const QgsRelation &nmrelation );
%Docstring
Set the relation(s) for this widget
If only one relation is set, it will act as a simple 1:N relation widget
If both relations are set, it will act as an N:M relation widget
inserting and deleting entries on the intermediate table as required.
:param relation: Relation referencing the edited table
:param nmrelation: Optional reference from the referencing table to a 3rd N:M table
%End
void setFeature( const QgsFeature &feature, bool update = true );
%Docstring
Sets the ``feature`` being edited and updates the UI unless ``update`` is set to ``False``
%End
void setEditorContext( const QgsAttributeEditorContext &context );
%Docstring
Sets the editor ``context``
.. note::
if context cadDockWidget is null, it won't be possible to digitize
the geometry of a referencing feature from this widget
%End
QgsAttributeEditorContext editorContext( ) const;
%Docstring
Returns the attribute editor context.
.. versionadded:: 3.14
%End
QgsIFeatureSelectionManager *featureSelectionManager();
%Docstring
The feature selection manager is responsible for the selected features
which are currently being edited.
%End
bool showLabel() const;
%Docstring
Defines if a title label should be shown for this widget.
.. versionadded:: 2.18
%End
void setShowLabel( bool showLabel );
%Docstring
Defines if a title label should be shown for this widget.
.. versionadded:: 2.18
%End
bool showLinkButton() const;
%Docstring
Determines if the "link feature" button should be shown
.. versionadded:: 2.18
%End
void setShowLinkButton( bool showLinkButton );
%Docstring
Determines if the "link feature" button should be shown
.. versionadded:: 2.18
%End
bool showUnlinkButton() const;
%Docstring
Determines if the "unlink feature" button should be shown
.. versionadded:: 2.18
%End
void setShowUnlinkButton( bool showUnlinkButton );
%Docstring
Determines if the "unlink feature" button should be shown
.. versionadded:: 2.18
%End
void setShowSaveChildEditsButton( bool showChildEdits );
%Docstring
Determines if the "Save child layer edits" button should be shown
.. versionadded:: 3.14
%End
bool showSaveChildEditsButton() const;
%Docstring
Determines if the "Save child layer edits" button should be shown
.. versionadded:: 3.14
%End
QgsFeature feature() const;
%Docstring
Returns the widget's current feature
.. versionadded:: 3.14
%End
public slots:
void parentFormValueChanged( const QString &attribute, const QVariant &newValue );
%Docstring
Called when an ``attribute`` value in the parent widget has changed to ``newValue``
.. versionadded:: 3.14
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/qgsrelationeditorwidget.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/