• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepim API Reference
  • KDE Home
  • Contact Us
 

kmail

  • KMail
  • Composer
Public Types | Public Slots | Public Member Functions | Protected Member Functions | List of all members
KMail::Composer Class Referenceabstract

#include <composer.h>

Inheritance diagram for KMail::Composer:
Inheritance graph
[legend]

Public Types

enum  TemplateContext {
  New, Reply, ReplyToAll, Forward,
  NoTemplate
}
 
enum  VisibleHeaderFlag {
  HDR_FROM = 0x01, HDR_REPLY_TO = 0x02, HDR_SUBJECT = 0x20, HDR_NEWSGROUPS = 0x40,
  HDR_FOLLOWUP_TO = 0x80, HDR_IDENTITY = 0x100, HDR_TRANSPORT = 0x200, HDR_FCC = 0x400,
  HDR_DICTIONARY = 0x800, HDR_ALL = 0xfff
}
 
typedef QFlags< VisibleHeaderFlag > VisibleHeaderFlags
 

Public Slots

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)
 

Public Member Functions

virtual void addAttach (KMime::Content *msgPart)=0
 
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 addExtraCustomHeaders (const QMap< QByteArray, QString > &header)=0
 
virtual QString dbusObjectPath () const =0
 
virtual void disableForgottenAttachmentsCheck ()=0
 
virtual void disableWordWrap ()=0
 
virtual void forceDisableHtml ()=0
 
virtual void ignoreStickyFields ()=0
 
virtual bool isComposing () const =0
 
virtual void send (int how)=0
 
virtual void setAutoSaveFileName (const QString &fileName)=0
 
virtual void setCollectionForNewMessage (const Akonadi::Collection &folder)=0
 
virtual void setCurrentReplyTo (const QString &replyTo)=0
 
virtual void setCurrentTransport (int transportId)=0
 
virtual void setCustomTemplate (const QString &customTemplate)=0
 
virtual void setFcc (const QString &idString)=0
 
virtual void setFocusToEditor ()=0
 
virtual void setFocusToSubject ()=0
 
virtual void setFolder (const Akonadi::Collection &)=0
 
virtual void setMessage (const KMime::Message::Ptr &newMsg, bool lastSignState=false, bool lastEncryptState=false, bool mayAutoSign=true, bool allowDecryption=false, bool isModified=false)=0
 
virtual void setSigningAndEncryptionDisabled (bool v)=0
 
virtual void setTextSelection (const QString &selection)=0
 
- Public Member Functions inherited from KMail::SecondaryWindow
 SecondaryWindow (const char *name=0)
 
 ~SecondaryWindow ()
 

Protected Member Functions

 Composer (const char *name=0)
 
- Protected Member Functions inherited from KMail::SecondaryWindow
virtual void closeEvent (QCloseEvent *)
 

Detailed Description

Definition at line 37 of file composer.h.

Member Typedef Documentation

typedef QFlags<VisibleHeaderFlag> KMail::Composer::VisibleHeaderFlags

Definition at line 57 of file composer.h.

Member Enumeration Documentation

enum KMail::Composer::TemplateContext
Enumerator
New 
Reply 
ReplyToAll 
Forward 
NoTemplate 

Definition at line 44 of file composer.h.

enum KMail::Composer::VisibleHeaderFlag
Enumerator
HDR_FROM 
HDR_REPLY_TO 
HDR_SUBJECT 
HDR_NEWSGROUPS 
HDR_FOLLOWUP_TO 
HDR_IDENTITY 
HDR_TRANSPORT 
HDR_FCC 
HDR_DICTIONARY 
HDR_ALL 

Definition at line 45 of file composer.h.

Constructor & Destructor Documentation

KMail::Composer::Composer ( const char *  name = 0)
inlineprotected

Definition at line 41 of file composer.h.

Member Function Documentation

virtual void KMail::Composer::addAttach ( KMime::Content *  msgPart)
pure virtual

Add an attachment to the list.

Implemented in KMComposeWin.

virtual void KMail::Composer::addAttachment ( const KUrl &  url,
const QString &  comment 
)
pure virtual
virtual void KMail::Composer::addAttachment ( const QString &  name,
KMime::Headers::contentEncoding  cte,
const QString &  charset,
const QByteArray &  data,
const QByteArray &  mimeType 
)
pure virtual
virtual void KMail::Composer::addAttachmentsAndSend ( const KUrl::List &  urls,
const QString &  comment,
int  how 
)
pure virtual
virtual void KMail::Composer::addExtraCustomHeaders ( const QMap< QByteArray, QString > &  header)
pure virtual

Implemented in KMComposeWin.

virtual void KMail::Composer::autoSaveMessage ( bool  force = false)
pure virtualslot
virtual QString KMail::Composer::dbusObjectPath ( ) const
pure virtual

Implemented in KMComposeWin.

virtual void KMail::Composer::disableForgottenAttachmentsCheck ( )
pure virtual

Implemented in KMComposeWin.

virtual void KMail::Composer::disableWordWrap ( )
pure virtual

Implemented in KMComposeWin.

virtual void KMail::Composer::forceDisableHtml ( )
pure virtual

Implemented in KMComposeWin.

virtual void KMail::Composer::ignoreStickyFields ( )
pure virtual

Implemented in KMComposeWin.

virtual bool KMail::Composer::isComposing ( ) const
pure virtual

Returns true while the message composing is in progress.

Implemented in KMComposeWin.

virtual void KMail::Composer::send ( int  how)
pure virtual

From MailComposerIface.

virtual void KMail::Composer::setAutoSaveFileName ( const QString &  fileName)
pure virtual
virtual void KMail::Composer::setCollectionForNewMessage ( const Akonadi::Collection &  folder)
pure virtual

Implemented in KMComposeWin.

virtual void KMail::Composer::setCurrentReplyTo ( const QString &  replyTo)
pure virtual

Implemented in KMComposeWin.

virtual void KMail::Composer::setCurrentTransport ( int  transportId)
pure virtual

Implemented in KMComposeWin.

virtual void KMail::Composer::setCustomTemplate ( const QString &  customTemplate)
pure virtual

Set custom template to be used for the message.

Implemented in KMComposeWin.

virtual void KMail::Composer::setFcc ( const QString &  idString)
pure virtual

Implemented in KMComposeWin.

virtual void KMail::Composer::setFocusToEditor ( )
pure virtual

Sets the focus to the edit-widget and the cursor below the "On ... you wrote" line when hasMessage is true.

Make sure you call this after setMsg().

Implemented in KMComposeWin.

virtual void KMail::Composer::setFocusToSubject ( )
pure virtual

Sets the focus to the subject line edit.

For use when creating a message to a known recipient.

Implemented in KMComposeWin.

virtual void KMail::Composer::setFolder ( const Akonadi::Collection &  )
pure virtual

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

Implemented in KMComposeWin.

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

Set the message the composer shall work with.

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

Implemented in KMComposeWin.

virtual void KMail::Composer::setModified ( bool  modified)
pure virtualslot
virtual void KMail::Composer::setSigningAndEncryptionDisabled ( bool  v)
pure virtual

Disabled signing and encryption completely for this composer window.

Implemented in KMComposeWin.

virtual void KMail::Composer::setTextSelection ( const QString &  selection)
pure virtual

Set the text selection the message is a response to.

Implemented in KMComposeWin.

virtual void KMail::Composer::slotSendNow ( )
pure virtualslot
virtual void KMail::Composer::slotWordWrapToggled ( bool  )
pure virtualslot

Switch wordWrap on/off.


The documentation for this class was generated from the following file:
  • composer.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:58:52 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kmail

Skip menu "kmail"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members

kdepim API Reference

Skip menu "kdepim API Reference"
  • akonadi_next
  • akregator
  • blogilo
  • calendarsupport
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt2
  • kjots
  • kleopatra
  • kmail
  • knode
  • knotes
  • kontact
  • korgac
  • korganizer
  • ktimetracker
  • libkdepim
  • libkleo
  • libkpgp
  • mailcommon
  • messagelist
  • messageviewer

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal