QGIS API Documentation  2.99.0-Master (e077efd)
Public Types | Public Slots | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsDirectoryItem Class Reference

A directory: contains subdirectories and layers. More...

#include <qgsdataitem.h>

Inheritance diagram for QgsDirectoryItem:
Inheritance graph
[legend]

Public Types

enum  Column {
  Name, Size, Date, Permissions,
  Owner, Group, Type
}
 
- Public Types inherited from QgsDataItem
enum  Capability { NoCapabilities = 0, SetCrs = 1 << 0, Fertile = 1 << 1, Fast = 1 << 2 }
 
enum  State { NotPopulated, Populating, Populated }
 
enum  Type {
  Collection, Directory, Layer, Error,
  Favorites, Project
}
 

Public Slots

virtual void childrenCreated () override
 
void directoryChanged ()
 
- Public Slots inherited from QgsDataItem
virtual void childrenCreated ()
 
virtual void deleteLater ()
 Safely delete the item: More...
 
virtual void depopulate ()
 Remove children recursively and set as not populated. This is used when refreshing collapsed items. More...
 
void emitDataChanged ()
 
virtual void populate (bool foreground=false)
 
virtual void refresh ()
 

Public Member Functions

 QgsDirectoryItem (QgsDataItem *parent, const QString &name, const QString &path)
 
 QgsDirectoryItem (QgsDataItem *parent, const QString &name, const QString &dirPath, const QString &path)
 Constructor. More...
 
 ~QgsDirectoryItem ()
 
QVector< QgsDataItem * > createChildren () override
 Create children. More...
 
QString dirPath () const
 
virtual bool equal (const QgsDataItem *other) override
 Returns true if this item is equal to another item (by testing item type and path). More...
 
virtual QIcon icon () override
 
virtual QWidget * paramWidget () override
 
virtual void setState (State state) override
 Set item state. More...
 
- Public Member Functions inherited from QgsDataCollectionItem
 QgsDataCollectionItem (QgsDataItem *parent, const QString &name, const QString &path=QString::null)
 
 ~QgsDataCollectionItem ()
 
void addChild (QgsDataItem *item)
 
- Public Member Functions inherited from QgsDataItem
 QgsDataItem (QgsDataItem::Type type, QgsDataItem *parent, const QString &name, const QString &path)
 Create new data item. More...
 
virtual ~QgsDataItem ()
 
virtual bool acceptDrop ()
 Returns whether the item accepts drag and dropped layers - e.g. More...
 
virtual QList< QAction * > actions ()
 Returns the list of actions available for this item. More...
 
virtual void addChildItem (QgsDataItem *child, bool refresh=false)
 Inserts a new child item. More...
 
virtual Capabilities capabilities2 () const
 
QVector< QgsDataItem * > children () const
 
virtual void deleteChildItem (QgsDataItem *child)
 Removes and deletes a child item, emitting relevant signals to the model. More...
 
virtual bool handleDrop (const QMimeData *, Qt::DropAction)
 Attempts to process the mime data dropped on this item. More...
 
bool hasChildren ()
 
virtual bool hasDragEnabled () const
 Returns true if the item may be dragged. More...
 
virtual QgsMimeDataUtils::Uri mimeUri () const
 Return mime URI for the data item. More...
 
void moveToThread (QThread *targetThread)
 Move object and all its descendants to thread. More...
 
QString name () const
 
QgsDataItemparent () const
 Get item parent. More...
 
QString path () const
 
virtual QgsDataItemremoveChildItem (QgsDataItem *child)
 Removes a child item and returns it without deleting it. More...
 
int rowCount ()
 
virtual void setCapabilities (Capabilities capabilities)
 Sets the capabilities for the data item. More...
 
virtual bool setCrs (const QgsCoordinateReferenceSystem &crs)
 Writes the selected crs into data source. More...
 
void setIcon (const QIcon &icon)
 
void setIconName (const QString &iconName)
 
void setName (const QString &name)
 
void setParent (QgsDataItem *parent)
 Set item parent and connect / disconnect parent to / from item signals. More...
 
void setPath (const QString &path)
 
void setToolTip (const QString &msg)
 
State state () const
 
QString toolTip () const
 
Type type () const
 

Static Public Member Functions

static bool hiddenPath (const QString &path)
 Check if the given path is hidden from the browser model. More...
 
- Static Public Member Functions inherited from QgsDataCollectionItem
static const QIcon & iconDataCollection ()
 
static const QIcon & iconDir ()
 
- Static Public Member Functions inherited from QgsDataItem
static void deleteLater (QVector< QgsDataItem *> &items)
 
static int findItem (QVector< QgsDataItem *> items, QgsDataItem *item)
 
static QString pathComponent (const QString &component)
 Create path component replacing path separators. More...
 

Protected Member Functions

void init ()
 
- Protected Member Functions inherited from QgsDataItem
bool deferredDelete ()
 The item is scheduled to be deleted. More...
 
virtual void populate (const QVector< QgsDataItem *> &children)
 
virtual void refresh (const QVector< QgsDataItem *> &children)
 Refresh the items from a specified list of child items. More...
 

Protected Attributes

QString mDirPath
 
- Protected Attributes inherited from QgsDataItem
Capabilities mCapabilities
 
QVector< QgsDataItem * > mChildren
 
QIcon mIcon
 
QMap< QString, QIcon > mIconMap
 
QString mIconName
 
QString mName
 
QgsDataItemmParent
 
QString mPath
 
State mState
 
QString mToolTip
 
Type mType
 

Additional Inherited Members

- Signals inherited from QgsDataItem
void beginInsertItems (QgsDataItem *parent, int first, int last)
 
void beginRemoveItems (QgsDataItem *parent, int first, int last)
 
void dataChanged (QgsDataItem *item)
 
void endInsertItems ()
 
void endRemoveItems ()
 
void stateChanged (QgsDataItem *item, QgsDataItem::State oldState)
 

Detailed Description

A directory: contains subdirectories and layers.

Definition at line 420 of file qgsdataitem.h.

Member Enumeration Documentation

§ Column

Enumerator
Name 
Size 
Date 
Permissions 
Owner 
Group 
Type 

Definition at line 424 of file qgsdataitem.h.

Constructor & Destructor Documentation

§ QgsDirectoryItem() [1/2]

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

Definition at line 748 of file qgsdataitem.cpp.

§ QgsDirectoryItem() [2/2]

QgsDirectoryItem::QgsDirectoryItem ( QgsDataItem parent,
const QString &  name,
const QString &  dirPath,
const QString &  path 
)

Constructor.

Parameters
parent
namedirectory name
dirPathpath to directory in file system
pathitem path in the tree, it may be dirPath or dirPath with some prefix, e.g. favorites:

Definition at line 758 of file qgsdataitem.cpp.

§ ~QgsDirectoryItem()

QgsDirectoryItem::~QgsDirectoryItem ( )

Definition at line 772 of file qgsdataitem.cpp.

Member Function Documentation

§ childrenCreated

void QgsDirectoryItem::childrenCreated ( )
overridevirtualslot

Definition at line 908 of file qgsdataitem.cpp.

§ createChildren()

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

Create children.

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

Reimplemented from QgsDataItem.

Definition at line 784 of file qgsdataitem.cpp.

§ directoryChanged

void QgsDirectoryItem::directoryChanged ( )
slot

Definition at line 886 of file qgsdataitem.cpp.

§ dirPath()

QString QgsDirectoryItem::dirPath ( ) const
inline

Definition at line 449 of file qgsdataitem.h.

§ equal()

bool QgsDirectoryItem::equal ( const QgsDataItem other)
overridevirtual

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

Reimplemented from QgsDataItem.

Definition at line 925 of file qgsdataitem.cpp.

§ hiddenPath()

bool QgsDirectoryItem::hiddenPath ( const QString &  path)
static

Check if the given path is hidden from the browser model.

Definition at line 899 of file qgsdataitem.cpp.

§ icon()

QIcon QgsDirectoryItem::icon ( )
overridevirtual

Reimplemented from QgsDataItem.

Definition at line 776 of file qgsdataitem.cpp.

§ init()

void QgsDirectoryItem::init ( )
protected

Definition at line 768 of file qgsdataitem.cpp.

§ paramWidget()

QWidget * QgsDirectoryItem::paramWidget ( )
overridevirtual

Reimplemented from QgsDataItem.

Definition at line 935 of file qgsdataitem.cpp.

§ setState()

void QgsDirectoryItem::setState ( State  state)
overridevirtual

Set item state.

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

Parameters
state
Note
added in 2.8

Reimplemented from QgsDataItem.

Definition at line 863 of file qgsdataitem.cpp.

Member Data Documentation

§ mDirPath

QString QgsDirectoryItem::mDirPath
protected

Definition at line 463 of file qgsdataitem.h.


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