Kate::View Class Reference

#include <view.h>

Inherits KTextEditor::View, KTextEditor::ClipboardInterface, KTextEditor::PopupMenuInterface, KTextEditor::ViewCursorInterface, KTextEditor::CodeCompletionInterface, and KTextEditor::DynWordWrapInterface.

Inherited by KateView.

Public Types
enum	saveResult { SAVE_OK , SAVE_CANCEL , SAVE_RETRY , SAVE_ERROR }

Public Slots
virtual void	flush ()
virtual int	getEol ()
virtual void	setEol (int)
virtual void	setFocus ()
virtual void	findAgain (bool forward)
virtual void	findAgain ()
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 *, TQWidget *, const char *name=0)
virtual	~View ()
virtual bool	isOverwriteMode () const
virtual void	setOverwriteMode (bool)
virtual TQString	currentTextLine ()
virtual TQString	currentWord ()
virtual TQString	word (int, int)
virtual void	insertText (const TQString &mark)
virtual bool	canDiscard ()
virtual int	tabWidth ()=0
virtual void	setTabWidth (int)=0
virtual void	setEncoding (TQString e)=0
virtual bool	isLastView ()=0
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 void	readSessionConfig (TDEConfig *)
virtual void	writeSessionConfig (TDEConfig *)
virtual void	findPrev ()
virtual void	slotEditCommand ()
virtual void	setIconBorder (bool enable)
virtual void	toggleIconBorder ()
virtual void	setLineNumbersOn (bool enable)
virtual void	toggleLineNumbersOn ()
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

saveResult

enum Kate::View::saveResult

Return values for "save" related commands.

Definition at line 52 of file view.h.

Constructor & Destructor Documentation

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()

Kate::View::~View ( )

virtual

Destructor, you need a destructor if Scott Meyers says so.

Definition at line 81 of file interfaces.cpp.

Member Function Documentation

canDiscard()

virtual bool Kate::View::canDiscard ( )

inlinevirtual

Works exactly like closeURL() of KParts::ReadWritePart.

Definition at line 90 of file view.h.

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.

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.

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

mark	is unused.

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.

keyReturn()

virtual void Kate::View::keyReturn ( )

inlinevirtual

Some simply key commands.

Definition at line 142 of file view.h.

lineNumbersOn()

virtual bool Kate::View::lineNumbersOn ( )

inlinevirtual

Returns

Wheather line numbers display is on

Definition at line 263 of file view.h.

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()

virtual saveResult Kate::View::save ( )

inlinevirtual

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()

virtual saveResult Kate::View::saveAs ( )

inlinevirtual

Allows the user to save the file under a new name.

Definition at line 118 of file view.h.

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

enable

the flag

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

enable

the flag

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.

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.

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.

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.

writeSessionConfig()

virtual void Kate::View::writeSessionConfig ( TDEConfig *  )

inlinevirtual

Writes session config into the TDEConfig object.

Definition at line 199 of file view.h.

---

The documentation for this class was generated from the following files:

• view.h
• interfaces.cpp