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.
tdepim/libtdepim/kmailcompletion.h

80 lines
2.2 KiB

/*
This file is part of libtdepim.
Copyright (c) 2006 Christian Schaarschmidt <schaarsc@gmx.de>
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_KMAILCOMPLETION_H
#define KPIM_KMAILCOMPLETION_H
#include <tqmap.h>
#include <tqstringlist.h>
#include "kcompletion.h"
namespace KPIM {
/**
* KMailCompletion allows lookup of email addresses by keyword.
* Typically a keywods would be firstname, lastname, nickname or domain.
*/
class KMailCompletion : public KCompletion
{
Q_OBJECT
public:
KMailCompletion();
/**
* Clears internal keyword map and calls KCompletion::clear.
*/
virtual void clear();
/**
* Uses KCompletion::makeCompletion to find email addresses which starts with string.
* ignores keywords.
*
* @returns email address
*/
TQString makeCompletion( const TQString &string );
/**
* Specify keywords for email.
*
* Items may be added with KCompletion::addItem, those will only be returned as match if they
* are in one of these formats:
* \li contains localpart@domain
* \li contains <email>
* or if they have also been added with this function.
*/
void addItemWithKeys( const TQString& email, int weight, const TQStringList * keyWords);
/**
* Uses an internal map to replace all keywords in pMatches whith corrsesponding email addresses.
*/
virtual void postProcessMatches( TQStringList * pMatches )const;
private:
TQMap< TQString, TQStringList > m_keyMap;
};
}
#endif