Class: QgsCptCityDataItem

Base class for all items in a QgsCptCityBrowserModel model.

Class Hierarchy

Base classes

QObject

Subclasses

QgsCptCityCollectionItem	A logical collection of subcollections and color ramps for use in QgsCptCityBrowserModel.
QgsCptCityColorRampItem	An item that represents a layer that can be opened with one of the providers for a QgsCptCityBrowserModel.

class qgis.core.QgsCptCityDataItem

Bases: QObject

AllRamps = 4

Collection = 1

ColorRamp = 0

Directory = 2

Selection = 3

class Type

Bases: int

virtual acceptDrop(self) → bool

Returns True if the item accepts drag & dropped layers - e.g. for import.

Deprecated since version 3.40: Is unused and will be removed in QGIS 4.0.

Return type:

bool

virtual addChildItem(self, child: QgsCptCityDataItem | None, refresh: bool = False)

Inserts a new child using alphabetical order based on mName, emits necessary signal to model before and after, sets parent and connects signals.

The refresh argument will refresh the populated item by emitting signals to the model.

Parameters:

• child (Optional[QgsCptCityDataItem])

• refresh (bool = False)

signal beginInsertItems

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal beginRemoveItems

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

virtual createChildren(self) → List[QgsCptCityDataItem]

Returns a vector of children items.

Return type:

List[QgsCptCityDataItem]

virtual deleteChildItem(self, child: QgsCptCityDataItem | None)

Removes and deletes a child item, signals to browser are emitted.

Parameters:

child (Optional[QgsCptCityDataItem])

signal endInsertItems

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal endRemoveItems

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

virtual equal(self, other: QgsCptCityDataItem | None) → bool

Returns True if this item is equal to an other item.

Parameters:

other (Optional[QgsCptCityDataItem])

Return type:

bool

static findItem(items: Iterable[QgsCptCityDataItem], item: QgsCptCityDataItem | None) → int

Finds a child index in vector of items using ‘==’ operator.

Parameters:

• items (Iterable[QgsCptCityDataItem])

• item (Optional[QgsCptCityDataItem])

Return type:

int

virtual handleDrop(self, data: QMimeData | None, action: Qt.DropAction) → bool

Tries to process the data dropped on this item.

Deprecated since version 3.40: Is unused and will be removed in QGIS 4.0.

Parameters:

• data (Optional[QMimeData])

• action (Qt.DropAction)

Return type:

bool

hasChildren(self) → bool

Return type:

bool

virtual icon(self) → QIcon

virtual icon(self, size: QSize) → QIcon

Return type:

QIcon

info(self) → str

Return type:

str

isPopulated(self) → bool

Returns True if the item is already populated.

Return type:

bool

isValid(self) → bool

Return type:

bool

virtual leafCount(self) → int

Returns the total count of “leaf” items (all children which are end nodes).

Return type:

int

name(self) → str

Return type:

str

virtual paramWidget(self) → QWidget | None

Deprecated since version 3.40.

Is unused and will be removed in QGIS 4.0.

Return type:

Optional[QWidget]

path(self) → str

Return type:

str

virtual populate(self)

Populates children using children vector created by createChildren().

virtual refresh(self)

virtual removeChildItem(self, child: QgsCptCityDataItem | None) → QgsCptCityDataItem | None

Removes a child item but doesn’t delete it, signals to browser are emitted.

Return type:

Optional[QgsCptCityDataItem]

Returns:

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

Parameters:

child (Optional[QgsCptCityDataItem])

rowCount(self) → int

Return type:

int

setIcon(self, icon: QIcon)

Parameters:

icon (QIcon)

setToolTip(self, msg: str | None)

Parameters:

msg (Optional[str])

shortInfo(self) → str

Return type:

str

toolTip(self) → str

Return type:

str

type(self) → QgsCptCityDataItem.Type

Return type:

QgsCptCityDataItem.Type