KDevelop API Documentation

misc.h

Go to the documentation of this file.
00001 /***************************************************************************
00002  *   Copyright (C) 2001 by Bernd Gehrmann                                  *
00003  *   bernd@kdevelop.org                                                    *
00004  *                                                                         *
00005  *   This program is free software; you can redistribute it and/or modify  *
00006  *   it under the terms of the GNU General Public License as published by  *
00007  *   the Free Software Foundation; either version 2 of the License, or     *
00008  *   (at your option) any later version.                                   *
00009  *                                                                         *
00010  ***************************************************************************/
00011 
00012 #ifndef _MISC_H_
00013 #define _MISC_H_
00014 
00015 #include <qstringlist.h>
00016 class QDomDocument;
00017 
00018 struct BookInfo{
00019     QString title;
00020     QString name;
00021     QString author;
00022     QString defaultLocation;
00023 };
00024 
00025 class DocTreeViewTool
00026 {
00027 public:
00028     // List of libraries to document
00029     static void getLibraries(QStringList *libNames, QStringList *docDirs, QStringList *sourceDirs);
00030     static void setLibraries(QStringList *libNames, QStringList *docDirs, QStringList *sourceDirs);
00031     // Looks up kdoc index files and returns lists of library names
00032     // and the corresponding index file names. Index files in ~/.kdoc
00033     // have a (private) suffix in their item name
00034     static void readLibraryDocs(QString dir, QStringList *itemNames, QStringList *fileNames);
00035     static void getAllLibraries(QStringList *itemNames, QStringList *fileNames); 
00036     // Returns the list of index files to be hidden
00037     static void getHiddenLibraries(QStringList *fileNames);
00038     static void setHiddenLibraries(const QStringList &fileNames);
00039     // Returns the list of items for the Others tree
00040     static void getBookmarks(QStringList *itemNames, QStringList *fileNames);
00041     static void setBookmarks(const QStringList &itemNames, const QStringList &fileNames);
00042     static void addBookmark(const QString& itemName, const QString & fileName);
00043     static void removeBookmark( int index );
00044 
00045     static QString tocDocDefaultLocation(const QString& fileName);
00046     static QString tocLocation(const QString& fileName);
00047     static QString tocTitle(const QString& fileName);
00048 
00049     // Scans for devhelp installation in path and copies all .devhelp files found into $kde_datadir/kdevdoctreeview/devhelp/
00050     // If the path is not provided, use setting from instance config in DevHelp/DevHelpDir
00051     static void scanDevHelpDirs(const QString path = QString::null);
00052     static void scanDevHelpOldWay(const QString path);
00053     static void scanDevHelpNewWay();
00054     static void scanDevHelpNewWay(const QString &path);
00055     static BookInfo devhelpInfo(const QString& fileName);
00056     static QString devhelpLocation(const QString& fileName);
00057     static QString devhelpLocation(const QString& docName, const QString &defaultLocation);
00058 };
00059 
00060 #endif
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 23 00:03:53 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003