Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KEdit Class Reference

#include <keditcl.h>

List of all members.

Public Types

enum  

Signals

void gotUrlDrop (QDropEvent *e)
void CursorPositionChanged ()
void toggle_overwrite_signal ()

Public Methods

 KEdit (QWidget *_parent=NULL, const char *name=NULL)
void insertText (QTextStream *)
void saveText (QTextStream *, bool softWrap)
void selectFont ()
void search ()
bool repeatSearch ()
void replace ()
void doGotoLine ()
void cleanWhiteSpace ()
void installRBPopup (QPopupMenu *)
int currentLine ()
int currentColumn ()
void spellcheck_start ()
void spellcheck_stop ()
void setOverwriteEnabled (bool b)

Protected Methods

void posToRowCol (unsigned int pos, unsigned int &line, unsigned int &col)
virtual void create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)


Detailed Description

A simple text editor for the KDE project.
Deprecated:
. Use KTextEditor::Editor or KTextEdit instead.

Author:
Bernd Johannes Wuebben <wuebben@math.cornell.edu>, Waldo Bastian <bastian@kde.org>

Definition at line 171 of file keditcl.h.


Member Enumeration Documentation

anonymous enum
 

Search directions.

Definition at line 187 of file keditcl.h.


Constructor & Destructor Documentation

KEdit::KEdit QWidget *    _parent = NULL,
const char *    name = NULL
 

The usual constructor.


Member Function Documentation

void KEdit::cleanWhiteSpace  
 

Clean up redundant whitespace from selected text.

virtual void KEdit::create WId    = 0,
bool    initializeWindow = true,
bool    destroyOldWindow = true
[protected, virtual]
 

Reimplemented for internal reasons, the API is not affected.

int KEdit::currentColumn  
 

Retrieve the actual column number the cursor is on.

This call differs from QMultiLineEdit::getCursorPosition() in that it returns the actual cursor position and not the character position. Use currentLine() and currentColumn() if you want to display the current line or column in the status bar for example.

int KEdit::currentLine  
 

Retrieve the current line number.

The current line is the line the cursor is on.

void KEdit::CursorPositionChanged   [signal]
 

This signal is emitted whenever the cursor position changes.

Use this in conjunction with currentLine(), currentColumn() if you need to know the cursor position.

void KEdit::doGotoLine  
 

Present a "Goto Line" dialog to the user.

void KEdit::gotUrlDrop QDropEvent *    e [signal]
 

This signal is emitted if the user dropped a URL over the text editor QMultiLineEdit widget.

Note that the user can drop also Text on it, but this is already handled internally by QMultiLineEdit.

void KEdit::insertText QTextStream *   
 

Insert text from the text stream into the edit widget.

void KEdit::installRBPopup QPopupMenu *   
 

Install a context menu for KEdit.

The Popup Menu will be activated on a right mouse button press event.

void KEdit::posToRowCol unsigned int    pos,
unsigned int &    line,
unsigned int &    col
[protected]
 

Sets line and col to the position pos, considering word wrap.

bool KEdit::repeatSearch  
 

Repeat the last search specified on the search dialog.

If the user hasn't searched for anything until now, this method will simply return without doing anything.

Returns:
true if a search was done. false if no search was done.

void KEdit::replace  
 

Present a Search and Replace Dialog to the user.

void KEdit::saveText QTextStream *   ,
bool    softWrap
 

Save text from the edit widget to a text stream. If softWrap is false soft line wrappings are replaced with line-feeds If softWrap is true soft line wrappings are ignored.

Since:
3.1

void KEdit::search  
 

Present a search dialog to the user

void KEdit::selectFont  
 

Let the user select a font and set the font of the textwidget to that selected font.

void KEdit::setOverwriteEnabled bool    b
 

Allow the user to toggle between insert mode and overwrite mode with the "Insert" key. See also toggle_overwrite_signal();

The default is false: the user can not toggle.

void KEdit::spellcheck_start  
 

Start spellchecking mode.

void KEdit::spellcheck_stop  
 

Exit spellchecking mode.

void KEdit::toggle_overwrite_signal   [signal]
 

This signal is emitted if the user toggles from insert to overwrite mode or vice versa.

The user can do so by pressing the "Insert" button on a PC keyboard.

This feature must be activated by calling setOverwriteEnabled(true) first.


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:11 2003 for kdelibs by doxygen1.2.18