qgsfavoritesitem.h

Go to the documentation of this file.

/***************************************************************************
                            qgsfavoritesitem.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 QGSFAVORITESITEM_H
#define QGSFAVORITESITEM_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsdatacollectionitem.h"
#include "qgsdirectoryitem.h"
#include "qgssettingstree.h"
 
#include <QString>
 
class QgsSettingsEntryStringList;
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsFavoritesItem : public QgsDataCollectionItem
{
    Q_OBJECT
  public:
#ifndef SIP_RUN
    static inline QgsSettingsTreeNode *sTreeBrowser = QgsSettingsTree::treeRoot()->createChildNode( u"browser"_s );
    static const QgsSettingsEntryStringList *settingsFavoriteDirs;
#endif

    QgsFavoritesItem( QgsDataItem *parent, const QString &name, const QString &path = QString() );
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsFavoritesItem: \"%1\">"_s.arg( sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
        QVector<QgsDataItem *> createChildren() override;

    void addDirectory( const QString &directory, const QString &name = QString() );

    void removeDirectory( QgsDirectoryItem *item );

    void renameFavorite( const QString &path, const QString &name );

    static QIcon iconFavorites();
 
    QVariant sortKey() const override;
 
  private:
    QVector<QgsDataItem *> createChildren( const QString &directory, const QString &name );
};
 
#ifndef SIP_RUN

Q_NOWARN_DEPRECATED_PUSH // rename is deprecated
  class CORE_EXPORT QgsFavoriteItem : public QgsDirectoryItem
{
    Q_OBJECT
 
  public:
    QgsFavoriteItem( QgsFavoritesItem *parent, const QString &name, const QString &dirPath, const QString &path );
 
    // TODO QGIS 5.0 - don't remove this method when the deprecated base class virtual method is removed, but instead
    // remove the override!

    bool rename( const QString &name ) override;
 
  private:
    QgsFavoritesItem *mFavorites = nullptr;
};
Q_NOWARN_DEPRECATED_POP
 
#endif
 
#endif // QGSFAVORITESITEM_H