KDevelop API Documentation

DocTreeItem Class Reference

#include <doctreeitem.h>

Inheritance diagram for DocTreeItem:

Inheritance graph
[legend]
Collaboration diagram for DocTreeItem:

Collaboration graph
[legend]
List of all members.

Public Types

enum  Type { Folder, Book, Doc }

Public Member Functions

 DocTreeItem (KListView *parent, Type type, const QString &text, const QString &context, bool lazy=false)
 DocTreeItem (DocTreeItem *parent, Type type, const QString &text, const QString &context, bool lazy=false)
virtual ~DocTreeItem ()
void postInit ()
virtual QString fileName ()
void setFileName (const QString &fn)
const QStringindexFileName () const
virtual void clear ()
virtual QString context () const
virtual Type type () const
bool isCurrent () const
void setDirty ()
virtual void setOpen (bool open)

Protected Member Functions

void setIndexFileName (const QString &fileName)
virtual void refresh ()

Private Member Functions

void init ()

Private Attributes

Type m_typ
QString m_fileName
QString m_indexFileName
QString m_context
bool m_current: 1
bool m_lazy: 1

Member Enumeration Documentation

enum DocTreeItem::Type
 

Enumeration values:
Folder 
Book 
Doc 

Definition at line 26 of file doctreeitem.h.

Referenced by type().


Constructor & Destructor Documentation

DocTreeItem::DocTreeItem KListView parent,
Type  type,
const QString text,
const QString context,
bool  lazy = false
 

Definition at line 36 of file doctreeitem.cpp.

References init(), and text().

Referenced by DocTreeDevHelpFolder::addTocSect(), DocTreeTocFolder::addTocSect(), DocTreeKDELibsBook::readKdoc2Index(), DocTreeQtFolder::refresh(), DocTreeProjectFolder::refresh(), DocTreeBookmarksFolder::refresh(), and DocTreeDoxygenBook::refresh().

DocTreeItem::DocTreeItem DocTreeItem parent,
Type  type,
const QString text,
const QString context,
bool  lazy = false
 

Definition at line 46 of file doctreeitem.cpp.

References init(), and text().

DocTreeItem::~DocTreeItem  )  [virtual]
 

Definition at line 56 of file doctreeitem.cpp.

References m_indexFileName, DocIndexWatcher::removeItem(), and watcher().


Member Function Documentation

void DocTreeItem::clear  )  [virtual]
 

Definition at line 127 of file doctreeitem.cpp.

Referenced by refresh().

QString DocTreeItem::context  )  const [virtual]
 

Definition at line 90 of file doctreeitem.cpp.

Referenced by DocTreeKDELibsBook::readKdoc2Index(), DocTreeQtFolder::refresh(), DocTreeProjectFolder::refresh(), DocTreeBookmarksFolder::refresh(), DocTreeDoxygenFolder::refresh(), DocTreeDoxygenBook::refresh(), and DocTreeKDELibsFolder::refresh().

QString DocTreeItem::fileName  )  [virtual]
 

Reimplemented in DocTreeKDELibsBook.

Definition at line 85 of file doctreeitem.cpp.

Referenced by DocTreeViewWidget::DocTreeViewWidget(), DocTreeKDELibsBook::fileName(), DocTreeKDELibsBook::refresh(), DocTreeViewWidget::slotAddBookmark(), DocTreeViewWidget::slotContextMenu(), DocTreeViewWidget::slotCurrentTabChanged(), and DocTreeViewWidget::slotItemExecuted().

const QString & DocTreeItem::indexFileName  )  const
 

Definition at line 138 of file doctreeitem.cpp.

Referenced by DocIndexWatcher::addItem(), DocTreeTocFolder::DocTreeTocFolder(), DocTreeKDELibsBook::readContents(), DocTreeQtFolder::refresh(), DocTreeDevHelpFolder::refresh(), DocTreeTocFolder::refresh(), DocTreeDoxygenBook::refresh(), and DocIndexWatcher::removeItem().

void DocTreeItem::init  )  [private]
 

Definition at line 62 of file doctreeitem.cpp.

References m_typ.

Referenced by DocTreeItem().

bool DocTreeItem::isCurrent  )  const
 

Definition at line 100 of file doctreeitem.cpp.

Referenced by setOpen().

void DocTreeItem::postInit  )  [inline]
 

Definition at line 31 of file doctreeitem.h.

References refresh().

Referenced by DocTreeDevHelpFolder::addTocSect(), DocTreeTocFolder::addTocSect(), DocTreeViewWidget::DocTreeViewWidget(), DocTreeKDELibsBook::readKdoc2Index(), DocTreeViewWidget::refresh(), DocTreeQtFolder::refresh(), DocTreeProjectFolder::refresh(), DocTreeBookmarksFolder::refresh(), and DocTreeDoxygenBook::refresh().

void DocTreeItem::refresh  )  [protected, virtual]
 

Reimplemented in DocTreeKDELibsBook, DocTreeKDELibsFolder, DocTreeDoxygenBook, DocTreeDoxygenFolder, DocTreeTocFolder, DocTreeDevHelpFolder, DocTreeBookmarksFolder, DocTreeProjectFolder, and DocTreeQtFolder.

Definition at line 121 of file doctreeitem.cpp.

References clear(), and m_current.

Referenced by postInit(), DocTreeQtFolder::refresh(), DocTreeProjectFolder::refresh(), DocTreeBookmarksFolder::refresh(), DocTreeDevHelpFolder::refresh(), DocTreeTocFolder::refresh(), DocTreeDoxygenFolder::refresh(), DocTreeDoxygenBook::refresh(), DocTreeKDELibsFolder::refresh(), DocTreeKDELibsBook::refresh(), and setOpen().

void DocTreeItem::setDirty  ) 
 

Definition at line 105 of file doctreeitem.cpp.

References m_current.

void DocTreeItem::setFileName const QString fn  ) 
 

Definition at line 80 of file doctreeitem.cpp.

References m_fileName.

Referenced by DocTreeDevHelpFolder::addTocSect(), DocTreeTocFolder::addTocSect(), DocTreeDoxygenBook::DocTreeDoxygenBook(), DocTreeTocFolder::DocTreeTocFolder(), DocTreeKDELibsBook::readKdoc2Index(), DocTreeQtFolder::refresh(), DocTreeProjectFolder::refresh(), DocTreeBookmarksFolder::refresh(), DocTreeDevHelpFolder::refresh(), DocTreeDoxygenFolder::refresh(), and DocTreeDoxygenBook::refresh().

void DocTreeItem::setIndexFileName const QString fileName  )  [protected]
 

Definition at line 143 of file doctreeitem.cpp.

References DocIndexWatcher::addItem(), m_indexFileName, DocIndexWatcher::removeItem(), and watcher().

Referenced by DocTreeDevHelpFolder::DocTreeDevHelpFolder(), DocTreeDoxygenBook::DocTreeDoxygenBook(), DocTreeKDELibsBook::DocTreeKDELibsBook(), DocTreeQtFolder::DocTreeQtFolder(), and DocTreeTocFolder::DocTreeTocFolder().

void DocTreeItem::setOpen bool  open  )  [virtual]
 

Definition at line 110 of file doctreeitem.cpp.

References isCurrent(), m_lazy, and refresh().

DocTreeItem::Type DocTreeItem::type  )  const [virtual]
 

Definition at line 95 of file doctreeitem.cpp.

References Type.


Member Data Documentation

QString DocTreeItem::m_context [private]
 

Definition at line 55 of file doctreeitem.h.

bool DocTreeItem::m_current [private]
 

Definition at line 56 of file doctreeitem.h.

Referenced by refresh(), and setDirty().

QString DocTreeItem::m_fileName [private]
 

Definition at line 55 of file doctreeitem.h.

Referenced by setFileName().

QString DocTreeItem::m_indexFileName [private]
 

Definition at line 55 of file doctreeitem.h.

Referenced by setIndexFileName(), and ~DocTreeItem().

bool DocTreeItem::m_lazy [private]
 

Definition at line 56 of file doctreeitem.h.

Referenced by setOpen().

Type DocTreeItem::m_typ [private]
 

Definition at line 54 of file doctreeitem.h.

Referenced by init().


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