KMComposeWin Class Reference

#include <kmcomposewin.h>

Inheritance diagram for KMComposeWin:

Public Slots
Q_SCRIPTABLE void	addAttachment (const KUrl &url, const QString &comment)
Q_SCRIPTABLE void	addAttachment (const QString &name, KMime::Headers::contentEncoding cte, const QString &charset, const QByteArray &data, const QByteArray &mimeType)
Q_SCRIPTABLE void	addAttachmentsAndSend (const KUrl::List &urls, const QString &comment, int how)
void	autoSaveMessage (bool force=false)
void	htmlToolBarVisibilityChanged (bool visible)
Q_SCRIPTABLE void	send (int how)
void	setModified (bool modified)
void	slotFetchJob (KJob *)
void	slotSendNow ()
void	slotSpellcheckDoneClearStatus ()
void	slotTextModeChanged (KRichTextEdit::Mode)
void	slotToggleMarkup ()
void	slotWordWrapToggled (bool)
Public Slots inherited from KMail::Composer
virtual void	autoSaveMessage (bool force=false)=0
virtual void	setModified (bool modified)=0
virtual void	slotSendNow ()=0
virtual void	slotWordWrapToggled (bool)=0
Public Slots inherited from KMail::SecondaryWindow
virtual void	setCaption (const QString &caption)

Signals
void	identityChanged (const KPIMIdentities::Identity &identity)

Public Member Functions
void	addAttach (KMime::Content *msgPart)
void	addExtraCustomHeaders (const QMap< QByteArray, QString > &header)
KActionMenuChangeCase *	changeCaseMenu () const
uint	currentIdentity () const
QString	dbusObjectPath () const
void	disableForgottenAttachmentsCheck ()
void	disableWordWrap ()
void	forceDisableHtml ()
KToggleAction *	generateShortenUrlAction () const
const KPIMIdentities::Identity &	identity () const
void	ignoreStickyFields ()
bool	insertFromMimeData (const QMimeData *source, bool forceAttachment=false)
bool	isComposing () const
void	setCollectionForNewMessage (const Akonadi::Collection &folder)
virtual void	setCurrentIdentity (uint identity)
void	setCurrentReplyTo (const QString &)
void	setCurrentTransport (int transportId)
void	setCustomTemplate (const QString &customTemplate)
void	setFcc (const QString &idString)
void	setFocusToEditor ()
void	setFocusToSubject ()
void	setFolder (const Akonadi::Collection &aFolder)
void	setMessage (const KMime::Message::Ptr &newMsg, bool lastSignState=false, bool lastEncryptState=false, bool mayAutoSign=true, bool allowDecryption=false, bool isModified=false)
void	setSigningAndEncryptionDisabled (bool v)
void	setTextSelection (const QString &selection)
QString	smartQuote (const QString &msg)
KToggleAction *	translateAction () const
Public Member Functions inherited from KMail::Composer
virtual void	addAttachment (const KUrl &url, const QString &comment)=0
virtual void	addAttachment (const QString &name, KMime::Headers::contentEncoding cte, const QString &charset, const QByteArray &data, const QByteArray &mimeType)=0
virtual void	addAttachmentsAndSend (const KUrl::List &urls, const QString &comment, int how)=0
virtual void	send (int how)=0
virtual void	setAutoSaveFileName (const QString &fileName)=0
Public Member Functions inherited from KMail::SecondaryWindow
	SecondaryWindow (const char *name=0)
	~SecondaryWindow ()

Static Public Member Functions
static Composer *	create (const KMime::Message::Ptr &msg, bool lastSignState, bool lastEncryptState, TemplateContext context=NoTemplate, uint identity=0, const QString &textSelection=QString(), const QString &customTemplate=QString())

Additional Inherited Members
Public Types inherited from KMail::Composer
enum	TemplateContext {   New, Reply, ReplyToAll, Forward,   NoTemplate }
enum	VisibleHeaderFlag {   HDR_FROM = 0x01, HDR_REPLY_TO = 0x02, HDR_SUBJECT = 0x20, HDR_IDENTITY = 0x100,   HDR_TRANSPORT = 0x200, HDR_FCC = 0x400, HDR_DICTIONARY = 0x800, HDR_ALL = 0xfff }
typedef QFlags< VisibleHeaderFlag >	VisibleHeaderFlags
Protected Member Functions inherited from KMail::Composer
	Composer (const char *name=0)
Protected Member Functions inherited from KMail::SecondaryWindow
virtual void	closeEvent (QCloseEvent *)

Detailed Description

Definition at line 109 of file kmcomposewin.h.

Member Function Documentation

void KMComposeWin::addAttach ( KMime::Content *  msgPart )

virtual

Add an attachment to the list.

Implements KMail::Composer.

Definition at line 1993 of file kmcomposewin.cpp.

void KMComposeWin::addAttachment ( const KUrl &  url, const QString &  comment  )

slot

Definition at line 574 of file kmcomposewin.cpp.

void KMComposeWin::addAttachment ( const QString &  name, KMime::Headers::contentEncoding  cte, const QString &  charset, const QByteArray &  data, const QByteArray &  mimeType  )

slot

Definition at line 580 of file kmcomposewin.cpp.

void KMComposeWin::addAttachmentsAndSend ( const KUrl::List &  urls, const QString &  comment, int  how  )

slot

Definition at line 562 of file kmcomposewin.cpp.

void KMComposeWin::addExtraCustomHeaders ( const QMap< QByteArray, QString > &  header )

virtual

Implements KMail::Composer.

Definition at line 3335 of file kmcomposewin.cpp.

void KMComposeWin::autoSaveMessage ( bool  force = false )

slot

Definition at line 1925 of file kmcomposewin.cpp.

KActionMenuChangeCase* KMComposeWin::changeCaseMenu ( ) const

inline

Definition at line 234 of file kmcomposewin.h.

KMail::Composer * KMComposeWin::create ( const KMime::Message::Ptr &  msg, bool  lastSignState, bool  lastEncryptState, TemplateContext  context = NoTemplate, uint  identity = 0, const QString &  textSelection = QString(), const QString &  customTemplate = QString()  )

static

Definition at line 197 of file kmcomposewin.cpp.

uint KMComposeWin::currentIdentity

(

)

const

Definition at line 1557 of file kmcomposewin.cpp.

QString KMComposeWin::dbusObjectPath ( ) const

virtual

Implements KMail::Composer.

Definition at line 528 of file kmcomposewin.cpp.

void KMComposeWin::disableForgottenAttachmentsCheck ( )

virtual

Don't check for forgotten attachments for a mail, eg.

when sending out invitations.

Implements KMail::Composer.

Definition at line 2471 of file kmcomposewin.cpp.

void KMComposeWin::disableWordWrap ( )

virtual

Disables word wrap completely.

No wrapping at all will occur, not even at the right end of the editor. This is useful when sending invitations.

Implements KMail::Composer.

Definition at line 2452 of file kmcomposewin.cpp.

void KMComposeWin::forceDisableHtml ( )

virtual

Disables HTML completely.

It disables HTML at the point of calling this and disables it again when sending the message, to be sure. Useful when sending invitations. This will not remove the actions for activating HTML mode again, it is only meant for automatic invitation sending. Also calls

See also

disableHtml() internally.

Implements KMail::Composer.

Definition at line 2458 of file kmcomposewin.cpp.

KToggleAction* KMComposeWin::generateShortenUrlAction ( ) const

inline

Definition at line 235 of file kmcomposewin.h.

void KMComposeWin::htmlToolBarVisibilityChanged ( bool  visible )

slot

Definition at line 2984 of file kmcomposewin.cpp.

const KPIMIdentities::Identity & KMComposeWin::identity

(

)

const

Definition at line 1979 of file kmcomposewin.cpp.

void KMComposeWin::identityChanged ( const KPIMIdentities::Identity &  identity )

signal

End of D-Bus callable stuff.

void KMComposeWin::ignoreStickyFields ( )

virtual

Ignore the "sticky" setting of the transport combo box and prefer the X-KMail-Transport header field of the message instead.

Do the same for the identity combo box, don't obey the "sticky" setting but use the X-KMail-Identity header field instead.

This is useful when sending out invitations, since you don't see the GUI and want the identity and transport to be set to the values stored in the messages.

Implements KMail::Composer.

Definition at line 2476 of file kmcomposewin.cpp.

bool KMComposeWin::insertFromMimeData	(	const QMimeData *	source,
		bool	forceAttachment = false
	)

Definition at line 2116 of file kmcomposewin.cpp.

bool KMComposeWin::isComposing ( ) const

virtual

Returns true while the message composing is in progress.

Implements KMail::Composer.

Definition at line 2466 of file kmcomposewin.cpp.

void KMComposeWin::send ( int  how )

slot

Start of D-Bus callable stuff.

The D-Bus methods need to be public slots, otherwise they can't be accessed.

Definition at line 546 of file kmcomposewin.cpp.

void KMComposeWin::setCollectionForNewMessage ( const Akonadi::Collection &  folder )

virtual

Implements KMail::Composer.

Definition at line 1079 of file kmcomposewin.cpp.

void KMComposeWin::setCurrentIdentity ( uint  identity )

virtual

Implements KMail::Composer.

Definition at line 3340 of file kmcomposewin.cpp.

void KMComposeWin::setCurrentReplyTo ( const QString &  replyTo )

virtual

Implements KMail::Composer.

Definition at line 1550 of file kmcomposewin.cpp.

void KMComposeWin::setCurrentTransport ( int  transportId )

virtual

Implements KMail::Composer.

Definition at line 1545 of file kmcomposewin.cpp.

void KMComposeWin::setCustomTemplate ( const QString &  customTemplate )

virtual

Set custom template to be used for the message.

Implements KMail::Composer.

Definition at line 1795 of file kmcomposewin.cpp.

void KMComposeWin::setFcc ( const QString &  idString )

virtual

Use the given folder as sent-mail folder if the given folder exists.

Else show an error message and use the default sent-mail folder as sent-mail folder.

Implements KMail::Composer.

Definition at line 1811 of file kmcomposewin.cpp.

void KMComposeWin::setFocusToEditor ( )

virtual

Sets the focus to the edit-widget.

Implements KMail::Composer.

Definition at line 3179 of file kmcomposewin.cpp.

void KMComposeWin::setFocusToSubject ( )

virtual

Sets the focus to the subject line edit.

For use when creating a message to a known recipient.

Implements KMail::Composer.

Definition at line 3186 of file kmcomposewin.cpp.

void KMComposeWin::setFolder ( const Akonadi::Collection &  aFolder )

virtual

If this folder is set, the original message is inserted back after canceling.

Implements KMail::Composer.

Definition at line 1805 of file kmcomposewin.cpp.

void KMComposeWin::setMessage ( const KMime::Message::Ptr &  newMsg, bool  lastSignState = false, bool  lastEncryptState = false, bool  mayAutoSign = true, bool  allowDecryption = false, bool  isModified = false  )

virtual

Set the message the composer shall work with.

This discards previous messages without calling applyChanges() on them before.

Implements KMail::Composer.

Definition at line 1562 of file kmcomposewin.cpp.

void KMComposeWin::setModified ( bool  modified )

slot

Set whether the message should be treated as modified or not.

Definition at line 1840 of file kmcomposewin.cpp.

void KMComposeWin::setSigningAndEncryptionDisabled ( bool  v )

virtual

Disabled signing and encryption completely for this composer window.

Implements KMail::Composer.

Definition at line 1800 of file kmcomposewin.cpp.

void KMComposeWin::setTextSelection ( const QString &  selection )

virtual

Set the text selection the message is a response to.

Implements KMail::Composer.

Definition at line 1789 of file kmcomposewin.cpp.

void KMComposeWin::slotFetchJob ( KJob *  job )

slot

Definition at line 2236 of file kmcomposewin.cpp.

void KMComposeWin::slotSendNow ( )

slot

Definition at line 2820 of file kmcomposewin.cpp.

void KMComposeWin::slotSpellcheckDoneClearStatus ( )

slot

Definition at line 3009 of file kmcomposewin.cpp.

void KMComposeWin::slotTextModeChanged ( KRichTextEdit::Mode  )

slot

Definition at line 2975 of file kmcomposewin.cpp.

void KMComposeWin::slotToggleMarkup ( )

slot

Definition at line 2969 of file kmcomposewin.cpp.

void KMComposeWin::slotWordWrapToggled ( bool  on )

slot

Switch wordWrap on/off.

Definition at line 2433 of file kmcomposewin.cpp.

QString KMComposeWin::smartQuote

(

const QString &

msg

)

Definition at line 2110 of file kmcomposewin.cpp.

KToggleAction* KMComposeWin::translateAction ( ) const

inline

Definition at line 233 of file kmcomposewin.h.

---

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

• kmcomposewin.h
• kmcomposewin.cpp