KDevelop API Documentation

DocumentationItem Class Reference

#include <kdevdocumentationplugin.h>

Inheritance diagram for DocumentationItem:

Inheritance graph
[legend]
Collaboration diagram for DocumentationItem:

Collaboration graph
[legend]
List of all members.

Public Types

enum  Type { Collection, Catalog, Book, Document }

Public Member Functions

 DocumentationItem (Type type, KListView *parent, const QString &name)
 DocumentationItem (Type type, KListView *parent, KListViewItem *after, const QString &name)
 DocumentationItem (Type type, KListViewItem *parent, const QString &name)
 DocumentationItem (Type type, KListViewItem *parent, KListViewItem *after, const QString &name)
virtual void setURL (const KURL &url)
virtual KURL url () const
Type type () const

Private Member Functions

void init ()

Private Attributes

KURL m_url
Type m_type

Member Enumeration Documentation

enum DocumentationItem::Type
 

Enumeration values:
Collection 
Catalog 
Book 
Document 

Definition at line 36 of file kdevdocumentationplugin.h.

Referenced by type().


Constructor & Destructor Documentation

DocumentationItem::DocumentationItem Type  type,
KListView parent,
const QString name
 

Definition at line 36 of file kdevdocumentationplugin.cpp.

References init().

DocumentationItem::DocumentationItem Type  type,
KListView parent,
KListViewItem after,
const QString name
 

Definition at line 50 of file kdevdocumentationplugin.cpp.

References init().

DocumentationItem::DocumentationItem Type  type,
KListViewItem parent,
const QString name
 

Definition at line 43 of file kdevdocumentationplugin.cpp.

References init().

DocumentationItem::DocumentationItem Type  type,
KListViewItem parent,
KListViewItem after,
const QString name
 

Definition at line 57 of file kdevdocumentationplugin.cpp.

References init().


Member Function Documentation

void DocumentationItem::init  )  [private]
 

Definition at line 65 of file kdevdocumentationplugin.cpp.

References Book, and Collection.

Referenced by DocumentationItem().

virtual void DocumentationItem::setURL const KURL url  )  [inline, virtual]
 

Definition at line 43 of file kdevdocumentationplugin.h.

References m_url.

Referenced by BookmarkView::addBookmark(), DocKDevTOCPlugin::addTocSect(), DocDevHelpPlugin::addTocSect(), SearchView::analyseSearchResults(), DocDoxygenPlugin::createBookTOC(), DocPDFPlugin::createCatalog(), DocPDBPlugin::createCatalog(), DocDoxygenPlugin::createCatalog(), DocDjvuPlugin::createCatalog(), DocCustomPlugin::createCatalog(), DocCHMPlugin::createCatalog(), DocQtPlugin::createTOC(), DocDoxygenPlugin::createTOC(), BookmarkView::editBookmark(), FindDocumentation::procInfoReadFromStdout(), FindDocumentation::procManReadFromStdout(), FindDocumentation::searchInContents(), FindDocumentation::searchInGoogle(), FindDocumentation::searchInIndex(), DocQtPlugin::setCatalogURL(), DocKDevTOCPlugin::setCatalogURL(), DocDoxygenPlugin::setCatalogURL(), DocDevHelpPlugin::setCatalogURL(), DocCHMPlugin::setCatalogURL(), and BookmarkView::showBookmarks().

Type DocumentationItem::type  )  const [inline]
 

Definition at line 46 of file kdevdocumentationplugin.h.

References Type.

Referenced by FindDocumentation::searchInContents().

virtual KURL DocumentationItem::url  )  const [inline, virtual]
 

Definition at line 44 of file kdevdocumentationplugin.h.

Referenced by FindDocumentation::buttonPressedOnItem(), FindDocumentation::clickOnItem(), DocDoxygenPlugin::createBookTOC(), DocDoxygenPlugin::createIndex(), DocDoxygenPlugin::createTOC(), DocUtils::docItemPopup(), BookmarkView::editBookmark(), SearchView::executed(), ContentsView::itemExecuted(), BookmarkView::itemExecuted(), FindDocumentation::searchInContents(), DocQtPlugin::setCatalogURL(), DocKDevTOCPlugin::setCatalogURL(), DocDoxygenPlugin::setCatalogURL(), DocDevHelpPlugin::setCatalogURL(), and DocCHMPlugin::setCatalogURL().


Member Data Documentation

Type DocumentationItem::m_type [private]
 

Definition at line 52 of file kdevdocumentationplugin.h.

KURL DocumentationItem::m_url [private]
 

Definition at line 51 of file kdevdocumentationplugin.h.

Referenced by setURL().


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 Wed Mar 23 00:23:56 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003