PimCommon::KMailCompletion

Search for usage in LXR

PimCommon::KMailCompletion Class Reference

#include <kmailcompletion.h>

Inheritance diagram for PimCommon::KMailCompletion:

Public Member Functions

void addItemWithKeys (const QString &email, int weight, const QStringList *keyWords)
 
void clear () override
 
QString makeCompletion (const QString &string) override
 
virtual void postProcessMatches (KCompletionMatches *matches) const
 
virtual void postProcessMatches (QStringList *matchList) const
 
void postProcessMatches (QStringList *pMatches) const override
 
- Public Member Functions inherited from KCompletion
QStringList allMatches ()
 
QStringList allMatches (const QString &string)
 
KCompletionMatches allWeightedMatches ()
 
KCompletionMatches allWeightedMatches (const QString &string)
 
CompletionMode completionMode () const
 
bool hasMultipleMatches () const
 
bool ignoreCase () const
 
bool isEmpty () const
 
QStringList items () const
 
virtual const QStringlastMatch () const
 
CompOrder order () const
 
virtual void setCompletionMode (CompletionMode mode)
 
virtual void setIgnoreCase (bool ignoreCase)
 
virtual void setOrder (CompOrder order)
 
virtual void setSoundsEnabled (bool enable)
 
bool shouldAutoSuggest () const
 
bool soundsEnabled () const
 
QStringList substringCompletion (const QString &string) const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Public Types inherited from KCompletion
enum  CompletionMode
 
enum  CompOrder
 
typedef std::function< void(QStringList &)> SorterFunction
 
- Properties inherited from QObject
 objectName
 
- Signals inherited from KCompletion
void match (const QString &item)
 
void matches (const QStringList &matchlist)
 
void multipleMatches ()
 
- Public Slots inherited from KCompletion
void addItem (const QString &item)
 
void addItem (const QString &item, uint weight)
 
void insertItems (const QStringList &items)
 
QString nextMatch ()
 
QString previousMatch ()
 
void removeItem (const QString &item)
 
virtual void setItems (const QStringList &itemList)
 
void slotMakeCompletion (const QString &string)
 
void slotNextMatch ()
 
void slotPreviousMatch ()
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from KCompletion
 CompletionAuto
 
 CompletionMan
 
 CompletionNone
 
 CompletionPopup
 
 CompletionPopupAuto
 
 CompletionShell
 
 Insertion
 
 Sorted
 
 Weighted
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from KCompletion
virtual void postProcessMatch (QString *match) const
 
virtual void postProcessMatches (KCompletionMatches *matches) const
 
void setShouldAutoSuggest (bool shouldAutosuggest)
 
void setSorterFunction (SorterFunction sortFunc)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

KMailCompletion allows lookup of email addresses by keyword.

This is used for lookup by nickname, since we don't want the nickname to appear in the final email. E.g. you have a nickname "idiot" for your boss, you want to type "idiot" but you want the completion to offer "Full Name <[email protected]>", without the nickname being visible.

Definition at line 26 of file kmailcompletion.h.

Member Function Documentation

◆ addItemWithKeys()

void KMailCompletion::addItemWithKeys ( const QString email,
int  weight,
const QStringList keyWords 
)

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:

  • contains [email protected]
  • contains <email> or if they have also been added with this function.

Definition at line 66 of file kmailcompletion.cpp.

◆ clear()

void KMailCompletion::clear ( )
overridevirtual

clears internal keyword map and calls KCompletion::clear.

Reimplemented from KCompletion.

Definition at line 21 of file kmailcompletion.cpp.

◆ makeCompletion()

QString KMailCompletion::makeCompletion ( const QString string)
overridevirtual

uses KCompletion::makeCompletion to find email addresses which starts with string.

ignores keywords.

Returns
email address

Reimplemented from KCompletion.

Definition at line 27 of file kmailcompletion.cpp.

◆ postProcessMatches()

void KMailCompletion::postProcessMatches ( QStringList pMatches) const
overridevirtual

use internal map to replace all keywords in pMatches with corresponding email addresses.

Reimplemented from KCompletion.

Definition at line 79 of file kmailcompletion.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Tue Jun 28 2022 04:02:30 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.