.TH "KTextEdit" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KTextEdit \- A KDE'ified \fBQTextEdit\fP.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ktextedit.h>\fP
.PP
Inherits \fBQTextEdit\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBcheckSpelling\fP ()"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKTextEdit\fP (const \fBQString\fP &\fBtext\fP, const \fBQString\fP &\fBcontext\fP=QString::null, \fBQWidget\fP *parent=0, const char *name=0)"
.br
.ti -1c
.RI "\fBKTextEdit\fP (\fBQWidget\fP *parent=0L, const char *name=0)"
.br
.ti -1c
.RI "\fB~KTextEdit\fP ()"
.br
.ti -1c
.RI "virtual void \fBsetReadOnly\fP (bool readOnly)"
.br
.ti -1c
.RI "virtual void \fBsetPalette\fP (const \fBQPalette\fP &palette)"
.br
.ti -1c
.RI "void \fBsetCheckSpellingEnabled\fP (bool check)"
.br
.ti -1c
.RI "bool \fBcheckSpellingEnabled\fP () const "
.br
.ti -1c
.RI "void \fBhighLightWord\fP (unsigned int \fBlength\fP, unsigned int pos)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBkeyPressEvent\fP (\fBQKeyEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBfocusInEvent\fP (\fBQFocusEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBcontentsWheelEvent\fP (\fBQWheelEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBdeleteWordBack\fP ()"
.br
.ti -1c
.RI "virtual void \fBdeleteWordForward\fP ()"
.br
.ti -1c
.RI "virtual \fBQPopupMenu\fP * \fBcreatePopupMenu\fP (const \fBQPoint\fP &pos)"
.br
.ti -1c
.RI "virtual \fBQPopupMenu\fP * \fBcreatePopupMenu\fP ()"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A KDE'ified \fBQTextEdit\fP. 

This is just a little subclass of \fBQTextEdit\fP, implementing some standard \fBKDE\fP features, like Cursor auto-hiding, configurable wheelscrolling (fast-scroll or zoom) and deleting of entire words with Ctrl-Backspace or Ctrl-Delete.
.PP
Basic rule: whenever you want to use \fBQTextEdit\fP, use KTextEdit!
.PP
\fBSee also:\fP
.RS 4
\fBQTextEdit\fP 
.RE
.PP
\fBAuthor:\fP
.RS 4
Carsten Pfeiffer <pfeiffer@kde.org> 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 43 of file ktextedit.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KTextEdit::KTextEdit (const \fBQString\fP & text, const \fBQString\fP & context = \fCQString::null\fP, \fBQWidget\fP * parent = \fC0\fP, const char * name = \fC0\fP)"
.PP
Constructs a KTextEdit object. 
.PP
See \fBQTextEdit::QTextEdit\fP for details. 
.PP
Definition at line 54 of file ktextedit.cpp.
.PP
References KCursor::setAutoHideCursor().
.SS "KTextEdit::KTextEdit (\fBQWidget\fP * parent = \fC0L\fP, const char * name = \fC0\fP)"
.PP
Constructs a KTextEdit object. 
.PP
See \fBQTextEdit::QTextEdit\fP for details. 
.PP
Definition at line 62 of file ktextedit.cpp.
.PP
References KCursor::setAutoHideCursor().
.SS "KTextEdit::~\fBKTextEdit\fP ()"
.PP
Destroys the KTextEdit object. 
.PP
Definition at line 69 of file ktextedit.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KTextEdit::setReadOnly (bool readOnly)\fC [virtual]\fP"
.PP
Reimplemented to set a proper 'deactivated' background color. 
.PP
Reimplemented from \fBQTextEdit\fP.
.PP
Definition at line 309 of file ktextedit.cpp.
.PP
References QPalette::color(), QTextEdit::isReadOnly(), QPalette::setColor(), setPalette(), and QTextEdit::setReadOnly().
.SS "void KTextEdit::setPalette (const \fBQPalette\fP & palette)\fC [virtual]\fP"
.PP
Reimplemented for tracking custom palettes. 
.PP
Definition at line 261 of file ktextedit.cpp.
.PP
Referenced by setReadOnly().
.SS "void KTextEdit::setCheckSpellingEnabled (bool check)"
.PP
Turns spell checking for this text edit on or off. 
.PP
\fBSee also:\fP
.RS 4
\fBcheckSpellingEnabled()\fP 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 274 of file ktextedit.cpp.
.SS "bool KTextEdit::checkSpellingEnabled () const"
.PP
Returns true if spell checking is enabled for this text edit. 
.PP
@ see \fBsetCheckSpellingEnabled()\fP 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 304 of file ktextedit.cpp.
.SS "void KTextEdit::checkSpelling ()\fC [slot]\fP"
.PP
Create a modal dialog to check the spelling. 
.PP
This slot will not return until spell checking has been completed.
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 344 of file ktextedit.cpp.
.PP
Referenced by createPopupMenu().
.SS "void KTextEdit::keyPressEvent (\fBQKeyEvent\fP *)\fC [protected, virtual]\fP"
.PP
Reimplemented to catch 'delete word' key events. 
.PP
Reimplemented from \fBQTextEdit\fP.
.PP
Definition at line 74 of file ktextedit.cpp.
.PP
References QApplication::clipboard(), QTextEdit::copy(), QTextEdit::cut(), deleteWordBack(), deleteWordForward(), QTextEdit::getCursorPosition(), QTextEdit::insert(), QString::isEmpty(), QTextEdit::keyPressEvent(), QTextEdit::moveCursor(), QTextEdit::paste(), QTextEdit::redo(), QTextEdit::text(), and QTextEdit::undo().
.SS "void KTextEdit::focusInEvent (\fBQFocusEvent\fP *)\fC [protected, virtual]\fP"
.PP
Reimplemented to instantiate a \fBKDictSpellingHighlighter\fP, if spellchecking is enabled. 
.PP
Definition at line 296 of file ktextedit.cpp.
.SS "void KTextEdit::contentsWheelEvent (\fBQWheelEvent\fP *)\fC [protected, virtual]\fP"
.PP
Reimplemented to allow fast-wheelscrolling with Ctrl-Wheel or zoom. 
.PP
Definition at line 253 of file ktextedit.cpp.
.PP
References QScrollView::contentsWheelEvent().
.SS "void KTextEdit::deleteWordBack ()\fC [protected, virtual]\fP"
.PP
Deletes a word backwards from the current cursor position, if available. 
.PP
Definition at line 194 of file ktextedit.cpp.
.PP
References QTextEdit::moveCursor(), QTextEdit::removeSelectedText(), and QTextEdit::removeSelection().
.PP
Referenced by keyPressEvent().
.SS "void KTextEdit::deleteWordForward ()\fC [protected, virtual]\fP"
.PP
Deletes a word forwards from the current cursor position, if available. 
.PP
Definition at line 201 of file ktextedit.cpp.
.PP
References QTextEdit::moveCursor(), QTextEdit::removeSelectedText(), and QTextEdit::removeSelection().
.PP
Referenced by keyPressEvent().
.SS "\fBQPopupMenu\fP * KTextEdit::createPopupMenu (const \fBQPoint\fP & pos)\fC [protected, virtual]\fP"
.PP
Reimplemented from \fBQTextEdit\fP to add spelling related items when appropriate. 
.PP
Reimplemented from \fBQTextEdit\fP.
.PP
Definition at line 213 of file ktextedit.cpp.
.PP
References QPopupMenu::changeItem(), checkSpelling(), QTextEdit::createPopupMenu(), QPopupMenu::idAt(), QPopupMenu::insertItem(), QPopupMenu::insertSeparator(), QTextEdit::isReadOnly(), QPopupMenu::setItemChecked(), QPopupMenu::setItemEnabled(), QTextEdit::tabChangesFocus(), QTextEdit::text(), and QPopupMenu::text().
.SS "\fBQPopupMenu\fP * KTextEdit::createPopupMenu ()\fC [protected, virtual]\fP"
.PP
This is just a reimplementation of a deprecated method from \fBQTextEdit\fP and is just here to keep source compatibility. 
.PP
This should not be used in new code. Specifically reimplementing this method will probably not do what you expect. See the method above.
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.PP
Definition at line 248 of file ktextedit.cpp.
.PP
References QTextEdit::createPopupMenu().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
