Kate::View Class Reference
The Kate::View text editor interface. More...
#include <view.h>
| Public Types | |
| enum | saveResult { SAVE_OK, SAVE_CANCEL, SAVE_RETRY, SAVE_ERROR } | 
| Public Slots | |
| virtual void | flush () | 
| virtual saveResult | save () | 
| virtual saveResult | saveAs () | 
| virtual void | indent () | 
| virtual void | unIndent () | 
| virtual void | cleanIndent () | 
| virtual void | comment () | 
| virtual void | uncomment () | 
| virtual void | keyReturn () | 
| virtual void | keyDelete () | 
| virtual void | backspace () | 
| virtual void | killLine () | 
| virtual void | cursorLeft () | 
| virtual void | shiftCursorLeft () | 
| virtual void | cursorRight () | 
| virtual void | shiftCursorRight () | 
| virtual void | wordLeft () | 
| virtual void | shiftWordLeft () | 
| virtual void | wordRight () | 
| virtual void | shiftWordRight () | 
| virtual void | home () | 
| virtual void | shiftHome () | 
| virtual void | end () | 
| virtual void | shiftEnd () | 
| virtual void | up () | 
| virtual void | shiftUp () | 
| virtual void | down () | 
| virtual void | shiftDown () | 
| virtual void | scrollUp () | 
| virtual void | scrollDown () | 
| virtual void | topOfView () | 
| virtual void | bottomOfView () | 
| virtual void | pageUp () | 
| virtual void | shiftPageUp () | 
| virtual void | pageDown () | 
| virtual void | shiftPageDown () | 
| virtual void | top () | 
| virtual void | shiftTop () | 
| virtual void | bottom () | 
| virtual void | shiftBottom () | 
| virtual void | find () | 
| virtual void | replace () | 
| virtual void | gotoLine () | 
| virtual int | getEol () | 
| virtual void | setEol (int) | 
| virtual void | setFocus () | 
| virtual void | findAgain (bool forward) | 
| virtual void | findAgain () | 
| virtual void | findPrev () | 
| virtual void | slotEditCommand () | 
| virtual void | setIconBorder (bool enable) | 
| virtual void | toggleIconBorder () | 
| virtual void | setLineNumbersOn (bool enable) | 
| virtual void | toggleLineNumbersOn () | 
| virtual void | slotIncFontSizes () | 
| virtual void | slotDecFontSizes () | 
| virtual void | gotoMark (KTextEditor::Mark *mark)=0 | 
| virtual void | toggleBookmark () | 
| virtual void | gotoLineNumber (int)=0 | 
| Signals | |
| void | gotFocus (View *) | 
| Public Member Functions | |
| View (KTextEditor::Document *, QWidget *, const char *name=0) | |
| virtual | ~View () | 
| virtual bool | isOverwriteMode () const | 
| virtual void | setOverwriteMode (bool) | 
| virtual QString | currentTextLine () | 
| virtual QString | currentWord () | 
| virtual QString | word (int, int) | 
| virtual void | insertText (const QString &mark) | 
| virtual bool | canDiscard () | 
| virtual int | tabWidth ()=0 | 
| virtual void | setTabWidth (int)=0 | 
| virtual void | setEncoding (QString e)=0 | 
| virtual bool | isLastView ()=0 | 
| virtual void | readSessionConfig (KConfig *) | 
| virtual void | writeSessionConfig (KConfig *) | 
| virtual bool | iconBorder () | 
| virtual bool | lineNumbersOn () | 
| virtual Document * | getDoc () | 
| virtual void | setActive (bool b)=0 | 
| virtual bool | isActive ()=0 | 
Detailed Description
The Kate::View text editor interface.
- Author:
- Cullmann Christoph, modified by rokrau (6/21/01)
Definition at line 42 of file view.h.
Member Enumeration Documentation
| 
 | 
| Return values for "save" related commands. 
 | 
Constructor & Destructor Documentation
| 
 | ||||||||||||||||
| Constructor (should much rather take a reference to the document). 
 Definition at line 77 of file interfaces.cpp. | 
| 
 | 
| Destructor, you need a destructor if Scott Meyers says so. 
 Definition at line 81 of file interfaces.cpp. | 
Member Function Documentation
| 
 | 
| Set editor mode. 
 | 
| 
 | 
| Get editor mode. 
 | 
| 
 | 
| Gets the text line where the cursor is on. 
 | 
| 
 | 
| Gets the word where the cursor is on. 
 | 
| 
 | ||||||||||||
| Gets the word at position x, y. Can be used to find the word under the mouse cursor | 
| 
 | 
| Insert text at the current cursor position. 
 
 | 
| 
 | 
| Works exactly like closeURL() of KParts::ReadWritePart. 
 | 
| 
 | 
| Returns true if this editor is the only owner of its document. 
 | 
| 
 | 
| Flushes the document of the text widget. The user is given a chance to save the current document if the current document has been modified. | 
| 
 | 
| Saves the file under the current file name. If the current file name is Untitled, as it is after a call to newFile(), this routine will call saveAs(). Definition at line 114 of file view.h. References saveResult. | 
| 
 | 
| Allows the user to save the file under a new name. 
 Definition at line 118 of file view.h. References saveResult. | 
| 
 | 
| Moves the current line or the selection one position to the right. 
 | 
| 
 | 
| Moves the current line or the selection one position to the left. 
 | 
| 
 | 
| Optimizes the selected indentation, replacing tabs and spaces as needed. 
 | 
| 
 | 
| Comments out current line. 
 | 
| 
 | 
| Removes comment signs in the current line. 
 | 
| 
 | 
| Some simply key commands. 
 | 
| 
 | 
| Move cursor in the view. 
 | 
| 
 | 
| Presents a search dialog to the user. 
 | 
| 
 | 
| Presents a replace dialog to the user. 
 | 
| 
 | 
| Presents a "Goto Line" dialog to the user. 
 | 
| 
 | 
| Reads session config out of the KConfig object. This also includes the actual cursor position and the bookmarks. | 
| 
 | 
| Writes session config into the KConfig object. 
 | 
| 
 | 
| Get the end of line mode (Unix, Macintosh or Dos). 
 | 
| 
 | 
| Set the end of line mode (Unix, Macintosh or Dos). 
 | 
| 
 | 
| Set focus to the current window. 
 Definition at line 214 of file view.h. References QWidget::setFocus(). | 
| 
 | 
| Searches for the last searched text forward from cursor position. 
 
 | 
| 
 | 
| Searches for the last searched text forward from cursor position. Searches forward from current cursor position. | 
| 
 | 
| Searches for the last searched text forward from cursor position. Searches backward from current cursor position. | 
| 
 | 
| Presents an edit command popup window, where the user can apply a shell command to the contents of the current window. 
 | 
| 
 | 
| Sets icon border on or off depending on. 
 
 | 
| 
 | 
| Toggles icon border. 
 | 
| 
 | 
| 
Sets display of line numbers on/off depending on  
 
 | 
| 
 | 
| Toggles display of lineNumbers. 
 | 
| 
 | 
| Returns whether iconborder is visible. 
 | 
| 
 | 
| 
 
 | 
| 
 | 
| Returns a pointer to the document of the view. 
 | 
| 
 | 
| Increase font size. 
 | 
| 
 | 
| Decrease font size. 
 | 
| 
 | 
| 
 
 | 
The documentation for this class was generated from the following files:

