KDevelop API Documentation

DocTreeViewTool Class Reference

#include <misc.h>

List of all members.

Static Public Member Functions

void getLibraries (QStringList *libNames, QStringList *docDirs, QStringList *sourceDirs)
void setLibraries (QStringList *libNames, QStringList *docDirs, QStringList *sourceDirs)
void readLibraryDocs (QString dir, QStringList *itemNames, QStringList *fileNames)
void getAllLibraries (QStringList *itemNames, QStringList *fileNames)
void getHiddenLibraries (QStringList *fileNames)
void setHiddenLibraries (const QStringList &fileNames)
void getBookmarks (QStringList *itemNames, QStringList *fileNames)
void setBookmarks (const QStringList &itemNames, const QStringList &fileNames)
void addBookmark (const QString &itemName, const QString &fileName)
void removeBookmark (int index)
QString tocDocDefaultLocation (const QString &fileName)
QString tocLocation (const QString &fileName)
QString tocTitle (const QString &fileName)
void scanDevHelpDirs (const QString path=QString::null)
void scanDevHelpOldWay (const QString path)
void scanDevHelpNewWay ()
void scanDevHelpNewWay (const QString &path)
BookInfo devhelpInfo (const QString &fileName)
QString devhelpLocation (const QString &fileName)
QString devhelpLocation (const QString &docName, const QString &defaultLocation)


Member Function Documentation

void DocTreeViewTool::addBookmark const QString itemName,
const QString fileName
[static]
 

Definition at line 129 of file misc.cpp.

References instanceConfig(), KConfigBase::readListEntry(), setBookmarks(), and KConfigBase::setGroup().

Referenced by DocTreeViewWidget::slotAddBookmark().

BookInfo DocTreeViewTool::devhelpInfo const QString fileName  )  [static]
 

Definition at line 245 of file misc.cpp.

References BookInfo::author, BookInfo::defaultLocation, BookInfo::name, and BookInfo::title.

Referenced by devhelpLocation(), DocTreeGlobalConfigWidget::dhAddButton_clicked(), DocTreeProjectConfigWidget::readConfig(), and DocTreeGlobalConfigWidget::readDevHelpConfig().

QString DocTreeViewTool::devhelpLocation const QString docName,
const QString defaultLocation
[static]
 

Definition at line 222 of file misc.cpp.

References instanceConfig(), KConfigBase::readPathEntry(), and KConfigBase::setGroup().

QString DocTreeViewTool::devhelpLocation const QString fileName  )  [static]
 

Definition at line 229 of file misc.cpp.

References BookInfo::defaultLocation, devhelpInfo(), instanceConfig(), KConfigBase::readPathEntry(), and KConfigBase::setGroup().

Referenced by DocTreeDevHelpFolder::refresh().

void DocTreeViewTool::getAllLibraries QStringList itemNames,
QStringList fileNames
[static]
 

Definition at line 86 of file misc.cpp.

References instanceConfig(), readLibraryDocs(), KConfigBase::readPathEntry(), and KConfigBase::setGroup().

Referenced by DocIndexDialog::readKDocIndex(), and ProgressDialog::scanDirectories().

void DocTreeViewTool::getBookmarks QStringList itemNames,
QStringList fileNames
[static]
 

Definition at line 112 of file misc.cpp.

References instanceConfig(), KConfigBase::readListEntry(), and KConfigBase::setGroup().

Referenced by DocTreeGlobalConfigWidget::readConfig(), DocTreeBookmarksFolder::refresh(), and ProgressDialog::scanDirectories().

void DocTreeViewTool::getHiddenLibraries QStringList fileNames  )  [static]
 

Todo:
not a good name

Definition at line 96 of file misc.cpp.

References instanceConfig(), KConfigBase::readListEntry(), and KConfigBase::setGroup().

Referenced by DocIndexDialog::readKDocIndex(), and ProgressDialog::scanDirectories().

void DocTreeViewTool::getLibraries QStringList libNames,
QStringList docDirs,
QStringList sourceDirs
[static]
 

Definition at line 44 of file misc.cpp.

References instanceConfig(), KConfigBase::readListEntry(), and KConfigBase::setGroup().

void DocTreeViewTool::readLibraryDocs QString  dir,
QStringList itemNames,
QStringList fileNames
[static]
 

Definition at line 62 of file misc.cpp.

References kdDebug().

Referenced by getAllLibraries(), and DocTreeKDELibsFolder::refresh().

void DocTreeViewTool::removeBookmark int  index  )  [static]
 

Definition at line 141 of file misc.cpp.

References instanceConfig(), KConfigBase::readListEntry(), setBookmarks(), and KConfigBase::setGroup().

Referenced by DocTreeViewWidget::slotRemoveBookmark().

void DocTreeViewTool::scanDevHelpDirs const QString  path = QString::null  )  [static]
 

Definition at line 239 of file misc.cpp.

References scanDevHelpNewWay().

Referenced by DocTreeGlobalConfigWidget::dhScanButton_clicked(), DocTreeViewWidget::DocTreeViewWidget(), and DocTreeGlobalConfigWidget::readConfig().

void DocTreeViewTool::scanDevHelpNewWay const QString path  )  [static]
 

Definition at line 387 of file misc.cpp.

References KIO::NetAccess::copy(), KStandardDirs::saveLocation(), KConfigBase::setGroup(), KURL::setPath(), KConfigBase::writeEntry(), and KConfigBase::writePathEntry().

void DocTreeViewTool::scanDevHelpNewWay  )  [static]
 

Definition at line 340 of file misc.cpp.

References instanceConfig(), KConfigBase::readPathEntry(), and KConfigBase::setGroup().

Referenced by scanDevHelpDirs().

void DocTreeViewTool::scanDevHelpOldWay const QString  path  )  [static]
 

Definition at line 270 of file misc.cpp.

References KIO::NetAccess::copy(), instanceConfig(), KConfigBase::readPathEntry(), KStandardDirs::saveLocation(), KConfigBase::setGroup(), KURL::setPath(), KConfigBase::writeEntry(), and KConfigBase::writePathEntry().

void DocTreeViewTool::setBookmarks const QStringList itemNames,
const QStringList fileNames
[static]
 

Definition at line 121 of file misc.cpp.

References instanceConfig(), KConfigBase::setGroup(), and KConfigBase::writeEntry().

Referenced by addBookmark(), removeBookmark(), and DocTreeGlobalConfigWidget::storeConfig().

void DocTreeViewTool::setHiddenLibraries const QStringList fileNames  )  [static]
 

Definition at line 104 of file misc.cpp.

References instanceConfig(), KConfigBase::setGroup(), and KConfigBase::writeEntry().

void DocTreeViewTool::setLibraries QStringList libNames,
QStringList docDirs,
QStringList sourceDirs
[static]
 

Definition at line 53 of file misc.cpp.

References instanceConfig(), KConfigBase::setGroup(), and KConfigBase::writeEntry().

QString DocTreeViewTool::tocDocDefaultLocation const QString fileName  )  [static]
 

Definition at line 154 of file misc.cpp.

References kdDebug().

Referenced by tocLocation().

QString DocTreeViewTool::tocLocation const QString fileName  )  [static]
 

Definition at line 214 of file misc.cpp.

References instanceConfig(), KConfigBase::readPathEntry(), KConfigBase::setGroup(), and tocDocDefaultLocation().

Referenced by DocTreeTocFolder::refresh().

QString DocTreeViewTool::tocTitle const QString fileName  )  [static]
 

Definition at line 185 of file misc.cpp.

References kdDebug().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Feb 22 09:41:21 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003