qgsdirectoryitem.h

Go to the documentation of this file.

/***************************************************************************
                             qgsddirectoryitem.h
                             -------------------
    begin                : 2011-04-01
    copyright            : (C) 2011 Radim Blazek
    email                : radim dot blazek at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSDIRECTORYITEM_H
#define QGSDIRECTORYITEM_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsdatacollectionitem.h"
 
#include <QDateTime>
#include <QString>
#include <QTreeWidget>
 
using namespace Qt::StringLiterals;
 
class QFileSystemWatcher;
class QMouseEvent;
class QgsSettingsEntryBool;
class QgsSettingsEntryInteger;
class QgsSettingsEntryString;
class QgsSettingsEntryStringList;
class QgsSettingsEntryVariant;

class CORE_EXPORT QgsDirectoryItem : public QgsDataCollectionItem
{
    Q_OBJECT
  public:
    QgsDirectoryItem( QgsDataItem *parent SIP_TRANSFERTHIS, const QString &name, const QString &path );
 
 
    // TODO QGIS 5.0 -- rename "name" to "title" or "text" or something more descriptive, and "path" to something
    // else to clarify the role of dirPath vs path

    QgsDirectoryItem( QgsDataItem *parent SIP_TRANSFERTHIS, const QString &name, const QString &dirPath, const QString &path, const QString &providerKey = QString() );
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsDirectoryItem: %1 - %2>"_s.arg( sipCpp->dirPath(), sipCpp->path() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
      void setState( Qgis::BrowserItemState state ) override;
 
    QVector<QgsDataItem *> createChildren() override;

    QString dirPath() const { return mDirPath; }
 
    bool equal( const QgsDataItem *other ) override;
    QIcon icon() override;

    QColor iconColor() const;

    void setIconColor( const QColor &color );

    static void setCustomColor( const QString &directory, const QColor &color );

    Q_DECL_DEPRECATED QWidget *paramWidget() override SIP_FACTORY SIP_DEPRECATED;
    bool hasDragEnabled() const override { return true; }
    QgsMimeDataUtils::UriList mimeUris() const override;

    static bool hiddenPath( const QString &path );

    static Qgis::BrowserDirectoryMonitoring monitoringForPath( const QString &path );

    static bool pathShouldByMonitoredByDefault( const QString &path );
 
#ifndef SIP_RUN
 
    static const QgsSettingsEntryBool *settingsMonitorDirectoriesInBrowser;
 
    static const QgsSettingsEntryStringList *settingsHiddenPaths SIP_SKIP;
 
    static const QgsSettingsEntryStringList *settingsDisableMonitorItemUris SIP_SKIP;
 
    static const QgsSettingsEntryStringList *settingsAlwaysMonitorItemUris SIP_SKIP;
 
    static const QgsSettingsEntryInteger *settingsMinScanInterval SIP_SKIP;
 
    static const QgsSettingsEntryString *settingsCustomPathColor SIP_SKIP;
#endif

    bool isMonitored() const { return mMonitored; }

    Qgis::BrowserDirectoryMonitoring monitoring() const;

    void setMonitoring( Qgis::BrowserDirectoryMonitoring monitoring );

    void reevaluateMonitoring() SIP_SKIP;
 
  public slots:
    void childrenCreated() override;
    void directoryChanged();
 
  protected:
    QString mDirPath;
 
  private:
    void init( const QString &dirName );
 
    void createOrDestroyFileSystemWatcher();
 
    Qgis::BrowserDirectoryMonitoring mMonitoring = Qgis::BrowserDirectoryMonitoring::Default;
    bool mMonitored = true;
    QFileSystemWatcher *mFileSystemWatcher = nullptr;
    bool mRefreshLater = false;
    QDateTime mLastScan;
    QColor mIconColor;
 
    bool mIsDir = false;
    bool mIsSymLink = false;
 
    friend class TestQgsDataItem;
};
 
// ---------
 
// TODO: move to qgis_gui for QGIS 5

class CORE_EXPORT QgsDirectoryParamWidget : public QTreeWidget
{
    Q_OBJECT
 
  public:
    static const QgsSettingsEntryVariant *settingsDirectoryHiddenColumns SIP_SKIP;
 
    QgsDirectoryParamWidget( const QString &path, QWidget *parent SIP_TRANSFERTHIS = nullptr );
 
  protected:
    void mousePressEvent( QMouseEvent *event ) override;
 
  public slots:
    void showHideColumn();
};
 
 
#ifndef SIP_RUN

class CORE_EXPORT QgsProjectHomeItem : public QgsDirectoryItem
{
    Q_OBJECT
 
  public:
    QgsProjectHomeItem( QgsDataItem *parent, const QString &name, const QString &dirPath, const QString &path );
 
    QIcon icon() override;
    QVariant sortKey() const override;
};
 
#endif
 
#endif // QGSDATAITEM_H