QGIS API Documentation 3.41.0-Master (181b2f43d8e)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
QgsZipItem Class Reference

A zip file: contains layers, using GDAL/OGR VSIFILE mechanism. More...

#include <qgszipitem.h>

Inheritance diagram for QgsZipItem:
Inheritance graph
[legend]

Public Member Functions

 QgsZipItem (QgsDataItem *parent, const QString &name, const QString &filePath, const QString &path, const QString &providerKey=QString())
 Constructor.
 
 QgsZipItem (QgsDataItem *parent, const QString &name, const QString &path)
 Constructor.
 
QVector< QgsDataItem * > createChildren () override
 Create children.
 
QStringList getZipFileList ()
 
bool hasDragEnabled () const override
 Returns true if the item may be dragged.
 
QgsMimeDataUtils::UriList mimeUris () const override
 Returns mime URIs for the data item, most data providers will only return a single URI but some data collection items (e.g.
 
- Public Member Functions inherited from QgsDataCollectionItem
 QgsDataCollectionItem (QgsDataItem *parent, const QString &name, const QString &path=QString(), const QString &providerKey=QString())
 Constructor for QgsDataCollectionItem, with the specified parent item.
 
 ~QgsDataCollectionItem () override
 
void addChild (QgsDataItem *item)
 
QgsAbstractDatabaseProviderConnectiondatabaseConnection () const override
 For data items that represent a DB connection or one of its children, this method returns a connection.
 
- 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 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 QIcon icon ()
 
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.
 
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.
 
QgsDataItemparent () const
 Gets item parent.
 
QString path () const
 
QString providerKey () const
 Returns the provider key that created this item (e.g.
 
virtual QgsDataItemremoveChildItem (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
 

Static Public Member Functions

static QIcon iconZip ()
 
static QgsDataItemitemFromPath (QgsDataItem *parent, const QString &filePath, const QString &name, const QString &path)
 Creates a new data item from the specified path.
 
static QgsDataItemitemFromPath (QgsDataItem *parent, const QString &path, const QString &name)
 Creates a new data item from the specified path.
 
static Q_DECL_DEPRECATED QString vsiPrefix (const QString &uri)
 
- Static Public Member Functions inherited from QgsDataCollectionItem
static QIcon iconDataCollection ()
 Returns the standard browser data collection icon.
 
static QIcon iconDir (const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
 Returns the standard browser directory icon.
 
- 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.
 

Static Public Attributes

static QVector< dataItem_t * > sDataItemPtr
 
static QStringList sProviderNames = QStringList()
 

Protected Attributes

QString mFilePath
 
QString mVsiPrefix
 
QStringList mZipFileList
 
- Protected Attributes inherited from QgsDataItem
Qgis::BrowserItemCapabilities mCapabilities = Qgis::BrowserItemCapability::NoCapabilities
 
QVector< QgsDataItem * > mChildren
 
QIcon mIcon
 
QMap< QString, QIcon > mIconMap
 
QString mIconName
 
QString mName
 
QgsDataItemmParent = 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
 

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.
 
- 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.
 
- Static Protected Member Functions inherited from QgsDataCollectionItem
static QIcon homeDirIcon (const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
 Shared home directory icon.
 
static QIcon openDirIcon (const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
 Shared open directory icon.
 

Detailed Description

A zip file: contains layers, using GDAL/OGR VSIFILE mechanism.

Definition at line 29 of file qgszipitem.h.

Constructor & Destructor Documentation

◆ QgsZipItem() [1/2]

QgsZipItem::QgsZipItem ( QgsDataItem parent,
const QString &  name,
const QString &  path 
)

Constructor.

Definition at line 42 of file qgszipitem.cpp.

◆ QgsZipItem() [2/2]

QgsZipItem::QgsZipItem ( QgsDataItem parent,
const QString &  name,
const QString &  filePath,
const QString &  path,
const QString &  providerKey = QString() 
)

Constructor.

Definition at line 49 of file qgszipitem.cpp.

Member Function Documentation

◆ createChildren()

QVector< QgsDataItem * > QgsZipItem::createChildren ( )
overridevirtual

Create children.

Children are not expected to have parent set.

Warning
This method MUST BE THREAD SAFE.

Reimplemented from QgsDataItem.

Definition at line 92 of file qgszipitem.cpp.

◆ getZipFileList()

QStringList QgsZipItem::getZipFileList ( )

Definition at line 216 of file qgszipitem.cpp.

◆ hasDragEnabled()

bool QgsZipItem::hasDragEnabled ( ) const
overridevirtual

Returns true if the item may be dragged.

Default implementation returns false. A draggable item has to implement mimeUris() that will be used to pass data.

See also
mimeUris()

Reimplemented from QgsDataItem.

Definition at line 73 of file qgszipitem.cpp.

◆ iconZip()

QIcon QgsZipItem::iconZip ( )
static

Definition at line 32 of file qgszipitem.cpp.

◆ itemFromPath() [1/2]

QgsDataItem * QgsZipItem::itemFromPath ( QgsDataItem parent,
const QString &  filePath,
const QString &  name,
const QString &  path 
)
static

Creates a new data item from the specified path.

Note
available in Python as itemFromFilePath

Definition at line 164 of file qgszipitem.cpp.

◆ itemFromPath() [2/2]

QgsDataItem * QgsZipItem::itemFromPath ( QgsDataItem parent,
const QString &  path,
const QString &  name 
)
static

Creates a new data item from the specified path.

Definition at line 159 of file qgszipitem.cpp.

◆ mimeUris()

QgsMimeDataUtils::UriList QgsZipItem::mimeUris ( ) const
overridevirtual

Returns mime URIs for the data item, most data providers will only return a single URI but some data collection items (e.g.

GPKG, OGR) may report multiple URIs (e.g. for vector and raster layer types).

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

Since
QGIS 3.18

Reimplemented from QgsDataItem.

Definition at line 78 of file qgszipitem.cpp.

◆ vsiPrefix()

QString QgsZipItem::vsiPrefix ( const QString &  uri)
static
Deprecated:
QGIS 3.40. Will be removed in QGIS 4.0.

Definition at line 87 of file qgszipitem.cpp.

Member Data Documentation

◆ mFilePath

QString QgsZipItem::mFilePath
protected

Definition at line 34 of file qgszipitem.h.

◆ mVsiPrefix

QString QgsZipItem::mVsiPrefix
protected

Definition at line 35 of file qgszipitem.h.

◆ mZipFileList

QStringList QgsZipItem::mZipFileList
protected

Definition at line 36 of file qgszipitem.h.

◆ sDataItemPtr

QVector<dataItem_t *> QgsZipItem::sDataItemPtr
static
Note
not available via Python bindings

Definition at line 60 of file qgszipitem.h.

◆ sProviderNames

QStringList QgsZipItem::sProviderNames = QStringList()
static

Definition at line 61 of file qgszipitem.h.


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