.TH "Kate::View" kde3 "11 Jun 2005" "Version Version 3.4.1" "kate Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Kate::View \- The Kate::View text editor interface.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <view.h>\fP
.PP
Inherits View, ClipboardInterface, PopupMenuInterface, ViewCursorInterface, CodeCompletionInterface, and DynWordWrapInterface.
.PP
Inherited by KateView.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBsaveResult\fP { \fBSAVE_OK\fP, \fBSAVE_CANCEL\fP, \fBSAVE_RETRY\fP, \fBSAVE_ERROR\fP }"
.br
.in -1c
.SS "Public Slots"

.in +1c
.ti -1c
.RI "virtual void \fBflush\fP ()"
.br
.ti -1c
.RI "virtual \fBsaveResult\fP \fBsave\fP ()"
.br
.ti -1c
.RI "virtual \fBsaveResult\fP \fBsaveAs\fP ()"
.br
.ti -1c
.RI "virtual void \fBindent\fP ()"
.br
.ti -1c
.RI "virtual void \fBunIndent\fP ()"
.br
.ti -1c
.RI "virtual void \fBcleanIndent\fP ()"
.br
.ti -1c
.RI "virtual void \fBcomment\fP ()"
.br
.ti -1c
.RI "virtual void \fBuncomment\fP ()"
.br
.ti -1c
.RI "virtual void \fBkeyReturn\fP ()"
.br
.ti -1c
.RI "virtual void \fBkeyDelete\fP ()"
.br
.ti -1c
.RI "virtual void \fBbackspace\fP ()"
.br
.ti -1c
.RI "virtual void \fBkillLine\fP ()"
.br
.ti -1c
.RI "virtual void \fBcursorLeft\fP ()"
.br
.ti -1c
.RI "virtual void \fBshiftCursorLeft\fP ()"
.br
.ti -1c
.RI "virtual void \fBcursorRight\fP ()"
.br
.ti -1c
.RI "virtual void \fBshiftCursorRight\fP ()"
.br
.ti -1c
.RI "virtual void \fBwordLeft\fP ()"
.br
.ti -1c
.RI "virtual void \fBshiftWordLeft\fP ()"
.br
.ti -1c
.RI "virtual void \fBwordRight\fP ()"
.br
.ti -1c
.RI "virtual void \fBshiftWordRight\fP ()"
.br
.ti -1c
.RI "virtual void \fBhome\fP ()"
.br
.ti -1c
.RI "virtual void \fBshiftHome\fP ()"
.br
.ti -1c
.RI "virtual void \fBend\fP ()"
.br
.ti -1c
.RI "virtual void \fBshiftEnd\fP ()"
.br
.ti -1c
.RI "virtual void \fBup\fP ()"
.br
.ti -1c
.RI "virtual void \fBshiftUp\fP ()"
.br
.ti -1c
.RI "virtual void \fBdown\fP ()"
.br
.ti -1c
.RI "virtual void \fBshiftDown\fP ()"
.br
.ti -1c
.RI "virtual void \fBscrollUp\fP ()"
.br
.ti -1c
.RI "virtual void \fBscrollDown\fP ()"
.br
.ti -1c
.RI "virtual void \fBtopOfView\fP ()"
.br
.ti -1c
.RI "virtual void \fBbottomOfView\fP ()"
.br
.ti -1c
.RI "virtual void \fBpageUp\fP ()"
.br
.ti -1c
.RI "virtual void \fBshiftPageUp\fP ()"
.br
.ti -1c
.RI "virtual void \fBpageDown\fP ()"
.br
.ti -1c
.RI "virtual void \fBshiftPageDown\fP ()"
.br
.ti -1c
.RI "virtual void \fBtop\fP ()"
.br
.ti -1c
.RI "virtual void \fBshiftTop\fP ()"
.br
.ti -1c
.RI "virtual void \fBbottom\fP ()"
.br
.ti -1c
.RI "virtual void \fBshiftBottom\fP ()"
.br
.ti -1c
.RI "virtual void \fBfind\fP ()"
.br
.ti -1c
.RI "virtual void \fBreplace\fP ()"
.br
.ti -1c
.RI "virtual void \fBgotoLine\fP ()"
.br
.ti -1c
.RI "virtual int \fBgetEol\fP ()"
.br
.ti -1c
.RI "virtual void \fBsetEol\fP (int)"
.br
.ti -1c
.RI "virtual void \fBsetFocus\fP ()"
.br
.ti -1c
.RI "virtual void \fBfindAgain\fP (bool forward)"
.br
.ti -1c
.RI "virtual void \fBfindAgain\fP ()"
.br
.ti -1c
.RI "virtual void \fBfindPrev\fP ()"
.br
.ti -1c
.RI "virtual void \fBslotEditCommand\fP ()"
.br
.ti -1c
.RI "virtual void \fBsetIconBorder\fP (bool enable)"
.br
.ti -1c
.RI "virtual void \fBtoggleIconBorder\fP ()"
.br
.ti -1c
.RI "virtual void \fBsetLineNumbersOn\fP (bool enable)"
.br
.ti -1c
.RI "virtual void \fBtoggleLineNumbersOn\fP ()"
.br
.ti -1c
.RI "virtual void \fBslotIncFontSizes\fP ()"
.br
.ti -1c
.RI "virtual void \fBslotDecFontSizes\fP ()"
.br
.ti -1c
.RI "virtual void \fBgotoMark\fP (KTextEditor::Mark *mark)=0"
.br
.ti -1c
.RI "virtual void \fBtoggleBookmark\fP ()"
.br
.ti -1c
.RI "virtual void \fBgotoLineNumber\fP (int)=0"
.br
.in -1c
.SS "Signals"

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

.in +1c
.ti -1c
.RI "\fBView\fP (KTextEditor::Document *, \fBQWidget\fP *, const char *name=0)"
.br
.ti -1c
.RI "virtual \fB~View\fP ()"
.br
.ti -1c
.RI "virtual bool \fBisOverwriteMode\fP () const "
.br
.ti -1c
.RI "virtual void \fBsetOverwriteMode\fP (bool)"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBcurrentTextLine\fP ()"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBcurrentWord\fP ()"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBword\fP (int, int)"
.br
.ti -1c
.RI "virtual void \fBinsertText\fP (const \fBQString\fP &mark)"
.br
.ti -1c
.RI "virtual bool \fBcanDiscard\fP ()"
.br
.ti -1c
.RI "virtual int \fBtabWidth\fP ()=0"
.br
.ti -1c
.RI "virtual void \fBsetTabWidth\fP (int)=0"
.br
.ti -1c
.RI "virtual void \fBsetEncoding\fP (\fBQString\fP e)=0"
.br
.ti -1c
.RI "virtual bool \fBisLastView\fP ()=0"
.br
.ti -1c
.RI "virtual void \fBreadSessionConfig\fP (\fBKConfig\fP *)"
.br
.ti -1c
.RI "virtual void \fBwriteSessionConfig\fP (\fBKConfig\fP *)"
.br
.ti -1c
.RI "virtual bool \fBiconBorder\fP ()"
.br
.ti -1c
.RI "virtual bool \fBlineNumbersOn\fP ()"
.br
.ti -1c
.RI "virtual \fBDocument\fP * \fBgetDoc\fP ()"
.br
.ti -1c
.RI "virtual void \fBsetActive\fP (bool b)=0"
.br
.ti -1c
.RI "virtual bool \fBisActive\fP ()=0"
.br
.in -1c
.SH "Detailed Description"
.PP 
The Kate::View text editor interface. 

\fBAuthor:\fP
.RS 4
Cullmann Christoph, modified by rokrau (6/21/01) 
.RE
.PP

.PP
Definition at line 42 of file view.h.
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBKate::View::saveResult\fP"
.PP
Return values for 'save' related commands. 
.PP
Definition at line 52 of file view.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "Kate::View::View (KTextEditor::Document *, \fBQWidget\fP *, const char * name = \fC0\fP)"
.PP
Constructor (should much rather take a reference to the document). 
.PP
Definition at line 77 of file interfaces.cpp.
.SS "Kate::View::~\fBView\fP ()\fC [virtual]\fP"
.PP
Destructor, you need a destructor if Scott Meyers says so. 
.PP
Definition at line 81 of file interfaces.cpp.
.SH "Member Function Documentation"
.PP 
.SS "virtual bool Kate::View::isOverwriteMode () const\fC [inline, virtual]\fP"
.PP
Set editor mode. 
.PP
Definition at line 64 of file view.h.
.SS "virtual void Kate::View::setOverwriteMode (bool)\fC [inline, virtual]\fP"
.PP
Get editor mode. 
.PP
Definition at line 68 of file view.h.
.SS "virtual \fBQString\fP Kate::View::currentTextLine ()\fC [inline, virtual]\fP"
.PP
Gets the text line where the cursor is on. 
.PP
Definition at line 72 of file view.h.
.SS "virtual \fBQString\fP Kate::View::currentWord ()\fC [inline, virtual]\fP"
.PP
Gets the word where the cursor is on. 
.PP
Definition at line 76 of file view.h.
.SS "virtual \fBQString\fP Kate::View::word (int, int)\fC [inline, virtual]\fP"
.PP
Gets the word at position x, y. 
.PP
Can be used to find the word under the mouse cursor 
.PP
Definition at line 81 of file view.h.
.SS "virtual void Kate::View::insertText (const \fBQString\fP & mark)\fC [inline, virtual]\fP"
.PP
Insert text at the current cursor position. 
.PP
\fBParameters:\fP
.RS 4
\fImark\fP is unused. 
.RE
.PP

.PP
Definition at line 86 of file view.h.
.SS "virtual bool Kate::View::canDiscard ()\fC [inline, virtual]\fP"
.PP
Works exactly like closeURL() of \fBKParts::ReadWritePart\fP. 
.PP
Definition at line 90 of file view.h.
.SS "virtual bool Kate::View::isLastView ()\fC [pure virtual]\fP"
.PP
Returns true if this editor is the only owner of its document. 
.PP
.SS "virtual void Kate::View::flush ()\fC [inline, virtual, slot]\fP"
.PP
Flushes the document of the text widget. 
.PP
The user is given a chance to save the current document if the current document has been modified. 
.PP
Definition at line 108 of file view.h.
.SS "virtual \fBsaveResult\fP Kate::View::save ()\fC [inline, virtual, slot]\fP"
.PP
Saves the file under the current file name. 
.PP
If the current file name is Untitled, as it is after a call to newFile(), this routine will call \fBsaveAs()\fP. 
.PP
Definition at line 114 of file view.h.
.SS "virtual \fBsaveResult\fP Kate::View::saveAs ()\fC [inline, virtual, slot]\fP"
.PP
Allows the user to save the file under a new name. 
.PP
Definition at line 118 of file view.h.
.SS "virtual void Kate::View::indent ()\fC [inline, virtual, slot]\fP"
.PP
Moves the current line or the selection one position to the right. 
.PP
Definition at line 122 of file view.h.
.SS "virtual void Kate::View::unIndent ()\fC [inline, virtual, slot]\fP"
.PP
Moves the current line or the selection one position to the left. 
.PP
Definition at line 126 of file view.h.
.SS "virtual void Kate::View::cleanIndent ()\fC [inline, virtual, slot]\fP"
.PP
Optimizes the selected indentation, replacing tabs and spaces as needed. 
.PP
Definition at line 130 of file view.h.
.SS "virtual void Kate::View::comment ()\fC [inline, virtual, slot]\fP"
.PP
Comments out current line. 
.PP
Definition at line 134 of file view.h.
.SS "virtual void Kate::View::uncomment ()\fC [inline, virtual, slot]\fP"
.PP
Removes comment signs in the current line. 
.PP
Definition at line 138 of file view.h.
.SS "virtual void Kate::View::keyReturn ()\fC [inline, virtual, slot]\fP"
.PP
Some simply key commands. 
.PP
Definition at line 142 of file view.h.
.SS "virtual void Kate::View::cursorLeft ()\fC [inline, virtual, slot]\fP"
.PP
Move cursor in the view. 
.PP
Definition at line 149 of file view.h.
.SS "virtual void Kate::View::find ()\fC [inline, virtual, slot]\fP"
.PP
Presents a search dialog to the user. 
.PP
Definition at line 180 of file view.h.
.SS "virtual void Kate::View::replace ()\fC [inline, virtual, slot]\fP"
.PP
Presents a replace dialog to the user. 
.PP
Definition at line 184 of file view.h.
.SS "virtual void Kate::View::gotoLine ()\fC [inline, virtual, slot]\fP"
.PP
Presents a 'Goto Line' dialog to the user. 
.PP
Definition at line 188 of file view.h.
.SS "virtual void Kate::View::readSessionConfig (\fBKConfig\fP *)\fC [inline, virtual]\fP"
.PP
Reads session config out of the \fBKConfig\fP object. 
.PP
This also includes the actual cursor position and the bookmarks. 
.PP
Definition at line 195 of file view.h.
.SS "virtual void Kate::View::writeSessionConfig (\fBKConfig\fP *)\fC [inline, virtual]\fP"
.PP
Writes session config into the \fBKConfig\fP object. 
.PP
Definition at line 199 of file view.h.
.SS "virtual int Kate::View::getEol ()\fC [inline, virtual, slot]\fP"
.PP
Get the end of line mode (Unix, Macintosh or Dos). 
.PP
Definition at line 205 of file view.h.
.SS "virtual void Kate::View::setEol (int)\fC [inline, virtual, slot]\fP"
.PP
Set the end of line mode (Unix, Macintosh or Dos). 
.PP
Definition at line 209 of file view.h.
.SS "virtual void Kate::View::setFocus ()\fC [inline, virtual, slot]\fP"
.PP
Set focus to the current window. 
.PP
Definition at line 214 of file view.h.
.PP
References QWidget::setFocus().
.SS "virtual void Kate::View::findAgain (bool forward)\fC [inline, virtual, slot]\fP"
.PP
Searches for the last searched text forward from cursor position. 
.PP
\fBParameters:\fP
.RS 4
\fIforward\fP determines the search direction. 
.RE
.PP

.PP
Definition at line 219 of file view.h.
.SS "virtual void Kate::View::findAgain ()\fC [inline, virtual, slot]\fP"
.PP
Searches for the last searched text forward from cursor position. 
.PP
Searches forward from current cursor position. 
.PP
Definition at line 224 of file view.h.
.SS "virtual void Kate::View::findPrev ()\fC [inline, virtual, slot]\fP"
.PP
Searches for the last searched text forward from cursor position. 
.PP
Searches backward from current cursor position. 
.PP
Definition at line 229 of file view.h.
.SS "virtual void Kate::View::slotEditCommand ()\fC [inline, virtual, slot]\fP"
.PP
Presents an edit command popup window, where the user can apply a shell command to the contents of the current window. 
.PP
Definition at line 234 of file view.h.
.SS "virtual void Kate::View::setIconBorder (bool enable)\fC [inline, virtual, slot]\fP"
.PP
Sets icon border on or off depending on. 
.PP
\fBParameters:\fP
.RS 4
\fIenable\fP the flag 
.RE
.PP

.PP
Definition at line 240 of file view.h.
.SS "virtual void Kate::View::toggleIconBorder ()\fC [inline, virtual, slot]\fP"
.PP
Toggles icon border. 
.PP
Definition at line 244 of file view.h.
.SS "virtual void Kate::View::setLineNumbersOn (bool enable)\fC [inline, virtual, slot]\fP"
.PP
Sets display of line numbers on/off depending on \fCenable\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIenable\fP the flag 
.RE
.PP

.PP
Definition at line 249 of file view.h.
.SS "virtual void Kate::View::toggleLineNumbersOn ()\fC [inline, virtual, slot]\fP"
.PP
Toggles display of lineNumbers. 
.PP
Definition at line 253 of file view.h.
.SS "virtual bool Kate::View::iconBorder ()\fC [inline, virtual]\fP"
.PP
Returns whether iconborder is visible. 
.PP
Definition at line 259 of file view.h.
.SS "virtual bool Kate::View::lineNumbersOn ()\fC [inline, virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
Wheather line numbers display is on 
.RE
.PP

.PP
Definition at line 263 of file view.h.
.SS "virtual \fBDocument\fP* Kate::View::getDoc ()\fC [inline, virtual]\fP"
.PP
Returns a pointer to the document of the view. 
.PP
Definition at line 267 of file view.h.
.SS "virtual void Kate::View::slotIncFontSizes ()\fC [inline, virtual, slot]\fP"
.PP
Increase font size. 
.PP
Definition at line 273 of file view.h.
.SS "virtual void Kate::View::slotDecFontSizes ()\fC [inline, virtual, slot]\fP"
.PP
Decrease font size. 
.PP
Definition at line 277 of file view.h.
.SS "virtual void Kate::View::toggleBookmark ()\fC [inline, virtual, slot]\fP"
.PP
\fBDeprecated\fP
.RS 4
No longer does anything. Use KTextEditor equivalents 
.RE
.PP

.PP
Definition at line 286 of file view.h.

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