• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdepim
  • Sitemap
  • Contact Us
 

knode

KNFolder Class Reference

#include <knfolder.h>

Inheritance diagram for KNFolder:

Inheritance graph
[legend]

List of all members.


Detailed Description

Representation of a folder.

This includes:

  • Information about the folder (eg. name, parent)
  • Methods to load the folder content from a mbox file.
  • Methods to store the folder content in a mbox file.

Definition at line 32 of file knfolder.h.


Public Member Functions

KNLocalArticle * at (int i)
KNLocalArticle * byId (int id)
KNLocalArticle * byMessageId (const QByteArray &mid)
void deleteAll ()
void deleteFiles ()
int id () const
bool isRootFolder ()
bool isStandardFolder ()
 KNFolder (int id, const QString &name, const QString &prefix, KNFolder *parent=0)
 KNFolder (int id, const QString &name, KNFolder *parent=0)
 KNFolder ()
bool loadArticle (KNLocalArticle *a)
bool loadHdrs ()
int parentId () const
QString path ()
bool readInfo ()
bool readInfo (const QString &confPath)
void removeArticles (KNLocalArticle::List &l, bool del=true)
bool saveArticles (KNLocalArticle::List &l)
void saveInfo ()
void setId (int i)
void setParent (KNCollection *p)
void syncIndex (bool force=false)
collectionType type ()
bool unloadHdrs (bool force=true)
void updateListItem ()
bool wasOpen () const
 ~KNFolder ()

Protected Member Functions

void closeFiles ()

Protected Attributes

int i_d
bool i_ndexDirty
QFile i_ndexFile
QString i_nfoPath
QFile m_boxFile
int p_arentId
bool w_asOpen

Classes

class  DynData

Constructor & Destructor Documentation

KNFolder::KNFolder (  ) 

Definition at line 38 of file knfolder.cpp.

KNFolder::KNFolder ( int  id,
const QString &  name,
KNFolder *  parent = 0 
)

Definition at line 44 of file knfolder.cpp.

KNFolder::KNFolder ( int  id,
const QString &  name,
const QString &  prefix,
KNFolder *  parent = 0 
)

Definition at line 63 of file knfolder.cpp.

KNFolder::~KNFolder (  ) 

Definition at line 82 of file knfolder.cpp.


Member Function Documentation

KNLocalArticle* KNFolder::at ( int  i  )  [inline]

Reimplemented from KNArticleCollection.

Definition at line 63 of file knfolder.h.

KNLocalArticle* KNFolder::byId ( int  id  )  [inline]

Reimplemented from KNArticleCollection.

Definition at line 64 of file knfolder.h.

KNLocalArticle* KNFolder::byMessageId ( const QByteArray &  mid  )  [inline]

Reimplemented from KNArticleCollection.

Definition at line 65 of file knfolder.h.

void KNFolder::closeFiles (  )  [protected]

Definition at line 564 of file knfolder.cpp.

void KNFolder::deleteAll (  ) 

Definition at line 517 of file knfolder.cpp.

void KNFolder::deleteFiles (  ) 

Definition at line 532 of file knfolder.cpp.

int KNFolder::id (  )  const [inline]

Definition at line 46 of file knfolder.h.

bool KNFolder::isRootFolder (  )  [inline]

Definition at line 50 of file knfolder.h.

bool KNFolder::isStandardFolder (  )  [inline]

Definition at line 49 of file knfolder.h.

bool KNFolder::loadArticle ( KNLocalArticle *  a  ) 

Definition at line 330 of file knfolder.cpp.

bool KNFolder::loadHdrs (  ) 

Definition at line 167 of file knfolder.cpp.

int KNFolder::parentId (  )  const [inline]

Definition at line 48 of file knfolder.h.

QString KNFolder::path (  )  [virtual]

Implements KNCollection.

Definition at line 98 of file knfolder.cpp.

bool KNFolder::readInfo (  ) 

Definition at line 138 of file knfolder.cpp.

bool KNFolder::readInfo ( const QString &  confPath  )  [virtual]

Load the properties/settings of this collection.

Implements KNCollection.

Definition at line 107 of file knfolder.cpp.

void KNFolder::removeArticles ( KNLocalArticle::List &  l,
bool  del = true 
)

Definition at line 472 of file knfolder.cpp.

bool KNFolder::saveArticles ( KNLocalArticle::List &  l  ) 

Definition at line 371 of file knfolder.cpp.

void KNFolder::saveInfo (  )  [virtual]

Save the properties/settings of this collection.

Implements KNCollection.

Definition at line 144 of file knfolder.cpp.

void KNFolder::setId ( int  i  )  [inline]

Definition at line 47 of file knfolder.h.

void KNFolder::setParent ( KNCollection *  p  )  [virtual]

Sets the parent collection.

Reimplemented from KNCollection.

Definition at line 160 of file knfolder.cpp.

void KNFolder::syncIndex ( bool  force = false  ) 

Definition at line 540 of file knfolder.cpp.

collectionType KNFolder::type (  )  [inline, virtual]

Returns the collection type.

Implements KNCollection.

Definition at line 43 of file knfolder.h.

bool KNFolder::unloadHdrs ( bool  force = true  ) 

Definition at line 310 of file knfolder.cpp.

void KNFolder::updateListItem (  )  [virtual]

Updates the listview item after the collection has changed.

Reimplemented from KNCollection.

Definition at line 88 of file knfolder.cpp.

bool KNFolder::wasOpen (  )  const [inline]

Definition at line 54 of file knfolder.h.


Member Data Documentation

int KNFolder::i_d [protected]

Definition at line 85 of file knfolder.h.

bool KNFolder::i_ndexDirty [protected]

Definition at line 87 of file knfolder.h.

QFile KNFolder::i_ndexFile [protected]

Definition at line 90 of file knfolder.h.

QString KNFolder::i_nfoPath [protected]

Definition at line 91 of file knfolder.h.

QFile KNFolder::m_boxFile [protected]

Definition at line 89 of file knfolder.h.

int KNFolder::p_arentId [protected]

Definition at line 86 of file knfolder.h.

bool KNFolder::w_asOpen [protected]

Definition at line 88 of file knfolder.h.


The documentation for this class was generated from the following files:
  • knfolder.h
  • knfolder.cpp

knode

Skip menu "knode"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

kdepim

Skip menu "kdepim"
  • akonadi
  •   clients
  •   kabc
  •   kcal
  •   kcm
  • akregator
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt
  • kdgantt1
  • kjots
  • kleopatra
  • kmail
  • kmobiletools
  • knode
  • knotes
  • kontact
  • kontactinterfaces
  • korganizer
  •   korgac
  • kpilot
  • ktimetracker
  •   doc
  • libkdepim
  • libkholidays
  • libkleo
  • libkpgp
  • maildir
Generated for kdepim by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal