KDevelop API Documentation

DocTreeViewPart Class Reference

This part shows apidocs and other documentation. More...

#include <doctreeviewpart.h>

Inheritance diagram for DocTreeViewPart:

KDevPlugin QObject KXMLGUIClient List of all members.

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< DocTreeViewWidgetm_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/

Author(s):
Bernd Gehrmann

Maintainer(s):
Sebastian Kratzert

Alexander Dymo

Feature(s):
shows html documentation

indexes the documentation

search for keywords in the indexed documentation

Bug:
bugs in doctreeview component at Bugzilla database

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

DocTreeViewPart::DocTreeViewPart QObject parent,
const char *  name,
const QStringList args
 

Definition at line 44 of file doctreeviewpart.cpp.

References _configProxy, KXMLGUIClient::actionCollection(), contextMenu(), KDevPlugin::core(), ConfigWidgetProxy::createGlobalConfigPage(), ConfigWidgetProxy::createProjectConfigPage(), DocTreeViewPart(), KDevMainWindow::embedSelectViewRight(), GLOBALDOC_OPTIONS, insertConfigWidget(), m_widget, KDevPlugin::mainWindow(), projectClosed(), PROJECTDOC_OPTIONS, projectOpened(), slotManpage(), and slotSearchDocumentation().

Referenced by DocTreeViewPart().

DocTreeViewPart::~DocTreeViewPart  ) 
 

Definition at line 94 of file doctreeviewpart.cpp.

References m_widget, KDevPlugin::mainWindow(), and KDevMainWindow::removeView().


Member Function Documentation

void DocTreeViewPart::contextMenu QPopupMenu popup,
const Context context
[private, slot]
 

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().

void DocTreeViewPart::insertConfigWidget const KDialogBase dlg,
QWidget page,
unsigned int  pagenumber
[private, slot]
 

Definition at line 219 of file doctreeviewpart.cpp.

References GLOBALDOC_OPTIONS, insertConfigWidget(), m_widget, KDevPlugin::project(), and PROJECTDOC_OPTIONS.

Referenced by DocTreeViewPart(), and insertConfigWidget().

void DocTreeViewPart::projectClosed  )  [private, slot]
 

Definition at line 108 of file doctreeviewpart.cpp.

References m_widget.

Referenced by DocTreeViewPart().

void DocTreeViewPart::projectOpened  )  [private, slot]
 

Definition at line 102 of file doctreeviewpart.cpp.

References m_widget, and KDevPlugin::project().

Referenced by DocTreeViewPart().

void DocTreeViewPart::slotContextFulltextSearch  )  [private, slot]
 

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().

void DocTreeViewPart::slotContextGotoManpage  )  [private, slot]
 

Definition at line 203 of file doctreeviewpart.cpp.

References m_popupstr, KDevPlugin::partController(), and KDevPartController::showDocument().

Referenced by contextMenu().

void DocTreeViewPart::slotManpage  )  [private, slot]
 

Definition at line 187 of file doctreeviewpart.cpp.

References KDevPlugin::partController(), and KDevPartController::showDocument().

Referenced by DocTreeViewPart().

void DocTreeViewPart::slotRaiseWidget  )  [private, slot]
 

Definition at line 197 of file doctreeviewpart.cpp.

References m_widget, KDevPlugin::mainWindow(), and KDevMainWindow::raiseView().

void DocTreeViewPart::slotSearchDocumentation  )  [private, slot]
 

Definition at line 177 of file doctreeviewpart.cpp.

References endl(), kdDebug(), m_widget, KDevPlugin::partController(), and KDevPartController::showDocument().

Referenced by DocTreeViewPart().


Member Data Documentation

ConfigWidgetProxy* DocTreeViewPart::_configProxy [private]
 

Definition at line 58 of file doctreeviewpart.h.

Referenced by DocTreeViewPart().

QString DocTreeViewPart::m_popupstr [private]
 

Definition at line 55 of file doctreeviewpart.h.

Referenced by contextMenu(), slotContextFulltextSearch(), and slotContextGotoManpage().

QGuardedPtr<DocTreeViewWidget> DocTreeViewPart::m_widget [private]
 

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:
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