#include <view.h>
Inherits KTextEditor::View, KTextEditor::ClipboardInterface, KTextEditor::PopupMenuInterface, KTextEditor::ViewCursorInterface, KTextEditor::CodeCompletionInterface, and KTextEditor::DynWordWrapInterface.
Inherited by KateView.
|
| enum | saveResult { SAVE_OK
, SAVE_CANCEL
, SAVE_RETRY
, SAVE_ERROR
} |
| |
The Kate::View text editor interface.
- Author
- Cullmann Christoph, modified by rokrau (6/21/01)
Definition at line 42 of file view.h.
◆ saveResult
Return values for "save" related commands.
Definition at line 52 of file view.h.
◆ View()
| Kate::View::View |
( |
KTextEditor::Document * |
doc, |
|
|
TQWidget * |
parent, |
|
|
const char * |
name = 0 |
|
) |
| |
Constructor (should much rather take a reference to the document).
Definition at line 77 of file interfaces.cpp.
◆ ~View()
Destructor, you need a destructor if Scott Meyers says so.
Definition at line 81 of file interfaces.cpp.
◆ backspace()
| virtual void Kate::View::backspace |
( |
| ) |
|
|
inlinevirtual |
◆ bottom()
| virtual void Kate::View::bottom |
( |
| ) |
|
|
inlinevirtual |
◆ bottomOfView()
| virtual void Kate::View::bottomOfView |
( |
| ) |
|
|
inlinevirtual |
◆ canDiscard()
| virtual bool Kate::View::canDiscard |
( |
| ) |
|
|
inlinevirtual |
◆ cleanIndent()
| virtual void Kate::View::cleanIndent |
( |
| ) |
|
|
inlinevirtual |
Optimizes the selected indentation, replacing tabs and spaces as needed.
Definition at line 130 of file view.h.
◆ comment()
| virtual void Kate::View::comment |
( |
| ) |
|
|
inlinevirtual |
Comments out current line.
Definition at line 134 of file view.h.
◆ currentTextLine()
| virtual TQString Kate::View::currentTextLine |
( |
| ) |
|
|
inlinevirtual |
Gets the text line where the cursor is on.
Definition at line 72 of file view.h.
◆ currentWord()
| virtual TQString Kate::View::currentWord |
( |
| ) |
|
|
inlinevirtual |
Gets the word where the cursor is on.
Definition at line 76 of file view.h.
◆ cursorLeft()
| virtual void Kate::View::cursorLeft |
( |
| ) |
|
|
inlinevirtual |
Move cursor in the view.
Definition at line 149 of file view.h.
◆ cursorRight()
| virtual void Kate::View::cursorRight |
( |
| ) |
|
|
inlinevirtual |
◆ down()
| virtual void Kate::View::down |
( |
| ) |
|
|
inlinevirtual |
◆ end()
| virtual void Kate::View::end |
( |
| ) |
|
|
inlinevirtual |
◆ find()
| virtual void Kate::View::find |
( |
| ) |
|
|
inlinevirtual |
Presents a search dialog to the user.
Definition at line 180 of file view.h.
◆ findAgain [1/2]
| virtual void Kate::View::findAgain |
( |
| ) |
|
|
inlinevirtualslot |
Searches for the last searched text forward from cursor position.
Searches forward from current cursor position.
Definition at line 224 of file view.h.
◆ findAgain [2/2]
| virtual void Kate::View::findAgain |
( |
bool |
forward | ) |
|
|
inlinevirtualslot |
Searches for the last searched text forward from cursor position.
- Parameters
-
| forward | determines the search direction. |
Definition at line 219 of file view.h.
◆ findPrev()
| virtual void Kate::View::findPrev |
( |
| ) |
|
|
inlinevirtual |
Searches for the last searched text forward from cursor position.
Searches backward from current cursor position.
Definition at line 229 of file view.h.
◆ flush
| virtual void Kate::View::flush |
( |
| ) |
|
|
inlinevirtualslot |
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.
Definition at line 108 of file view.h.
◆ getDoc()
| virtual Document * Kate::View::getDoc |
( |
| ) |
|
|
inlinevirtual |
Returns a pointer to the document of the view.
Definition at line 267 of file view.h.
◆ getEol
| virtual int Kate::View::getEol |
( |
| ) |
|
|
inlinevirtualslot |
Get the end of line mode (Unix, Macintosh or Dos).
Definition at line 205 of file view.h.
◆ gotoLine()
| virtual void Kate::View::gotoLine |
( |
| ) |
|
|
inlinevirtual |
Presents a "Goto Line" dialog to the user.
Definition at line 188 of file view.h.
◆ home()
| virtual void Kate::View::home |
( |
| ) |
|
|
inlinevirtual |
◆ iconBorder()
| virtual bool Kate::View::iconBorder |
( |
| ) |
|
|
inlinevirtual |
Returns whether iconborder is visible.
Definition at line 259 of file view.h.
◆ indent()
| virtual void Kate::View::indent |
( |
| ) |
|
|
inlinevirtual |
Moves the current line or the selection one position to the right.
Definition at line 122 of file view.h.
◆ insertText()
| virtual void Kate::View::insertText |
( |
const TQString & |
mark | ) |
|
|
inlinevirtual |
Insert text at the current cursor position.
- Parameters
-
Definition at line 86 of file view.h.
◆ isLastView()
| virtual bool Kate::View::isLastView |
( |
| ) |
|
|
pure virtual |
Returns true if this editor is the only owner of its document.
◆ isOverwriteMode()
| virtual bool Kate::View::isOverwriteMode |
( |
| ) |
const |
|
inlinevirtual |
Set editor mode.
Definition at line 64 of file view.h.
◆ keyDelete()
| virtual void Kate::View::keyDelete |
( |
| ) |
|
|
inlinevirtual |
◆ keyReturn()
| virtual void Kate::View::keyReturn |
( |
| ) |
|
|
inlinevirtual |
Some simply key commands.
Definition at line 142 of file view.h.
◆ killLine()
| virtual void Kate::View::killLine |
( |
| ) |
|
|
inlinevirtual |
◆ lineNumbersOn()
| virtual bool Kate::View::lineNumbersOn |
( |
| ) |
|
|
inlinevirtual |
- Returns
- Wheather line numbers display is on
Definition at line 263 of file view.h.
◆ pageDown()
| virtual void Kate::View::pageDown |
( |
| ) |
|
|
inlinevirtual |
◆ pageUp()
| virtual void Kate::View::pageUp |
( |
| ) |
|
|
inlinevirtual |
◆ readSessionConfig()
| virtual void Kate::View::readSessionConfig |
( |
TDEConfig * |
| ) |
|
|
inlinevirtual |
Reads session config out of the TDEConfig object.
This also includes the actual cursor position and the bookmarks.
Definition at line 195 of file view.h.
◆ replace()
| virtual void Kate::View::replace |
( |
| ) |
|
|
inlinevirtual |
Presents a replace dialog to the user.
Definition at line 184 of file view.h.
◆ save()
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.
◆ saveAs()
Allows the user to save the file under a new name.
Definition at line 118 of file view.h.
◆ scrollDown()
| virtual void Kate::View::scrollDown |
( |
| ) |
|
|
inlinevirtual |
◆ scrollUp()
| virtual void Kate::View::scrollUp |
( |
| ) |
|
|
inlinevirtual |
◆ setEol
| virtual void Kate::View::setEol |
( |
int |
| ) |
|
|
inlinevirtualslot |
Set the end of line mode (Unix, Macintosh or Dos).
Definition at line 209 of file view.h.
◆ setFocus
| virtual void Kate::View::setFocus |
( |
| ) |
|
|
inlinevirtualslot |
Set focus to the current window.
Definition at line 214 of file view.h.
◆ setIconBorder()
| virtual void Kate::View::setIconBorder |
( |
bool |
enable | ) |
|
|
inlinevirtual |
Sets icon border on or off depending on.
- Parameters
-
Definition at line 240 of file view.h.
◆ setLineNumbersOn()
| virtual void Kate::View::setLineNumbersOn |
( |
bool |
enable | ) |
|
|
inlinevirtual |
Sets display of line numbers on/off depending on enable.
- Parameters
-
Definition at line 249 of file view.h.
◆ setOverwriteMode()
| virtual void Kate::View::setOverwriteMode |
( |
bool |
| ) |
|
|
inlinevirtual |
Get editor mode.
Definition at line 68 of file view.h.
◆ shiftBottom()
| virtual void Kate::View::shiftBottom |
( |
| ) |
|
|
inlinevirtual |
◆ shiftCursorLeft()
| virtual void Kate::View::shiftCursorLeft |
( |
| ) |
|
|
inlinevirtual |
◆ shiftCursorRight()
| virtual void Kate::View::shiftCursorRight |
( |
| ) |
|
|
inlinevirtual |
◆ shiftDown()
| virtual void Kate::View::shiftDown |
( |
| ) |
|
|
inlinevirtual |
◆ shiftEnd()
| virtual void Kate::View::shiftEnd |
( |
| ) |
|
|
inlinevirtual |
◆ shiftHome()
| virtual void Kate::View::shiftHome |
( |
| ) |
|
|
inlinevirtual |
◆ shiftPageDown()
| virtual void Kate::View::shiftPageDown |
( |
| ) |
|
|
inlinevirtual |
◆ shiftPageUp()
| virtual void Kate::View::shiftPageUp |
( |
| ) |
|
|
inlinevirtual |
◆ shiftTop()
| virtual void Kate::View::shiftTop |
( |
| ) |
|
|
inlinevirtual |
◆ shiftUp()
| virtual void Kate::View::shiftUp |
( |
| ) |
|
|
inlinevirtual |
◆ shiftWordLeft()
| virtual void Kate::View::shiftWordLeft |
( |
| ) |
|
|
inlinevirtual |
◆ shiftWordRight()
| virtual void Kate::View::shiftWordRight |
( |
| ) |
|
|
inlinevirtual |
◆ slotDecFontSizes
| virtual void Kate::View::slotDecFontSizes |
( |
| ) |
|
|
inlinevirtualslot |
Decrease font size.
Definition at line 277 of file view.h.
◆ slotEditCommand()
| virtual void Kate::View::slotEditCommand |
( |
| ) |
|
|
inlinevirtual |
Presents an edit command popup window, where the user can apply a shell command to the contents of the current window.
Definition at line 234 of file view.h.
◆ slotIncFontSizes
| virtual void Kate::View::slotIncFontSizes |
( |
| ) |
|
|
inlinevirtualslot |
Increase font size.
Definition at line 273 of file view.h.
◆ toggleBookmark
| virtual void Kate::View::toggleBookmark |
( |
| ) |
|
|
inlinevirtualslot |
- Deprecated:
- No longer does anything. Use KTextEditor equivalents
Definition at line 286 of file view.h.
◆ toggleIconBorder()
| virtual void Kate::View::toggleIconBorder |
( |
| ) |
|
|
inlinevirtual |
Toggles icon border.
Definition at line 244 of file view.h.
◆ toggleLineNumbersOn()
| virtual void Kate::View::toggleLineNumbersOn |
( |
| ) |
|
|
inlinevirtual |
Toggles display of lineNumbers.
Definition at line 253 of file view.h.
◆ top()
| virtual void Kate::View::top |
( |
| ) |
|
|
inlinevirtual |
◆ topOfView()
| virtual void Kate::View::topOfView |
( |
| ) |
|
|
inlinevirtual |
◆ uncomment()
| virtual void Kate::View::uncomment |
( |
| ) |
|
|
inlinevirtual |
Removes comment signs in the current line.
Definition at line 138 of file view.h.
◆ unIndent()
| virtual void Kate::View::unIndent |
( |
| ) |
|
|
inlinevirtual |
Moves the current line or the selection one position to the left.
Definition at line 126 of file view.h.
◆ up()
| virtual void Kate::View::up |
( |
| ) |
|
|
inlinevirtual |
◆ word()
| virtual TQString Kate::View::word |
( |
int |
, |
|
|
int |
|
|
) |
| |
|
inlinevirtual |
Gets the word at position x, y.
Can be used to find the word under the mouse cursor
Definition at line 81 of file view.h.
◆ wordLeft()
| virtual void Kate::View::wordLeft |
( |
| ) |
|
|
inlinevirtual |
◆ wordRight()
| virtual void Kate::View::wordRight |
( |
| ) |
|
|
inlinevirtual |
◆ writeSessionConfig()
| virtual void Kate::View::writeSessionConfig |
( |
TDEConfig * |
| ) |
|
|
inlinevirtual |
The documentation for this class was generated from the following files:
Trinity API Reference