You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdelibs/kdeui/ktextedit.h

175 lines
4.9 KiB

/* This file is part of the KDE libraries
Copyright (C) 2002 Carsten Pfeiffer <pfeiffer@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KTEXTEDIT_H
#define KTEXTEDIT_H
#include <qtextedit.h>
#include <kdelibs_export.h>
class KSpell;
/**
* @short A KDE'ified QTextEdit
*
* This is just a little subclass of QTextEdit, implementing
* some standard KDE features, like Cursor auto-hiding, configurable
* wheelscrolling (fast-scroll or zoom) and deleting of entire
* words with Ctrl-Backspace or Ctrl-Delete.
*
* Basic rule: whenever you want to use QTextEdit, use KTextEdit!
*
* @see QTextEdit
* @author Carsten Pfeiffer <pfeiffer@kde.org>
* @since 3.1
*/
class KDEUI_EXPORT KTextEdit : public QTextEdit
{
Q_OBJECT
public:
/**
* Constructs a KTextEdit object. See QTextEdit::QTextEdit
* for details.
*/
KTextEdit( const QString& text,
const QString& context = QString::null,
QWidget * parent = 0, const char *name = 0 );
/**
* Constructs a KTextEdit object. See QTextEdit::QTextEdit
* for details.
*/
KTextEdit( QWidget *parent = 0L, const char *name = 0 );
/**
* Destroys the KTextEdit object.
*/
~KTextEdit();
/**
* Reimplemented to set a proper "deactivated" background color.
*/
virtual void setReadOnly (bool readOnly);
/**
* Reimplemented for tracking custom palettes.
*/
virtual void setPalette( const QPalette& palette );
/**
* Turns spell checking for this text edit on or off. Note that spell
* checking is only available in read-writable KTextEdits.
*
* @see checkSpellingEnabled()
* @see isReadOnly()
* @see setReadOnly()
* @since 3.2
*/
void setCheckSpellingEnabled( bool check );
/**
* Returns true if spell checking is enabled for this text edit.
* Note that it even returns true if this is a read-only KTextEdit,
* where spell checking is actually disabled.
*
@ see setCheckSpellingEnabled()
* @since 3.2
*/
bool checkSpellingEnabled() const;
void highLightWord( unsigned int length, unsigned int pos );
public slots:
/**
* Create a modal dialog to check the spelling. This slot will not return
* until spell checking has been completed.
*
* @since 3.2
*/
void checkSpelling();
protected:
/**
* Reimplemented to catch "delete word" key events.
*/
virtual void keyPressEvent( QKeyEvent * );
/**
* Reimplemented to instantiate a KDictSpellingHighlighter, if
* spellchecking is enabled.
*/
virtual void focusInEvent( QFocusEvent * );
/**
* Reimplemented to allow fast-wheelscrolling with Ctrl-Wheel
* or zoom.
*/
virtual void contentsWheelEvent( QWheelEvent * );
/**
* Deletes a word backwards from the current cursor position,
* if available.
*/
virtual void deleteWordBack();
/**
* Deletes a word forwards from the current cursor position,
* if available.
*/
virtual void deleteWordForward();
/**
* Reimplemented from QTextEdit to add spelling related items
* when appropriate.
*/
virtual QPopupMenu *createPopupMenu( const QPoint &pos );
/**
* This is just a reimplementation of a deprecated method from QTextEdit and
* is just here to keep source compatibility. This should not be used in
* new code. Specifically reimplementing this method will probably not do
* what you expect. See the method above.
*
* @deprecated
*/
virtual QPopupMenu *createPopupMenu();
protected:
virtual void virtual_hook( int id, void* data );
private slots:
void slotSpellCheckReady( KSpell *s );
void slotSpellCheckDone( const QString &s );
void spellCheckerMisspelling( const QString &text, const QStringList &, unsigned int pos);
void spellCheckerCorrected( const QString &, const QString &, unsigned int );
void spellCheckerFinished();
void toggleAutoSpellCheck();
void slotAllowTab();
private:
void posToRowCol( unsigned int pos, unsigned int &line, unsigned int &col );
class KTextEditPrivate;
KTextEditPrivate *d;
};
#endif // KTEXTEDIT_H