You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
152 lines
5.0 KiB
152 lines
5.0 KiB
/*
|
|
This file is part of libkcal.
|
|
|
|
Copyright (c) 2004 Cornelius Schumacher <schumacher@kde.org>
|
|
Copyright (c) 2004 Till Adam <adam@kde.org>
|
|
Copyright (c) 2004 Reinhold Kainhofer <reinhold@kainhofer.com>
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Library General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to
|
|
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02110-1301, USA.
|
|
*/
|
|
#ifndef KPIM_FOLDERLISTER_H
|
|
#define KPIM_FOLDERLISTER_H
|
|
|
|
// #include "kresources_groupwareprefs.h"
|
|
/*#include "groupwareresourcejob.h"*/
|
|
#include <kurl.h>
|
|
#include <tdepimmacros.h>
|
|
|
|
#include <tqvaluelist.h>
|
|
#include <tqstring.h>
|
|
#include <tqstringlist.h>
|
|
#include <tqobject.h>
|
|
|
|
namespace KIO {
|
|
class Job;
|
|
}
|
|
|
|
class KConfig;
|
|
|
|
namespace KPIM {
|
|
|
|
class GroupwareDataAdaptor;
|
|
class GroupwarePrefsBase;
|
|
|
|
|
|
class KDE_EXPORT FolderLister : public TQObject
|
|
{
|
|
Q_OBJECT
|
|
TQ_OBJECT
|
|
public:
|
|
enum Type { AddressBook, Calendar };
|
|
enum ContentType {
|
|
Contact=0x1, Event=0x2, Todo=0x4, Journal=0x8,
|
|
Message=0x10, Memo=0x20, Folder=0x40,
|
|
Incidences=Event|Todo|Journal, All=Contact|Incidences,
|
|
Unknown=0x000
|
|
};
|
|
|
|
class Entry
|
|
{
|
|
public:
|
|
Entry() : active( false ) {}
|
|
|
|
typedef TQValueList<Entry> List;
|
|
|
|
TQString id;
|
|
TQString name;
|
|
ContentType type;
|
|
bool active;
|
|
};
|
|
static TQStringList contentTypeToStrings( ContentType );
|
|
ContentType contentTypeFromString( const TQString &type );
|
|
|
|
TQValueList<ContentType> supportedTypes();
|
|
|
|
FolderLister( Type );
|
|
|
|
/** Initialize the retrieval with given root URL */
|
|
virtual void retrieveFolders( const KURL & );
|
|
|
|
void setFolders( const Entry::List & );
|
|
Entry::List folders() const { return mFolders; }
|
|
|
|
void setAdaptor( KPIM::GroupwareDataAdaptor *adaptor );
|
|
GroupwareDataAdaptor* adaptor() const { return mAdaptor; }
|
|
|
|
KURL::List activeFolderIds() const;
|
|
bool isActive( const TQString &id ) const;
|
|
|
|
void setWriteDestinationId( KPIM::FolderLister::ContentType type, const TQString &dest );
|
|
TQString writeDestinationId( KPIM::FolderLister::ContentType type ) const;
|
|
|
|
void readConfig( KPIM::GroupwarePrefsBase *newprefs );
|
|
void writeConfig( KPIM::GroupwarePrefsBase *newprefs );
|
|
|
|
|
|
signals:
|
|
void foldersRead();
|
|
|
|
protected slots:
|
|
void slotListJobResult( KIO::Job * );
|
|
/** Adds the folder with the given url and display name to the folder
|
|
* tree (if is has an appropriate type) */
|
|
virtual void processFolderResult( const KURL &href,
|
|
const TQString &displayName,
|
|
KPIM::FolderLister::ContentType type );
|
|
/** Retrieve information about the folder u. If it has sub-folders, it
|
|
descends into the hierarchy */
|
|
virtual void doRetrieveFolder( const KURL &u );
|
|
/** A subitem was detected. If it's a folder, we need to descend, otherwise
|
|
we just add the url to the list of processed URLs. */
|
|
void folderSubitemRetrieved( const KURL &url, bool isFolder );
|
|
|
|
protected:
|
|
/** Creates the job to retrieve information about the folder at the given
|
|
url. It's results will be interpreted by interpretFolderResult
|
|
*/
|
|
virtual KIO::Job *createListFoldersJob( const KURL &url );
|
|
/** Interprets the results returned by the liste job (created by
|
|
* createJob(url) ). The default implementation calls
|
|
* interpretFolderListJob of the GroupwareDataAdaptor. Typically,
|
|
* this adds an Entry to the mFolders list if the job describes a
|
|
* folder of the appropriate type, by calling processsFolderResult.
|
|
* If the folder has subfolders, just call doRetrieveFolder(url)
|
|
* recursively. */
|
|
virtual void interpretListFoldersJob( KIO::Job *job );
|
|
/** List of folders that will always be included (subfolders won't!).
|
|
* Usually this is not needed as you should traverse the whole folder
|
|
* tree starting from the user's root dir. */
|
|
virtual Entry::List defaultFolders();
|
|
/** Type of this folder lister (i.e. AddressBook or Calendar) */
|
|
Type getType() const { return mType; }
|
|
|
|
|
|
protected:
|
|
Type mType;
|
|
KURL::List mUrls;
|
|
TQStringList mProcessedPathes;
|
|
Entry::List mFolders;
|
|
GroupwareDataAdaptor *mAdaptor;
|
|
private:
|
|
// TODO: We need multiple destinations for Events, Tasks and Journals
|
|
TQMap<KPIM::FolderLister::ContentType, TQString> mWriteDestinationId;
|
|
KURL mOldURL;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|