GenericTree Class Reference

#include <generictree.h>

Inheritance diagram for GenericTree:

OSDGenericTree UIListGenericTree PlaylistItem TreeCheckItem PlaylistTitle PlaylistTrack CDCheckItem PlaylistCD PlaylistPlaylist

List of all members.

Detailed Description

Definition at line 15 of file generictree.h.


Public Member Functions

 GenericTree (const QString &a_string="", int an_int=0, bool selectable_flag=false)
virtual ~GenericTree ()
GenericTree * addNode (const QString &a_string, int an_int=0, bool selectable_flag=false)
GenericTree * addNode (GenericTree *child)
void removeNode (GenericTree *child)
GenericTree * findLeaf (int ordering_index=-1)
GenericTree * findNode (QValueList< int > route_of_branches)
GenericTree * recursiveNodeFinder (QValueList< int > route_of_branches)
bool checkNode (QValueList< int > route_of_branches)
GenericTree * nextSibling (int number_down, int ordering_index=-1)
GenericTree * prevSibling (int number_up, int ordering_index=-1)
QPtrListIterator< GenericTree > getFirstChildIterator (int ordering=-1)
GenericTree * getSelectedChild (int ordering_index)
GenericTree * getChildAt (uint reference, int ordering_index=-1)
GenericTree * getChildByName (const QString &a_name)
GenericTree * getChildByInt (int an_int)
QPtrList< GenericTree > * getAllChildren (int ordering_index=-1)
int getChildPosition (GenericTree *child, int ordering_index=-1)
int getPosition (void)
int getPosition (int ordering_index)
void setInt (int an_int)
int getInt ()
void setParent (GenericTree *a_parent)
GenericTree * getParent (void)
const QString getString (void)
void setString (const QString &str)
int calculateDepth (int start)
int childCount (void)
int siblingCount (void)
void setSelectable (bool flag)
bool isSelectable ()
void setAttribute (uint attribute_position, int value_of_attribute)
int getAttribute (uint which_one)
IntVector * getAttributes (void)
void reorderSubnodes (int ordering_index)
void setOrderingIndex (int ordering_index)
int getOrderingIndex (void)
void becomeSelectedChild (void)
void setSelectedChild (GenericTree *a_node)
void addYourselfIfSelectable (QPtrList< GenericTree > *flat_list)
void buildFlatListOfSubnodes (int ordering_index, bool scrambled_parents)
GenericTree * nextPrevFromFlatList (bool forward_or_back, bool wrap_around, GenericTree *active)
void sortByString ()
void sortByAttributeThenByString (int which_attribute)
void sortBySelectable ()
void deleteAllChildren ()
void pruneAllChildren ()
void reOrderAsSorted ()
void MoveItemUpDown (GenericTree *item, bool flag)

Private Types

typedef QValueVector< int > IntVector

Private Attributes

QString m_string
int m_int
SortableGenericTreeList * m_subnodes
SortableGenericTreeList * m_ordered_subnodes
SortableGenericTreeList * m_flatened_subnodes
GenericTree * m_selected_subnode
IntVector * m_attributes
GenericTree * m_parent
bool m_selectable
int m_current_ordering_index

Member Typedef Documentation

typedef QValueVector<int> GenericTree::IntVector [private]

Definition at line 17 of file generictree.h.

Constructor & Destructor Documentation

GenericTree::GenericTree ( const QString &  a_string = "",
int  an_int = 0,
bool  selectable_flag = false 
)

Definition at line 87 of file generictree.cpp.

Referenced by addNode().

GenericTree::~GenericTree (  )  [virtual]

Definition at line 108 of file generictree.cpp.

Member Function Documentation

GenericTree * GenericTree::addNode ( const QString &  a_string,
int  an_int = 0,
bool  selectable_flag = false 
)

Definition at line 116 of file generictree.cpp.

Referenced by VideoListImp::addDirNode(), VideoListImp::addFileNode(), DirectoryContainer::addToTree(), MythImageFileDialog::buildTree(), MoviesUI::drawDisplayTree(), GameTree::fillNode(), GameTree::GameTree(), MoviesUI::getDisplayTreeByMovie(), MoviesUI::getDisplayTreeByTheater(), OSDGenericTree::OSDGenericTree(), DirectoryContainer::PutVoicemailInTree(), UIListGenericTree::UIListGenericTree(), PlaylistsContainer::writeTree(), Playlist::writeTree(), MusicNode::writeTree(), DirectoryContainer::writeTree(), CallRecord::writeTree(), and DirEntry::writeTree().

GenericTree * GenericTree::addNode ( GenericTree *  child  ) 

Definition at line 125 of file generictree.cpp.

void GenericTree::removeNode ( GenericTree *  child  ) 

Definition at line 134 of file generictree.cpp.

Referenced by VideoGallery::fetchVideos(), and UIListGenericTree::RemoveFromParent().

GenericTree * GenericTree::findLeaf ( int  ordering_index = -1  ) 

Definition at line 163 of file generictree.cpp.

Referenced by UIManagedTreeListType::assignTreeData(), findLeaf(), UIManagedTreeListType::moveToNode(), UIManagedTreeListType::moveToNodesFirstChild(), UIManagedTreeListType::select(), and PlaylistsContainer::writeTree().

GenericTree * GenericTree::findNode ( QValueList< int >  route_of_branches  ) 

Definition at line 178 of file generictree.cpp.

Referenced by UIManagedTreeListType::moveToNode(), UIManagedTreeListType::moveToNodesFirstChild(), MusicPlayer::restorePosition(), and UIManagedTreeListType::tryToSetActive().

GenericTree * GenericTree::recursiveNodeFinder ( QValueList< int >  route_of_branches  ) 

Definition at line 191 of file generictree.cpp.

Referenced by findNode(), and recursiveNodeFinder().

bool GenericTree::checkNode ( QValueList< int >  route_of_branches  ) 

Definition at line 214 of file generictree.cpp.

Referenced by recursiveNodeFinder().

GenericTree * GenericTree::nextSibling ( int  number_down,
int  ordering_index = -1 
)

Definition at line 340 of file generictree.cpp.

Referenced by DirectoryContainer::clearAllVoicemail(), UIManagedTreeListType::Draw(), DirectoryContainer::findInTree(), UIManagedTreeListType::incSearchNext(), UIListTreeType::moveAwayFrom(), UIManagedTreeListType::moveDown(), UIManagedTreeListType::moveDownByAmount(), MusicPlayer::next(), UIManagedTreeListType::nextActive(), and PlaylistsContainer::refreshRelevantPlaylists().

GenericTree * GenericTree::prevSibling ( int  number_up,
int  ordering_index = -1 
)

Definition at line 321 of file generictree.cpp.

Referenced by UIManagedTreeListType::Draw(), UIListTreeType::moveAwayFrom(), UIManagedTreeListType::moveUp(), UIManagedTreeListType::moveUpByAmount(), UIManagedTreeListType::prevActive(), and MusicPlayer::previous().

QPtrListIterator< GenericTree > GenericTree::getFirstChildIterator ( int  ordering = -1  ) 

Definition at line 359 of file generictree.cpp.

Referenced by DatabaseBox::checkParent(), DatabaseBox::checkTree(), DatabaseBox::doSelected(), and DatabaseBox::fillCD().

GenericTree * GenericTree::getSelectedChild ( int  ordering_index  ) 

Definition at line 306 of file generictree.cpp.

Referenced by UIManagedTreeListType::Draw(), and UIManagedTreeListType::pushDown().

GenericTree * GenericTree::getChildAt ( uint  reference,
int  ordering_index = -1 
)

Definition at line 286 of file generictree.cpp.

Referenced by VideoTree::buildVideoList(), DatabaseBox::checkParent(), DirectoryContainer::clearAllVoicemail(), DatabaseBox::doSelected(), PlaybackBoxMusic::doUpdatePlaylist(), VideoGallery::fetchVideos(), DatabaseBox::fillCD(), DirectoryContainer::findInTree(), findLeaf(), getSelectedChild(), VideoGallery::handleDirSelect(), UIManagedTreeListType::incSearchNext(), VideoGallery::moveCursor(), UIManagedTreeListType::moveToNodesFirstChild(), MusicPlayer::next(), UIManagedTreeListType::nextActive(), nextSibling(), UIManagedTreeListType::prevActive(), prevSibling(), PlaylistsContainer::refreshRelevantPlaylists(), MusicPlayer::restorePosition(), OSDListTreeType::SetAsTree(), UIListTreeType::SetTree(), PlaylistsContainer::showRelevantPlaylists(), VideoGallery::updateSingleIcon(), and VideoGallery::updateView().

GenericTree * GenericTree::getChildByName ( const QString &  a_name  ) 

Definition at line 489 of file generictree.cpp.

Referenced by DirectoryContainer::addToTree(), MythImageFileDialog::buildTree(), UIManagedTreeListType::tryToSetCurrent(), and UIListTreeType::tryToSetCurrent().

GenericTree * GenericTree::getChildByInt ( int  an_int  ) 

Definition at line 502 of file generictree.cpp.

QPtrList< GenericTree > * GenericTree::getAllChildren ( int  ordering_index = -1  ) 

Definition at line 278 of file generictree.cpp.

Referenced by UIManagedTreeListType::Draw(), UIListTreeType::FillLevelFromTree(), and OSDListTreeType::FillLevelFromTree().

int GenericTree::getChildPosition ( GenericTree *  child,
int  ordering_index = -1 
)

Definition at line 238 of file generictree.cpp.

Referenced by UIManagedTreeListType::Draw(), getPosition(), nextSibling(), and prevSibling().

int GenericTree::getPosition ( void   ) 

Definition at line 252 of file generictree.cpp.

Referenced by UIManagedTreeListType::Draw(), and VideoGallery::positionIcon().

int GenericTree::getPosition ( int  ordering_index  ) 

Definition at line 259 of file generictree.cpp.

void GenericTree::setInt ( int  an_int  )  [inline]

Definition at line 52 of file generictree.h.

int GenericTree::getInt (  )  [inline]

Definition at line 53 of file generictree.h.

Referenced by UIManagedTreeListType::activate(), checkNode(), MiniPlayer::decreaseRating(), VideoGallery::drawIcon(), UIManagedTreeListType::enter(), VideoGallery::fetchVideos(), GameTree::fillNode(), getChildByInt(), MusicPlayer::getCurrentMetadata(), UIManagedTreeListType::getRouteToActive(), MusicPlayer::getRouteToCurrent(), VideoGallery::handleSelect(), PlaybackBoxMusic::handleTreeListSignals(), VideoGallery::handleVideoSelect(), MiniPlayer::increaseRating(), UIManagedTreeListType::incSearchNext(), VideoGallery::keyPressEvent(), VideoGallery::moveCursor(), UIManagedTreeListType::moveDown(), UIManagedTreeListType::moveDownByAmount(), UIManagedTreeListType::moveToNode(), UIManagedTreeListType::moveToNodesFirstChild(), UIManagedTreeListType::moveUp(), UIManagedTreeListType::moveUpByAmount(), MusicPlayer::next(), MusicPlayer::play(), UIManagedTreeListType::popUp(), MusicPlayer::previous(), UIManagedTreeListType::pushDown(), PlaybackBoxMusic::restorePosition(), MusicPlayer::restorePosition(), UIManagedTreeListType::select(), PlaybackBoxMusic::showEditMetadataDialog(), GameTree::showInfo(), GameTree::toggleFavorite(), MusicPlayer::updateLastplay(), and VideoGallery::updateText().

void GenericTree::setParent ( GenericTree *  a_parent  )  [inline]

Definition at line 55 of file generictree.h.

Referenced by addNode().

GenericTree * GenericTree::getParent ( void   ) 

Definition at line 373 of file generictree.cpp.

Referenced by DatabaseBox::alternateDoMenus(), checkNode(), DatabaseBox::checkParent(), DirectoryContainer::deleteFromTree(), DatabaseBox::deleteTrack(), PlaybackBoxMusic::doUpdatePlaylist(), UIManagedTreeListType::Draw(), DirectoryContainer::findInTree(), UIManagedTreeListType::getRouteToActive(), UIManagedTreeListType::getRouteToCurrent(), UIListTreeType::getRouteToCurrent(), MusicPlayer::getRouteToCurrent(), VideoGallery::goBack(), VideoGallery::handleUpDirSelect(), UIManagedTreeListType::incSearchNext(), VideoGallery::keyPressEvent(), VideoGallery::moveCursor(), UIListGenericTree::movePositionUpDown(), UIManagedTreeListType::moveToNode(), UIManagedTreeListType::moveToNodesFirstChild(), MusicPlayer::next(), UIManagedTreeListType::nextActive(), UIManagedTreeListType::popUp(), UIManagedTreeListType::prevActive(), UIListGenericTree::RemoveFromParent(), UIManagedTreeListType::select(), DatabaseBox::selected(), UIManagedTreeListType::tryToSetActive(), UIListTreeType::tryToSetCurrent(), VideoGallery::updateSingleIcon(), and VideoGallery::updateView().

const QString GenericTree::getString ( void   )  [inline]

Definition at line 58 of file generictree.h.

Referenced by VideoListImp::addDirNode(), DirectoryContainer::clearAllVoicemail(), SortableGenericTreeList::compareItems(), DatabaseBox::doPlaylistPopup(), UIManagedTreeListType::Draw(), MoviesUI::drawDisplayTree(), VideoGallery::drawIcon(), UIListTreeType::FillLevelFromTree(), OSDListTreeType::FillLevelFromTree(), GameTree::fillNode(), getChildByName(), UIManagedTreeListType::getRouteToCurrent(), UIListTreeType::getRouteToCurrent(), MoviesUI::handleTreeListEntry(), PhoneUIBox::handleTreeListSignals(), UIManagedTreeListType::incSearchNext(), UIManagedTreeListType::tryToSetCurrent(), UIListTreeType::tryToSetCurrent(), VideoGallery::updateText(), and PhoneUIBox::vmailEntryDelete().

void GenericTree::setString ( const QString &  str  )  [inline]

Definition at line 59 of file generictree.h.

Referenced by UIListGenericTree::setText().

int GenericTree::calculateDepth ( int  start  ) 

Definition at line 144 of file generictree.cpp.

Referenced by calculateDepth(), DatabaseBox::fillCD(), and OSDListTreeType::SetAsTree().

int GenericTree::childCount ( void   ) 

Definition at line 266 of file generictree.cpp.

Referenced by DatabaseBox::alternateDoMenus(), MythImageFileDialog::buildTree(), VideoTree::buildVideoList(), DatabaseBox::doSelected(), UIManagedTreeListType::Draw(), DatabaseBox::entered(), VideoGallery::fetchVideos(), DatabaseBox::fillCD(), UIListTreeType::FillLevelFromTree(), OSDListTreeType::FillLevelFromTree(), DirectoryContainer::findInTree(), VideoGallery::handleDirSelect(), OSDListTreeType::HandleKeypress(), PlaybackBoxMusic::handleTreeListSignals(), UIListTreeType::MoveRight(), UIManagedTreeListType::moveToNodesFirstChild(), nextSibling(), UIManagedTreeListType::prevActive(), UIManagedTreeListType::pushDown(), PlaylistsContainer::refreshRelevantPlaylists(), UIListGenericTree::RemoveFromParent(), PlaylistsContainer::showRelevantPlaylists(), siblingCount(), and VideoGallery::updateView().

int GenericTree::siblingCount ( void   ) 

Definition at line 271 of file generictree.cpp.

Referenced by PlaybackBoxMusic::doUpdatePlaylist(), UIManagedTreeListType::Draw(), VideoGallery::fetchVideos(), VideoGallery::handleUpDirSelect(), and VideoGallery::positionIcon().

void GenericTree::setSelectable ( bool  flag  )  [inline]

Definition at line 66 of file generictree.h.

Referenced by OSDGenericTree::OSDGenericTree(), and UIListGenericTree::UIListGenericTree().

bool GenericTree::isSelectable (  )  [inline]

Definition at line 67 of file generictree.h.

Referenced by SortableGenericTreeList::compareItems(), UIManagedTreeListType::Draw(), UIManagedTreeListType::select(), and UIManagedTreeListType::tryToSetActive().

void GenericTree::setAttribute ( uint  attribute_position,
int  value_of_attribute 
)

Definition at line 380 of file generictree.cpp.

Referenced by VideoListImp::addDirNode(), VideoListImp::addFileNode(), DirectoryContainer::addToTree(), VideoListImp::build_generic_tree(), MusicPlayer::constructPlaylist(), DirectoryContainer::createTree(), DirectoryContainer::PutVoicemailInTree(), PlaylistsContainer::writeTree(), Playlist::writeTree(), MusicNode::writeTree(), DirectoryContainer::writeTree(), CallRecord::writeTree(), and DirEntry::writeTree().

int GenericTree::getAttribute ( uint  which_one  ) 

Definition at line 391 of file generictree.cpp.

Referenced by SortableGenericTreeList::compareItems(), PhoneUIBox::doMenuPopup(), UIManagedTreeListType::Draw(), VideoGallery::drawIcon(), DirectoryContainer::findInTree(), PlaybackBoxMusic::handleTreeListSignals(), PhoneUIBox::menuEntryDelete(), PhoneUIBox::menuEntryEdit(), PhoneUIBox::menuEntryMakeSpeedDial(), PhoneUIBox::menuHistoryClear(), PhoneUIBox::menuHistorySave(), PhoneUIBox::menuSpeedDialRemove(), PhoneUIBox::vmailEntryDelete(), and PhoneUIBox::vmailEntryDeleteAll().

IntVector* GenericTree::getAttributes ( void   )  [inline]

Definition at line 71 of file generictree.h.

Referenced by UIManagedTreeListType::activate(), UIManagedTreeListType::enter(), UIManagedTreeListType::incSearchNext(), UIManagedTreeListType::moveDown(), UIManagedTreeListType::moveDownByAmount(), UIManagedTreeListType::moveToNode(), UIManagedTreeListType::moveToNodesFirstChild(), UIManagedTreeListType::moveUp(), UIManagedTreeListType::moveUpByAmount(), UIManagedTreeListType::popUp(), UIManagedTreeListType::pushDown(), and UIManagedTreeListType::select().

void GenericTree::reorderSubnodes ( int  ordering_index  ) 

Definition at line 402 of file generictree.cpp.

Referenced by DirectoryContainer::AddToCallHistory(), DirectoryContainer::addToTree(), getChildAt(), getChildPosition(), getFirstChildIterator(), and DirectoryContainer::setSpeedDial().

void GenericTree::setOrderingIndex ( int  ordering_index  )  [inline]

Definition at line 74 of file generictree.h.

Referenced by VideoListImp::addDirNode(), VideoListImp::addFileNode(), and VideoGallery::fetchVideos().

int GenericTree::getOrderingIndex ( void   )  [inline]

Definition at line 76 of file generictree.h.

void GenericTree::becomeSelectedChild ( void   ) 

Definition at line 313 of file generictree.cpp.

Referenced by UIManagedTreeListType::incSearchNext(), UIManagedTreeListType::moveDown(), UIManagedTreeListType::moveDownByAmount(), UIManagedTreeListType::moveUp(), and UIManagedTreeListType::moveUpByAmount().

void GenericTree::setSelectedChild ( GenericTree *  a_node  )  [inline]

Definition at line 79 of file generictree.h.

Referenced by becomeSelectedChild().

void GenericTree::addYourselfIfSelectable ( QPtrList< GenericTree > *  flat_list  ) 

Definition at line 413 of file generictree.cpp.

Referenced by addYourselfIfSelectable(), and buildFlatListOfSubnodes().

void GenericTree::buildFlatListOfSubnodes ( int  ordering_index,
bool  scrambled_parents 
)

Definition at line 427 of file generictree.cpp.

Referenced by UIManagedTreeListType::select().

GenericTree * GenericTree::nextPrevFromFlatList ( bool  forward_or_back,
bool  wrap_around,
GenericTree *  active 
)

Definition at line 452 of file generictree.cpp.

Referenced by UIManagedTreeListType::complexInternalNextPrevActive().

void GenericTree::sortByString (  ) 

Definition at line 517 of file generictree.cpp.

Referenced by sortByString().

void GenericTree::sortByAttributeThenByString ( int  which_attribute  ) 

Definition at line 531 of file generictree.cpp.

Referenced by sortByAttributeThenByString().

void GenericTree::sortBySelectable (  ) 

Definition at line 546 of file generictree.cpp.

Referenced by sortBySelectable().

void GenericTree::deleteAllChildren (  ) 

Definition at line 560 of file generictree.cpp.

Referenced by DirectoryContainer::clearAllVoicemail(), DirectoryContainer::clearCallHistory(), DirectoryContainer::deleteFromTree(), DirectoryContainer::deleteVoicemail(), GameTree::handleTreeListEntry(), pruneAllChildren(), DirectoryContainer::removeSpeedDial(), and MythImageFileDialog::~MythImageFileDialog().

void GenericTree::pruneAllChildren (  ) 

Definition at line 569 of file generictree.cpp.

void GenericTree::reOrderAsSorted (  ) 

Definition at line 582 of file generictree.cpp.

Referenced by reOrderAsSorted().

void GenericTree::MoveItemUpDown ( GenericTree *  item,
bool  flag 
)

Definition at line 613 of file generictree.cpp.

Referenced by UIListGenericTree::movePositionUpDown().

Member Data Documentation

QString GenericTree::m_string [private]

Definition at line 98 of file generictree.h.

Referenced by GenericTree().

int GenericTree::m_int [private]

Definition at line 99 of file generictree.h.

Referenced by GenericTree().

SortableGenericTreeList* GenericTree::m_subnodes [private]

Definition at line 101 of file generictree.h.

Referenced by addNode(), addYourselfIfSelectable(), buildFlatListOfSubnodes(), calculateDepth(), childCount(), deleteAllChildren(), findLeaf(), GenericTree(), getAllChildren(), getChildAt(), getChildByInt(), getChildByName(), getChildPosition(), MoveItemUpDown(), pruneAllChildren(), recursiveNodeFinder(), removeNode(), reOrderAsSorted(), sortByAttributeThenByString(), sortBySelectable(), sortByString(), and ~GenericTree().

SortableGenericTreeList* GenericTree::m_ordered_subnodes [private]

Definition at line 102 of file generictree.h.

Referenced by addNode(), deleteAllChildren(), GenericTree(), getAllChildren(), getChildAt(), getChildPosition(), removeNode(), reOrderAsSorted(), reorderSubnodes(), sortByAttributeThenByString(), sortBySelectable(), sortByString(), and ~GenericTree().

SortableGenericTreeList* GenericTree::m_flatened_subnodes [private]

Definition at line 103 of file generictree.h.

Referenced by buildFlatListOfSubnodes(), deleteAllChildren(), GenericTree(), nextPrevFromFlatList(), removeNode(), and ~GenericTree().

GenericTree* GenericTree::m_selected_subnode [private]

Definition at line 105 of file generictree.h.

Referenced by deleteAllChildren(), GenericTree(), getSelectedChild(), and removeNode().

IntVector* GenericTree::m_attributes [private]

Definition at line 106 of file generictree.h.

Referenced by GenericTree(), getAttribute(), setAttribute(), and ~GenericTree().

GenericTree* GenericTree::m_parent [private]

Definition at line 107 of file generictree.h.

Referenced by becomeSelectedChild(), GenericTree(), getParent(), getPosition(), nextSibling(), prevSibling(), and siblingCount().

bool GenericTree::m_selectable [private]

Definition at line 109 of file generictree.h.

Referenced by addYourselfIfSelectable(), and GenericTree().

int GenericTree::m_current_ordering_index [private]

Definition at line 110 of file generictree.h.

Referenced by deleteAllChildren(), GenericTree(), getChildAt(), getChildPosition(), getFirstChildIterator(), and reOrderAsSorted().

The documentation for this class was generated from the following files:
Generated on Sat Sep 4 05:16:02 2010 for MythTV by  doxygen 1.5.5