A browser item representing a relationship. More...
#include <qgsrelationshipsitem.h>
Inheritance diagram for QgsRelationshipItem:
Public Member Functions | |
| QgsRelationshipItem (QgsDataItem *parent, const QgsWeakRelation &relation) | |
| Constructor for QgsRelationshipItem, with the specified parent item and relation. | |
| ~QgsRelationshipItem () override | |
| QIcon | icon () override |
| const QgsWeakRelation & | relation () const |
| Returns the associated relationship. | |
 Public Member Functions inherited from QgsDataItem | |
| QgsDataItem (Qgis::BrowserItemType type, QgsDataItem *parent, const QString &name, const QString &path, const QString &providerKey=QString()) | |
| Constructor for QgsDataItem, with the specified parent item. | |
| ~QgsDataItem () override | |
| virtual Q_DECL_DEPRECATED bool | acceptDrop () |
| Returns whether the item accepts drag and dropped layers - e.g. | |
| virtual QList< QAction * > | actions (QWidget *parent) |
| Returns the list of actions available for this item. | |
| virtual void | addChildItem (QgsDataItem *child, bool refresh=false) |
| Inserts a new child item. | |
| virtual Qgis::BrowserItemCapabilities | capabilities2 () const |
| Returns the capabilities for the data item. | |
| QVector< QgsDataItem * > | children () const |
| virtual QVector< QgsDataItem * > | createChildren () |
| Create children. | |
| virtual QgsAbstractDatabaseProviderConnection * | databaseConnection () const |
| For data items that represent a DB connection or one of its children, this method returns a connection. | |
| virtual void | deleteChildItem (QgsDataItem *child) |
| Removes and deletes a child item, emitting relevant signals to the model. | |
| virtual bool | equal (const QgsDataItem *other) |
Returns true if this item is equal to another item (by testing item type and path). | |
| virtual bool | handleDoubleClick () |
| Called when a user double clicks on the item. | |
| virtual Q_DECL_DEPRECATED bool | handleDrop (const QMimeData *, Qt::DropAction) |
| Attempts to process the mime data dropped on this item. | |
| bool | hasChildren () |
| virtual bool | hasDragEnabled () const |
Returns true if the item may be dragged. | |
| virtual bool | layerCollection () const |
Returns true if the data item is a collection of layers The default implementation returns false, subclasses must implement this method if their children are layers. | |
| virtual QList< QMenu * > | menus (QWidget *parent) |
| Returns the list of menus available for this item. | |
| virtual Q_DECL_DEPRECATED QgsMimeDataUtils::Uri | mimeUri () const |
| Returns mime URI for the data item. | |
| virtual QgsMimeDataUtils::UriList | mimeUris () const |
| Returns mime URIs for the data item, most data providers will only return a single URI but some data collection items (e.g. | |
| void | moveToThread (QThread *targetThread) |
| Move object and all its descendants to thread. | |
| QString | name () const |
| Returns the name of the item (the displayed text for the item). | |
| virtual Q_DECL_DEPRECATED QWidget * | paramWidget () |
| Returns source widget from data item for QgsBrowserPropertiesWidget. | |
| QgsDataItem * | parent () const |
| Gets item parent. | |
| QString | path () const |
| QString | providerKey () const |
| Returns the provider key that created this item (e.g. | |
| virtual QgsDataItem * | removeChildItem (QgsDataItem *child) |
| Removes a child item and returns it without deleting it. | |
| virtual Q_DECL_DEPRECATED bool | rename (const QString &name) |
Sets a new name for the item, and returns true if the item was successfully renamed. | |
| int | rowCount () |
| Q_DECL_DEPRECATED void | setCapabilities (int capabilities) |
| virtual void | setCapabilities (Qgis::BrowserItemCapabilities capabilities) |
| Sets the capabilities for the data item. | |
| virtual Q_DECL_DEPRECATED bool | setCrs (const QgsCoordinateReferenceSystem &crs) |
| Writes the selected crs into data source. | |
| void | setIcon (const QIcon &icon) |
| void | setIconName (const QString &iconName) |
| void | setName (const QString &name) |
| Sets the name of the item (the displayed text for the item). | |
| void | setParent (QgsDataItem *parent) |
| Set item parent and connect / disconnect parent to / from item signals. | |
| void | setPath (const QString &path) |
| void | setProviderKey (const QString &value) |
| Sets the provider key that created this item (e.g. | |
| void | setSortKey (const QVariant &key) |
| Sets a custom sorting key for the item. | |
| virtual void | setState (Qgis::BrowserItemState state) |
| Set item state. | |
| void | setToolTip (const QString &msg) |
| virtual QVariant | sortKey () const |
| Returns the sorting key for the item. | |
| Qgis::BrowserItemState | state () const |
| QString | toolTip () const |
| Qgis::BrowserItemType | type () const |
Additional Inherited Members | |
| Public Slots inherited from QgsDataItem | |
| virtual void | childrenCreated () |
| virtual void | deleteLater () |
| Safely delete the item: | |
| virtual void | depopulate () |
| Remove children recursively and set as not populated. This is used when refreshing collapsed items. | |
| virtual void | populate (bool foreground=false) |
| virtual void | refresh () |
| virtual void | refreshConnections (const QString &providerKey=QString()) |
| Causes a data item provider to refresh all registered connections. | |
| Signals inherited from QgsDataItem | |
| void | beginInsertItems (QgsDataItem *parent, int first, int last) |
| Emitted before child items are added to this data item. | |
| void | beginRemoveItems (QgsDataItem *parent, int first, int last) |
| Emitted before child items are removed from this data item. | |
| void | connectionsChanged (const QString &providerKey=QString()) |
| Emitted when the connections of the provider with the specified providerKey have changed. | |
| void | dataChanged (QgsDataItem *item) |
| Emitted when data changes for an item. | |
| void | endInsertItems () |
| Emitted after child items have been added to this data item. | |
| void | endRemoveItems () |
| Emitted after child items have been removed from this data item. | |
| void | stateChanged (QgsDataItem *item, Qgis::BrowserItemState oldState) |
| Emitted when an item's state is changed. | |
| Static Public Member Functions inherited from QgsDataItem | |
| static void | deleteLater (QVector< QgsDataItem * > &items) |
| template<class T > | |
| static QList< T * > | filteredItems (const QList< QgsDataItem * > &items) |
| Returns a filtered list of data items which match the template type. | |
| static int | findItem (QVector< QgsDataItem * > items, QgsDataItem *item) |
| static QString | pathComponent (const QString &component) |
| Create path component replacing path separators. | |
| Protected Slots inherited from QgsDataItem | |
| void | updateIcon () |
| Will request a repaint of this icon. | |
| Protected Member Functions inherited from QgsDataItem | |
| bool | deferredDelete () |
| The item is scheduled to be deleted. | |
| virtual void | populate (const QVector< QgsDataItem * > &children) |
| virtual void | refresh (const QVector< QgsDataItem * > &children) |
| Refresh the items from a specified list of child items. | |
| Protected Attributes inherited from QgsDataItem | |
| Qgis::BrowserItemCapabilities | mCapabilities = Qgis::BrowserItemCapability::NoCapabilities |
| QVector< QgsDataItem * > | mChildren |
| QIcon | mIcon |
| QMap< QString, QIcon > | mIconMap |
| QString | mIconName |
| QString | mName |
| QgsDataItem * | mParent = nullptr |
| QString | mPath |
| QString | mProviderKey |
| QVariant | mSortKey |
| Custom sort key. If invalid, name() will be used for sorting instead. | |
| Qgis::BrowserItemState | mState = Qgis::BrowserItemState::NotPopulated |
| QString | mToolTip |
| Qgis::BrowserItemType | mType |
Detailed Description
A browser item representing a relationship.
- Since
- QGIS 3.28
Definition at line 103 of file qgsrelationshipsitem.h.
Constructor & Destructor Documentation
◆ QgsRelationshipItem()
| QgsRelationshipItem::QgsRelationshipItem | ( | QgsDataItem * | parent, |
| const QgsWeakRelation & | relation | ||
| ) |
Constructor for QgsRelationshipItem, with the specified parent item and relation.
- Note
- parent item must be a QgsRelationshipsItem.
Definition at line 103 of file qgsrelationshipsitem.cpp.
◆ ~QgsRelationshipItem()
|
overridedefault |
Member Function Documentation
◆ icon()
|
overridevirtual |
Reimplemented from QgsDataItem.
Definition at line 113 of file qgsrelationshipsitem.cpp.
◆ relation()
| const QgsWeakRelation & QgsRelationshipItem::relation | ( | ) | const |
Returns the associated relationship.
Definition at line 118 of file qgsrelationshipsitem.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/browser/qgsrelationshipsitem.h
- /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/browser/qgsrelationshipsitem.cpp
