KSelectionProxyModel

KDE 4.7 PyKDE API Reference

- KDE's Python API

# KSelectionProxyModel Class Reference

`from PyKDE4.kdeui import *`

Inherits: QAbstractProxyModel → QAbstractItemModel → QObject

## Detailed Description

A Proxy Model which presents a subset of its source model to observers.

The KSelectionProxyModel is most useful as a convenience for displaying the selection in one view in another view. The selectionModel of the initial view is used to create a proxied model which is filtered based on the configuration of this class.

For example, when a user clicks a mail folder in one view in an email application, the contained emails should be displayed in another view.

This takes away the need for the developer to handle the selection between the views, including all the mapToSource, mapFromSource and setRootIndex calls.

    MyModel *sourceModel = new MyModel(this);
    QTreeView *leftView = new QTreeView(this);
    leftView->setModel(sourceModel);

    KSelectionProxyModel *selectionProxy = new KSelectionProxyModel(leftView->selectionModel(), this);
    selectionProxy->setSourceModel(sourceModel);

    QTreeView *rightView = new QTreeView(this);
    rightView->setModel(selectionProxy);

"A Selection in one view creating a model for use with another view."

The KSelectionProxyModel can handle complex selections.

"Non-contiguous selection creating a new simple model in a second view."

The contents of the secondary view depends on the selection in the primary view, and the configuration of the proxy model. See KSelectionProxyModel.setFilterBehavior for the different possible configurations.

For example, if the filterBehavior is SubTrees, selecting another item in an already selected subtree has no effect.

"Selecting an item and its descendant."

See the test application in KDE/kdelibs/kdeui/tests/proxymodeltestapp to try out the valid configurations.

"KSelectionProxyModel test application"

Obviously, the KSelectionProxyModel may be used in a view, or further processed with other proxy models. See KAddressBook and AkonadiConsole in kdepim for examples which use a further KDescendantsProxyModel and QSortFilterProxyModel on top of a KSelectionProxyModel.

Additionally, this class can be used to programmatically choose some items from the source model to display in the view. For example, this is how the Favourite Folder View in KMail works, and is also used in unit testing.

See also: http://doc.trolltech.com/4.5/model-view-proxy-models.html

Since:
  4.4

Author:
  Stephen Kelly <steveire@gmail.com>

## Enumerations
FilterBehavior | { SubTrees, SubTreeRoots, SubTreesWithoutRoots, ExactSelection, ChildrenOfExactSelection }
## Methods
| __init__ (self, QItemSelectionModel selectionModel, QObject parent=0)
int | columnCount (self, QModelIndex a0=QModelIndex())
QVariant | data (self, QModelIndex index, int role=Qt.DisplayRole)
bool | dropMimeData (self, QMimeData data, Qt::DropAction action, int row, int column, QModelIndex parent)
KSelectionProxyModel.FilterBehavior | filterBehavior (self)
Qt::ItemFlags | flags (self, QModelIndex index)
bool | hasChildren (self, QModelIndex parent=QModelIndex())
QVariant | headerData (self, int section, Qt::Orientation orientation, int role=Qt.DisplayRole)
QModelIndex | index (self, int a0, int a1, QModelIndex a2=QModelIndex())
QModelIndex | mapFromSource (self, QModelIndex sourceIndex)
QItemSelection | mapSelectionFromSource (self, QItemSelection selection)
QItemSelection | mapSelectionToSource (self, QItemSelection selection)
QModelIndex | mapToSource (self, QModelIndex proxyIndex)
[QModelIndex] | match (self, QModelIndex start, int role, QVariant value, int hits=1, Qt::MatchFlags flags=Qt.MatchFlags(Qt.MatchStartsWith|Qt.MatchWrap))
QMimeData | mimeData (self, [QModelIndex] indexes)
QStringList | mimeTypes (self)
QModelIndex | parent (self, QModelIndex a0)
int | rowCount (self, QModelIndex parent=QModelIndex())
QItemSelectionModel | selectionModel (self)
| setFilterBehavior (self, KSelectionProxyModel.FilterBehavior behavior)
| setSourceModel (self, QAbstractItemModel sourceModel)
[QPersistentModelIndex] | sourceRootIndexes (self)
Qt::DropActions | supportedDropActions (self)

## Method Documentation

__init__ | ( | self, |
|  | QItemSelectionModel | selectionModel,
|  | QObject | parent=0
| ) |  |  |

ctor.

selectionModel The selection model used to filter what is presented by the proxy.

int columnCount | ( | self, |
|  | QModelIndex | a0=QModelIndex()
| ) |  |  |

QVariant data | ( | self, |
|  | QModelIndex | index,
|  | int | role=Qt.DisplayRole
| ) |  |  |

bool dropMimeData | ( | self, |
|  | QMimeData | data,
|  | Qt::DropAction | action,
|  | int | row,
|  | int | column,
|  | QModelIndex | parent
| ) |  |  |

KSelectionProxyModel.FilterBehavior filterBehavior | ( |  | self ) |

Qt::ItemFlags flags | ( | self, |
|  | QModelIndex | index
| ) |  |  |

bool hasChildren | ( | self, |
|  | QModelIndex | parent=QModelIndex()
| ) |  |  |

QVariant headerData | ( | self, |
|  | int | section,
|  | Qt::Orientation | orientation,
|  | int | role=Qt.DisplayRole
| ) |  |  |

QModelIndex index | ( | self, |
|  | int | a0,
|  | int | a1,
|  | QModelIndex | a2=QModelIndex()
| ) |  |  |

QModelIndex mapFromSource | ( | self, |
|  | QModelIndex | sourceIndex
| ) |  |  |

QItemSelection mapSelectionFromSource | ( | self, |
|  | QItemSelection | selection
| ) |  |  |

QItemSelection mapSelectionToSource | ( | self, |
|  | QItemSelection | selection
| ) |  |  |

QModelIndex mapToSource | ( | self, |
|  | QModelIndex | proxyIndex
| ) |  |  |

[QModelIndex] match | ( | self, |
|  | QModelIndex | start,
|  | int | role,
|  | QVariant | value,
|  | int | hits=1,
|  | Qt::MatchFlags | flags=Qt.MatchFlags(Qt.MatchStartsWith|Qt.MatchWrap)
| ) |  |  |

QMimeData mimeData | ( | self, |
|  | [QModelIndex] | indexes
| ) |  |  |

QStringList mimeTypes | ( |  | self ) |

QModelIndex parent | ( | self, |
|  | QModelIndex | a0
| ) |  |  |

int rowCount | ( | self, |
|  | QModelIndex | parent=QModelIndex()
| ) |  |  |

QItemSelectionModel selectionModel | ( |  | self ) |

setFilterBehavior | ( | self, |
|  | KSelectionProxyModel.FilterBehavior | behavior
| ) |  |  |

Set the filter behaviors of this model. The filter behaviors of the model govern the content of the model based on the selection of the contained QItemSelectionModel.

See kdeui/proxymodeltestapp to try out the different proxy model behaviors.

The most useful behaviors are SubTrees, ExactSelection and ChildrenOfExactSelection.

The default behavior is SubTrees. This means that this proxy model will contain the roots of the items in the source model. Any descendants which are also selected have no additional effect. For example if the source model is like:

@verbatim (root) - A - B - C - D - E - F - G - H - I - J - K - L @endverbatim

And A, B, C and D are selected, the proxy will contain:

@verbatim (root) - A - B - C - D - E - F - G @endverbatim

That is, selecting 'D' or 'C' if 'B' is also selected has no effect. If 'B' is de-selected, then 'C' amd 'D' become top-level items:

@verbatim (root) - A - C - D - E - F - G @endverbatim

This is the behavior used by KJots when rendering books.

If the behavior is set to SubTreeRoots, then the children of selected indexes are not part of the model. If 'A', 'B' and 'D' are selected,

@verbatim (root) - A - B @endverbatim

Note that although 'D' is selected, it is not part of the proxy model, because its parent 'B' is already selected.

SubTreesWithoutRoots has the effect of not making the selected items part of the model, but making their children part of the model instead. If 'A', 'B' and 'I' are selected:

@verbatim (root) - C - D - E - F - G - J - K - L @endverbatim

Note that 'A' has no children, so selecting it has no outward effect on the model.

ChildrenOfExactSelection causes the proxy model to contain the children of the selected indexes,but further descendants are omitted. Additionally, if descendants of an already selected index are selected, their children are part of the proxy model. For example, if 'A', 'B', 'D' and 'I' are selected:

@verbatim (root) - C - D - E - G - J - K - L @endverbatim

This would be useful for example if showing containers (for example maildirs) in one view and their items in another. Sub-maildirs would still appear in the proxy, but could be filtered out using a QSortfilterProxyModel.

The ExactSelection behavior causes the selected items to be part of the proxy model, even if their ancestors are already selected, but children of selected items are not included.

Again, if 'A', 'B', 'D' and 'I' are selected:

@verbatim (root) - A - B - D - I @endverbatim

This is the behavior used by the Favourite Folder View in KMail.

setSourceModel | ( | self, |
|  | QAbstractItemModel | sourceModel
| ) |  |  |

reimp.

[QPersistentModelIndex] sourceRootIndexes | ( |  | self ) |

Qt::DropActions supportedDropActions | ( |  | self ) |

## Enumeration Documentation

FilterBehavior

Enumerator:

  SubTrees |
  SubTreeRoots |
  SubTreesWithoutRoots |
  ExactSelection |
  ChildrenOfExactSelection |