#include <katedocument.h>

Inheritance diagram for KateDocument:

Public Types
enum	EncodedCharaterInsertionPolicy { EncodeAlways, EncodeWhenPresent, EncodeNever }
typedef QList< QPair< int, int > >	OffsetList
enum	TextTransform { Uppercase, Lowercase, Capitalize }
Public Slots
virtual void	addMark (int line, uint markType)
virtual bool	clear ()
void	clearDictionaryRanges ()
virtual void	clearMark (int line)
virtual void	clearMarks ()
virtual bool	documentReload ()
virtual bool	documentSave ()
virtual bool	documentSaveAs ()
void	exportAs (const QString &)
bool	handleMarkClick (int line)
bool	handleMarkContextMenu (int line, QPoint position)
virtual bool	insertLine (int line, const QString &s)
virtual bool	insertLines (int line, const QStringList &s)
virtual bool	insertText (const KTextEditor::Cursor &position, const QString &s, bool block=false)
virtual bool	insertText (const KTextEditor::Cursor &position, const QStringList &text, bool block=false)
void	onTheFlySpellCheckingEnabled (bool enable)
bool	print ()
bool	printDialog ()
void	redo ()
void	refreshOnTheFlyCheck (const KTextEditor::Range &range=KTextEditor::Range::invalid())
virtual bool	removeLine (int line)
virtual void	removeMark (int line, uint markType)
virtual bool	removeText (const KTextEditor::Range &range, bool block=false)
virtual bool	replaceText (const KTextEditor::Range &range, const QString &s, bool block=false)
virtual bool	replaceText (const KTextEditor::Range &r, const QStringList &l, bool b)
void	requestMarkTooltip (int line, QPoint position)
void	respellCheckBlock (int start, int end)
void	revertToDefaultDictionary (const KTextEditor::Range &range)
virtual bool	save ()
void	setDefaultDictionary (const QString &dict)
void	setDictionary (const QString &dict, const KTextEditor::Range &range)
virtual void	setEditableMarks (uint markMask)
virtual void	setMark (int line, uint markType)
virtual void	setMarkDescription (MarkInterface::MarkTypes, const QString &)
virtual void	setMarkPixmap (MarkInterface::MarkTypes, const QPixmap &)
void	setPageUpDownMovesCursor (bool on)
virtual bool	setText (const QStringList &text)
virtual bool	setText (const QString &)
void	setWordWrap (bool on)
void	setWordWrapAt (uint col)
virtual void	slotModifiedOnDisk (KTextEditor::View *v=0)
void	slotQueryClose_save (bool handled, bool abortClosing)
void	tagLines (KTextEditor::Cursor start, KTextEditor::Cursor end)
void	tagLines (int start, int end)
void	undo ()
Signals
void	aboutToDeleteMovingInterfaceContent (KTextEditor::Document *document)
void	aboutToInvalidateMovingInterfaceContent (KTextEditor::Document *document)
void	aboutToRemoveText (const KTextEditor::Range &)
void	annotationModelChanged (KTextEditor::AnnotationModel , KTextEditor::AnnotationModel )
void	charactersSemiInteractivelyInserted (const KTextEditor::Cursor &position, const QString &text)
void	codeFoldingUpdated ()
void	configChanged ()
void	defaultDictionaryChanged (KateDocument *document)
void	dictionaryRangesPresent (bool yesNo)
void	editLineUnWrapped (int line, int col)
void	editLineWrapped (int line, int col, int len)
void	markChanged (KTextEditor::Document *, KTextEditor::Mark, KTextEditor::MarkInterface::MarkChangeAction)
void	markClicked (KTextEditor::Document *document, KTextEditor::Mark mark, bool &handled)
void	markContextMenuRequested (KTextEditor::Document *document, KTextEditor::Mark mark, QPoint pos, bool &handled)
void	marksChanged (KTextEditor::Document *)
void	markToolTipRequested (KTextEditor::Document *document, KTextEditor::Mark mark, QPoint position, bool &handled)
void	modifiedOnDisk (KTextEditor::Document *doc, bool isModified, KTextEditor::ModificationInterface::ModifiedOnDiskReason reason)
void	preHighlightChanged (uint)
void	respellCheckBlock (KateDocument *document, int start, int end)
void	undoChanged ()
void	variableChanged (KTextEditor::Document *, const QString &, const QString &)
Public Member Functions
	KateDocument (bool bSingleViewMode=false, bool bBrowserView=false, bool bReadOnly=false, QWidget parentWidget=0, QObject =0)
	~KateDocument ()
KateView *	activeKateView () const
virtual KTextEditor::View *	activeView () const
void	addView (KTextEditor::View *)
void	align (KateView *view, const KTextEditor::Range &range)
virtual KTextEditor::AnnotationModel *	annotationModel () const
void	backspace (KateView *view, const KTextEditor::Cursor &)
void	bomSetByUser ()
bool	browserView () const
KateBuffer &	buffer ()
void	bufferHlChanged ()
virtual QChar	character (const KTextEditor::Cursor &position) const
void	clearMisspellingForWord (const QString &word)
virtual bool	closeUrl ()
void	comment (KateView *view, uint line, uint column, int change)
int	computePositionWrtOffsets (const OffsetList &offsetList, int pos)
KateDocumentConfig *	config ()
KateDocumentConfig *	config () const
virtual QStringList	configKeys () const
virtual QVariant	configValue (const QString &key)
bool	containsCharacterEncoding (const KTextEditor::Range &range)
virtual KTextEditor::View *	createView (QWidget *parent)
QString	decodeCharacters (const KTextEditor::Range &range, KateDocument::OffsetList &decToEncOffsetList, KateDocument::OffsetList &encToDecOffsetList)
QString	defaultDictionary () const
virtual KTextEditor::Attribute::Ptr	defaultStyle (const KTextEditor::HighlightInterface::DefaultStyle ds) const
void	del (KateView *view, const KTextEditor::Cursor &)
QString	dictionaryForMisspelledRange (const KTextEditor::Range &range) const
QList< QPair < KTextEditor::MovingRange *, QString > >	dictionaryRanges () const
virtual void	discardDataRecovery ()
virtual KTextEditor::Cursor	documentEnd () const
virtual const QString &	documentName () const
virtual uint	editableMarks () const
void	editBegin ()
void	editEnd ()
bool	editInsertLine (int line, const QString &s)
bool	editInsertText (int line, int col, const QString &s)
bool	editMarkLineAutoWrapped (int line, bool autowrapped)
virtual KTextEditor::Editor *	editor ()
bool	editRemoveLine (int line)
bool	editRemoveLines (int from, int to)
bool	editRemoveText (int line, int col, int len)
void	editStart ()
bool	editUnWrapLine (int line, bool removeLine=true, int length=0)
bool	editWrapLine (int line, int col, bool newLine=true, bool *newLineAdded=0)
virtual QStringList	embeddedHighlightingModes () const
virtual const QString &	encoding () const
virtual bool	endEditing ()
QString	fileType () const
bool	findMatchingBracket (KTextEditor::Range &range, int maxLines=-1)
KateCodeFoldingTree *	foldingTree ()
uint	getRealLine (unsigned int virtualLine)
uint	getVirtualLine (unsigned int realLine)
QString	getWord (const KTextEditor::Cursor &cursor)
KateHighlighting *	highlight () const
virtual QString	highlightingMode () const
virtual QString	highlightingModeAt (const KTextEditor::Cursor &position)
virtual QStringList	highlightingModes () const
virtual QString	highlightingModeSection (int index) const
void	ignoreModifiedOnDiskOnce ()
void	indent (KTextEditor::Range range, int change)
void	inputMethodEnd ()
void	inputMethodStart ()
void	insertTab (KateView *view, const KTextEditor::Cursor &)
virtual bool	insertTemplateTextImplementation (const KTextEditor::Cursor &c, const QString &templateString, const QMap< QString, QString > &initialValues, KTextEditor::TemplateScript templateScript, KateView view)
virtual bool	isDataRecoveryAvailable () const
bool	isEditRunning () const
bool	isModifiedOnDisc ()
bool	isOnTheFlySpellCheckingEnabled () const
void	joinLines (uint first, uint last)
Kate::TextLine	kateTextLine (uint i)
int	lastLine () const
virtual qint64	lastSavedRevision () const
virtual QString	line (int line) const
virtual QList < KTextEditor::HighlightInterface::AttributeBlock >	lineAttributes (const unsigned int line)
void	lineInfo (KateLineInfo *info, unsigned int line)
virtual int	lineLength (int line) const
virtual int	lines () const
virtual void	lockRevision (qint64 revision)
void	makeAttribs (bool needInvalidate=true)
virtual uint	mark (int line)
virtual QColor	markColor (MarkInterface::MarkTypes) const
virtual QString	markDescription (MarkInterface::MarkTypes) const
virtual QPixmap	markPixmap (MarkInterface::MarkTypes) const
virtual const QHash< int, KTextEditor::Mark * > &	marks ()
virtual QString	mimeType ()
KMimeType::Ptr	mimeTypeForContent ()
virtual QString	mode () const
virtual QStringList	modes () const
virtual QString	modeSection (int index) const
void	newBracketMark (const KTextEditor::Cursor &start, KTextEditor::Range &bm, int maxLines=-1)
void	newLine (KateView *view)
virtual KTextEditor::MovingCursor *	newMovingCursor (const KTextEditor::Cursor &position, KTextEditor::MovingCursor::InsertBehavior insertBehavior=KTextEditor::MovingCursor::MoveOnInsert)
virtual KTextEditor::MovingRange *	newMovingRange (const KTextEditor::Range &range, KTextEditor::MovingRange::InsertBehaviors insertBehaviors=KTextEditor::MovingRange::DoNotExpand, KTextEditor::MovingRange::EmptyBehavior emptyBehavior=KTextEditor::MovingRange::AllowEmpty)
int	numVisLines () const
virtual bool	openFile ()
bool	ownedView (KateView *)
bool	pageUpDownMovesCursor () const
void	paste (KateView *view, QClipboard::Mode=QClipboard::Clipboard)
Kate::TextLine	plainKateTextLine (uint i)
void	popEditState ()
void	pushEditState ()
virtual bool	queryClose ()
KTextEditor::Range	rangeOnLine (KTextEditor::Range range, int line) const
bool	readOnly () const
virtual void	readParameterizedSessionConfig (const KConfigGroup &, unsigned long configParameters)
virtual void	readSessionConfig (const KConfigGroup &)
virtual void	recoverData ()
uint	redoCount () const
void	removeView (KTextEditor::View *)
void	repaintViews (bool paintOnlyDirty=true)
void	replaceCharactersByEncoding (const KTextEditor::Range &range)
virtual qint64	revision () const
virtual bool	saveAs (const KUrl &url)
virtual bool	saveFile ()
virtual QVector < KTextEditor::Range >	searchText (const KTextEditor::Range &range, const QString &pattern, const KTextEditor::Search::SearchOptions options)
void	setActiveView (KTextEditor::View *)
virtual void	setAnnotationModel (KTextEditor::AnnotationModel *model)
virtual void	setConfigValue (const QString &key, const QVariant &value)
void	setDocName (QString docName)
void	setDontChangeHlOnSave ()
virtual bool	setEncoding (const QString &e)
virtual bool	setHighlightingMode (const QString &name)
virtual bool	setMode (const QString &name)
virtual void	setModified (bool m)
virtual void	setModifiedOnDisk (ModifiedOnDiskReason reason)
virtual void	setModifiedOnDiskWarning (bool on)
virtual void	setReadWrite (bool rw=true)
void	setUndoMergeAllEdits (bool merge)
bool	singleViewMode () const
virtual bool	startEditing ()
virtual KTextEditor::Search::SearchOptions	supportedSearchOptions () const
Kate::SwapFile *	swapFile ()
virtual QString	text () const
virtual QString	text (const KTextEditor::Range &range, bool blockwise=false) const
virtual QStringList	textLines (const KTextEditor::Range &range, bool block=false) const
virtual int	totalCharacters () const
uint	toVirtualColumn (const KTextEditor::Cursor &)
void	transform (KateView *view, const KTextEditor::Cursor &, TextTransform)
virtual void	transformCursor (KTextEditor::Cursor &cursor, KTextEditor::MovingCursor::InsertBehavior insertBehavior, qint64 fromRevision, qint64 toRevision=-1)
virtual void	transformCursor (int &line, int &column, KTextEditor::MovingCursor::InsertBehavior insertBehavior, qint64 fromRevision, qint64 toRevision=-1)
virtual void	transformRange (KTextEditor::Range &range, KTextEditor::MovingRange::InsertBehaviors insertBehaviors, KTextEditor::MovingRange::EmptyBehavior emptyBehavior, qint64 fromRevision, qint64 toRevision=-1)
void	transpose (const KTextEditor::Cursor &)
bool	typeChars (KateView *type, const QString &chars)
uint	undoCount () const
virtual void	unlockRevision (qint64 revision)
void	updateConfig ()
void	updateFileType (const QString &newType, bool user=false)
virtual QString	variable (const QString &name) const
virtual const QList < KTextEditor::View * > &	views () const
uint	visibleLines ()
virtual QWidget *	widget ()
bool	wordWrap () const
uint	wordWrapAt () const
bool	wrapText (int startLine, int endLine)
virtual void	writeParameterizedSessionConfig (KConfigGroup &, unsigned long configParameters)
virtual void	writeSessionConfig (KConfigGroup &)
Static Public Member Functions
static bool	checkOverwrite (KUrl u, QWidget *parent)
static bool	simpleMode ()
Protected Slots
void	dumpRegionTree ()
Protected Member Functions
void	deleteDictionaryRange (KTextEditor::MovingRange *movingRange)
void	rangeEmpty (KTextEditor::MovingRange *movingRange)
void	rangeInvalid (KTextEditor::MovingRange *movingRange)
Protected Attributes
QString	m_defaultDictionary
QList< QPair < KTextEditor::MovingRange *, QString > >	m_dictionaryRanges
KateOnTheFlyChecker *	m_onTheFlyChecker
KateUndoManager *const	m_undoManager

Detailed Description

Definition at line 75 of file katedocument.h.

Member Typedef Documentation

typedef QList<QPair<int, int> > KateDocument::OffsetList

Definition at line 1132 of file katedocument.h.

Member Enumeration Documentation

enum KateDocument::EncodedCharaterInsertionPolicy

Enumerator:

EncodeAlways
EncodeWhenPresent
EncodeNever

Definition at line 1145 of file katedocument.h.

enum KateDocument::TextTransform

Enumerator:

Uppercase
Lowercase
Capitalize

Definition at line 717 of file katedocument.h.

Constructor & Destructor Documentation

KateDocument::KateDocument	(	bool	bSingleViewMode = `false`,
		bool	bBrowserView = `false`,
		bool	bReadOnly = `false`,
		QWidget *	parentWidget = `0`,
		QObject *	parent = `0`
	)		`[explicit]`

Definition at line 160 of file katedocument.cpp.

KateDocument::~KateDocument ( )

we are about to delete cursors/ranges/...

Definition at line 264 of file katedocument.cpp.

Member Function Documentation

void KateDocument::aboutToDeleteMovingInterfaceContent ( KTextEditor::Document * document ) [signal]

This signal is emitted before the cursors/ranges/revisions of a document are destroyed as the document is deleted.

Parameters:

document the document which the interface belongs too which is in the process of being deleted

Reimplemented from KTextEditor::MovingInterface.

void KateDocument::aboutToInvalidateMovingInterfaceContent ( KTextEditor::Document * document ) [signal]

This signal is emitted before the ranges of a document are invalidated and the revisions are deleted as the document is cleared (for example on load/reload).

While this signal is emitted, still the old document content is around before the clear.

Parameters:

document the document which the interface belongs too which will invalidate its data

Reimplemented from KTextEditor::MovingInterface.

void KateDocument::aboutToRemoveText ( const KTextEditor::Range & ) [signal]

KateView * KateDocument::activeKateView ( ) const

Definition at line 4673 of file katedocument.cpp.

virtual KTextEditor::View* KateDocument::activeView ( ) const [inline, virtual]

Implements KTextEditor::Document.

Definition at line 142 of file katedocument.h.

void KateDocument::addMark	(	int	line,
		uint	markType
	)		`[virtual, slot]`

Implements KTextEditor::MarkInterface.

Definition at line 1713 of file katedocument.cpp.

void KateDocument::addView ( KTextEditor::View * view )

Definition at line 2531 of file katedocument.cpp.

void KateDocument::align	(	KateView *	view,
		const KTextEditor::Range &	range
	)

Definition at line 2925 of file katedocument.cpp.

KTextEditor::AnnotationModel * KateDocument::annotationModel ( ) const [virtual]

Implements KTextEditor::AnnotationInterface.

Definition at line 4810 of file katedocument.cpp.

void KateDocument::annotationModelChanged	(	KTextEditor::AnnotationModel *	,
		KTextEditor::AnnotationModel *
	)		`[signal]`

void KateDocument::backspace	(	KateView *	view,
		const KTextEditor::Cursor &	c
	)

Definition at line 2724 of file katedocument.cpp.

void KateDocument::bomSetByUser ( )

Set that the BOM marker is forced via the tool menu.

Definition at line 1572 of file katedocument.cpp.

bool KateDocument::browserView ( ) const [inline]

Definition at line 125 of file katedocument.h.

KateBuffer& KateDocument::buffer ( ) [inline]

Get access to buffer of this document.

Is needed to create cursors and ranges for example.

Returns:: document buffer

Definition at line 939 of file katedocument.h.

void KateDocument::bufferHlChanged ( )

Definition at line 1555 of file katedocument.cpp.

QChar KateDocument::character ( const KTextEditor::Cursor & position ) const [virtual]

Implements KTextEditor::Document.

Definition at line 418 of file katedocument.cpp.

void KateDocument::charactersSemiInteractivelyInserted	(	const KTextEditor::Cursor &	position,
		const QString &	text
	)		`[signal]`

bool KateDocument::checkOverwrite	(	KUrl	u,
		QWidget *	parent
	)		`[static]`

Definition at line 4575 of file katedocument.cpp.

bool KateDocument::clear ( ) [virtual, slot]

Implements KTextEditor::Document.

Definition at line 542 of file katedocument.cpp.

void KateDocument::clearDictionaryRanges ( ) [slot]

Definition at line 4901 of file katedocument.cpp.

void KateDocument::clearMark ( int line ) [virtual, slot]

Implements KTextEditor::MarkInterface.

Definition at line 1697 of file katedocument.cpp.

void KateDocument::clearMarks ( ) [virtual, slot]

Implements KTextEditor::MarkInterface.

Definition at line 1823 of file katedocument.cpp.

void KateDocument::clearMisspellingForWord ( const QString & word )

Definition at line 5046 of file katedocument.cpp.

bool KateDocument::closeUrl ( ) [virtual]

we are about to invalidate all cursors/ranges/.. => m_buffer->clear will do so

Reimplemented from KParts::ReadWritePart.

Definition at line 2364 of file katedocument.cpp.

void KateDocument::codeFoldingUpdated ( ) [signal]

void KateDocument::comment	(	KateView *	view,
		uint	line,
		uint	column,
		int	change
	)

Definition at line 3305 of file katedocument.cpp.

int KateDocument::computePositionWrtOffsets	(	const OffsetList &	offsetList,
		int	pos
	)

Definition at line 5113 of file katedocument.cpp.

KateDocumentConfig* KateDocument::config ( ) [inline]

Configuration.

Definition at line 984 of file katedocument.h.

KateDocumentConfig* KateDocument::config ( ) const [inline]

Definition at line 985 of file katedocument.h.

void KateDocument::configChanged ( ) [signal]

QStringList KateDocument::configKeys ( ) const [virtual]

Implements KTextEditor::ConfigInterface.

Definition at line 4594 of file katedocument.cpp.

QVariant KateDocument::configValue ( const QString & key ) [virtual]

Implements KTextEditor::ConfigInterface.

Definition at line 4599 of file katedocument.cpp.

bool KateDocument::containsCharacterEncoding ( const KTextEditor::Range & range )

Definition at line 5087 of file katedocument.cpp.

KTextEditor::View * KateDocument::createView ( QWidget * parent ) [virtual]

Implements KTextEditor::Document.

Definition at line 327 of file katedocument.cpp.

QString KateDocument::decodeCharacters	(	const KTextEditor::Range &	range,
		KateDocument::OffsetList &	decToEncOffsetList,
		KateDocument::OffsetList &	encToDecOffsetList
	)

The first OffsetList is from decoded to encoded, and the second OffsetList from encoded to decoded.

Definition at line 5125 of file katedocument.cpp.

QString KateDocument::defaultDictionary ( ) const

Definition at line 4891 of file katedocument.cpp.

void KateDocument::defaultDictionaryChanged ( KateDocument * document ) [signal]

KTextEditor::Attribute::Ptr KateDocument::defaultStyle ( const KTextEditor::HighlightInterface::DefaultStyle ds ) const [virtual]

TODO: move attributes to document, they are not view-dependant

Implements KTextEditor::HighlightInterface.

Definition at line 5213 of file katedocument.cpp.

void KateDocument::del	(	KateView *	view,
		const KTextEditor::Cursor &	c
	)

Definition at line 2808 of file katedocument.cpp.

void KateDocument::deleteDictionaryRange ( KTextEditor::MovingRange * movingRange ) [protected]

Definition at line 5070 of file katedocument.cpp.

QString KateDocument::dictionaryForMisspelledRange ( const KTextEditor::Range & range ) const

Definition at line 5036 of file katedocument.cpp.

QList< QPair< KTextEditor::MovingRange *, QString > > KateDocument::dictionaryRanges ( ) const

Definition at line 4896 of file katedocument.cpp.

void KateDocument::dictionaryRangesPresent ( bool yesNo ) [signal]

void KateDocument::discardDataRecovery ( ) [virtual]

Implements KTextEditor::RecoveryInterface.

Definition at line 2471 of file katedocument.cpp.

KTextEditor::Cursor KateDocument::documentEnd ( ) const [virtual]

Implements KTextEditor::Document.

Definition at line 4678 of file katedocument.cpp.

virtual const QString& KateDocument::documentName ( ) const [inline, virtual]

Implements KTextEditor::Document.

Definition at line 810 of file katedocument.h.

bool KateDocument::documentReload ( ) [virtual, slot]

Reloads the current document from disk if possible.

Implements KTextEditor::Document.

Definition at line 3838 of file katedocument.cpp.

bool KateDocument::documentSave ( ) [virtual, slot]

Implements KTextEditor::Document.

Definition at line 3926 of file katedocument.cpp.

bool KateDocument::documentSaveAs ( ) [virtual, slot]

Implements KTextEditor::Document.

Definition at line 3934 of file katedocument.cpp.

void KateDocument::dumpRegionTree ( ) [protected, slot]

Definition at line 3979 of file katedocument.cpp.

uint KateDocument::editableMarks ( ) const [virtual]

Implements KTextEditor::MarkInterface.

Definition at line 1877 of file katedocument.cpp.

void KateDocument::editBegin ( ) [inline]

Alias for editStart()

Definition at line 200 of file katedocument.h.

void KateDocument::editEnd ( )

End a editor operation.

See also:: editStart()

Definition at line 831 of file katedocument.cpp.

bool KateDocument::editInsertLine	(	int	line,
		const QString &	s
	)

Insert a string at the given line.

Parameters:

line	line number
s	string to insert

Returns:: true on success

Definition at line 1255 of file katedocument.cpp.

bool KateDocument::editInsertText	(	int	line,
		int	col,
		const QString &	s
	)

Add a string in the given line/column.

Parameters:

line	line number
col	column
s	string to be inserted

Returns:: true on success

Definition at line 1012 of file katedocument.cpp.

void KateDocument::editLineUnWrapped	(	int	line,
		int	col
	)		`[signal]`

Emitted each time text from nextLine was upwrapped onto line.

void KateDocument::editLineWrapped	(	int	line,
		int	col,
		int	len
	)		`[signal]`

Emmitted when text from line was wrapped at position pos onto line nextLine.

bool KateDocument::editMarkLineAutoWrapped	(	int	line,
		bool	autowrapped
	)

Mark line as autowrapped.

This is necessary if static word warp is enabled, because we have to know whether to insert a new line or add the wrapped words to the followin line.

Parameters:

line	line number
autowrapped	autowrapped?

Returns:: true on success

Definition at line 1093 of file katedocument.cpp.

KTextEditor::Editor * KateDocument::editor ( ) [virtual]

Implements KTextEditor::Document.

Definition at line 343 of file katedocument.cpp.

bool KateDocument::editRemoveLine ( int line )

Remove a line.

Parameters:

line	line number

Returns:: true on success

Definition at line 1322 of file katedocument.cpp.

bool KateDocument::editRemoveLines	(	int	from,
		int	to
	)

Definition at line 1327 of file katedocument.cpp.

bool KateDocument::editRemoveText	(	int	line,
		int	col,
		int	len
	)

Remove a string in the given line/column.

Parameters:

line	line number
col	column
len	length of text to be removed

Returns:: true on success

Definition at line 1050 of file katedocument.cpp.

void KateDocument::editStart ( )

Enclose editor actions with editStart() and editEnd() to group them.

Definition at line 811 of file katedocument.cpp.

bool KateDocument::editUnWrapLine	(	int	line,
		bool	removeLine = `true`,
		int	length = `0`
	)

Unwrap line.

If removeLine is true, we force to join the lines. If removeLine is true, length is ignored (eg not needed).

Parameters:

line	line number
removeLine	if true, force to remove the next line

Returns:: true on success

Definition at line 1188 of file katedocument.cpp.

bool KateDocument::editWrapLine	(	int	line,
		int	col,
		bool	newLine = `true`,
		bool *	newLineAdded = `0`
	)

Wrap line.

If newLine is true, ignore the textline's flag KateTextLine::flagAutoWrapped and force a new line. Whether a new line was needed/added you can grab with newLineAdded.

Parameters:

line	line number
col	column
newLine	if true, force a new line
newLineAdded	return value is true, if new line was added (may be 0)

Returns:: true on success

Definition at line 1117 of file katedocument.cpp.

QStringList KateDocument::embeddedHighlightingModes ( ) const [virtual]

Implements KTextEditor::HighlightInterface.

Definition at line 5264 of file katedocument.cpp.

const QString & KateDocument::encoding ( ) const [virtual]

Implements KTextEditor::Document.

Definition at line 4000 of file katedocument.cpp.

virtual bool KateDocument::endEditing ( ) [inline, virtual]

Implements KTextEditor::Document.

Definition at line 212 of file katedocument.h.

void KateDocument::exportAs ( const QString & ) [inline, slot]

Definition at line 682 of file katedocument.h.

QString KateDocument::fileType ( ) const [inline]

Definition at line 932 of file katedocument.h.

bool KateDocument::findMatchingBracket	(	KTextEditor::Range &	range,
		int	maxLines = `-1`
	)

Definition at line 3623 of file katedocument.cpp.

KateCodeFoldingTree * KateDocument::foldingTree ( )

Definition at line 3990 of file katedocument.cpp.

uint KateDocument::getRealLine ( unsigned int virtualLine )

Definition at line 4703 of file katedocument.cpp.

uint KateDocument::getVirtualLine ( unsigned int realLine )

Definition at line 4708 of file katedocument.cpp.

QString KateDocument::getWord ( const KTextEditor::Cursor & cursor )

Definition at line 3555 of file katedocument.cpp.

bool KateDocument::handleMarkClick ( int line ) [slot]

Returns true if the click on the mark should not be further processed.

Definition at line 1798 of file katedocument.cpp.

bool KateDocument::handleMarkContextMenu	(	int	line,
		QPoint	position
	)		`[slot]`

Returns true if the context-menu event should not further be processed.

Definition at line 1810 of file katedocument.cpp.

KateHighlighting * KateDocument::highlight ( ) const

Definition at line 4698 of file katedocument.cpp.

QString KateDocument::highlightingMode ( ) const [virtual]

Return the name of the currently used mode.

Returns:: name of the used mode

Implements KTextEditor::Document.

Definition at line 1530 of file katedocument.cpp.

QString KateDocument::highlightingModeAt ( const KTextEditor::Cursor & position ) [virtual]

Implements KTextEditor::HighlightInterface.

Definition at line 5269 of file katedocument.cpp.

QStringList KateDocument::highlightingModes ( ) const [virtual]

Return a list of the names of all possible modes.

Returns:: list of mode names

Implements KTextEditor::Document.

Definition at line 1535 of file katedocument.cpp.

QString KateDocument::highlightingModeSection ( int index ) const [virtual]

Returns the name of the section for a highlight given its index in the highlight list (as returned by highlightModes()).

You can use this function to build a tree of the highlight names, organized in sections.

Parameters:

name	the name of the highlight for which to find the section name.

Implements KTextEditor::Document.

Definition at line 1545 of file katedocument.cpp.

void KateDocument::ignoreModifiedOnDiskOnce ( )

Definition at line 4693 of file katedocument.cpp.

void KateDocument::indent	(	KTextEditor::Range	range,
		int	change
	)

Definition at line 2906 of file katedocument.cpp.

void KateDocument::inputMethodEnd ( )

Definition at line 885 of file katedocument.cpp.

void KateDocument::inputMethodStart ( )

Definition at line 880 of file katedocument.cpp.

bool KateDocument::insertLine	(	int	line,
		const QString &	s
	)		`[virtual, slot]`

Implements KTextEditor::Document.

Definition at line 731 of file katedocument.cpp.

bool KateDocument::insertLines	(	int	line,
		const QStringList &	s
	)		`[virtual, slot]`

Implements KTextEditor::Document.

Definition at line 742 of file katedocument.cpp.

void KateDocument::insertTab	(	KateView *	view,
		const KTextEditor::Cursor &	c
	)

Definition at line 2940 of file katedocument.cpp.

bool KateDocument::insertTemplateTextImplementation	(	const KTextEditor::Cursor &	c,
		const QString &	templateString,
		const QMap< QString, QString > &	initialValues,
		KTextEditor::TemplateScript *	templateScript,
		KateView *	view
	)		`[virtual]`

Starts a KateTemplateHandler for the given template.

Multiple handlers may run at the same time, while only the last one created for this document will be active.

See also:: KTextEditor::TemplateInterface::insertTemplateTextImplementation(), KateTemplateHandler

Definition at line 4654 of file katedocument.cpp.

bool KateDocument::insertText	(	const KTextEditor::Cursor &	position,
		const QStringList &	text,
		bool	block = `false`
	)		`[virtual, slot]`

Implements KTextEditor::Document.

Definition at line 653 of file katedocument.cpp.

bool KateDocument::insertText	(	const KTextEditor::Cursor &	position,
		const QString &	s,
		bool	block = `false`
	)		`[virtual, slot]`

Implements KTextEditor::Document.

Definition at line 563 of file katedocument.cpp.

bool KateDocument::isDataRecoveryAvailable ( ) const [virtual]

Implements KTextEditor::RecoveryInterface.

Definition at line 2460 of file katedocument.cpp.

bool KateDocument::isEditRunning ( ) const

Definition at line 4729 of file katedocument.cpp.

bool KateDocument::isModifiedOnDisc ( ) [inline]

Returns:: whether the document is modified on disk since last saved

Definition at line 822 of file katedocument.h.

bool KateDocument::isOnTheFlySpellCheckingEnabled ( ) const

Definition at line 5031 of file katedocument.cpp.

void KateDocument::joinLines	(	uint	first,
		uint	last
	)

Unwrap a range of lines.

Definition at line 3514 of file katedocument.cpp.

Kate::TextLine KateDocument::kateTextLine ( uint i )

Definition at line 4718 of file katedocument.cpp.

int KateDocument::lastLine ( ) const [inline]

gets the last line number (lines() - 1)

Definition at line 669 of file katedocument.h.

qint64 KateDocument::lastSavedRevision ( ) const [virtual]

Last revision the buffer got successful saved.

Returns:: last revision buffer got saved, -1 if none

Implements KTextEditor::MovingInterface.

Definition at line 4756 of file katedocument.cpp.

QString KateDocument::line ( int line ) const [virtual]

Implements KTextEditor::Document.

Definition at line 480 of file katedocument.cpp.

QList< KTextEditor::HighlightInterface::AttributeBlock > KateDocument::lineAttributes ( const unsigned int line ) [virtual]

TODO: move attributes to document, they are not view-dependant

Implements KTextEditor::HighlightInterface.

Definition at line 5231 of file katedocument.cpp.

void KateDocument::lineInfo	(	KateLineInfo *	info,
		unsigned int	line
	)

Definition at line 3985 of file katedocument.cpp.

int KateDocument::lineLength ( int line ) const [virtual]

Implements KTextEditor::Document.

Definition at line 793 of file katedocument.cpp.

int KateDocument::lines ( ) const [virtual]

Implements KTextEditor::Document.

Definition at line 783 of file katedocument.cpp.

void KateDocument::lockRevision ( qint64 revision ) [virtual]

Lock a revision, this will keep it around until released again.

But all revisions will always be cleared on buffer clear() (and therefor load())

Parameters:

revision revision to lock

Implements KTextEditor::MovingInterface.

Definition at line 4761 of file katedocument.cpp.

void KateDocument::makeAttribs ( bool needInvalidate = true )

Definition at line 2510 of file katedocument.cpp.

uint KateDocument::mark ( int line ) [virtual]

Implements KTextEditor::MarkInterface.

Definition at line 1682 of file katedocument.cpp.

void KateDocument::markChanged	(	KTextEditor::Document *	,
		KTextEditor::Mark	,
		KTextEditor::MarkInterface::MarkChangeAction
	)		`[virtual, signal]`

Implements KTextEditor::MarkInterface.

void KateDocument::markClicked	(	KTextEditor::Document *	document,
		KTextEditor::Mark	mark,
		bool &	handled
	)		`[signal]`

Reimplemented from KTextEditor::MarkInterface.

QColor KateDocument::markColor ( MarkInterface::MarkTypes type ) const [virtual]

Definition at line 1857 of file katedocument.cpp.

void KateDocument::markContextMenuRequested	(	KTextEditor::Document *	document,
		KTextEditor::Mark	mark,
		QPoint	pos,
		bool &	handled
	)		`[signal]`

Reimplemented from KTextEditor::MarkInterface.

QString KateDocument::markDescription ( MarkInterface::MarkTypes type ) const [virtual]

Definition at line 1867 of file katedocument.cpp.

QPixmap KateDocument::markPixmap ( MarkInterface::MarkTypes type ) const [virtual]

Definition at line 1852 of file katedocument.cpp.

const QHash< int, KTextEditor::Mark * > & KateDocument::marks ( ) [virtual]

Implements KTextEditor::MarkInterface.

Definition at line 1783 of file katedocument.cpp.

void KateDocument::marksChanged ( KTextEditor::Document * ) [virtual, signal]

Implements KTextEditor::MarkInterface.

void KateDocument::markToolTipRequested	(	KTextEditor::Document *	document,
		KTextEditor::Mark	mark,
		QPoint	position,
		bool &	handled
	)		`[signal]`

Reimplemented from KTextEditor::MarkInterface.

QString KateDocument::mimeType ( ) [virtual]

Returns:: the name of the mimetype for the document.

This method is using KMimeType::findByUrl, and if the pointer is then still the default MimeType for a nonlocal or unsaved file, uses mimeTypeForContent().

Implements KTextEditor::Document.

Definition at line 1896 of file katedocument.cpp.

KMimeType::Ptr KateDocument::mimeTypeForContent ( )

Returns:: a pointer to the KMimeType for this document, found by analyzing the actual content.

Note that this method is *not* part of the DocumentInfoInterface.

Definition at line 1910 of file katedocument.cpp.

QString KateDocument::mode ( ) const [virtual]

Return the name of the currently used mode.

Returns:: name of the used mode

Implements KTextEditor::Document.

Definition at line 1508 of file katedocument.cpp.

QStringList KateDocument::modes ( ) const [virtual]

Return a list of the names of all possible modes.

Returns:: list of mode names

Implements KTextEditor::Document.

Definition at line 1513 of file katedocument.cpp.

QString KateDocument::modeSection ( int index ) const [virtual]

Returns the name of the section for a mode given its index in the highlight list (as returned by modes()).

You can use this function to build a tree of the mode names, organized in sections.

Parameters:

name	the name of the highlight for which to find the section name.

Implements KTextEditor::Document.

Definition at line 1550 of file katedocument.cpp.

void KateDocument::modifiedOnDisk	(	KTextEditor::Document *	doc,
		bool	isModified,
		KTextEditor::ModificationInterface::ModifiedOnDiskReason	reason
	)		`[virtual, signal]`

Indicate this file is modified on disk.

Parameters:

doc	the KTextEditor::Document object that represents the file on disk
isModified	indicates the file was modified rather than created or deleted
reason	the reason we are emitting the signal.

Implements KTextEditor::ModificationInterface.

void KateDocument::newBracketMark	(	const KTextEditor::Cursor &	start,
		KTextEditor::Range &	bm,
		int	maxLines = `-1`
	)

Definition at line 3607 of file katedocument.cpp.

void KateDocument::newLine ( KateView * view )

Definition at line 2659 of file katedocument.cpp.

KTextEditor::MovingCursor * KateDocument::newMovingCursor	(	const KTextEditor::Cursor &	position,
		KTextEditor::MovingCursor::InsertBehavior	insertBehavior = `KTextEditor::MovingCursor::MoveOnInsert`
	)		`[virtual]`

Create a new moving cursor for this document.

Parameters:

position	position of the moving cursor to create
insertBehavior	insertion behavior

Returns:: new moving cursor for the document

Implements KTextEditor::MovingInterface.

Definition at line 4741 of file katedocument.cpp.

KTextEditor::MovingRange * KateDocument::newMovingRange	(	const KTextEditor::Range &	range,
		KTextEditor::MovingRange::InsertBehaviors	insertBehaviors = `KTextEditor::MovingRange::DoNotExpand`,
		KTextEditor::MovingRange::EmptyBehavior	emptyBehavior = `KTextEditor::MovingRange::AllowEmpty`
	)		`[virtual]`

Create a new moving range for this document.

Parameters:

range	range of the moving range to create
insertBehaviors	insertion behaviors
emptyBehavior	behavior on becoming empty

Returns:: new moving range for the document

Definition at line 4746 of file katedocument.cpp.

int KateDocument::numVisLines ( ) const

Definition at line 788 of file katedocument.cpp.

void KateDocument::onTheFlySpellCheckingEnabled ( bool enable ) [slot]

Definition at line 5011 of file katedocument.cpp.

bool KateDocument::openFile ( ) [virtual]

open the file obtained by the kparts framework the framework abstracts the loading of remote files

Returns:: success

we are about to invalidate all cursors/ranges/.. => m_buffer->openFile will do so

Reimplemented from KParts::ReadOnlyPart.

Definition at line 1941 of file katedocument.cpp.

bool KateDocument::ownedView ( KateView * view )

Definition at line 2567 of file katedocument.cpp.

bool KateDocument::pageUpDownMovesCursor ( ) const

Definition at line 3974 of file katedocument.cpp.

void KateDocument::paste	(	KateView *	view,
		QClipboard::Mode	mode = `QClipboard::Clipboard`
	)

Definition at line 2825 of file katedocument.cpp.

Kate::TextLine KateDocument::plainKateTextLine ( uint i )

Definition at line 4724 of file katedocument.cpp.

void KateDocument::popEditState ( )

Definition at line 871 of file katedocument.cpp.

void KateDocument::preHighlightChanged ( uint ) [signal]

bool KateDocument::print ( ) [slot]

Definition at line 1889 of file katedocument.cpp.

bool KateDocument::printDialog ( ) [slot]

Definition at line 1884 of file katedocument.cpp.

void KateDocument::pushEditState ( )

Definition at line 866 of file katedocument.cpp.

bool KateDocument::queryClose ( ) [virtual]

Reimplemented from KParts::ReadWritePart.

Definition at line 4817 of file katedocument.cpp.

void KateDocument::rangeEmpty ( KTextEditor::MovingRange * movingRange ) [protected, virtual]

Reimplemented from KTextEditor::MovingRangeFeedback.

Definition at line 5065 of file katedocument.cpp.

void KateDocument::rangeInvalid ( KTextEditor::MovingRange * movingRange ) [protected, virtual]

Reimplemented from KTextEditor::MovingRangeFeedback.

Definition at line 5060 of file katedocument.cpp.

KTextEditor::Range KateDocument::rangeOnLine	(	KTextEditor::Range	range,
		int	line
	)		const

Definition at line 348 of file katedocument.cpp.

bool KateDocument::readOnly ( ) const [inline]

Definition at line 124 of file katedocument.h.

void KateDocument::readParameterizedSessionConfig	(	const KConfigGroup &	kconfig,
		unsigned long	configParameters
	)		`[virtual]`

Implements KTextEditor::ParameterizedSessionConfigInterface.

Definition at line 1584 of file katedocument.cpp.

void KateDocument::readSessionConfig ( const KConfigGroup & kconfig ) [virtual]

Implements KTextEditor::SessionConfigInterface.

Definition at line 1579 of file katedocument.cpp.

void KateDocument::recoverData ( ) [virtual]

Implements KTextEditor::RecoveryInterface.

Definition at line 2465 of file katedocument.cpp.

void KateDocument::redo ( ) [slot]

Definition at line 1420 of file katedocument.cpp.

uint KateDocument::redoCount ( ) const

Definition at line 1410 of file katedocument.cpp.

void KateDocument::refreshOnTheFlyCheck ( const KTextEditor::Range & range = KTextEditor::Range::invalid() ) [slot]

Definition at line 5053 of file katedocument.cpp.

bool KateDocument::removeLine ( int line ) [virtual, slot]

Implements KTextEditor::Document.

Definition at line 757 of file katedocument.cpp.

void KateDocument::removeMark	(	int	line,
		uint	markType
	)		`[virtual, slot]`

Implements KTextEditor::MarkInterface.

Definition at line 1750 of file katedocument.cpp.

bool KateDocument::removeText	(	const KTextEditor::Range &	range,
		bool	block = `false`
	)		`[virtual, slot]`

Implements KTextEditor::Document.

Definition at line 662 of file katedocument.cpp.

void KateDocument::removeView ( KTextEditor::View * view )

removes the view from the list of views.

The view is *not* deleted. That's your job. Or, easier, just delete the view in the first place. It will remove itself. TODO: this could be converted to a private slot connected to the view's destroyed() signal. It is not currently called anywhere except from the KateView destructor.

Definition at line 2548 of file katedocument.cpp.

void KateDocument::repaintViews ( bool paintOnlyDirty = true )

Definition at line 3590 of file katedocument.cpp.

void KateDocument::replaceCharactersByEncoding ( const KTextEditor::Range & range )

Definition at line 5181 of file katedocument.cpp.

bool KateDocument::replaceText	(	const KTextEditor::Range &	range,
		const QString &	s,
		bool	block = `false`
	)		`[virtual, slot]`

Reimplemented from KTextEditor::Document.

Definition at line 4683 of file katedocument.cpp.

virtual bool KateDocument::replaceText	(	const KTextEditor::Range &	r,
		const QStringList &	l,
		bool	b
	)		`[inline, virtual, slot]`

Reimplemented from KTextEditor::Document.

Definition at line 171 of file katedocument.h.

void KateDocument::requestMarkTooltip	(	int	line,
		QPoint	position
	)		`[slot]`

Definition at line 1788 of file katedocument.cpp.

void KateDocument::respellCheckBlock	(	KateDocument *	document,
		int	start,
		int	end
	)		`[signal]`

void KateDocument::respellCheckBlock	(	int	start,
		int	end
	)		`[inline, slot]`

Definition at line 1121 of file katedocument.h.

void KateDocument::revertToDefaultDictionary ( const KTextEditor::Range & range ) [slot]

Definition at line 4991 of file katedocument.cpp.

qint64 KateDocument::revision ( ) const [virtual]

Current revision.

Returns:: current revision

Implements KTextEditor::MovingInterface.

Definition at line 4751 of file katedocument.cpp.

bool KateDocument::save ( ) [virtual, slot]

Reimplemented from KParts::ReadWritePart.

Definition at line 4881 of file katedocument.cpp.

bool KateDocument::saveAs ( const KUrl & url ) [virtual]

Reimplemented from KParts::ReadWritePart.

Definition at line 4886 of file katedocument.cpp.

bool KateDocument::saveFile ( ) [virtual]

save the file obtained by the kparts framework the framework abstracts the uploading of remote files

Returns:: success

Implements KParts::ReadWritePart.

Definition at line 2090 of file katedocument.cpp.

QVector< KTextEditor::Range > KateDocument::searchText	(	const KTextEditor::Range &	range,
		const QString &	pattern,
		const KTextEditor::Search::SearchOptions	options
	)		`[virtual]`

Definition at line 1427 of file katedocument.cpp.

void KateDocument::setActiveView ( KTextEditor::View * view )

Definition at line 2559 of file katedocument.cpp.

void KateDocument::setAnnotationModel ( KTextEditor::AnnotationModel * model ) [virtual]

Implements KTextEditor::AnnotationInterface.

Definition at line 4803 of file katedocument.cpp.

void KateDocument::setConfigValue	(	const QString &	key,
		const QVariant &	value
	)		`[virtual]`

Implements KTextEditor::ConfigInterface.

Definition at line 4617 of file katedocument.cpp.

void KateDocument::setDefaultDictionary ( const QString & dict ) [slot]

Definition at line 4996 of file katedocument.cpp.

void KateDocument::setDictionary	(	const QString &	dict,
		const KTextEditor::Range &	range
	)		`[slot]`

Definition at line 4916 of file katedocument.cpp.

void KateDocument::setDocName ( QString docName )

avoid senseless name changes

if name given, use it!

avoid to emit this, if name doesn't change!

Definition at line 3697 of file katedocument.cpp.

void KateDocument::setDontChangeHlOnSave ( )

allow to mark, that we changed hl on user wish and should not reset it atm used for the user visible menu to select highlightings

Definition at line 1567 of file katedocument.cpp.

void KateDocument::setEditableMarks ( uint markMask ) [virtual, slot]

Implements KTextEditor::MarkInterface.

Definition at line 1872 of file katedocument.cpp.

bool KateDocument::setEncoding ( const QString & e ) [virtual]

Implements KTextEditor::Document.

Definition at line 3995 of file katedocument.cpp.

bool KateDocument::setHighlightingMode ( const QString & name ) [virtual]

Set the current mode of the document by giving its name.

Parameters:

name	name of the mode to use for this document

Returns:: true on success, otherwise false

Implements KTextEditor::Document.

Definition at line 1524 of file katedocument.cpp.

void KateDocument::setMark	(	int	line,
		uint	markType
	)		`[virtual, slot]`

Implements KTextEditor::MarkInterface.

Definition at line 1691 of file katedocument.cpp.

void KateDocument::setMarkDescription	(	MarkInterface::MarkTypes	type,
		const QString &	description
	)		`[virtual, slot]`

Definition at line 1847 of file katedocument.cpp.

void KateDocument::setMarkPixmap	(	MarkInterface::MarkTypes	type,
		const QPixmap &	pixmap
	)		`[virtual, slot]`

Definition at line 1842 of file katedocument.cpp.

bool KateDocument::setMode ( const QString & name ) [virtual]

Set the current mode of the document by giving its name.

Parameters:

name	name of the mode to use for this document

Returns:: true on success, otherwise false

Implements KTextEditor::Document.

Definition at line 1502 of file katedocument.cpp.

void KateDocument::setModified ( bool m ) [virtual]

Reimplemented from KParts::ReadWritePart.

Definition at line 2491 of file katedocument.cpp.

void KateDocument::setModifiedOnDisk ( ModifiedOnDiskReason reason ) [virtual]

Definition at line 3819 of file katedocument.cpp.

void KateDocument::setModifiedOnDiskWarning ( bool on ) [virtual]

Implements KTextEditor::ModificationInterface.

Definition at line 3833 of file katedocument.cpp.

void KateDocument::setPageUpDownMovesCursor ( bool on ) [slot]

Definition at line 3969 of file katedocument.cpp.

void KateDocument::setReadWrite ( bool rw = true ) [virtual]

Reimplemented from KParts::ReadWritePart.

Definition at line 2477 of file katedocument.cpp.

bool KateDocument::setText ( const QStringList & text ) [virtual, slot]

Implements KTextEditor::Document.

Definition at line 516 of file katedocument.cpp.

bool KateDocument::setText ( const QString & s ) [virtual, slot]

Implements KTextEditor::Document.

Definition at line 490 of file katedocument.cpp.

void KateDocument::setUndoMergeAllEdits ( bool merge )

Definition at line 4734 of file katedocument.cpp.

void KateDocument::setWordWrap ( bool on ) [slot]

Definition at line 3949 of file katedocument.cpp.

void KateDocument::setWordWrapAt ( uint col ) [slot]

Definition at line 3959 of file katedocument.cpp.

bool KateDocument::simpleMode ( ) [static]

Definition at line 4791 of file katedocument.cpp.

bool KateDocument::singleViewMode ( ) const [inline]

Definition at line 126 of file katedocument.h.

void KateDocument::slotModifiedOnDisk ( KTextEditor::View * v = 0 ) [virtual, slot]

Ask the user what to do, if the file has been modified on disk.

Reimplemented from KTextEditor::Document.

Implements KTextEditor::ModificationInterface.

Definition at line 3745 of file katedocument.cpp.

void KateDocument::slotQueryClose_save	(	bool *	handled,
		bool *	abortClosing
	)		`[slot]`

Definition at line 4549 of file katedocument.cpp.

virtual bool KateDocument::startEditing ( ) [inline, virtual]

Implements KTextEditor::Document.

Definition at line 211 of file katedocument.h.

KTextEditor::Search::SearchOptions KateDocument::supportedSearchOptions ( ) const [virtual]

Implements KTextEditor::SearchInterface.

Definition at line 1472 of file katedocument.cpp.

Kate::SwapFile * KateDocument::swapFile ( )

Definition at line 5305 of file katedocument.cpp.

void KateDocument::tagLines	(	int	start,
		int	end
	)		`[slot]`

Definition at line 3571 of file katedocument.cpp.

void KateDocument::tagLines	(	KTextEditor::Cursor	start,
		KTextEditor::Cursor	end
	)		`[slot]`

Definition at line 3577 of file katedocument.cpp.

QString KateDocument::text ( ) const [virtual]

Implements KTextEditor::Document.

Definition at line 362 of file katedocument.cpp.

QString KateDocument::text	(	const KTextEditor::Range &	range,
		bool	blockwise = `false`
	)		const `[virtual]`

Implements KTextEditor::Document.

Definition at line 367 of file katedocument.cpp.

QStringList KateDocument::textLines	(	const KTextEditor::Range &	range,
		bool	block = `false`
	)		const `[virtual]`

Implements KTextEditor::Document.

Definition at line 431 of file katedocument.cpp.

int KateDocument::totalCharacters ( ) const [virtual]

Implements KTextEditor::Document.

Definition at line 768 of file katedocument.cpp.

uint KateDocument::toVirtualColumn ( const KTextEditor::Cursor & cursor )

Definition at line 2572 of file katedocument.cpp.

void KateDocument::transform	(	KateView *	view,
		const KTextEditor::Cursor &	c,
		KateDocument::TextTransform	t
	)

Handling uppercase, lowercase and capitalize for the view.

If there is a selection, that is transformed, otherwise for uppercase or lowercase the character right of the cursor is transformed, for capitalize the word under the cursor is transformed.

Definition at line 3401 of file katedocument.cpp.

void KateDocument::transformCursor	(	KTextEditor::Cursor &	cursor,
		KTextEditor::MovingCursor::InsertBehavior	insertBehavior,
		qint64	fromRevision,
		qint64	toRevision = `-1`
	)		`[virtual]`

Transform a cursor from one revision to an other.

Parameters:

cursor	cursor to transform
insertBehavior	behavior of this cursor on insert of text at it's position
fromRevision	from this revision we want to transform
toRevision	to this revision we want to transform, default of -1 is current revision

Implements KTextEditor::MovingInterface.

Definition at line 4776 of file katedocument.cpp.

void KateDocument::transformCursor	(	int &	line,
		int &	column,
		KTextEditor::MovingCursor::InsertBehavior	insertBehavior,
		qint64	fromRevision,
		qint64	toRevision = `-1`
	)		`[virtual]`

Transform a cursor from one revision to an other.

Parameters:

line	line number of the cursor to transform
column	column number of the cursor to transform
insertBehavior	behavior of this cursor on insert of text at it's position
fromRevision	from this revision we want to transform
toRevision	to this revision we want to transform, default of -1 is current revision

Implements KTextEditor::MovingInterface.

Definition at line 4771 of file katedocument.cpp.

void KateDocument::transformRange	(	KTextEditor::Range &	range,
		KTextEditor::MovingRange::InsertBehaviors	insertBehaviors,
		KTextEditor::MovingRange::EmptyBehavior	emptyBehavior,
		qint64	fromRevision,
		qint64	toRevision = `-1`
	)		`[virtual]`

Transform a range from one revision to an other.

Parameters:

range	range to transform
insertBehaviors	behavior of this range on insert of text at it's position
emptyBehavior	behavior on becoming empty
fromRevision	from this revision we want to transform
toRevision	to this revision we want to transform, default of -1 is current revision

Implements KTextEditor::MovingInterface.

Definition at line 4784 of file katedocument.cpp.

void KateDocument::transpose ( const KTextEditor::Cursor & cursor )

Definition at line 2693 of file katedocument.cpp.

bool KateDocument::typeChars	(	KateView *	type,
		const QString &	chars
	)

Type chars in a view.

Definition at line 2582 of file katedocument.cpp.

void KateDocument::undo ( ) [slot]

Definition at line 1415 of file katedocument.cpp.

void KateDocument::undoChanged ( ) [signal]

uint KateDocument::undoCount ( ) const

Definition at line 1405 of file katedocument.cpp.

void KateDocument::unlockRevision ( qint64 revision ) [virtual]

Release a revision.

Parameters:

revision revision to release

Implements KTextEditor::MovingInterface.

Definition at line 4766 of file katedocument.cpp.

void KateDocument::updateConfig ( )

Definition at line 4005 of file katedocument.cpp.

void KateDocument::updateFileType	(	const QString &	newType,
		bool	user = `false`
	)

set the indentation mode, if any in the mode...

Definition at line 4498 of file katedocument.cpp.

QString KateDocument::variable ( const QString & name ) const [virtual]

Implements KTextEditor::VariableInterface.

Definition at line 4365 of file katedocument.cpp.

void KateDocument::variableChanged	(	KTextEditor::Document *	,
		const QString &	,
		const QString &
	)		`[virtual, signal]`

Implements KTextEditor::VariableInterface.

const QList< KTextEditor::View * > & KateDocument::views ( ) const [virtual]

Implements KTextEditor::Document.

Definition at line 338 of file katedocument.cpp.

uint KateDocument::visibleLines ( )

Definition at line 4713 of file katedocument.cpp.

QWidget * KateDocument::widget ( ) [virtual]

Returns:: The widget defined by this part, set by setWidget().

Reimplemented from KParts::Part.

Definition at line 308 of file katedocument.cpp.

bool KateDocument::wordWrap ( ) const

Definition at line 3954 of file katedocument.cpp.

unsigned int KateDocument::wordWrapAt ( ) const

Definition at line 3964 of file katedocument.cpp.

bool KateDocument::wrapText	(	int	startLine,
		int	endLine
	)

Remove a line.

Parameters:

startLine	line to begin wrapping
endLine	line to stop wrapping

Returns:: true on success

Definition at line 890 of file katedocument.cpp.

void KateDocument::writeParameterizedSessionConfig	(	KConfigGroup &	kconfig,
		unsigned long	configParameters
	)		`[virtual]`

Implements KTextEditor::ParameterizedSessionConfigInterface.

Definition at line 1635 of file katedocument.cpp.

void KateDocument::writeSessionConfig ( KConfigGroup & kconfig ) [virtual]

Implements KTextEditor::SessionConfigInterface.

Definition at line 1630 of file katedocument.cpp.

Member Data Documentation

QString KateDocument::m_defaultDictionary [protected]

Definition at line 1149 of file katedocument.h.

QList<QPair<KTextEditor::MovingRange*, QString> > KateDocument::m_dictionaryRanges [protected]

Definition at line 1150 of file katedocument.h.

KateOnTheFlyChecker* KateDocument::m_onTheFlyChecker [protected]

Definition at line 1148 of file katedocument.h.

KateUndoManager* const KateDocument::m_undoManager [protected]

Definition at line 325 of file katedocument.h.

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

Kate

KateDocument Class Reference

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Kate

kdelibs