KDevelop API Documentation

DocumentationPart Class Reference

#include <documentationpart.h>

Inheritance diagram for DocumentationPart:

Inheritance graph
[legend]
Collaboration diagram for DocumentationPart:

Collaboration graph
[legend]
List of all members.

Public Types

enum  ContextFeature {
  Finder, IndexLookup, FullTextSearch, GotoMan,
  GotoInfo
}

Public Slots

void lookInDocumentationIndex ()
void lookInDocumentationIndex (const QString &term)
void contextLookInDocumentationIndex ()
void contextFindDocumentation ()
void findInDocumentation ()
void findInDocumentation (const QString &term)
void searchInDocumentation ()
void searchInDocumentation (const QString &term)
void contextSearchInDocumentation ()
void manPage ()
void manPage (const QString &term)
void contextManPage ()
void infoPage ()
void infoPage (const QString &term)
void contextInfoPage ()
void projectOpened ()
void projectClosed ()

Signals

void indexSelected (IndexBox *indexBox)
void bookmarkLocation (const QString &title, const KURL &url)

Public Member Functions

 DocumentationPart ()
 DocumentationPart (QObject *parent, const char *name, const QStringList &)
 ~DocumentationPart ()
void emitIndexSelected (IndexBox *indexBox)
void emitBookmarkLocation (const QString &title, const KURL &url)
bool configure (int page=0)
bool hasContextFeature (ContextFeature feature)
void setContextFeature (ContextFeature feature, bool b)
bool isAssistantUsed () const
void setAssistantUsed (bool b)

Protected Slots

virtual void slotDuplicate ()
virtual void slotOpenInNewWindow (const KURL &url)
void insertConfigWidget (const KDialogBase *dlg, QWidget *page, unsigned int pageNo)
void contextMenu (QPopupMenu *popup, const Context *context)

Protected Member Functions

void loadDocumentationPlugins ()
KConfigconfig ()
void setupActions ()
void loadSettings ()
void saveProjectDocumentationInfo ()
QCString startAssistant ()
void activateAssistantWindow (const QCString &ref)
void callAssistant (const QCString &interface, const QCString &method)
void callAssistant (const QCString &interface, const QCString &method, const QString &dataStr)

Private Attributes

QGuardedPtr< DocumentationWidgetm_widget
ConfigWidgetProxym_configProxy
QValueList< DocumentationPlugin * > m_plugins
ProjectDocumentationPluginm_projectDocumentationPlugin
ProjectDocumentationPluginm_userManualPlugin
QString m_contextStr
bool m_hasIndex
bool m_assistantUsed

Friends

class DocGlobalConfigWidget
class DocProjectConfigWidget
class SearchView
class FindDocumentation

Member Enumeration Documentation

enum DocumentationPart::ContextFeature
 

Enumeration values:
Finder 
IndexLookup 
FullTextSearch 
GotoMan 
GotoInfo 

Definition at line 46 of file documentation_part.h.


Constructor & Destructor Documentation

DocumentationPart::DocumentationPart  ) 
 

Definition at line 5 of file documentationpart.cpp.

References KDevHTMLPart::setOptions().

DocumentationPart::DocumentationPart QObject parent,
const char *  name,
const QStringList
 

Definition at line 76 of file documentation_part.cpp.

References contextMenu(), KDevPlugin::core(), ConfigWidgetProxy::createGlobalConfigPage(), ConfigWidgetProxy::createProjectConfigPage(), KDevMainWindow::embedSelectViewRight(), GLOBALDOC_OPTIONS, KDevPlugin::icon(), insertConfigWidget(), loadDocumentationPlugins(), loadSettings(), m_configProxy, m_widget, KDevPlugin::mainWindow(), projectClosed(), PROJECTDOC_OPTIONS, projectOpened(), KXMLGUIClient::setInstance(), setupActions(), and KXMLGUIClient::setXMLFile().

DocumentationPart::~DocumentationPart  ) 
 

Definition at line 114 of file documentation_part.cpp.

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


Member Function Documentation

void DocumentationPart::activateAssistantWindow const QCString ref  )  [protected]
 

Definition at line 612 of file documentation_part.cpp.

References DCOPClient::call(), data, KApplication::dcopClient(), kdDebug(), and DCOPClient::send().

Referenced by callAssistant().

void DocumentationPart::bookmarkLocation const QString title,
const KURL url
[signal]
 

Referenced by emitBookmarkLocation().

void DocumentationPart::callAssistant const QCString interface,
const QCString method,
const QString dataStr
[protected]
 

Definition at line 641 of file documentation_part.cpp.

References activateAssistantWindow(), data, KApplication::dcopClient(), kdDebug(), DCOPClient::send(), and startAssistant().

void DocumentationPart::callAssistant const QCString interface,
const QCString method
[protected]
 

Definition at line 631 of file documentation_part.cpp.

References activateAssistantWindow(), data, KApplication::dcopClient(), kdDebug(), DCOPClient::send(), and startAssistant().

Referenced by contextFindDocumentation(), contextInfoPage(), contextLookInDocumentationIndex(), contextManPage(), contextSearchInDocumentation(), findInDocumentation(), infoPage(), lookInDocumentationIndex(), manPage(), and searchInDocumentation().

KConfig * DocumentationPart::config  )  [protected]
 

Definition at line 183 of file documentation_part.cpp.

Referenced by DocGlobalConfigWidget::accept(), DocGlobalConfigWidget::DocGlobalConfigWidget(), hasContextFeature(), loadSettings(), SearchView::search(), setAssistantUsed(), and setContextFeature().

bool DocumentationPart::configure int  page = 0  ) 
 

Definition at line 188 of file documentation_part.cpp.

References DocGlobalConfigWidget, DocGlobalConfigWidgetBase::docTab, m_widget, and KDialogBase::plainPage().

Referenced by SearchView::search().

void DocumentationPart::contextFindDocumentation  )  [slot]
 

Definition at line 323 of file documentation_part.cpp.

References callAssistant(), findInDocumentation(), isAssistantUsed(), and m_contextStr.

Referenced by contextMenu().

void DocumentationPart::contextInfoPage  )  [slot]
 

Definition at line 315 of file documentation_part.cpp.

References callAssistant(), infoPage(), isAssistantUsed(), and m_contextStr.

Referenced by contextMenu().

void DocumentationPart::contextLookInDocumentationIndex  )  [slot]
 

Definition at line 474 of file documentation_part.cpp.

References callAssistant(), isAssistantUsed(), lookInDocumentationIndex(), and m_contextStr.

Referenced by contextMenu().

void DocumentationPart::contextManPage  )  [slot]
 

Definition at line 307 of file documentation_part.cpp.

References callAssistant(), isAssistantUsed(), m_contextStr, and manPage().

Referenced by contextMenu().

void DocumentationPart::contextMenu QPopupMenu popup,
const Context context
[protected, slot]
 

Definition at line 348 of file documentation_part.cpp.

References contextFindDocumentation(), contextInfoPage(), contextLookInDocumentationIndex(), contextManPage(), contextSearchInDocumentation(), KStringHandler::csqueeze(), EditorContext::currentWord(), Finder, FullTextSearch, GotoInfo, GotoMan, hasContextFeature(), Context::hasType(), IndexLookup, and m_contextStr.

Referenced by DocumentationPart().

void DocumentationPart::contextSearchInDocumentation  )  [slot]
 

Definition at line 261 of file documentation_part.cpp.

References callAssistant(), isAssistantUsed(), m_contextStr, and searchInDocumentation().

Referenced by contextMenu().

void DocumentationPart::emitBookmarkLocation const QString title,
const KURL url
 

Definition at line 239 of file documentation_part.cpp.

References bookmarkLocation().

Referenced by DocUtils::docItemPopup().

void DocumentationPart::emitIndexSelected IndexBox indexBox  ) 
 

Definition at line 152 of file documentation_part.cpp.

References IndexBox::fill(), indexSelected(), and m_hasIndex.

Referenced by FindDocumentation::searchInIndex(), and DocumentationWidget::tabChanged().

void DocumentationPart::findInDocumentation const QString term  )  [slot]
 

Definition at line 342 of file documentation_part.cpp.

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

void DocumentationPart::findInDocumentation  )  [slot]
 

Definition at line 331 of file documentation_part.cpp.

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

Referenced by contextFindDocumentation(), and loadSettings().

bool DocumentationPart::hasContextFeature ContextFeature  feature  ) 
 

Definition at line 401 of file documentation_part.cpp.

References config(), Finder, FullTextSearch, GotoInfo, GotoMan, KConfigBase::group(), IndexLookup, KConfigBase::readBoolEntry(), and KConfigBase::setGroup().

Referenced by contextMenu(), and DocGlobalConfigWidget::DocGlobalConfigWidget().

void DocumentationPart::indexSelected IndexBox indexBox  )  [signal]
 

Referenced by emitIndexSelected(), and loadDocumentationPlugins().

void DocumentationPart::infoPage const QString term  )  [slot]
 

Definition at line 301 of file documentation_part.cpp.

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

void DocumentationPart::infoPage  )  [slot]
 

Definition at line 282 of file documentation_part.cpp.

References callAssistant(), KInputDialog::getText(), and isAssistantUsed().

Referenced by contextInfoPage(), and setupActions().

void DocumentationPart::insertConfigWidget const KDialogBase dlg,
QWidget page,
unsigned int  pageNo
[protected, slot]
 

Definition at line 164 of file documentation_part.cpp.

References DocGlobalConfigWidget, DocProjectConfigWidget, GLOBALDOC_OPTIONS, m_widget, and PROJECTDOC_OPTIONS.

Referenced by DocumentationPart().

bool DocumentationPart::isAssistantUsed  )  const
 

Definition at line 592 of file documentation_part.cpp.

Referenced by contextFindDocumentation(), contextInfoPage(), contextLookInDocumentationIndex(), contextManPage(), contextSearchInDocumentation(), DocGlobalConfigWidget::DocGlobalConfigWidget(), findInDocumentation(), infoPage(), lookInDocumentationIndex(), manPage(), searchInDocumentation(), and setAssistantUsed().

void DocumentationPart::loadDocumentationPlugins  )  [protected]
 

Definition at line 123 of file documentation_part.cpp.

References indexSelected(), DocumentationPlugin::init(), kdDebug(), m_plugins, m_widget, and KService::Ptr.

Referenced by DocumentationPart().

void DocumentationPart::loadSettings  )  [protected]
 

Definition at line 653 of file documentation_part.cpp.

References KDevPlugin::aboutData(), config(), findInDocumentation(), lookInDocumentationIndex(), m_assistantUsed, KConfigBase::readBoolEntry(), KConfigBase::readNumEntry(), searchInDocumentation(), and KConfigBase::setGroup().

Referenced by DocumentationPart().

void DocumentationPart::lookInDocumentationIndex const QString term  )  [slot]
 

Definition at line 468 of file documentation_part.cpp.

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

void DocumentationPart::lookInDocumentationIndex  )  [slot]
 

Definition at line 457 of file documentation_part.cpp.

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

Referenced by contextLookInDocumentationIndex(), loadSettings(), and setupActions().

void DocumentationPart::manPage const QString term  )  [slot]
 

Definition at line 295 of file documentation_part.cpp.

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

void DocumentationPart::manPage  )  [slot]
 

Definition at line 269 of file documentation_part.cpp.

References callAssistant(), KInputDialog::getText(), and isAssistantUsed().

Referenced by contextManPage(), and setupActions().

void DocumentationPart::projectClosed  )  [slot]
 

Definition at line 508 of file documentation_part.cpp.

References m_projectDocumentationPlugin, and m_userManualPlugin.

Referenced by DocumentationPart().

void DocumentationPart::projectOpened  )  [slot]
 

Definition at line 482 of file documentation_part.cpp.

References ProjectDocumentationPlugin::init(), kdDebug(), m_plugins, m_projectDocumentationPlugin, m_userManualPlugin, m_widget, KDevPlugin::project(), KDevPlugin::projectDom(), and DomUtil::readEntry().

Referenced by DocumentationPart().

void DocumentationPart::saveProjectDocumentationInfo  )  [protected]
 

Definition at line 518 of file documentation_part.cpp.

References ProjectDocumentationPlugin::catalogURL(), URLUtil::extractPathNameRelative(), m_projectDocumentationPlugin, m_userManualPlugin, ProjectDocumentationPlugin::pluginName(), KDevPlugin::project(), KDevPlugin::projectDom(), and DomUtil::writeEntry().

Referenced by DocProjectConfigWidget::accept().

void DocumentationPart::searchInDocumentation const QString term  )  [slot]
 

Definition at line 255 of file documentation_part.cpp.

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

void DocumentationPart::searchInDocumentation  )  [slot]
 

Definition at line 244 of file documentation_part.cpp.

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

Referenced by contextSearchInDocumentation(), DocUtils::docItemPopup(), loadSettings(), and setupActions().

void DocumentationPart::setAssistantUsed bool  b  ) 
 

Definition at line 603 of file documentation_part.cpp.

References config(), isAssistantUsed(), m_assistantUsed, KConfigBase::setGroup(), and KConfigBase::writeEntry().

Referenced by DocGlobalConfigWidget::accept().

void DocumentationPart::setContextFeature ContextFeature  feature,
bool  b
 

Definition at line 428 of file documentation_part.cpp.

References config(), Finder, FullTextSearch, GotoInfo, GotoMan, KConfigBase::group(), IndexLookup, KConfigBase::setGroup(), and KConfigBase::writeEntry().

Referenced by DocGlobalConfigWidget::accept().

void DocumentationPart::setupActions  )  [protected]
 

Definition at line 202 of file documentation_part.cpp.

References KXMLGUIClient::actionCollection(), infoPage(), lookInDocumentationIndex(), manPage(), and searchInDocumentation().

Referenced by DocumentationPart().

void DocumentationPart::slotDuplicate  )  [protected, virtual, slot]
 

Implements KDevHTMLPart.

Definition at line 11 of file documentationpart.cpp.

References PartController::getInstance(), PartController::showDocument(), and KParts::ReadOnlyPart::url().

void DocumentationPart::slotOpenInNewWindow const KURL url  )  [protected, virtual, slot]
 

Implements KDevHTMLPart.

Definition at line 16 of file documentationpart.cpp.

References PartController::getInstance(), and PartController::showDocument().

QCString DocumentationPart::startAssistant  )  [protected]
 

Definition at line 539 of file documentation_part.cpp.

References DCOPClient::call(), data, KApplication::dcopClient(), DCOPClient::isApplicationRegistered(), kdDebug(), and DCOPClient::remoteObjects().

Referenced by callAssistant().


Friends And Related Function Documentation

friend class DocGlobalConfigWidget [friend]
 

Definition at line 112 of file documentation_part.h.

Referenced by configure(), and insertConfigWidget().

friend class DocProjectConfigWidget [friend]
 

Definition at line 113 of file documentation_part.h.

Referenced by insertConfigWidget().

friend class FindDocumentation [friend]
 

Definition at line 115 of file documentation_part.h.

friend class SearchView [friend]
 

Definition at line 114 of file documentation_part.h.


Member Data Documentation

bool DocumentationPart::m_assistantUsed [private]
 

Definition at line 110 of file documentation_part.h.

Referenced by loadSettings(), and setAssistantUsed().

ConfigWidgetProxy* DocumentationPart::m_configProxy [private]
 

Definition at line 102 of file documentation_part.h.

Referenced by DocumentationPart().

QString DocumentationPart::m_contextStr [private]
 

Definition at line 108 of file documentation_part.h.

Referenced by contextFindDocumentation(), contextInfoPage(), contextLookInDocumentationIndex(), contextManPage(), contextMenu(), and contextSearchInDocumentation().

bool DocumentationPart::m_hasIndex [private]
 

Definition at line 109 of file documentation_part.h.

Referenced by DocGlobalConfigWidget::accept(), and emitIndexSelected().

QValueList<DocumentationPlugin*> DocumentationPart::m_plugins [private]
 

Definition at line 104 of file documentation_part.h.

Referenced by DocProjectConfigWidget::accept(), DocGlobalConfigWidget::accept(), DocGlobalConfigWidget::DocGlobalConfigWidget(), DocProjectConfigWidget::DocProjectConfigWidget(), loadDocumentationPlugins(), and projectOpened().

ProjectDocumentationPlugin* DocumentationPart::m_projectDocumentationPlugin [private]
 

Definition at line 105 of file documentation_part.h.

Referenced by DocProjectConfigWidget::accept(), projectClosed(), projectOpened(), and saveProjectDocumentationInfo().

ProjectDocumentationPlugin* DocumentationPart::m_userManualPlugin [private]
 

Definition at line 106 of file documentation_part.h.

Referenced by DocProjectConfigWidget::accept(), projectClosed(), projectOpened(), and saveProjectDocumentationInfo().

QGuardedPtr<DocumentationWidget> DocumentationPart::m_widget [private]
 

Definition at line 101 of file documentation_part.h.

Referenced by DocProjectConfigWidget::accept(), DocGlobalConfigWidget::accept(), configure(), DocumentationPart(), findInDocumentation(), insertConfigWidget(), loadDocumentationPlugins(), lookInDocumentationIndex(), projectOpened(), searchInDocumentation(), and ~DocumentationPart().


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:27 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003