Provides access to data stored in a Project through Qt's model-view framework. More...

#include <ProjectItemModel.h>

Inherited by Isis::ProjectItemProxyModel.

Signals
void	itemAdded (ProjectItem *)
	This signal is emitted when a ProjectItem is added to the model. More...

void	itemRemoved (ProjectItem *)

Public Member Functions
	ProjectItemModel (QObject *parent=0)
	Constructs an empty model. More...

	~ProjectItemModel ()
	Destructs the model. More...

QItemSelectionModel *	selectionModel ()
	Returns the internal selection model. More...

ProjectItem *	addProject (Project *project)
	Adds a Project to the model. More...

ProjectItem *	findItemData (const QVariant &data, int role=Qt::UserRole+1)
	Returns the first item found that contains the given data in the given role or a null pointer if no item is found. More...

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const
	You cannot drop mime data into the ProjectItemModel. More...

virtual void	removeItem (ProjectItem *item)
	Removes an item and its children from the model. More...

virtual void	removeItems (QList< ProjectItem * > items)
	Removes a list of items and their children from the model. More...

ProjectItem *	currentItem ()
	Returns the current item of the internal selection model. More...

QList< ProjectItem * >	selectedItems ()
	Returns a list of the selected items of the internal selection model. More...

void	appendRow (ProjectItem *item)
	Appends a top-level item to the model. More...

QModelIndex	indexFromItem (const ProjectItem *item)
	Returns the QModelIndex corresponding to a given ProjectItem. More...

void	insertRow (int row, ProjectItem *item)
	Inserts a top-level item at the given row. More...

ProjectItem *	item (int row)
	Returns the top-level item at the given row. More...

ProjectItem *	itemFromIndex (const QModelIndex &index)
	Returns the ProjectItem corresponding to a given QModelIndex. More...

void	setItem (int row, ProjectItem *item)
	Sets the item at the top-level row. More...

ProjectItem *	takeItem (int row)
	Removes the top-level row and returns the removed item. More...

Protected Slots
void	onSelectionChanged (const QItemSelection &selected, const QItemSelection &deselected)
	Slot to connect to the selectionChanged() signal from a selection model. More...

Detailed Description

Provides access to data stored in a Project through Qt's model-view framework.

Items corresponding to data are organized in a tree structure. Data can be accessed through a ProjectItem or through a QModelIndex. Views associated with the model can access it either through the model directly or through a ProjectItemProxyModel.

Top-level items can be accessed through the item() method using the row where the item is stored. Children of items can be accessed through the child() method on the parent item. The data stored in an item can be accessed as a QVariant using the data() method of the item or through the various convenience methods in ProjectItem. Alternatively, the data in an item can be accessed with its corresponding QModelIndex and the model's data() method. It should be noted that the data() method in the model and the data() method of ProjectItem require a Qt::ItemDataRole interpreted as an int. Data stored in the model that correspond to Isis classes are stored as Qt::UserRole + 1.

Top-level items should be added to the model using the appendRow() or the insertRow() method. To add child items to a parent item the appendRow() or insertRow() methods of the parent item should be used.

The model keeps track of selected items and the current item using an internal QItemSelectionModel.

Views that only need access to a subset of the items or the items organized in a different way should use a ProjectItemProxyModel.

* Image *image = new Image("example.cub");
* ProjectItemModel *model = new ProjectItemModel();
* ProjectItem *item = new ProjectItem(image);
* model->appendRow(item);
* 

Author: 2015-10-21 Jeffrey Covington

Constructor & Destructor Documentation

Isis::ProjectItemModel::ProjectItemModel ( QObject * parent = 0 )

Constructs an empty model.

Parameters

[in] parent (QObject *) The parent.

References onSelectionChanged().

Isis::ProjectItemModel::~ProjectItemModel ( )

Destructs the model.

Member Function Documentation

ProjectItem * Isis::ProjectItemModel::addProject ( Project * project )

Adds a Project to the model.

An item is created that corresponds to the Project as well as children items that correspond to various parts of the Project.

Parameters

[in] project (Project *) The Project to be added.

Returns: ProjectItem* The new item that corresponds to the Project.

References appendRow().

void Isis::ProjectItemModel::appendRow ( ProjectItem * item )

Appends a top-level item to the model.

Parameters

[in] item (ProjectItem *) The item to append.

Referenced by Isis::ProjectItemProxyModel::addChild(), and addProject().

bool Isis::ProjectItemModel::canDropMimeData	(	const QMimeData *	data,
		Qt::DropAction	action,
		int	row,
		int	column,
		const QModelIndex &	parent
	)		const

virtual

You cannot drop mime data into the ProjectItemModel.

See Also: ProjectItemProxyModel

Parameters

data	(const QMimeData *) The data to drop
action	(Qt::DropAction) The drop action
row	(int) ???
column	(int) ???
parent	(const QModelIndex &) The index of the data's parent

Returns: bool False

Reimplemented in Isis::ProjectItemProxyModel.

ProjectItem * Isis::ProjectItemModel::currentItem ( )

Returns the current item of the internal selection model.

Returns: ProjectItem* The current item.

References itemFromIndex(), and selectionModel().

Referenced by Isis::AbstractProjectItemView::currentItem(), and Isis::RemoveImagesWorkOrder::syncRedo().

ProjectItem * Isis::ProjectItemModel::findItemData	(	const QVariant &	data,
		int	role = `Qt::UserRole+1`
	)

Returns the first item found that contains the given data in the given role or a null pointer if no item is found.

Parameters

data	(const QVariant &) The data contained in the item.
data	(int) The role of the data (see Qt::ItemDataRole).

Returns: ProjectItem* First project item found.

References Isis::ProjectItem::findItemData(), and item().

QModelIndex Isis::ProjectItemModel::indexFromItem ( const ProjectItem * item )

Returns the QModelIndex corresponding to a given ProjectItem.

Parameters

[in] item (const ProjectItem *) The item.

Returns: QModelIndex The index of the item.

void Isis::ProjectItemModel::insertRow	(	int	row,
		ProjectItem *	item
	)

Inserts a top-level item at the given row.

Parameters

[in]	row	(int) The row where the item will be inserted.
[in]	item	(ProjectItem *) The item to insert.

ProjectItem * Isis::ProjectItemModel::item ( int row )

Returns the top-level item at the given row.

Parameters

[in] row (int) The row of the item.

Returns: ProjectItem* The item at the row.

Referenced by Isis::ProjectItemProxyModel::addItems(), findItemData(), onSelectionChanged(), and removeItems().

void Isis::ProjectItemModel::itemAdded ( ProjectItem * _t1 )

signal

This signal is emitted when a ProjectItem is added to the model.

ProjectItem * Isis::ProjectItemModel::itemFromIndex ( const QModelIndex & index )

Returns the ProjectItem corresponding to a given QModelIndex.

Parameters

[in] index (const QModelIndex &) The index of the item.

Returns: ProjectItem* The item.

Referenced by currentItem(), Isis::ProjectItemProxyModel::mapIndexFromSource(), Isis::ProjectItemProxyModel::mapIndexToSource(), onSelectionChanged(), and selectedItems().

void Isis::ProjectItemModel::itemRemoved ( ProjectItem * _t1 )

signal

void Isis::ProjectItemModel::onSelectionChanged	(	const QItemSelection &	selected,
		const QItemSelection &	deselected
	)

protectedslot

Slot to connect to the selectionChanged() signal from a selection model.

Updates other factors in the model that rely on selected items but do not directly correspond with the selection model. Currently changes the selected property of Images that correspond with selected or deselected items.

Parameters