• Skip to content
  • Skip to link menu
KDE 4.6 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

KPIMTextedit Library

  • KPIMTextEdit
  • EMailQuoteHighlighter
Public Member Functions | Static Public Member Functions | Protected Member Functions

KPIMTextEdit::EMailQuoteHighlighter Class Reference

This highlighter highlights spelling mistakes and also highlightes quotes. More...

#include <emailquotehighlighter.h>

Inherits Sonnet::Highlighter.

List of all members.

Public Member Functions

 EMailQuoteHighlighter (TextEdit *textEdit, const QColor &normalColor=Qt::black, const QColor &quoteDepth1=QColor(0x00, 0x80, 0x00), const QColor &quoteDepth2=QColor(0x00, 0x80, 0x00), const QColor &quoteDepth3=QColor(0x00, 0x80, 0x00), const QColor &misspelledColor=Qt::red)
virtual void highlightBlock (const QString &text)
void setQuoteColor (const QColor &normalColor, const QColor &quoteDepth1, const QColor &quoteDepth2, const QColor &quoteDepth3, const QColor &misspelledColor=Qt::red)
void toggleSpellHighlighting (bool on)

Static Public Member Functions

static QString highlightParagraph (const QString &text, const QColor &quoteDepth1=QColor(0x00, 0x80, 0x00), const QColor &quoteDepth2=QColor(0x00, 0x80, 0x00), const QColor &quoteDepth3=QColor(0x00, 0x80, 0x00))
static QString highlightText (const QString &text, const QColor &quoteDepth1=QColor(0x00, 0x80, 0x00), const QColor &quoteDepth2=QColor(0x00, 0x80, 0x00), const QColor &quoteDepth3=QColor(0x00, 0x80, 0x00))

Protected Member Functions

virtual void setMisspelled (int start, int count)
virtual void unsetMisspelled (int start, int count)

Detailed Description

This highlighter highlights spelling mistakes and also highlightes quotes.

Spelling mistakes inside quotes will not be highlighted. The quote highlighting color is configurable.

Spell highlighting is disabled by default but can be toggled.

Since:
4.3

Definition at line 44 of file emailquotehighlighter.h.


Constructor & Destructor Documentation

KPIMTextEdit::EMailQuoteHighlighter::EMailQuoteHighlighter ( TextEdit *  textEdit,
const QColor &  normalColor = Qt::black,
const QColor &  quoteDepth1 = QColor( 0x00, 0x80, 0x00 ),
const QColor &  quoteDepth2 = QColor( 0x00, 0x80, 0x00 ),
const QColor &  quoteDepth3 = QColor( 0x00, 0x80, 0x00 ),
const QColor &  misspelledColor = Qt::red 
) [explicit]

Constructor.

See setQuoteColor() for the parameters. FIXME: Default colors don't obey color scheme

Definition at line 38 of file emailquotehighlighter.cpp.


Member Function Documentation

void KPIMTextEdit::EMailQuoteHighlighter::highlightBlock ( const QString &  text) [virtual]

Reimplemented to highlight quote blocks.

Definition at line 128 of file emailquotehighlighter.cpp.

QString KPIMTextEdit::EMailQuoteHighlighter::highlightParagraph ( const QString &  text,
const QColor &  quoteDepth1 = QColor( 0x00, 0x80, 0x00 ),
const QColor &  quoteDepth2 = QColor( 0x00, 0x80, 0x00 ),
const QColor &  quoteDepth3 = QColor( 0x00, 0x80, 0x00 ) 
) [static]

Use this static method to get proper highlighting for a single line.

Since:
4.4

Definition at line 82 of file emailquotehighlighter.cpp.

QString KPIMTextEdit::EMailQuoteHighlighter::highlightText ( const QString &  text,
const QColor &  quoteDepth1 = QColor( 0x00, 0x80, 0x00 ),
const QColor &  quoteDepth2 = QColor( 0x00, 0x80, 0x00 ),
const QColor &  quoteDepth3 = QColor( 0x00, 0x80, 0x00 ) 
) [static]

Use this static method to get a text consisting of multiple lines highligted.

Since:
4.4

Definition at line 66 of file emailquotehighlighter.cpp.

void KPIMTextEdit::EMailQuoteHighlighter::setMisspelled ( int  start,
int  count 
) [protected, virtual]

Reimplemented to set the color of the misspelled word to a color defined by setQuoteColor().

Definition at line 163 of file emailquotehighlighter.cpp.

void KPIMTextEdit::EMailQuoteHighlighter::setQuoteColor ( const QColor &  normalColor,
const QColor &  quoteDepth1,
const QColor &  quoteDepth2,
const QColor &  quoteDepth3,
const QColor &  misspelledColor = Qt::red 
)

Sets the colors used for highlighting quoted text and spelling mistakes.

Parameters:
quoteDepth1color for text quoted 1 level deep
quoteDepth2color for text quoted 2 level deep
quoteDepth3color for text quoted 3 level deep
misspelledColorcolor in which misspelled words will be underlined
normalColorwill be ignored, only provided for KNode compatibility.

Definition at line 107 of file emailquotehighlighter.cpp.

void KPIMTextEdit::EMailQuoteHighlighter::toggleSpellHighlighting ( bool  on)

Turns spellcheck highlighting on or off.

Parameters:
onif true, spelling mistakes will be highlighted

Definition at line 120 of file emailquotehighlighter.cpp.

void KPIMTextEdit::EMailQuoteHighlighter::unsetMisspelled ( int  start,
int  count 
) [protected, virtual]

Reimplemented, the base version sets the text color to black, which is not what we want.

We do nothing, the format is already reset by Qt.

Definition at line 157 of file emailquotehighlighter.cpp.


The documentation for this class was generated from the following files:
  • emailquotehighlighter.h
  • emailquotehighlighter.cpp

KPIMTextedit Library

Skip menu "KPIMTextedit Library"
  • Main Page
  • Namespace List
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.3
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal