Page MenuHomePhorge
Files F16571082

kmeditor.h
No OneTemporary
Actions

kmeditor.h
View Options

/**
* kmeditor.h
*
* Copyright 2007 Laurent Montel <montel@kde.org>
* Copyright 2008 Thomas McGuire <mcguire@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#ifndef KDEPIM_KMEDITOR_H
#define KDEPIM_KMEDITOR_H
#include "kdepim_export.h"
#include <KRichTextWidget>
namespace KPIMIdentities {
class Signature;
}
class KUrl;
namespace KPIM {
class KMeditorPrivate;
class KEMailQuotingHighlighter;
/**
* The KMeditor class provides a widget to edit and display text,
* specially geared towards writing e-mails.
*
* It offers sevaral additional functions of a KRichTextWidget:
*
* @li Quote highlighting
* @li The ability to us an external editor
* @li Signature handling
* @li Utility functions like removing whitespace, inserting a file,
* adding quotes or rot13'ing the text
*/
class KDEPIM_EXPORT KMeditor : public KRichTextWidget, protected KTextEditSpellInterface
{ //TODO: KDE5: get rid of KTextEditSpellInterface
Q_OBJECT
public:
/**
* Describes the placement of a text which is to be inserted into this
* textedit
*/
enum Placement { Start, ///< The text is placed at the start of the textedit
End, ///< The text is placed at the end of the textedit
AtCursor ///< The text is placed at the current cursor position
};
/**
* Constructs a KMeditor object
*/
explicit KMeditor( const QString& text, QWidget *parent = 0 );
/**
* Constructs a KMeditor object.
*/
explicit KMeditor( QWidget *parent = 0 );
virtual ~KMeditor();
virtual void changeHighlighterColors(KEMailQuotingHighlighter*);
//Redefine it for each apps
virtual QString quotePrefixName() const; //define by kmail
virtual QString smartQuote( const QString & msg ); //need by kmail
void setUseExternalEditor( bool use );
void setExternalEditorPath( const QString & path );
/**
* Show the open file dialog and returns the selected URL there.
* The file dialog has an encoding combobox displayed, and the selected
* encoding there will be set as the encoding of the URL's fileEncoding().
*/
KUrl insertFile();
/**
* Enables word wrap. Words will be wrapped at the specified column.
*
* @param wrapColumn the column where words will be wrapped
*/
void enableWordWrap( int wrapColumn );
/**
* Disables word wrap.
* Note that words are still wrapped at the end of the editor; no scrollbar
* will appear.
*/
void disableWordWrap();
/**
* Changes the font of the whole text.
* Also sets the default font for the document.
*
* @param font the font that the whole text will get
*/
void setFontForWholeText( const QFont &font );
bool checkExternalEditorFinished();
void killExternalEditor();
void setCursorPositionFromStart( unsigned int pos );
/**
* @return the line number where the cursor is. This takes word-wrapping
* into account. Line numbers start at 0.
*/
int linePosition();
int columnNumber();
void setCursorPosition( int linePos, int columnPos );
/**
* Inserts the signature @p sig into the textedit.
* The cursor position is preserved.
* A leading or trailing newline is also added automatically, depending on
* the placement.
* For undo/redo, this is treated as one operation.
*
* Rich text mode will be enabled if the signature is in inlined HTML format.
*
* @param placement defines where in the textedit the signature should be
* inserted.
* @param addSeparator if true, the separator '-- \n' will be added in front
* of the signature
*/
void insertSignature( const KPIMIdentities::Signature &sig,
Placement placement = End, bool addSeparator = true );
/**
* Inserts the signature @p sig into the textedit.
* The cursor position is preserved.
* A leading or trailing newline is also added automatically, depending on
* the placement.
* For undo/redo, this is treated as one operation.
* A separator is not added.
*
* Use the other insertSignature() function if possible, as it has support
* for separators and does HTML detection automatically.
*
* Rich text mode will be enabled if @p isHtml is true.
*
* @param placement defines where in the textedit the signature should be
* inserted.
* @param isHtml defines whether the signature should be inserted as text or html
*/
void insertSignature( const QString &signature, Placement placement = End,
bool isHtml = false );
/**
* Replaces all occurrences of the old signature with the new signature.
* Text in quotes will be ignored.
* For undo/redo, this is treated as one operation.
* If the old signature is empty, nothing is done.
* If the new signature is empty, the old signature including the
* separator is removed.
*
* @param oldSig the old signature, which will be replaced
* @param newSig the new signature
*/
void replaceSignature( const KPIMIdentities::Signature &oldSig,
const KPIMIdentities::Signature &newSig );
/**
* Cleans the whitespace of the edit's text.
* Adjacent tabs and spaces will be converted to a single space.
* Trailing whitespace will be removed.
* More than 2 newlines in a row will be changed to 2 newlines.
* Text in quotes or text inside of the given signature will not be
* cleaned.
* For undo/redo, this is treated as one operation.
*
* @param sig text inside this signature will not be cleaned
*/
void cleanWhitespace( const KPIMIdentities::Signature &sig );
/**
* Returns the text of the editor as plain text, with linebreaks inserted
* where word-wrapping occurred.
*/
QString toWrappedPlainText() const;
/**
* Same as toPlainText() from QTextEdit, only that it removes embedded images.
*/
QString toCleanPlainText() const;
/**
* Reimplemented again to work around a bug (see comment in implementation).
* FIXME: This is _not_ virtual in the base class
*/
void ensureCursorVisible();
public Q_SLOTS:
void slotAddQuotes();
void slotRemoveBox();
void slotAddBox();
void slotPasteAsQuotation();
void slotRemoveQuotes();
/**
* Warning: This function switches back to plain text mode.
*/
void slotRot13();
void slotChangeInsertMode();
Q_SIGNALS:
/**
* Emitted whenever the foucs is lost or gained
*
* @param focusGained true if the focus was gained, false when it was lost
*/
void focusChanged( bool focusGained );
void focusUp();
void overwriteModeText();
protected:
// For the explaination for these three methods, see the comment at the
// spellCheckingEnabled variable of the private class.
/**
* Reimplemented from KTextEditSpellInterface
*/
virtual bool isSpellCheckingEnabled() const;
/**
* Reimplemented from KTextEditSpellInterface
*/
virtual void setSpellCheckingEnabled(bool enable);
/**
* Reimplemented from KTextEditSpellInterface, to avoid spellchecking
* quoted text.
*/
virtual bool shouldBlockBeSpellChecked(const QString& block) const;
/**
* Reimplemented to create our own highlighter which does quote and
* spellcheck highlighting
*/
virtual void createHighlighter();
virtual void dragEnterEvent( QDragEnterEvent *e );
virtual void dragMoveEvent( QDragMoveEvent *e );
virtual bool eventFilter( QObject *o, QEvent *e );
virtual void keyPressEvent( QKeyEvent *e );
/**
* Handles drag enter/move event for dragEnterEvent() and dragMoveEvent()
*/
void handleDragEvent( QDragMoveEvent *e );
/**
* Reimplemented to block rich text pastes in plain text mode.
*/
virtual void insertFromMimeData ( const QMimeData * source );
private:
KMeditorPrivate *const d;
friend class KMeditorPrivate;
Q_PRIVATE_SLOT( d, void ensureCursorVisibleDelayed() )
Q_PRIVATE_SLOT( d, void slotEditorFinished( int, QProcess::ExitStatus ) )
};
}
#endif

File Metadata

Mime Type
text/x-c++
Expires
Fri, Nov 1, 9:54 AM (1 d, 19 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
10076226
Default Alt Text
kmeditor.h (8 KB)

Event Timeline