DocTreeViewPart Class Reference
This part shows apidocs and other documentation. More...
#include <doctreeviewpart.h>
Inheritance diagram for DocTreeViewPart:

Public Member Functions | |
DocTreeViewPart (QObject *parent, const char *name, const QStringList &args) | |
~DocTreeViewPart () | |
Private Slots | |
void | projectOpened () |
void | projectClosed () |
void | contextMenu (QPopupMenu *popup, const Context *context) |
void | slotSearchDocumentation () |
void | slotManpage () |
void | slotRaiseWidget () |
void | slotContextGotoManpage () |
void | slotContextFulltextSearch () |
void | insertConfigWidget (const KDialogBase *dlg, QWidget *page, unsigned int pagenumber) |
Private Attributes | |
QGuardedPtr< DocTreeViewWidget > | m_widget |
QString | m_popupstr |
ConfigWidgetProxy * | _configProxy |
Detailed Description
This part shows apidocs and other documentation.It is also responsible for indexing the documentation. The indexing is done whith the helper tool "kdevelop-htdig", located in htdigindex.h/cpp. With the index you can search for keywords in the kdelibs/qt api.
If you use KDE-3.1 you must make the doxygen docs yourself with "make apidox" in your kdelibs sources. Then copy the subfolders of "apidocs" to a folder of your choice. Recommend is $KDEDIR/share/doc/HTML/en/kdelibs-apidocs/
- Feature(s):
- shows html documentation
indexes the documentation
search for keywords in the indexed documentation
- Todo:
- make project docs nicer
disable STL or remove
custom folders
- Warning:
- If you use KDE-3.1 you must make the doxygen docs yourself with "make apidox" in your kdelibs sources. Then copy the subfolders of "apidocs" to a folder of your choice. Recommend is $KDEDIR/share/doc/HTML/en/kdelibs-apidocs/
Definition at line 27 of file doctreeviewpart.h.
Constructor & Destructor Documentation
|
|
Definition at line 94 of file doctreeviewpart.cpp. References m_widget, KDevPlugin::mainWindow(), and KDevMainWindow::removeView(). |
Member Function Documentation
|
Definition at line 137 of file doctreeviewpart.cpp. References contextMenu(), EditorContext::currentWord(), endl(), Context::hasType(), kdDebug(), m_popupstr, DocumentationContext::selection(), slotContextFulltextSearch(), and slotContextGotoManpage(). Referenced by contextMenu(), and DocTreeViewPart(). |
|
Definition at line 219 of file doctreeviewpart.cpp. References GLOBALDOC_OPTIONS, insertConfigWidget(), m_widget, KDevPlugin::project(), and PROJECTDOC_OPTIONS. Referenced by DocTreeViewPart(), and insertConfigWidget(). |
|
Definition at line 108 of file doctreeviewpart.cpp. References m_widget. Referenced by DocTreeViewPart(). |
|
Definition at line 102 of file doctreeviewpart.cpp. References m_widget, and KDevPlugin::project(). Referenced by DocTreeViewPart(). |
|
Definition at line 209 of file doctreeviewpart.cpp. References m_popupstr, m_widget, KDevPlugin::partController(), DocSearchDialog::performSearch(), DocSearchDialog::setSearchTerm(), and KDevPartController::showDocument(). Referenced by contextMenu(). |
|
Definition at line 203 of file doctreeviewpart.cpp. References m_popupstr, KDevPlugin::partController(), and KDevPartController::showDocument(). Referenced by contextMenu(). |
|
Definition at line 187 of file doctreeviewpart.cpp. References KDevPlugin::partController(), and KDevPartController::showDocument(). Referenced by DocTreeViewPart(). |
|
Definition at line 197 of file doctreeviewpart.cpp. References m_widget, KDevPlugin::mainWindow(), and KDevMainWindow::raiseView(). |
|
Definition at line 177 of file doctreeviewpart.cpp. References endl(), kdDebug(), m_widget, KDevPlugin::partController(), and KDevPartController::showDocument(). Referenced by DocTreeViewPart(). |
Member Data Documentation
|
Definition at line 58 of file doctreeviewpart.h. Referenced by DocTreeViewPart(). |
|
Definition at line 55 of file doctreeviewpart.h. Referenced by contextMenu(), slotContextFulltextSearch(), and slotContextGotoManpage(). |
|
Definition at line 53 of file doctreeviewpart.h. Referenced by DocTreeViewPart(), insertConfigWidget(), projectClosed(), projectOpened(), slotContextFulltextSearch(), slotRaiseWidget(), slotSearchDocumentation(), and ~DocTreeViewPart(). |
The documentation for this class was generated from the following files:
- parts/doctreeview/doctreeviewpart.h
- parts/doctreeview/doctreeviewpart.cpp