QGIS API Documentation 3.39.0-Master (67e056379ed)
Loading...
Searching...
No Matches
Signals | Public Member Functions | List of all members
QgsDbRelationWidget Class Reference

A widget for configuration of the properties of a relationship in a database. More...

#include <qgsdbrelationshipwidget.h>

Inheritance diagram for QgsDbRelationWidget:
Inheritance graph
[legend]

Signals

void validityChanged (bool isValid)
 Emitted whenever the validity of the relationship configuration in the widget changes.
 

Public Member Functions

 QgsDbRelationWidget (QgsAbstractDatabaseProviderConnection *connection, QWidget *parent=nullptr)
 Constructor for QgsDbRelationWidget with the specified parent widget, for the specified connection.
 
bool isValid () const
 Returns true if the widget currently represents a valid relationship configuration.
 
QgsWeakRelation relationship () const
 Returns the relationship as defined in the widget.
 
void setRelationship (const QgsWeakRelation &relationship)
 Sets the current relationship to show properties for in the widget.
 

Detailed Description

A widget for configuration of the properties of a relationship in a database.

Since
QGIS 3.30

Definition at line 37 of file qgsdbrelationshipwidget.h.

Constructor & Destructor Documentation

◆ QgsDbRelationWidget()

QgsDbRelationWidget::QgsDbRelationWidget ( QgsAbstractDatabaseProviderConnection connection,
QWidget *  parent = nullptr 
)

Constructor for QgsDbRelationWidget with the specified parent widget, for the specified connection.

Ownership of connection is transferred to the widget.

Definition at line 28 of file qgsdbrelationshipwidget.cpp.

Member Function Documentation

◆ isValid()

bool QgsDbRelationWidget::isValid ( ) const

Returns true if the widget currently represents a valid relationship configuration.

See also
validityChanged()

Definition at line 170 of file qgsdbrelationshipwidget.cpp.

◆ relationship()

QgsWeakRelation QgsDbRelationWidget::relationship ( ) const

Returns the relationship as defined in the widget.

See also
setRelationship()

Definition at line 141 of file qgsdbrelationshipwidget.cpp.

◆ setRelationship()

void QgsDbRelationWidget::setRelationship ( const QgsWeakRelation relationship)

Sets the current relationship to show properties for in the widget.

See also
relationship()

Definition at line 121 of file qgsdbrelationshipwidget.cpp.

◆ validityChanged

void QgsDbRelationWidget::validityChanged ( bool  isValid)
signal

Emitted whenever the validity of the relationship configuration in the widget changes.

See also
isValid()

The documentation for this class was generated from the following files: