qgssettingstreenode.h

Go to the documentation of this file.

/***************************************************************************
  qgssettingstreenode.h
  --------------------------------------
  Date                 : December 2022
  Copyright            : (C) 2022 by Denis Rouzaud
  Email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   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 QGSSETTINGSTREENODE_H
#define QGSSETTINGSTREENODE_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QObject>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsSettingsTreeNamedListNode;
class QgsSettingsEntryBase;
class QgsSettingsEntryString;

class CORE_EXPORT QgsSettingsTreeNode
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast< QgsSettingsTreeNamedListNode * >( sipCpp ) )
      sipType = sipType_QgsSettingsTreeNamedListNode;
    else if ( dynamic_cast< QgsSettingsTreeNode * >( sipCpp ) )
      sipType = sipType_QgsSettingsTreeNode;
    else
      sipType = NULL;
    SIP_END
#endif
 
    // clang-format off
  Q_GADGET
 
  public:
    // clang-format on
 
    virtual ~QgsSettingsTreeNode();

    static QgsSettingsTreeNode *createRootNode() SIP_SKIP;

    QgsSettingsTreeNode *createChildNode( const QString &key ) SIP_THROW( QgsSettingsException ) SIP_KEEPREFERENCE;

    QgsSettingsTreeNamedListNode *createNamedListNode( const QString &key, const Qgis::SettingsTreeNodeOptions &options = Qgis::SettingsTreeNodeOptions() ) SIP_THROW( QgsSettingsException )
      SIP_KEEPREFERENCE;
 

    Qgis::SettingsTreeNodeType type() const { return mType; }

    void registerChildSetting( const QgsSettingsEntryBase *setting, const QString &key ) SIP_THROW( QgsSettingsException );

    void unregisterChildSetting( const QgsSettingsEntryBase *setting, bool deleteSettingValues = false, const QStringList &parentsNamedItems = QStringList() );

    void unregisterChildNode( QgsSettingsTreeNode *node );

    QList<QgsSettingsTreeNode *> childrenNodes() const { return mChildrenNodes; }

    QgsSettingsTreeNode *childNode( const QString &key ) const;

    QList<const QgsSettingsEntryBase *> childrenSettings() const { return mChildrenSettings; }

    const QgsSettingsEntryBase *childSetting( const QString &key ) const;

    QgsSettingsTreeNode *parent() const { return mParent; }

    QString key() const { return mKey; }

    QString completeKey() const { return mCompleteKey; }

    int namedNodesCount() const { return mNamedNodesCount; }
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    const QMetaEnum metaEnum = QMetaEnum::fromType<Qgis::SettingsTreeNodeType>();
 
    QString str = u"<QgsSettingsTreeNode (%1): %2>"_s.arg( metaEnum.valueToKey( static_cast<int>( sipCpp->type() ) ), sipCpp->key() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
    // clang-format off
    protected:
    // clang-format on
    void registerChildNode( QgsSettingsTreeNode *node );
 
    Qgis::SettingsTreeNodeType mType = Qgis::SettingsTreeNodeType::Root;
 
  private:
    QgsSettingsTreeNode() = default SIP_FORCE;
 
    QgsSettingsTreeNode( const QgsSettingsTreeNode &other ) = default SIP_FORCE;

    void init( QgsSettingsTreeNode *parent, const QString &key );
 
    friend class QgsSettingsTree;
    friend class QgsSettingsTreeNamedListNode;
 
    QgsSettingsTreeNode *childNodeAtKey( const QString &key );
 
    QList<QgsSettingsTreeNode *> mChildrenNodes;
    QList<const QgsSettingsEntryBase *> mChildrenSettings;
    QgsSettingsTreeNode *mParent = nullptr;
 
    QString mKey;
    QString mCompleteKey;
    int mNamedNodesCount = 0;
};
 

class CORE_EXPORT QgsSettingsTreeNamedListNode : public QgsSettingsTreeNode
{
  public:
    ~QgsSettingsTreeNamedListNode() override;

    QStringList items( const QStringList &parentsNamedItems = QStringList() ) const SIP_THROW( QgsSettingsException );

    QStringList items( Qgis::SettingsOrigin origin, const QStringList &parentsNamedItems = QStringList() ) const SIP_THROW( QgsSettingsException );
 

    void setSelectedItem( const QString &item, const QStringList &parentsNamedItems = QStringList() ) SIP_THROW( QgsSettingsException );

    QString selectedItem( const QStringList &parentsNamedItems = QStringList() ) SIP_THROW( QgsSettingsException );

    void deleteItem( const QString &item, const QStringList &parentsNamedItems = QStringList() ) SIP_THROW( QgsSettingsException );

    void deleteAllItems( const QStringList &parentsNamedItems = QStringList() ) SIP_THROW( QgsSettingsException );

    const QgsSettingsEntryString *selectedItemSetting() const { return mSelectedItemSetting.get(); }
 
  protected:
    void initNamedList( const Qgis::SettingsTreeNodeOptions &options );
 
  private:
    friend class QgsSettingsTreeNode;

    QgsSettingsTreeNamedListNode() SIP_FORCE;
 
    QgsSettingsTreeNamedListNode( const QgsSettingsTreeNamedListNode &other ) = delete;

    QString completeKeyWithNamedItems( const QString &key, const QStringList &namedItems ) const;
 
    Qgis::SettingsTreeNodeOptions mOptions;
    std::unique_ptr<const QgsSettingsEntryString> mSelectedItemSetting;
    QString mItemsCompleteKey;
};
 
#endif // QGSSETTINGSTREENODE_H