Class: QgsRelationshipsItem¶
- class qgis.core.QgsRelationshipsItem¶
Bases:
QgsDataItem
Contains a collection of relationship items.
New in version 3.28.
QgsRelationshipsItem(parent:
QgsDataItem
, path: str, connectionUri: str, providerKey: str, schema: str = ‘’, tableName: str = ‘’) Constructor forQgsRelationshipsItem
, with the specifiedparent
item.The
path
argument gives the item path in the browser tree. Thepath
string can take any form, butQgsDataItem
items pointing to different logical locations should always use a different itempath
. TheconnectionUri
argument is the connection part of the layer URI that it is used internally to create a connection and retrieve fields information. TheproviderKey
string can be used to specify the key for theQgsDataItemProvider
that created this item.The optional
schema
andtableName
arguments can be used to restrict the visible relationships to those with a matching parent table.Methods
Returns the connection URI
- rtype:
List[QgsDataItem]
The item is scheduled to be deleted.
- rtype:
QIcon
Refresh the items from a specified list of child items.
Returns the schema for filtering relationships, if set.
Returns the table name for filtering relationships, if set.
Will request a repaint of this icon.
- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- connectionUri(self) str ¶
Returns the connection URI
- Return type:
str
- createChildren(self) List[QgsDataItem] ¶
- Return type:
List[QgsDataItem]
- customEvent(self, QEvent)¶
- deferredDelete(self) bool ¶
The item is scheduled to be deleted. E.g. if
deleteLater()
is called when item is in Populating state (createChildren()
running in another thread), thedeferredDelete()
returnsTrue
and item will be deleted once Populating finished. Items with slowreateChildren()
(for example network or database based) may check duringcreateChildren()
ifdeferredDelete()
returnsTrue
and return fromcreateChildren()
immediately because result will be useless.
- disconnectNotify(self, QMetaMethod)¶
- icon(self) QIcon ¶
- Return type:
QIcon
- isSignalConnected(self, QMetaMethod) bool ¶
- populate(self, children: Iterable[QgsDataItem])¶
- populate(self, foreground: bool = False) None
- receivers(self, PYQT_SIGNAL) int ¶
- refresh(self, children: Iterable[QgsDataItem])¶
Refresh the items from a specified list of child items.
refresh(self)
- schema(self) str ¶
Returns the schema for filtering relationships, if set.
See also
- Return type:
str
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- tableName(self) str ¶
Returns the table name for filtering relationships, if set.
See also
- Return type:
str
- timerEvent(self, QTimerEvent)¶
- updateIcon(self)¶
Will request a repaint of this icon.
New in version 3.0.