/usr/include/akonadi/selectionproxymodel.h is in kdepimlibs5-dev 4:4.14.10-7+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | /*
Copyright (c) 2009 Stephen Kelly <steveire@gmail.com>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_SELECTIONPROXYMODEL_H
#define AKONADI_SELECTIONPROXYMODEL_H
#include <kselectionproxymodel.h>
#include "akonadi_export.h"
namespace Akonadi
{
class SelectionProxyModelPrivate;
/**
* @short A proxy model used to reference count selected Akonadi::Collection in a view
*
* Only selected Collections will be populated and monitored for changes. Unselected
* Collections will be ignored.
*
* This model extends KSelectionProxyModel to implement reference counting on the Collections
* in an EntityTreeModel. The EntityTreeModel must use LazyPopulation to enable
* SelectionProxyModel to work.
*
* By selecting a Collection, its reference count will be increased. A Collection in the
* EntityTreeModel which has a reference count of zero will ignore all signals from Monitor
* about items changed, inserted, removed etc, which can be expensive operations.
*
* Example:
*
* @code
*
* using namespace Akonadi;
*
* // itemView
* // ^
* // |
* // itemModel
* // |
* // flatModel
* // |
* // collectionView --> selectionModel
* // ^ ^
* // | |
* // collectionFilter |
* // \______________model
*
* EntityTreeModel *model = new EntityTreeModel( ... );
*
* // setup collection model
* EntityMimeTypeFilterModel *collectionFilter = new EntityMimeTypeFilterModel( this );
* collectionFilter->setSourceModel( model );
* collectionFilter->addMimeTypeInclusionFilter( Collection::mimeType() );
* collectionFilter->setHeaderGroup( EntityTreeModel::CollectionTreeHeaders );
*
* // setup collection view
* EntityTreeView *collectionView = new EntityTreeView( this );
* collectionView->setModel( collectionFilter );
*
* // setup selection model
* SelectionProxyModel *selectionModel = new SelectionProxyModel( collectionView->selectionModel(), this );
* selectionModel->setSourceModel( model );
*
* // setup item model
* KDescendantsProxyModel *flatModel = new KDescendantsProxyModel( this );
* flatModel->setSourceModel( selectionModel );
*
* EntityMimeTypeFilterModel *itemModel = new EntityMimeTypeFilterModel( this );
* itemModel->setSourceModel( flatModel );
* itemModel->setHeaderGroup( EntityTreeModel::ItemListHeaders );
* itemModel->addMimeTypeExclusionFilter( Collection::mimeType() );
*
* EntityListView *itemView = new EntityListView( this );
* itemView->setModel( itemModel );
* @endcode
*
* See \ref libakonadi_integration "Integration in your Application" for further guidance on the use of this class.
* @author Stephen Kelly <steveire@gmail.com>
* @since 4.4
*/
class AKONADI_EXPORT SelectionProxyModel : public KSelectionProxyModel
{
Q_OBJECT
public:
/**
* Creates a new selection proxy model.
*
* @param selectionModel The selection model of the source view.
* @param parent The parent object.
*/
explicit SelectionProxyModel(QItemSelectionModel *selectionModel, QObject *parent = 0);
~SelectionProxyModel();
private:
//@cond PRIVATE
Q_DECLARE_PRIVATE(SelectionProxyModel)
SelectionProxyModelPrivate *const d_ptr;
Q_PRIVATE_SLOT(d_func(), void rootIndexAdded(const QModelIndex &))
Q_PRIVATE_SLOT(d_func(), void rootIndexAboutToBeRemoved(const QModelIndex &))
//@endcond
};
}
#endif
|