Class: QgsDataItem

class qgis.core.QgsDataItem(type: QgsDataItem.Type, parent: QgsDataItem, name: str, path: str)

Bases: PyQt5.QtCore.QObject

Create new data item.

Base class for all items in the model. Parent/children hierarchy is not based on QObject.

Parameters
class Capabilities

Bases: sip.wrapper

QgsDataItem.Capabilities(Union[QgsDataItem.Capabilities, QgsDataItem.Capability]) QgsDataItem.Capabilities(QgsDataItem.Capabilities)

class Capability

Bases: int

Collapse = 8
Collection = 0
Custom = 6
Delete = 32
Directory = 1
Error = 3
Fast = 4
Favorites = 4
Fertile = 2
Layer = 2
NoCapabilities = 0
NotPopulated = 0
Populated = 2
Populating = 1
Project = 5
Rename = 16
SetCrs = 1
class State

Bases: int

baseClass

alias of QgsDataItem

class Type

Bases: int

baseClass

alias of QgsDataItem

acceptDrop(self) → bool

Returns whether the item accepts drag and dropped layers - e.g. for importing a dataset to a provider. Subclasses should override this and handleDrop() to accept dropped layers.

See also

handleDrop()

See also

QgsDataItemGuiProvider.handleDrop()

Deprecated since version QGIS: 3.10

Return type

bool

actions(self, parent: QWidget) → List[QAction]

Returns the list of actions available for this item. This is usually used for the popup menu on right-clicking the item. Subclasses should override this to provide actions.

Subclasses should ensure that ownership of created actions is correctly handled by parenting them to the specified parent widget.

Parameters

parent (QWidget) –

Return type

List[QAction]

addChildItem(self, child: QgsDataItem, refresh: bool = False)

Inserts a new child item. The child will be inserted at a position using an alphabetical order based on mName.

Parameters
  • child (QgsDataItem) – child item to insert. Ownership is transferred, and item parent will be set and relevant connections made.

  • refresh (bool = False) –

    • set to True to refresh populated item, emitting relevant signals to the model

beginInsertItems

beginInsertItems(self, parent: QgsDataItem, first: int, last: int) [signal]

Parameters
  • parent (QgsDataItem) –

  • first (int) –

  • last (int) –

beginRemoveItems

beginRemoveItems(self, parent: QgsDataItem, first: int, last: int) [signal]

Parameters
  • parent (QgsDataItem) –

  • first (int) –

  • last (int) –

capabilities2(self) → QgsDataItem.Capabilities

Returns the capabilities for the data item.

Return type

QgsDataItem.Capabilities

childEvent()
children(self) → object
Return type

object

childrenCreated(self)
connectNotify()
connectionsChanged

Emitted when the provider’s connections of the child items have changed This signal is normally forwarded to the app in order to refresh the connection item in the provider dialogs and to refresh the connection items in the other open browsers [signal]

createChildren(self) → object

Create children. Children are not expected to have parent set. This method MUST BE THREAD SAFE. *

Return type

object

customEvent()
dataChanged

dataChanged(self, item: QgsDataItem) [signal]

Parameters

item (QgsDataItem) –

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), the deferredDelete() returns True and item will be deleted once Populating finished. Items with slow reateChildren() (for example network or database based) may check during createChildren() if deferredDelete() returns True and return from createChildren() immediately because result will be useless. *

Return type

bool

deleteChildItem(self, child: QgsDataItem)

Removes and deletes a child item, emitting relevant signals to the model.

Parameters

child (QgsDataItem) – child to remove. Item must exist as a current child.

See also

addChildItem()

deleteLater(items: object)

deleteLater(self) Safely delete the item: - disconnects parent - unsets parent (but does not remove itself) - deletes all its descendants recursively - waits until Populating state (createChildren() in thread) finished without blocking main thread - calls QObject.deleteLater()

Parameters

items (object) –

depopulate(self)

Remove children recursively and set as not populated. This is used when refreshing collapsed items.

disconnectNotify()
endInsertItems

endInsertItems(self) [signal]

endRemoveItems

endRemoveItems(self) [signal]

equal(self, other: QgsDataItem) → bool

Returns True if this item is equal to another item (by testing item type and path).

Parameters

other (QgsDataItem) –

Return type

bool

findItem(items: object, item: QgsDataItem) → int
Parameters
Return type

int

handleDoubleClick(self) → bool

Called when a user double clicks on the item. Subclasses should return True if they have implemented a double-click handler and do not want the default double-click behavior for items.

New in version 3.0.

Return type

bool

handleDrop(self, QMimeData, Qt.DropAction) → bool

Attempts to process the mime data dropped on this item. Subclasses must override this and acceptDrop() if they accept dropped layers.

See also

acceptDrop()

See also

QgsDataItemGuiProvider.handleDrop()

Deprecated since version QGIS: 3.10

Return type

bool

hasChildren(self) → bool
Return type

bool

hasDragEnabled(self) → bool

Returns True if the item may be dragged. Default implementation returns False. A draggable item has to implement mimeUri() that will be used to pass data.

See also

mimeUri()

New in version 3.0.

Return type

bool

icon(self) → QIcon
Return type

QIcon

isSignalConnected()
menus(self, parent: QWidget) → List[QMenu]

Returns the list of menus available for this item. This is usually used for the popup menu on right-clicking the item. Subclasses should override this to provide actions. Subclasses should ensure that ownership of created menus is correctly handled by parenting them to the specified parent widget.

Parameters

parent (QWidget) – a parent widget of the menu

Return type

List[QMenu]

Returns

list of menus

New in version 3.0.

mimeUri(self) → QgsMimeDataUtils.Uri

Returns mime URI for the data item. Items that return valid URI will be returned in mime data when dragging a selection from browser model.

See also

hasDragEnabled()

New in version 3.0.

Return type

QgsMimeDataUtils.Uri

moveToThread(self, targetThread: QThread)

Move object and all its descendants to thread

Parameters

targetThread (QThread) –

name(self) → str

Returns the name of the item (the displayed text for the item).

See also

setName()

Return type

str

paramWidget(self) → QWidget

Returns source widget from data item for QgsBrowserPropertiesWidget

Use QgsDataItemGuiProvider.createParamWidget() instead

Deprecated since version QGIS: 3.10

Return type

QWidget

parent(self) → QgsDataItem

Gets item parent. QgsDataItem maintains its own items hierarchy, it does not use QObject hierarchy. *

Return type

QgsDataItem

path(self) → str
Return type

str

pathComponent(component: str) → str

Create path component replacing path separators

Parameters

component (str) –

Return type

str

populate(self, children: object)

populate(self, foreground: bool = False)

Parameters

children (object) –

receivers()
refresh(self, children: object)

Refresh the items from a specified list of child items.

refresh(self)

Parameters

children (object) –

refreshConnections(self)

Refresh connections: update GUI and emit signal

removeChildItem(self, child: QgsDataItem) → QgsDataItem

Removes a child item and returns it without deleting it. Emits relevant signals to model as required.

Parameters

child (QgsDataItem) – child to remove

Return type

QgsDataItem

Returns

pointer to the removed item or None if no such item was found

rename(self, name: str) → bool

Sets a new name for the item, and returns True if the item was successfully renamed.

Items which implement this method should return the QgsDataItem.Rename capability.

The default implementation does nothing.

Use QgsDataItemGuiProvider:

New in version 3.4.

Deprecated since version QGIS: 3.10

Parameters

name (str) –

Return type

bool

rowCount(self) → int
Return type

int

sender()
senderSignalIndex()
setCapabilities(self, capabilities: Union[QgsDataItem.Capabilities, QgsDataItem.Capability])

Sets the capabilities for the data item.

See also

capabilities2()

Parameters

capabilities (Union[QgsDataItem.Capabilities) –

setCrs(self, crs: QgsCoordinateReferenceSystem) → bool

Writes the selected crs into data source. The original data source will be modified when calling this method.

Deprecated since version QGIS: 3.6. This method is no longer used by QGIS and will be removed in QGIS 4.0.

Parameters

crs (QgsCoordinateReferenceSystem) –

Return type

bool

setIcon(self, icon: QIcon)
Parameters

icon (QIcon) –

setIconName(self, iconName: str)
Parameters

iconName (str) –

setName(self, name: str)

Sets the name of the item (the displayed text for the item).

See also

name()

Parameters

name (str) –

setParent(self, parent: QgsDataItem)

Set item parent and connect / disconnect parent to / from item signals. It does not add itself to parents children (mChildren) *

Parameters

parent (QgsDataItem) –

setPath(self, path: str)
Parameters

path (str) –

setSortKey(self, key: Any)

Sets a custom sorting key for the item.

See also

sortKey()

New in version 3.0.

Parameters

key (Any) –

setState(self, state: QgsDataItem.State)

Set item state. It also take care about starting/stopping loading icon animation.

Parameters

state (QgsDataItem.State) –

New in version 2.8.

setToolTip(self, msg: str)
Parameters

msg (str) –

sortKey(self) → Any

Returns the sorting key for the item. By default name() is returned, but setSortKey() can be used to set a custom sort key for the item.

Alternatively subclasses can override this method to return a custom sort key.

See also

setSortKey()

New in version 3.0.

Return type

Any

state(self) → QgsDataItem.State

New in version 2.8.

Return type

QgsDataItem.State

stateChanged

stateChanged(self, item: QgsDataItem, oldState: QgsDataItem.State) [signal]

Parameters
timerEvent()
toolTip(self) → str
Return type

str

type(self) → QgsDataItem.Type
Return type

QgsDataItem.Type

updateIcon(self)

Will request a repaint of this icon.

New in version 3.0.