File indexing completed on 2024-05-05 03:56:40

 /*
     SPDX-FileCopyrightText: 2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.net>
     SPDX-FileContributor: Stephen Kelly <stephen@kdab.com>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef KBREADCRUMBSELECTIONMODEL_H
 #define KBREADCRUMBSELECTIONMODEL_H
 
 #include <QItemSelectionModel>
 
 #include "kitemmodels_export.h"
 
 #include <memory>
 
 class KBreadcrumbSelectionModelPrivate;
 
 /**
   @class KBreadcrumbSelectionModel kbreadcrumbselectionmodel.h KBreadcrumbSelectionModel
 
   @brief Selects the parents of selected items to create breadcrumbs
 
   For example, if the tree is
   @verbatim
     - A
     - B
     - - C
     - - D
     - - - E
     - - - - F
   @endverbatim
 
   and E is selected, the selection can contain
 
   @verbatim
     - B
     - D
   @endverbatim
 
   or
 
   @verbatim
     - B
     - D
     - E
   @endverbatim
 
   if isActualSelectionIncluded is true.
 
   The depth of the selection may also be set. For example if the breadcrumbLength is 1:
 
   @verbatim
     - D
     - E
   @endverbatim
 
   And if breadcrumbLength is 2:
 
   @verbatim
     - B
     - D
     - E
   @endverbatim
 
   A KBreadcrumbsSelectionModel with a breadcrumbLength of 0 and including the actual selection is
   the same as a KSelectionProxyModel in the KSelectionProxyModel::ExactSelection configuration.
 
   @code
     view1->setModel(rootModel);
 
     QItemSelectionModel *breadcrumbSelectionModel = new QItemSelectionModel(rootModel, this);
 
     KBreadcrumbSelectionModel *breadcrumbProxySelector = new KBreadcrumbSelectionModel(breadcrumbSelectionModel, rootModel, this);
 
     view1->setSelectionModel(breadcrumbProxySelector);
 
     KSelectionProxyModel *breadcrumbSelectionProxyModel = new KSelectionProxyModel( breadcrumbSelectionModel, this);
     breadcrumbSelectionProxyModel->setSourceModel( rootModel );
     breadcrumbSelectionProxyModel->setFilterBehavior( KSelectionProxyModel::ExactSelection );
 
     view2->setModel(breadcrumbSelectionProxyModel);
   @endcode
 
   @image html kbreadcrumbselectionmodel.png "KBreadcrumbSelectionModel in several configurations"
 
   This can work in two directions. One option is for a single selection in the KBreadcrumbSelectionModel to invoke
   the breadcrumb selection in its constructor argument.
 
   The other is for a selection in the itemselectionmodel in the constructor argument to cause a breadcrumb selection
   in @p this.
 
   @since 4.5
 
 */
 class KITEMMODELS_EXPORT KBreadcrumbSelectionModel : public QItemSelectionModel
 {
     Q_OBJECT
 public:
     enum BreadcrumbTarget {
         MakeBreadcrumbSelectionInOther,
         MakeBreadcrumbSelectionInSelf,
     };
 
     explicit KBreadcrumbSelectionModel(QItemSelectionModel *selectionModel, QObject *parent = nullptr);
     KBreadcrumbSelectionModel(QItemSelectionModel *selectionModel, BreadcrumbTarget target, QObject *parent = nullptr);
     ~KBreadcrumbSelectionModel() override;
 
     /**
       Returns whether the actual selection in included in the proxy.
 
       The default is true.
     */
     bool isActualSelectionIncluded() const;
 
     /**
       Set whether the actual selection in included in the proxy to @p isActualSelectionIncluded.
     */
     void setActualSelectionIncluded(bool isActualSelectionIncluded);
 
     /**
       Returns the depth that the breadcrumb selection should go to.
     */
     int breadcrumbLength() const;
 
     /**
       Sets the depth that the breadcrumb selection should go to.
 
       If the @p breadcrumbLength is -1, all breadcrumbs are selected.
       The default is -1
     */
     void setBreadcrumbLength(int breadcrumbLength);
 
     void select(const QModelIndex &index, QItemSelectionModel::SelectionFlags command) override;
 
     void select(const QItemSelection &selection, QItemSelectionModel::SelectionFlags command) override;
 
 protected:
     std::unique_ptr<KBreadcrumbSelectionModelPrivate> const d_ptr;
 
 private:
     //@cond PRIVATE
     Q_DECLARE_PRIVATE(KBreadcrumbSelectionModel)
     //@cond PRIVATE
 };
 
 #endif