KDevelop API Documentation

DocTreeViewWidget Class Reference

#include <doctreeviewwidget.h>

Inheritance diagram for DocTreeViewWidget:

QVBox List of all members.

Public Member Functions

 DocTreeViewWidget (DocTreeViewPart *part)
 ~DocTreeViewWidget ()
void configurationChanged ()
void projectChanged (KDevProject *project)

Static Public Member Functions

QString locatehtml (const QString &fileName)

Protected Member Functions

void searchForItem (const QString &)
bool initKDocKDELibs ()
void filterMultiReferences ()

Private Types

enum  { filteredMode, plainListMode }

Private Slots

void refresh ()
void slotConfigure ()
void slotConfigureProject ()
void slotItemExecuted (QListViewItem *item)
void slotContextMenu (KListView *, QListViewItem *item, const QPoint &p)
void slotJumpToNextMatch ()
void slotJumpToPrevMatch ()
void slotStartSearching ()
void slotHistoryReturnPressed (const QString &)
void slotSelectionChanged (QListViewItem *)
void slotAddBookmark ()
void slotRemoveBookmark ()
void slotFilterTextChanged (const QString &)
void slotFilterReturn ()
void slotIndexItemExecuted (QListViewItem *item)
void slotCurrentTabChanged (int)
void slotSubstringCheckClicked ()
void slotIndexModeCheckClicked ()
void slotIndexNextMatch ()
void slotIndexPrevMatch ()
void slotIndexPgUp ()
void slotIndexPgDown ()
void slotIndexHome ()
void slotIndexEnd ()

Private Attributes

bool kdelibskdoc
KListViewdocView
QPtrList< QListViewItemsearchResultList
QListViewItemcontextItem
QPtrList< DocTreeDoxygenFolderfolder_doxygen
QPtrList< DocTreeKDELibsFolderfolder_kdoc
DocTreeBookmarksFolderfolder_bookmarks
DocTreeDocbaseFolder * folder_docbase
DocTreeProjectFolderfolder_project
QPtrList< DocTreeTocFolderfolder_toc
QPtrList< DocTreeDevHelpFolderfolder_devhelp
DocTreeViewPartm_part
QPtrList< DocTreeQtFolderfolder_qt
QHBoxsearchToolbar
QToolButtonprevButton
QToolButtonnextButton
QToolButtonstartButton
KHistoryCombocompletionCombo
DocTreeItemm_activeTreeItem
KTabCtlmodeSwitch
QVBoxtreeWidget
QVBoxindexWidget
DocLineEditfilterEdit
KListViewindexView
QToolButtonsubSearchButton
QToolButtonindexModeSwitch
int indexMode
bool subStringSearch
QPtrList< IndexTreeDataindexItems

Member Enumeration Documentation

anonymous enum [private]
 

Enumeration values:
filteredMode 
plainListMode 

Definition at line 148 of file doctreeviewwidget.h.


Constructor & Destructor Documentation

DocTreeViewWidget::DocTreeViewWidget DocTreeViewPart part  ) 
 

Definition at line 1002 of file doctreeviewwidget.cpp.

References KListView::addColumn(), KTabCtl::addTab(), completionCombo, DocTreeViewWidget(), docView, KConfig::entryMap(), URLUtil::envExpand(), filterEdit, KStandardDirs::findAllResources(), folder_bookmarks, folder_devhelp, folder_docbase, folder_doxygen, folder_kdoc, folder_project, folder_qt, folder_toc, indexModeSwitch, indexView, indexWidget, m_part, modeSwitch, nextButton, prevButton, KConfigBase::readEntry(), KConfigBase::readPathEntry(), DocTreeQtFolder::refresh(), DocTreeDoxygenFolder::refresh(), DocTreeKDELibsFolder::refresh(), DocTreeProjectFolder::refresh(), DocTreeBookmarksFolder::refresh(), searchToolbar, KTabCtl::setBorder(), KConfigBase::setGroup(), KListView::setSorting(), slotContextMenu(), slotCurrentTabChanged(), slotFilterReturn(), slotFilterTextChanged(), slotHistoryReturnPressed(), slotIndexEnd(), slotIndexHome(), slotIndexItemExecuted(), slotIndexModeCheckClicked(), slotIndexNextMatch(), slotIndexPgDown(), slotIndexPgUp(), slotIndexPrevMatch(), slotItemExecuted(), slotJumpToNextMatch(), slotJumpToPrevMatch(), slotSelectionChanged(), slotStartSearching(), slotSubstringCheckClicked(), startButton, subSearchButton, treeWidget, KConfigBase::writeEntry(), and KConfigBase::writePathEntry().

Referenced by DocTreeViewWidget().

DocTreeViewWidget::~DocTreeViewWidget  ) 
 

Definition at line 1250 of file doctreeviewwidget.cpp.


Member Function Documentation

void DocTreeViewWidget::configurationChanged  ) 
 

Definition at line 1464 of file doctreeviewwidget.cpp.

References endl(), initKDocKDELibs(), kdDebug(), and refresh().

Referenced by DocTreeProjectConfigWidget::accept(), and DocTreeGlobalConfigWidget::accept().

void DocTreeViewWidget::filterMultiReferences  )  [protected]
 

Definition at line 1795 of file doctreeviewwidget.cpp.

References indexItems, IndexTreeData::isVisible(), IndexTreeData::setVisible(), and IndexTreeData::text().

bool DocTreeViewWidget::initKDocKDELibs  )  [protected]
 

Definition at line 979 of file doctreeviewwidget.cpp.

Referenced by configurationChanged().

QString DocTreeViewWidget::locatehtml const QString fileName  )  [static]
 

Definition at line 1684 of file doctreeviewwidget.cpp.

References locate(), and locatehtml().

Referenced by locatehtml().

void DocTreeViewWidget::projectChanged KDevProject project  ) 
 

Definition at line 1579 of file doctreeviewwidget.cpp.

References docView, endl(), folder_bookmarks, folder_devhelp, folder_docbase, folder_doxygen, folder_kdoc, folder_project, folder_qt, folder_toc, kdDebug(), m_part, projectChanged(), KDevPlugin::projectDom(), DocTreeProjectFolder::refresh(), DocTreeProjectFolder::setProject(), and KListView::takeItem().

Referenced by projectChanged().

void DocTreeViewWidget::refresh  )  [private, slot]
 

Definition at line 1472 of file doctreeviewwidget.cpp.

References docView, endl(), KConfig::entryMap(), KStandardDirs::findAllResources(), folder_bookmarks, folder_devhelp, folder_doxygen, folder_kdoc, folder_project, folder_qt, folder_toc, kdDebug(), m_part, KDevPlugin::projectDom(), DocTreeQtFolder::refresh(), DocTreeDoxygenFolder::refresh(), DocTreeKDELibsFolder::refresh(), DocTreeProjectFolder::refresh(), DocTreeBookmarksFolder::refresh(), and KConfigBase::setGroup().

Referenced by configurationChanged().

void DocTreeViewWidget::searchForItem const QString  )  [protected]
 

Definition at line 1253 of file doctreeviewwidget.cpp.

References KHistoryCombo::addToHistory(), completionCombo, docView, searchForItem(), and searchResultList.

Referenced by searchForItem(), and slotHistoryReturnPressed().

void DocTreeViewWidget::slotAddBookmark  )  [private, slot]
 

Definition at line 1695 of file doctreeviewwidget.cpp.

References contextItem, DocTreeItem::fileName(), folder_bookmarks, and DocTreeBookmarksFolder::refresh().

Referenced by slotContextMenu().

void DocTreeViewWidget::slotConfigure  )  [private, slot]
 

Definition at line 1429 of file doctreeviewwidget.cpp.

References KDialogBase::addVBoxPage(), and m_part.

Referenced by slotContextMenu().

void DocTreeViewWidget::slotConfigureProject  )  [private, slot]
 

Definition at line 1444 of file doctreeviewwidget.cpp.

References KDialogBase::addVBoxPage(), m_part, and KDevPlugin::project().

Referenced by slotContextMenu().

void DocTreeViewWidget::slotContextMenu KListView ,
QListViewItem item,
const QPoint p
[private, slot]
 

Definition at line 1387 of file doctreeviewwidget.cpp.

References contextItem, KDevPlugin::core(), DocTreeItem::fileName(), KDevCore::fillContextMenu(), folder_bookmarks, folder_project, m_part, slotAddBookmark(), slotConfigure(), slotConfigureProject(), slotContextMenu(), and slotRemoveBookmark().

Referenced by DocTreeViewWidget(), and slotContextMenu().

void DocTreeViewWidget::slotCurrentTabChanged int   )  [private, slot]
 

Definition at line 1828 of file doctreeviewwidget.cpp.

References docView, DocTreeItem::fileName(), indexItems, indexView, slotCurrentTabChanged(), and slotIndexModeCheckClicked().

Referenced by DocTreeViewWidget(), and slotCurrentTabChanged().

void DocTreeViewWidget::slotFilterReturn  )  [private, slot]
 

Definition at line 1745 of file doctreeviewwidget.cpp.

References indexView.

Referenced by DocTreeViewWidget().

void DocTreeViewWidget::slotFilterTextChanged const QString  )  [private, slot]
 

Definition at line 1722 of file doctreeviewwidget.cpp.

References indexView, slotFilterTextChanged(), and subStringSearch.

Referenced by DocTreeViewWidget(), slotFilterTextChanged(), slotIndexModeCheckClicked(), and slotSubstringCheckClicked().

void DocTreeViewWidget::slotHistoryReturnPressed const QString  )  [private, slot]
 

Definition at line 1315 of file doctreeviewwidget.cpp.

References docView, endl(), kdDebug(), nextButton, prevButton, searchForItem(), searchResultList, slotHistoryReturnPressed(), and slotItemExecuted().

Referenced by DocTreeViewWidget(), slotHistoryReturnPressed(), and slotStartSearching().

void DocTreeViewWidget::slotIndexEnd  )  [private, slot]
 

Definition at line 1958 of file doctreeviewwidget.cpp.

Referenced by DocTreeViewWidget().

void DocTreeViewWidget::slotIndexHome  )  [private, slot]
 

Definition at line 1948 of file doctreeviewwidget.cpp.

Referenced by DocTreeViewWidget().

void DocTreeViewWidget::slotIndexItemExecuted QListViewItem item  )  [private, slot]
 

Definition at line 1755 of file doctreeviewwidget.cpp.

References filteredMode, indexItems, indexMode, KDevMainWindow::lowerView(), m_part, KDevPlugin::mainWindow(), IndexTreeData::parent(), KDevPlugin::partController(), plainListMode, ChooseDlg::setList(), KDevPartController::showDocument(), slotIndexItemExecuted(), and IndexTreeData::text().

Referenced by DocTreeViewWidget(), and slotIndexItemExecuted().

void DocTreeViewWidget::slotIndexModeCheckClicked  )  [private, slot]
 

Definition at line 1876 of file doctreeviewwidget.cpp.

References filterEdit, filteredMode, indexItems, indexMode, indexView, IndexTreeData::isVisible(), IndexTreeData::parent(), plainListMode, slotFilterTextChanged(), and IndexTreeData::text().

Referenced by DocTreeViewWidget(), and slotCurrentTabChanged().

void DocTreeViewWidget::slotIndexNextMatch  )  [private, slot]
 

Definition at line 1901 of file doctreeviewwidget.cpp.

References indexView.

Referenced by DocTreeViewWidget().

void DocTreeViewWidget::slotIndexPgDown  )  [private, slot]
 

Definition at line 1931 of file doctreeviewwidget.cpp.

Referenced by DocTreeViewWidget().

void DocTreeViewWidget::slotIndexPgUp  )  [private, slot]
 

Definition at line 1927 of file doctreeviewwidget.cpp.

Referenced by DocTreeViewWidget().

void DocTreeViewWidget::slotIndexPrevMatch  )  [private, slot]
 

Definition at line 1914 of file doctreeviewwidget.cpp.

References indexView.

Referenced by DocTreeViewWidget().

void DocTreeViewWidget::slotItemExecuted QListViewItem item  )  [private, slot]
 

Definition at line 1359 of file doctreeviewwidget.cpp.

References DocTreeItem::context(), endl(), DocTreeItem::fileName(), kdDebug(), KDevMainWindow::lowerView(), m_part, KDevPlugin::mainWindow(), KDevPlugin::partController(), KDevPartController::showDocument(), and slotItemExecuted().

Referenced by DocTreeViewWidget(), slotHistoryReturnPressed(), slotItemExecuted(), slotJumpToNextMatch(), and slotJumpToPrevMatch().

void DocTreeViewWidget::slotJumpToNextMatch  )  [private, slot]
 

Definition at line 1272 of file doctreeviewwidget.cpp.

References docView, nextButton, prevButton, searchResultList, and slotItemExecuted().

Referenced by DocTreeViewWidget().

void DocTreeViewWidget::slotJumpToPrevMatch  )  [private, slot]
 

Definition at line 1291 of file doctreeviewwidget.cpp.

References docView, nextButton, prevButton, searchResultList, and slotItemExecuted().

Referenced by DocTreeViewWidget().

void DocTreeViewWidget::slotRemoveBookmark  )  [private, slot]
 

Definition at line 1705 of file doctreeviewwidget.cpp.

References contextItem, docView, folder_bookmarks, KListView::itemIndex(), and DocTreeBookmarksFolder::refresh().

Referenced by slotContextMenu().

void DocTreeViewWidget::slotSelectionChanged QListViewItem  )  [private, slot]
 

Definition at line 1341 of file doctreeviewwidget.cpp.

References contextItem, and slotSelectionChanged().

Referenced by DocTreeViewWidget(), and slotSelectionChanged().

void DocTreeViewWidget::slotStartSearching  )  [private, slot]
 

Definition at line 1309 of file doctreeviewwidget.cpp.

References completionCombo, and slotHistoryReturnPressed().

Referenced by DocTreeViewWidget().

void DocTreeViewWidget::slotSubstringCheckClicked  )  [private, slot]
 

Definition at line 1870 of file doctreeviewwidget.cpp.

References filterEdit, slotFilterTextChanged(), and subStringSearch.

Referenced by DocTreeViewWidget().


Member Data Documentation

KHistoryCombo* DocTreeViewWidget::completionCombo [private]
 

Definition at line 134 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), searchForItem(), and slotStartSearching().

QListViewItem* DocTreeViewWidget::contextItem [private]
 

Definition at line 117 of file doctreeviewwidget.h.

Referenced by slotAddBookmark(), slotContextMenu(), slotRemoveBookmark(), and slotSelectionChanged().

KListView* DocTreeViewWidget::docView [private]
 

Definition at line 114 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), projectChanged(), refresh(), searchForItem(), slotCurrentTabChanged(), slotHistoryReturnPressed(), slotJumpToNextMatch(), slotJumpToPrevMatch(), and slotRemoveBookmark().

DocLineEdit* DocTreeViewWidget::filterEdit [private]
 

Definition at line 141 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), slotIndexModeCheckClicked(), and slotSubstringCheckClicked().

DocTreeBookmarksFolder* DocTreeViewWidget::folder_bookmarks [private]
 

Definition at line 121 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), projectChanged(), refresh(), slotAddBookmark(), slotContextMenu(), and slotRemoveBookmark().

QPtrList<DocTreeDevHelpFolder> DocTreeViewWidget::folder_devhelp [private]
 

Definition at line 125 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), projectChanged(), and refresh().

DocTreeDocbaseFolder* DocTreeViewWidget::folder_docbase [private]
 

Definition at line 122 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), and projectChanged().

QPtrList<DocTreeDoxygenFolder> DocTreeViewWidget::folder_doxygen [private]
 

Definition at line 118 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), projectChanged(), and refresh().

QPtrList<DocTreeKDELibsFolder> DocTreeViewWidget::folder_kdoc [private]
 

Definition at line 120 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), projectChanged(), and refresh().

DocTreeProjectFolder* DocTreeViewWidget::folder_project [private]
 

Definition at line 123 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), projectChanged(), refresh(), and slotContextMenu().

QPtrList<DocTreeQtFolder> DocTreeViewWidget::folder_qt [private]
 

Definition at line 127 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), projectChanged(), and refresh().

QPtrList<DocTreeTocFolder> DocTreeViewWidget::folder_toc [private]
 

Definition at line 124 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), projectChanged(), and refresh().

QPtrList<IndexTreeData> DocTreeViewWidget::indexItems [private]
 

Definition at line 150 of file doctreeviewwidget.h.

Referenced by filterMultiReferences(), slotCurrentTabChanged(), slotIndexItemExecuted(), and slotIndexModeCheckClicked().

int DocTreeViewWidget::indexMode [private]
 

Definition at line 145 of file doctreeviewwidget.h.

Referenced by slotIndexItemExecuted(), and slotIndexModeCheckClicked().

QToolButton* DocTreeViewWidget::indexModeSwitch [private]
 

Definition at line 144 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget().

KListView* DocTreeViewWidget::indexView [private]
 

Definition at line 142 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), slotCurrentTabChanged(), slotFilterReturn(), slotFilterTextChanged(), slotIndexModeCheckClicked(), slotIndexNextMatch(), and slotIndexPrevMatch().

QVBox* DocTreeViewWidget::indexWidget [private]
 

Definition at line 140 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget().

bool DocTreeViewWidget::kdelibskdoc [private]
 

Definition at line 113 of file doctreeviewwidget.h.

DocTreeItem* DocTreeViewWidget::m_activeTreeItem [private]
 

Definition at line 136 of file doctreeviewwidget.h.

DocTreeViewPart* DocTreeViewWidget::m_part [private]
 

Definition at line 126 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), projectChanged(), refresh(), slotConfigure(), slotConfigureProject(), slotContextMenu(), slotIndexItemExecuted(), and slotItemExecuted().

KTabCtl* DocTreeViewWidget::modeSwitch [private]
 

Definition at line 138 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget().

QToolButton* DocTreeViewWidget::nextButton [private]
 

Definition at line 132 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), slotHistoryReturnPressed(), slotJumpToNextMatch(), and slotJumpToPrevMatch().

QToolButton* DocTreeViewWidget::prevButton [private]
 

Definition at line 131 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget(), slotHistoryReturnPressed(), slotJumpToNextMatch(), and slotJumpToPrevMatch().

QPtrList<QListViewItem> DocTreeViewWidget::searchResultList [private]
 

Definition at line 115 of file doctreeviewwidget.h.

Referenced by searchForItem(), slotHistoryReturnPressed(), slotJumpToNextMatch(), and slotJumpToPrevMatch().

QHBox* DocTreeViewWidget::searchToolbar [private]
 

Definition at line 129 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget().

QToolButton* DocTreeViewWidget::startButton [private]
 

Definition at line 133 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget().

QToolButton* DocTreeViewWidget::subSearchButton [private]
 

Definition at line 143 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget().

bool DocTreeViewWidget::subStringSearch [private]
 

Definition at line 146 of file doctreeviewwidget.h.

Referenced by slotFilterTextChanged(), and slotSubstringCheckClicked().

QVBox* DocTreeViewWidget::treeWidget [private]
 

Definition at line 139 of file doctreeviewwidget.h.

Referenced by DocTreeViewWidget().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.0.4.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Oct 6 17:39:23 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003