KPIM::AddresseeLineEdit Class Reference

#include <addresseelineedit.h>

Inheritance diagram for KPIM::AddresseeLineEdit:

Public Slots
void	cursorAtEnd ()
void	enableCompletion (bool enable)
virtual void	setText (const QString &text)

Signals
void	textCompleted ()

Public Member Functions
	AddresseeLineEdit (QWidget *parent, bool enableCompletion=true)
virtual	~AddresseeLineEdit ()
int	addCompletionSource (const QString &name, int weight)
void	addContact (const KABC::Addressee &contact, int weight, int source=-1, QString append=QString())
void	addContactGroup (const KABC::ContactGroup &group, int weight, int source=-1)
void	addItem (const Akonadi::Item &item, int weight, int source=-1)
void	allowSemicolonAsSeparator (bool allow)
void	callSetCompletedText (const QString &, bool)
void	callSetCompletedText (const QString &text)
void	callSetUserSelection (bool)
void	callUserCancelled (const QString &str)
void	emitTextCompleted ()
bool	isCompletionEnabled () const
void	removeCompletionSource (const QString &source)
void	setEnableBalooSearch (bool enable)
void	setFont (const QFont &font)

Protected Member Functions
QStringList	cleanupEmailList (const QStringList &inputList)
virtual void	configureCompletionOrder (QMenu *menu)
virtual void	contextMenuEvent (QContextMenuEvent *)
virtual QMenu *	createStandardContextMenu ()
virtual void	dropEvent (QDropEvent *)
virtual void	insert (const QString &)
virtual void	keyPressEvent (QKeyEvent *)
virtual void	mouseReleaseEvent (QMouseEvent *)
virtual void	paste ()

Detailed Description

Definition at line 55 of file addresseelineedit.h.

Constructor & Destructor Documentation

AddresseeLineEdit::AddresseeLineEdit ( QWidget *  parent, bool  enableCompletion = true  )

explicit

Creates a new addressee line edit.

Parameters

parent	The parent object.
enableCompletion	Whether autocompletion shall be enabled.

Definition at line 79 of file addresseelineedit.cpp.

AddresseeLineEdit::~AddresseeLineEdit ( )

virtual

Destroys the addressee line edit.

Definition at line 88 of file addresseelineedit.cpp.

Member Function Documentation

int KPIM::AddresseeLineEdit::addCompletionSource	(	const QString &	name,
		int	weight
	)

Adds the name of a completion source and its weight to the internal list of completion sources and returns its index, which can be used for insertion of items associated with that source.

If the source already exists, the weight will be updated.

Definition at line 446 of file addresseelineedit.cpp.

void AddresseeLineEdit::addContact	(	const KABC::Addressee &	contact,
		int	weight,
		int	source = -1,
		QString	append = QString()
	)

Adds a new contact to the completion with a given weight source index append is added to completion string, but removed, when mail is selected.

Definition at line 344 of file addresseelineedit.cpp.

void AddresseeLineEdit::addContactGroup	(	const KABC::ContactGroup &	group,
		int	weight,
		int	source = -1
	)

Same as the above, but this time with contact groups.

Definition at line 339 of file addresseelineedit.cpp.

void AddresseeLineEdit::addItem	(	const Akonadi::Item &	item,
		int	weight,
		int	source = -1
	)

Definition at line 329 of file addresseelineedit.cpp.

void AddresseeLineEdit::allowSemicolonAsSeparator

(

bool

allow

)

Sets whether semicolons are allowed as separators.

Definition at line 107 of file addresseelineedit.cpp.

void AddresseeLineEdit::callSetCompletedText	(	const QString &	text,
		bool	marked
	)

Definition at line 634 of file addresseelineedit.cpp.

void AddresseeLineEdit::callSetCompletedText

(

const QString &

text

)

Definition at line 639 of file addresseelineedit.cpp.

void AddresseeLineEdit::callSetUserSelection

(

bool

b

)

Definition at line 644 of file addresseelineedit.cpp.

void AddresseeLineEdit::callUserCancelled

(

const QString &

str

)

Definition at line 629 of file addresseelineedit.cpp.

QStringList KPIM::AddresseeLineEdit::cleanupEmailList ( const QStringList &  inputList )

protected

void KPIM::AddresseeLineEdit::configureCompletionOrder ( QMenu *  menu )

protectedvirtual

Definition at line 422 of file addresseelineedit.cpp.

void AddresseeLineEdit::contextMenuEvent ( QContextMenuEvent *  event )

protectedvirtual

Reimplemented for internal reasons.

API not affected.

See QLineEdit::contextMenuEvent().

Definition at line 397 of file addresseelineedit.cpp.

QMenu * AddresseeLineEdit::createStandardContextMenu ( )

protectedvirtual

Reimplemented for subclass access to menu.

Definition at line 406 of file addresseelineedit.cpp.

void AddresseeLineEdit::cursorAtEnd ( )

slot

Moves the cursor at the end of the line edit.

Definition at line 314 of file addresseelineedit.cpp.

void AddresseeLineEdit::dropEvent ( QDropEvent *  event )

protectedvirtual

Reimplemented for smart insertion of dragged email addresses.

Definition at line 257 of file addresseelineedit.cpp.

void AddresseeLineEdit::emitTextCompleted

(

)

Definition at line 624 of file addresseelineedit.cpp.

void AddresseeLineEdit::enableCompletion ( bool  enable )

slot

Sets whether autocompletion shall be enabled.

Definition at line 319 of file addresseelineedit.cpp.

void AddresseeLineEdit::insert ( const QString &  t )

protectedvirtual

Reimplemented for smart insertion of email addresses.

Features:

• Automatically adds ',' if necessary to separate email addresses
• Correctly decodes mailto URLs
• Recognizes email addresses which are protected against address harvesters, i.e. "name at kde dot org" and "name(at)kde.org"

Definition at line 159 of file addresseelineedit.cpp.

bool AddresseeLineEdit::isCompletionEnabled

(

)

const

Definition at line 324 of file addresseelineedit.cpp.

void AddresseeLineEdit::keyPressEvent ( QKeyEvent *  event )

protectedvirtual

Reimplemented for internal reasons.

Definition at line 112 of file addresseelineedit.cpp.

void AddresseeLineEdit::mouseReleaseEvent ( QMouseEvent *  event )

protectedvirtual

Reimplemented for smart insertion with middle mouse button.

Definition at line 240 of file addresseelineedit.cpp.

void AddresseeLineEdit::paste ( )

protectedvirtual

Reimplemented for smart insertion of pasted email addresses.

Definition at line 230 of file addresseelineedit.cpp.

void KPIM::AddresseeLineEdit::removeCompletionSource

(

const QString &

source

)

Definition at line 441 of file addresseelineedit.cpp.

void AddresseeLineEdit::setEnableBalooSearch

(

bool

enable

)

Definition at line 102 of file addresseelineedit.cpp.

void AddresseeLineEdit::setFont

(

const QFont &

font

)

Reimplemented for setting the font for line edit and completion box.

Definition at line 93 of file addresseelineedit.cpp.

void AddresseeLineEdit::setText ( const QString &  text )

virtualslot

Reimplemented for stripping whitespace after completion Danger: This is not virtual in the base class!

Definition at line 223 of file addresseelineedit.cpp.

void KPIM::AddresseeLineEdit::textCompleted ( )

signal

---

The documentation for this class was generated from the following files:

• addresseelineedit.h
• addresseelineedit.cpp