kde-playground/kdepim/knode/kncomposer.h

/*
    KNode, the KDE newsreader
    Copyright (c) 1999-2006 the KNode authors.
    See file AUTHORS for details

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software Foundation,
    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, US
*/

#ifndef KNCOMPOSER_H
#define KNCOMPOSER_H

#include "knarticle.h"

#include <kxmlguiwindow.h>
#include <kdialog.h>
#include <QList>
#include <kprocess.h>
#include <kabc/addresslineedit.h>


class KSelectAction;
class KTemporaryFile;
class KToggleAction;
#include <QComboBox>
#include <QFile>
namespace KNode {
  namespace Composer {
    class View;
  }
}
using KNode::Composer::View;


/** Message composer window. */
class KNComposer : public KXmlGuiWindow {

  Q_OBJECT
  Q_CLASSINFO( "D-Bus Interface", "org.kde.knode.composer")

  public:
    enum composerResult { CRsendNow, CRsendLater, CRdelAsk,
                          CRdel, CRsave, CRcancel };

    enum MessageMode {
      news = 0,       ///< Message is to be sent to a newsgroup.
      mail = 1,       ///< Message is to be sent by e-mail.
      news_mail = 2   ///< Message is to be sent by e-mail and to a newsgroup.
    };

    /**
      Create a composer for a message (e-mail or newsgroup post).
      @param a The article to edit.
      @param text The <strong>wraped</strong> text of the message.
      @param unwraped The original, <strong>not rewraped</strong> text.
      @param firstEdit Indicates if it is the first time that this message is edited.
      @param dislikesCopies When true, this indicates that the author of the message
                            that is replied to did not want an e-mail copy of the answer.
      @param createCopy When true, this indicates that a copy should be sent by e-mail.
      @param allowMail Enables or disables sending the message via e-mail.
    */
    explicit KNComposer( KNLocalArticle::Ptr a, const QString &text = QString(),
                const QString &unwraped = QString(), bool firstEdit = false,
                bool dislikesCopies = false, bool createCopy = false, bool allowMail = true);
    ~KNComposer();
    void setConfig(bool onlyFonts);
    void setMessageMode(MessageMode mode);

    //get result
    bool hasValidData();
    composerResult result() const              { return r_esult; }
    KNLocalArticle::Ptr article() const { return a_rticle; }

    /**
      Applies changes from the editor into the article being edited.
      @return false if an error occurred.
    */
    bool applyChanges();

    void closeEvent(QCloseEvent *e);

  public slots:
    //set data from the given article
    Q_SCRIPTABLE void initData(const QString &text);

  public:

    /** Inserts at cursor position if clear is false, replaces content otherwise
     * puts the file content into a box if box==true
     * "file" is already open for reading
     */
    void insertFile( QFile *file, bool clear = false, bool box = false, const QString &boxTitle = QString() );

    /// ask for a filename, handle network urls
    void insertFile(bool clear=false, bool box=false);

//internal classes
    class Editor;
    class AttachmentPropertiesDlg;

    //GUI
    View *v_iew;

    //Data
    composerResult r_esult;
    KNLocalArticle::Ptr a_rticle;
    QString u_nwraped;
    MessageMode m_ode;
    bool n_eeds8Bit,    // false: fall back to us-ascii
         v_alidated,    // hasValidData was run and found no problems, n_eeds8Bit is valid
         a_uthorDislikesMailCopies;

    /**
      Sets the character set to used to encode this message.
      This also enforces some sanity check.
    */
    void setCharset( const QString &charset );

    //edit
    bool e_xternalEdited;
    KProcess *e_xternalEditor;
    KTemporaryFile *e_ditorTempfile;

    //Attachments
    QList<KNAttachment::Ptr> mDeletedAttachments;
    bool a_ttChanged;

  //------------------------------ <Actions> -----------------------------

    QAction       *a_ctExternalEditor,
                  *a_ctSpellCheck,
                  *a_ctRemoveAttachment,
                  *a_ctAttachmentProperties,
                  *a_ctSetCharsetKeyb;
    KToggleAction *a_ctPGPsign,
                  *a_ctDoPost, *a_ctDoMail, *a_ctWordWrap, *a_ctAutoSpellChecking;
    KSelectAction *a_ctSetCharset;
  protected slots:
    void slotSendNow();
    void slotSendLater();
    void slotSaveAsDraft();
    void slotArtDelete();
    void slotInsertFile();
    void slotInsertFileBoxed();
    void slotAttachFile();
    void slotToggleDoPost();
    void slotToggleDoMail();
    void slotSetCharset(const QString &s);
    void slotSetCharsetKeyboard();
    void slotToggleWordWrap();
    void slotAutoSpellCheckingToggled();
    void slotUndoRewrap();
    void slotExternalEditor();

    void slotUpdateStatusBar();
    void slotUpdateCursorPos();
    void slotConfKeys();
    void slotConfToolbar();
    void slotNewToolbarConfig();
  void slotUpdateCheckSpellChecking(bool _b);

  //------------------------------ </Actions> ----------------------------

    // GUI
    void slotSubjectChanged(const QString &t);
    void slotToBtnClicked();
    void slotGroupsBtnClicked();

    // external editor
    void slotEditorFinished(int, QProcess::ExitStatus);
    void slotCancelEditor();

    // attachment list
    /**
      Open a popup menu to do action on an attachment
      @param point the global position where the popup should be opened.
    */
    void slotAttachmentPopup( const QPoint &point );
    /**
      Called by the View when an attachment was removed.
    */
    void slotAttachmentRemoved( KNAttachment::Ptr attachment, bool last );
    /**
      Called by the View to notify that an attachment was modified.
    */
    void slotAttachmentChanged();


    void slotUndo();
    void slotRedo();
    void slotCut();
    void slotCopy();
    void slotPaste();
    void slotSelectAll();
    void addRecentAddress();

  protected:

    // DND handling
    /**
      Reimplemented to accept list of URI as drag content
    */
    virtual void dragEnterEvent( QDragEnterEvent *event );
    /**
      Reimplemented to add the dropped files as attachments.
    */
    virtual void dropEvent( QDropEvent *event );

  signals:
    void composerDone(KNComposer*);

  private:
    bool mFirstEdit;
    /**
      Character set used to encode the out-going message.

      This is going to end up in the mime header of the message
      so it should be a valid encoding as per
      @link http://www.iana.org/assignments/character-sets IANA character-set encoding @endlink
      and not be empty; both issues are taken care of by setCharset().

      As a consequence this cannot be used directly as input of methods from KCharset.
    */
    QString mCharset;
};


/** Attachment properties dialog. */
class KNComposer::AttachmentPropertiesDlg : public KDialog {

  Q_OBJECT

  public:
    /**
      Create a dialog to edit attribute of a message attachment.

      Note: if this dialog is accepted, the attachement @p a is updated automatically.
      @param a The attachment to edit.
      @param parent Parent widget.
    */
    AttachmentPropertiesDlg( KNAttachment::Ptr a, QWidget *parent = 0 );
    /**
      Destructor.
    */
    ~AttachmentPropertiesDlg();

  protected:
    /**
      Apply the change to the attachment passed to the constructor.
    */
    void apply();

    KLineEdit *m_imeType,
              *d_escription;
    QComboBox *e_ncoding;

    KNAttachment::Ptr a_ttachment;
    bool n_onTextAsText;

  protected slots:
    void accept();
    void slotMimeTypeTextChanged(const QString &text);
};

//-----------------------------------------------------------------------------
/** Line edit for addresses used in the composer. */
class KNLineEdit : public KABC::AddressLineEdit
{
    Q_OBJECT

public:
    /**
      Constructor.
    */
    explicit KNLineEdit( View *parent, bool useCompletion = true );
    /**
      Helper constructor (for UI designer generated class).
      You must call setView later.
    */
    explicit KNLineEdit( QWidget *parent, bool useCompletion = true );

    /**
      Sets the View that this line edit belongs to.
    */
    void setView( View *view )
      { composerView = view; }

protected:
    // Inherited. Always called by the parent when this widget is created.
    virtual void loadAddresses();
    void keyPressEvent(QKeyEvent *e);
    virtual void contextMenuEvent( QContextMenuEvent*e );
private slots:
    void editRecentAddresses();
private:
    View *composerView;
};

/** Line edit with on-the-fly spell checking. */
class KNLineEditSpell : public KNLineEdit
{
    Q_OBJECT
public:
    /**
      Constructor.
    */
    explicit KNLineEditSpell( View *parent, bool useCompletion = true );
    /**
      Helper constructor (for UI designer generated class).
      You must call setView later.
    */
    explicit KNLineEditSpell( QWidget *parent, bool useCompletion = true );

    void highLightWord( unsigned int length, unsigned int pos );
    void spellCheckDone( const QString &s );
    void spellCheckerMisspelling( const QString &text, const QStringList &, unsigned int pos);
    void spellCheckerCorrected( const QString &old, const QString &corr, unsigned int pos);
};

#endif