Isis 3 Developer Reference
Classes | Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Isis::AbstractTreeModel Class Referenceabstract

Base class for tree models. More...

#include <AbstractTreeModel.h>

Inheritance diagram for Isis::AbstractTreeModel:
Inheritance graph
Collaboration diagram for Isis::AbstractTreeModel:
Collaboration graph

Public Types

enum  InterestingItems { PointItems = 1, MeasureItems = 2, ImageItems = 4, AllItems = PointItems | MeasureItems | ImageItems }
 

Public Slots

void applyFilter ()
 

Signals

void cancelSort ()
 
void modelModified ()
 
void filterProgressChanged (int)
 
void filterProgressRangeChanged (int, int)
 
void rebuildProgressChanged (int)
 
void rebuildProgressRangeChanged (int, int)
 
void treeSelectionChanged (QList< AbstractTreeItem *>)
 
void tableSelectionChanged (QList< AbstractTreeItem *>)
 
void filterCountsChanged (int visibleTopLevelItemCount, int topLevelItemCount)
 This signal is emitted after filtering to provide the number of visible top-level items remaining after the filter was applied, as well as the total number of items that were possible. More...
 

Public Member Functions

 AbstractTreeModel (ControlNet *controlNet, TreeView *v, QObject *parent=0)
 
virtual ~AbstractTreeModel ()
 
QList< AbstractTreeItem *> getItems (int, int, InterestingItemsFlag=AllItems, bool=false)
 
QList< AbstractTreeItem *> getItems (AbstractTreeItem *, AbstractTreeItem *, InterestingItemsFlag=AllItems, bool=false)
 
QList< AbstractTreeItem *> getSelectedItems (InterestingItemsFlag=AllItems, bool=false)
 
QMutex * getMutex () const
 
int getItemCount (InterestingItemsFlag) const
 
int getTopLevelItemCount () const
 
int getVisibleItemCount (InterestingItemsFlag, bool) const
 
int getVisibleTopLevelItemCount () const
 
TreeView * getView () const
 
void setDrivable (bool drivableStatus)
 
bool isDrivable () const
 
bool isFiltering () const
 
bool isRebuilding () const
 
void setRebuilding (bool running)
 
void setFilter (FilterWidget *newFilter)
 
void setGlobalSelection (bool selected, InterestingItemsFlag=AllItems)
 
void stopWorking ()
 
QSize getVisibleSize (int indentation) const
 indentation is in pixels More...
 
int indexOfVisibleItem (AbstractTreeItem const *item, InterestingItemsFlag=AllItems, bool=false) const
 
void setFrozen (bool)
 
bool isFrozen () const
 
void queueRebuild ()
 
virtual void rebuildItems ()=0
 

Protected Member Functions

void clear ()
 
ControlNet * getControlNetwork () const
 
FilterWidget * getFilterWidget () const
 
QFutureWatcher< QAtomicPointer< RootItem > > * getRebuildWatcher () const
 
RootItem * getRootItem () const
 

Protected Attributes

RootItem * rootItem
 

Detailed Description

Base class for tree models.

This class is a base class for models that store data in a tree-like structure. There is also a linked-list for iterating over the filtered items in an efficient manner. This handles the filtering of items and provides an interface for rebuilding.

Author
????-??-?? Eric Hyer

Member Enumeration Documentation

◆ InterestingItems

enum Isis::AbstractTreeModel::InterestingItems
Enumerator
PointItems 
MeasureItems 
ImageItems 
AllItems 

Constructor & Destructor Documentation

◆ AbstractTreeModel()

Isis::AbstractTreeModel::AbstractTreeModel ( ControlNet *  controlNet,
TreeView *  v,
QObject *  parent = 0 
)

References ASSERT, filterProgressChanged(), filterProgressRangeChanged(), rebuildProgressChanged(), rebuildProgressRangeChanged(), and rootItem.

◆ ~AbstractTreeModel()

Isis::AbstractTreeModel::~AbstractTreeModel ( )
virtual

References rootItem.

Member Function Documentation

◆ applyFilter

void Isis::AbstractTreeModel::applyFilter ( )
slot

References cancelSort(), filterCountsChanged(), Isis::AbstractParentItem::getChildren(), getTopLevelItemCount(), rootItem, and Isis::RootItem::setLastVisibleFilteredItem().

Referenced by Isis::AbstractTableModel::applyFilter(), setFilter(), and setFrozen().

◆ cancelSort

void Isis::AbstractTreeModel::cancelSort ( )
signal

Referenced by applyFilter(), Isis::ImagePointTreeModel::rebuildItems(), Isis::ImageImageTreeModel::rebuildItems(), and Isis::PointMeasureTreeModel::rebuildItems().

◆ clear()

void Isis::AbstractTreeModel::clear ( )
protected

References ASSERT, and rootItem.

◆ filterCountsChanged

void Isis::AbstractTreeModel::filterCountsChanged ( int  visibleTopLevelItemCount,
int  topLevelItemCount 
)
signal

This signal is emitted after filtering to provide the number of visible top-level items remaining after the filter was applied, as well as the total number of items that were possible.

Referenced by applyFilter(), Isis::ImagePointTreeModel::rebuildItems(), Isis::ImageImageTreeModel::rebuildItems(), and Isis::PointMeasureTreeModel::rebuildItems().

◆ filterProgressChanged

void Isis::AbstractTreeModel::filterProgressChanged ( int  )
signal

Referenced by AbstractTreeModel().

◆ filterProgressRangeChanged

void Isis::AbstractTreeModel::filterProgressRangeChanged ( int  ,
int   
)
signal

Referenced by AbstractTreeModel().

◆ getControlNetwork()

ControlNet * Isis::AbstractTreeModel::getControlNetwork ( ) const
protected

Referenced by Isis::ImagePointTreeModel::rebuildItems(), Isis::ImageImageTreeModel::rebuildItems(), and Isis::PointMeasureTreeModel::rebuildItems().

◆ getFilterWidget()

FilterWidget* Isis::AbstractTreeModel::getFilterWidget ( ) const
protected

◆ getItemCount()

int Isis::AbstractTreeModel::getItemCount ( InterestingItemsFlag  flags) const

References rootItem.

◆ getItems() [1/2]

QList< AbstractTreeItem *> Isis::AbstractTreeModel::getItems ( int  start,
int  end,
InterestingItemsFlag  flags = AllItems,
bool  ignoreExpansion = false 
)

References ASSERT, Isis::AbstractParentItem::childCount(), Isis::AbstractParentItem::getFirstVisibleChild(), Isis::AbstractTreeItem::getLastVisibleChild(), Isis::RootItem::getLastVisibleFilteredItem(), isFiltering(), Isis::AbstractTreeItem::parent(), and rootItem.

Referenced by Isis::CnetEditorWidget::filteredNetwork(), Isis::AbstractTableModel::getSortedItems(), and Isis::TreeViewContent::mousePressEvent().

◆ getItems() [2/2]

QList< AbstractTreeItem *> Isis::AbstractTreeModel::getItems ( AbstractTreeItem *  item1,
AbstractTreeItem *  item2,
InterestingItemsFlag  flags = AllItems,
bool  ignoreExpansion = false 
)

References _FILEINFO_, Isis::AbstractParentItem::childCount(), Isis::AbstractParentItem::getFirstVisibleChild(), Isis::IException::Programmer, and rootItem.

◆ getMutex()

QMutex * Isis::AbstractTreeModel::getMutex ( ) const

◆ getRebuildWatcher()

QFutureWatcher< QAtomicPointer< RootItem > > * Isis::AbstractTreeModel::getRebuildWatcher ( ) const
protected

Referenced by Isis::ImagePointTreeModel::rebuildItems(), Isis::ImageImageTreeModel::rebuildItems(), and Isis::PointMeasureTreeModel::rebuildItems().

◆ getRootItem()

RootItem * Isis::AbstractTreeModel::getRootItem ( ) const
protected

References rootItem.

◆ getSelectedItems()

QList< AbstractTreeItem *> Isis::AbstractTreeModel::getSelectedItems ( InterestingItemsFlag  flags = AllItems,
bool  ignoreExpansion = false 
)

References ASSERT, Isis::AbstractParentItem::getFirstVisibleChild(), isFiltering(), Isis::AbstractTreeItem::isSelected(), and rootItem.

Referenced by Isis::PointTableModel::getSelectedItems(), and Isis::MeasureTableModel::getSelectedItems().

◆ getTopLevelItemCount()

int Isis::AbstractTreeModel::getTopLevelItemCount ( ) const

References Isis::AbstractParentItem::childCount(), and rootItem.

Referenced by applyFilter(), Isis::ImagePointTreeModel::rebuildItems(), Isis::ImageImageTreeModel::rebuildItems(), and Isis::PointMeasureTreeModel::rebuildItems().

◆ getView()

TreeView * Isis::AbstractTreeModel::getView ( ) const

◆ getVisibleItemCount()

int Isis::AbstractTreeModel::getVisibleItemCount ( InterestingItemsFlag  flags,
bool  ignoreExpansion 
) const

References Isis::AbstractParentItem::getFirstVisibleChild(), isFiltering(), and rootItem.

Referenced by Isis::PointTableModel::getVisibleRowCount(), and Isis::MeasureTableModel::getVisibleRowCount().

◆ getVisibleSize()

QSize Isis::AbstractTreeModel::getVisibleSize ( int  indentation) const

indentation is in pixels

References AllItems, Isis::AbstractTreeItem::getDataWidth(), Isis::AbstractTreeItem::getDepth(), Isis::AbstractParentItem::getFirstVisibleChild(), isFiltering(), and rootItem.

Referenced by Isis::TreeViewContent::refresh().

◆ getVisibleTopLevelItemCount()

int Isis::AbstractTreeModel::getVisibleTopLevelItemCount ( ) const

References Isis::AbstractParentItem::getFirstVisibleChild(), Isis::AbstractTreeItem::getNextVisiblePeer(), isFiltering(), and rootItem.

◆ indexOfVisibleItem()

int Isis::AbstractTreeModel::indexOfVisibleItem ( AbstractTreeItem const *  item,
InterestingItemsFlag  flags = AllItems,
bool  ignoreExpansion = false 
) const

References Isis::AbstractParentItem::getFirstVisibleChild(), isFiltering(), and rootItem.

Referenced by Isis::PointTableModel::indexOfVisibleItem(), and Isis::MeasureTableModel::indexOfVisibleItem().

◆ isDrivable()

bool Isis::AbstractTreeModel::isDrivable ( ) const

◆ isFiltering()

bool Isis::AbstractTreeModel::isFiltering ( ) const

Referenced by getItems(), getSelectedItems(), getVisibleItemCount(), getVisibleSize(), getVisibleTopLevelItemCount(), indexOfVisibleItem(), Isis::AbstractTableModel::isFiltering(), Isis::TreeViewContent::refresh(), and Isis::AbstractTableModel::sort().

◆ isFrozen()

bool Isis::AbstractTreeModel::isFrozen ( ) const

Referenced by Isis::ImagePointTreeModel::rebuildItems(), Isis::ImageImageTreeModel::rebuildItems(), and Isis::PointMeasureTreeModel::rebuildItems().

◆ isRebuilding()

bool Isis::AbstractTreeModel::isRebuilding ( ) const

Referenced by Isis::AbstractTableModel::sort().

◆ modelModified

void Isis::AbstractTreeModel::modelModified ( )
signal

◆ queueRebuild()

void Isis::AbstractTreeModel::queueRebuild ( )

Referenced by Isis::ImagePointTreeModel::rebuildItems(), Isis::ImageImageTreeModel::rebuildItems(), and Isis::PointMeasureTreeModel::rebuildItems().

◆ rebuildItems()

virtual void Isis::AbstractTreeModel::rebuildItems ( )
pure virtual

Implemented in Isis::PointMeasureTreeModel, Isis::ImageImageTreeModel, and Isis::ImagePointTreeModel.

Referenced by setFrozen().

◆ rebuildProgressChanged

void Isis::AbstractTreeModel::rebuildProgressChanged ( int  )
signal

Referenced by AbstractTreeModel().

◆ rebuildProgressRangeChanged

void Isis::AbstractTreeModel::rebuildProgressRangeChanged ( int  ,
int   
)
signal

Referenced by AbstractTreeModel().

◆ setDrivable()

void Isis::AbstractTreeModel::setDrivable ( bool  drivableStatus)

◆ setFilter()

void Isis::AbstractTreeModel::setFilter ( FilterWidget *  newFilter)

References applyFilter().

◆ setFrozen()

void Isis::AbstractTreeModel::setFrozen ( bool  newFrozenState)

References applyFilter(), and rebuildItems().

Referenced by Isis::CnetEditorWidget::setTablesFrozen().

◆ setGlobalSelection()

void Isis::AbstractTreeModel::setGlobalSelection ( bool  selected,
InterestingItemsFlag  flags = AllItems 
)

References rootItem.

Referenced by Isis::TreeViewContent::keyPressEvent(), Isis::TreeViewContent::mousePressEvent(), Isis::PointTableModel::setGlobalSelection(), and Isis::MeasureTableModel::setGlobalSelection().

◆ setRebuilding()

void Isis::AbstractTreeModel::setRebuilding ( bool  running)
inline

Referenced by Isis::ImagePointTreeModel::rebuildItems(), Isis::ImageImageTreeModel::rebuildItems(), and Isis::PointMeasureTreeModel::rebuildItems().

◆ stopWorking()

void Isis::AbstractTreeModel::stopWorking ( )

◆ tableSelectionChanged

void Isis::AbstractTreeModel::tableSelectionChanged ( QList< AbstractTreeItem *>  )
signal

◆ treeSelectionChanged

void Isis::AbstractTreeModel::treeSelectionChanged ( QList< AbstractTreeItem *>  )
signal

Member Data Documentation

◆ rootItem

RootItem* Isis::AbstractTreeModel::rootItem
protected

Referenced by AbstractTreeModel(), applyFilter(), clear(), getItemCount(), getItems(), getRootItem(), getSelectedItems(), getTopLevelItemCount(), getVisibleItemCount(), getVisibleSize(), getVisibleTopLevelItemCount(), indexOfVisibleItem(), setGlobalSelection(), and ~AbstractTreeModel().

The documentation for this class was generated from the following files: