KateDocument Class Reference

#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
void	addMark (int line, uint markType)
virtual bool	clear ()
void	clearDictionaryRanges ()
void	clearMark (int line)
void	clearMarks ()
bool	documentReload ()
bool	documentSave ()
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 QStringList &text, bool block=false)
virtual bool	insertText (const KTextEditor::Cursor &position, const QString &s, bool block=false)
void	onTheFlySpellCheckingEnabled (bool enable)
bool	print ()
bool	printDialog ()
void	redo ()
void	refreshOnTheFlyCheck (const KTextEditor::Range &range=KTextEditor::Range::invalid())
virtual void	removeActionsFromDocument (KTextEditor::SmartRange *topRange)
virtual void	removeHighlightFromDocument (KTextEditor::SmartRange *topRange)
bool	removeLine (int line)
void	removeMark (int line, uint markType)
bool	removeText (const KTextEditor::Range &range, bool block=false)
bool	replaceText (const KTextEditor::Range &r, const QStringList &l, bool b)
bool	replaceText (const KTextEditor::Range &range, const QString &s, bool block=false)
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)
void	setEditableMarks (uint markMask)
void	setMark (int line, uint markType)
void	setMarkDescription (MarkInterface::MarkTypes, const QString &)
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)
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	aboutToRemoveText (const KTextEditor::Range &)
void	activeViewSelectionChanged (KTextEditor::View *view)
void	annotationModelChanged (KTextEditor::AnnotationModel , KTextEditor::AnnotationModel )
void	charactersSemiInteractivelyInserted (const KTextEditor::Cursor &position, const QString &text)
void	codeFoldingUpdated ()
void	defaultDictionaryChanged (KateDocument *document)
void	dictionaryRangesPresent (bool yesNo)
void	dynamicHighlightAdded (KateSmartRange *range)
void	dynamicHighlightRemoved (KateSmartRange *range)
void	editLineUnWrapped (int line, int col)
void	editLineWrapped (int line, int col, int len)
void	highlightingModeChanged (KTextEditor::Document *document)
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	modeChanged (KTextEditor::Document *document)
void	modifiedOnDisk (KTextEditor::Document *doc, bool isModified, KTextEditor::ModificationInterface::ModifiedOnDiskReason reason)
void	preHighlightChanged (uint)
void	respellCheckBlock (KateDocument *document, int start, int end)
void	textRemoved ()
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
virtual void	addActionsToDocument (KTextEditor::SmartRange *topRange)
virtual void	addActionsToView (KTextEditor::View view, KTextEditor::SmartRange topRange)
virtual void	addHighlightToDocument (KTextEditor::SmartRange *topRange, bool supportDynamic)
virtual void	addHighlightToView (KTextEditor::View view, KTextEditor::SmartRange topRange, bool supportDynamic)
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 ()
KateBrowserExtension *	browserExtension ()
bool	browserView () const
void	bufferHlChanged ()
virtual QChar	character (const KTextEditor::Cursor &position) const
virtual void	clearDocumentActions ()
virtual void	clearDocumentHighlights ()
void	clearMisspellingForWord (const QString &word)
virtual void	clearSmartInterface ()
virtual void	clearViewActions (KTextEditor::View *view)
virtual void	clearViewHighlights (KTextEditor::View *view)
bool	closeUrl ()
void	comment (KateView *view, uint line, uint column, int change)
int	computePositionWrtOffsets (const OffsetList &offsetList, int pos)
KateDocumentConfig *	config () const
KateDocumentConfig *	config ()
QStringList	configKeys () const
QVariant	configValue (const QString &key)
bool	containsCharacterEncoding (const KTextEditor::Range &range)
KTextEditor::View *	createView (QWidget *parent)
virtual int	currentRevision () const
QString	decodeCharacters (const KTextEditor::Range &range, KateDocument::OffsetList &decToEncOffsetList, KateDocument::OffsetList &encToDecOffsetList)
QString	defaultDictionary () const
void	del (KateView *view, const KTextEditor::Cursor &)
virtual void	deleteCursors ()
virtual void	deleteRanges ()
QString	dictionaryForMisspelledRange (const KTextEditor::Range &range) const
QList< QPair < KTextEditor::SmartRange *, QString > >	dictionaryRanges () const
virtual const QList < KTextEditor::SmartRange * >	documentActions () const
virtual KTextEditor::Cursor	documentEnd () const
virtual const QList < KTextEditor::SmartRange * >	documentHighlights () const
const QString &	documentName () const
uint	editableMarks () const
void	editBegin (Kate::EditSource editSource=Kate::NoEditSource)
void	editEnd ()
bool	editInsertLine (int line, const QString &s, Kate::EditSource editSource=Kate::NoEditSource)
bool	editInsertText (int line, int col, const QString &s, Kate::EditSource editSource=Kate::NoEditSource)
bool	editMarkLineAutoWrapped (int line, bool autowrapped)
KTextEditor::Editor *	editor ()
bool	editRemoveLine (int line, Kate::EditSource editSource=Kate::NoEditSource)
bool	editRemoveText (int line, int col, int len, Kate::EditSource editSource=Kate::NoEditSource)
void	editStart (Kate::EditSource editSource=Kate::NoEditSource)
bool	editUnWrapLine (int line, bool removeLine=true, int length=0)
bool	editWrapLine (int line, int col, bool newLine=true, bool *newLineAdded=0)
const QString &	encoding () const
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 QStringList	highlightingModes () const
virtual QString	highlightingModeSection (int index) const
KateEditHistory *	history () const
void	ignoreModifiedOnDiskOnce ()
void	indent (KateView *view, uint line, int change)
void	inputMethodEnd ()
void	inputMethodStart ()
virtual bool	insertTemplateTextImplementation (const KTextEditor::Cursor &c, const QString &templateString, const QMap< QString, QString > &initialValues, QWidget *)
bool	invokeTemplateHandler (int key)
bool	isEditRunning () const
bool	isModifiedOnDisc ()
bool	isOnTheFlySpellCheckingEnabled () const
void	joinLines (uint first, uint last)
KateTextLine::Ptr	kateTextLine (uint i)
int	lastLine () const
virtual QString	line (int line) const
void	lineInfo (KateLineInfo *info, unsigned int line)
int	lineLength (int line) const
int	lines () const
void	makeAttribs (bool needInvalidate=true)
uint	mark (int line)
QColor	markColor (MarkInterface::MarkTypes) const
QString	markDescription (MarkInterface::MarkTypes) const
QPixmap	markPixmap (MarkInterface::MarkTypes) const
const QHash< int, KTextEditor::Mark * > &	marks ()
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::SmartCursor *	newSmartCursor (const KTextEditor::Cursor &position, KTextEditor::SmartCursor::InsertBehavior insertBehavior=KTextEditor::SmartCursor::MoveOnInsert)
virtual KTextEditor::SmartRange *	newSmartRange (KTextEditor::SmartCursor start, KTextEditor::SmartCursor end, KTextEditor::SmartRange *parent=0L, KTextEditor::SmartRange::InsertBehaviors insertBehavior=KTextEditor::SmartRange::DoNotExpand)
virtual KTextEditor::SmartRange *	newSmartRange (const KTextEditor::Range &range, KTextEditor::SmartRange *parent=0L, KTextEditor::SmartRange::InsertBehaviors insertBehavior=KTextEditor::SmartRange::DoNotExpand)
int	numVisLines () const
QPair< KTextEditor::Range, QString >	onTheFlyMisspelledItem (const KTextEditor::Cursor &cursor) const
bool	openFile ()
bool	ownedView (KateView *)
bool	pageUpDownMovesCursor () const
void	paste (KateView *view, QClipboard::Mode=QClipboard::Clipboard)
KateTextLine::Ptr	plainKateTextLine (uint i)
void	popEditState ()
KEncodingProber::ProberType	proberTypeForEncodingAutoDetection () const
void	pushEditState ()
virtual bool	queryClose ()
bool	readOnly () const
void	readSessionConfig (const KConfigGroup &)
uint	redoCount () const
virtual void	releaseRevision (int revision) const
virtual void	removeActionsFromView (KTextEditor::View view, KTextEditor::SmartRange topRange)
virtual void	removeHighlightFromView (KTextEditor::View view, KTextEditor::SmartRange topRange)
void	removeView (KTextEditor::View *)
void	repaintViews (bool paintOnlyDirty=true)
void	replaceCharactersByEncoding (const KTextEditor::Range &range)
virtual bool	saveAs (const KUrl &url)
bool	saveFile ()
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)
void	setConfigValue (const QString &key, const QVariant &value)
void	setDocName (QString docName)
void	setDontChangeHlOnSave ()
bool	setEncoding (const QString &e)
virtual bool	setHighlightingMode (const QString &name)
void	setMergeAllEdits (bool merge)
virtual bool	setMode (const QString &name)
void	setModified (bool m)
void	setModifiedOnDisk (ModifiedOnDiskReason reason)
void	setModifiedOnDiskWarning (bool on)
void	setProberTypeForEncodingAutoDetection (KEncodingProber::ProberType)
void	setReadWrite (bool rw=true)
void	setUndoAllowComplexMerge (bool allow)
void	setUndoDontMerge (bool dontMerge)
bool	singleViewMode () const
KateSmartManager *	smartManager () const
bool	startEditing ()
KTextEditor::Search::SearchOptions	supportedSearchOptions () const
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
int	totalCharacters () const
uint	toVirtualColumn (const KTextEditor::Cursor &)
void	transform (KateView *view, const KTextEditor::Cursor &, TextTransform)
virtual KTextEditor::Range	translateFromRevision (const KTextEditor::Range &range, KTextEditor::SmartRange::InsertBehaviors insertBehavior=KTextEditor::SmartRange::ExpandLeft\|KTextEditor::SmartRange::ExpandRight) const
virtual KTextEditor::Cursor	translateFromRevision (const KTextEditor::Cursor &cursor, KTextEditor::SmartCursor::InsertBehavior insertBehavior=KTextEditor::SmartCursor::StayOnInsert) const
void	transpose (const KTextEditor::Cursor &)
bool	typeChars (KateView *type, const QString &chars)
virtual void	unbindSmartRange (KTextEditor::SmartRange *range)
bool	undoAllowComplexMerge () const
uint	undoCount () const
bool	undoDontMerge () const
void	undoSafePoint ()
void	updateConfig ()
void	updateFileType (const QString &newType, bool user=false)
virtual void	useRevision (int revision=-1)
QString	variable (const QString &name) const
virtual const QList < KTextEditor::SmartRange * >	viewActions (KTextEditor::View *view) const
virtual const QList < KTextEditor::SmartRange * >	viewHighlights (KTextEditor::View *view) const
const QList< KTextEditor::View * > &	views () const
uint	visibleLines ()
virtual QWidget *	widget ()
bool	wordWrap () const
uint	wordWrapAt () const
bool	wrapText (int startLine, int endLine)
void	writeSessionConfig (KConfigGroup &)
Static Public Member Functions
static bool	checkOverwrite (KUrl u, QWidget *parent)
static bool	simpleMode ()
Protected Slots
void	deleteDiscardedSmartRanges ()
void	dictionaryRangeEliminated (KTextEditor::SmartRange *smartRange)
void	dumpRegionTree ()
void	testTemplateCode ()
Protected Member Functions
virtual void	attributeDynamic (KTextEditor::Attribute::Ptr a)
virtual void	attributeNotDynamic (KTextEditor::Attribute::Ptr a)
KTextEditor::SmartRangeNotifier *	dictionaryRangeNotifier ()
Protected Attributes
QString	m_defaultDictionary
KTextEditor::SmartRangeNotifier *	m_dictionaryRangeNotifier
QList< QPair < KTextEditor::SmartRange *, QString > >	m_dictionaryRanges
QList< KTextEditor::SmartRange * >	m_discardedSmartRanges
KateOnTheFlyChecker *	m_onTheFlyChecker
KateTemplateHandler *	m_templateHandler

Detailed Description

Definition at line 71 of file katedocument.h.

Member Typedef Documentation

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

Definition at line 1098 of file katedocument.h.

Member Enumeration Documentation

enum KateDocument::EncodedCharaterInsertionPolicy

Enumerator:

EncodeAlways
EncodeWhenPresent
EncodeNever

Definition at line 1111 of file katedocument.h.

enum KateDocument::TextTransform

Enumerator:

Uppercase
Lowercase
Capitalize

Definition at line 701 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 164 of file katedocument.cpp.

KateDocument::~KateDocument ( )

Definition at line 280 of file katedocument.cpp.

Member Function Documentation

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

KateView * KateDocument::activeKateView ( ) const

Definition at line 4759 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 132 of file katedocument.h.

void KateDocument::activeViewSelectionChanged ( KTextEditor::View * view ) [signal]

void KateDocument::addActionsToDocument ( KTextEditor::SmartRange * topRange ) [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4888 of file katedocument.cpp.

void KateDocument::addActionsToView	(	KTextEditor::View *	view,
		KTextEditor::SmartRange *	topRange
	)			`[virtual]`

Implements KTextEditor::SmartInterface.

Definition at line 4913 of file katedocument.cpp.

void KateDocument::addHighlightToDocument	(	KTextEditor::SmartRange *	topRange,
		bool	supportDynamic
	)			`[virtual]`

Implements KTextEditor::SmartInterface.

Definition at line 4832 of file katedocument.cpp.

void KateDocument::addHighlightToView	(	KTextEditor::View *	view,
		KTextEditor::SmartRange *	topRange,
		bool	supportDynamic
	)			`[virtual]`

Implements KTextEditor::SmartInterface.

Definition at line 4873 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1774 of file katedocument.cpp.

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

Definition at line 2563 of file katedocument.cpp.

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

Definition at line 2995 of file katedocument.cpp.

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

Implements KTextEditor::AnnotationInterface.

Definition at line 5075 of file katedocument.cpp.

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

void KateDocument::attributeDynamic ( KTextEditor::Attribute::Ptr a ) [protected, virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4928 of file katedocument.cpp.

void KateDocument::attributeNotDynamic ( KTextEditor::Attribute::Ptr a ) [protected, virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4933 of file katedocument.cpp.

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

Definition at line 2794 of file katedocument.cpp.

void KateDocument::bomSetByUser ( )

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

Definition at line 1668 of file katedocument.cpp.

KateBrowserExtension* KateDocument::browserExtension ( ) [inline]

Definition at line 115 of file katedocument.h.

bool KateDocument::browserView ( ) const [inline]

Definition at line 113 of file katedocument.h.

void KateDocument::bufferHlChanged ( )

Definition at line 1651 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 435 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 4652 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 558 of file katedocument.cpp.

void KateDocument::clearDictionaryRanges ( ) [slot]

Definition at line 5169 of file katedocument.cpp.

void KateDocument::clearDocumentActions ( ) [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4969 of file katedocument.cpp.

void KateDocument::clearDocumentHighlights ( ) [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4959 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1758 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1882 of file katedocument.cpp.

void KateDocument::clearMisspellingForWord ( const QString & word )

Definition at line 5326 of file katedocument.cpp.

void KateDocument::clearSmartInterface ( ) [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4938 of file katedocument.cpp.

void KateDocument::clearViewActions ( KTextEditor::View * view ) [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4974 of file katedocument.cpp.

void KateDocument::clearViewHighlights ( KTextEditor::View * view ) [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4964 of file katedocument.cpp.

bool KateDocument::closeUrl ( ) [virtual]

Reimplemented from KParts::ReadWritePart.

Definition at line 2419 of file katedocument.cpp.

void KateDocument::codeFoldingUpdated ( ) [signal]

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

Definition at line 3358 of file katedocument.cpp.

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

Definition at line 5413 of file katedocument.cpp.

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

Definition at line 968 of file katedocument.h.

KateDocumentConfig* KateDocument::config ( ) [inline]

Configuration.

Definition at line 967 of file katedocument.h.

QStringList KateDocument::configKeys ( ) const [virtual]

Implements KTextEditor::ConfigInterface.

Definition at line 4671 of file katedocument.cpp.

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

Implements KTextEditor::ConfigInterface.

Definition at line 4676 of file katedocument.cpp.

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

Definition at line 5387 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 339 of file katedocument.cpp.

int KateDocument::currentRevision ( ) const [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4771 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 5425 of file katedocument.cpp.

QString KateDocument::defaultDictionary ( ) const

Definition at line 5159 of file katedocument.cpp.

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

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

Definition at line 2878 of file katedocument.cpp.

void KateDocument::deleteCursors ( ) [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4949 of file katedocument.cpp.

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

Definition at line 5364 of file katedocument.cpp.

void KateDocument::deleteRanges ( ) [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4954 of file katedocument.cpp.

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

Definition at line 5316 of file katedocument.cpp.

void KateDocument::dictionaryRangeEliminated ( KTextEditor::SmartRange * smartRange ) [protected, slot]

Definition at line 5340 of file katedocument.cpp.

KTextEditor::SmartRangeNotifier * KateDocument::dictionaryRangeNotifier ( ) [protected]

Definition at line 5374 of file katedocument.cpp.

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

Definition at line 5164 of file katedocument.cpp.

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

const QList< KTextEditor::SmartRange * > KateDocument::documentActions ( ) const [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4908 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 4764 of file katedocument.cpp.

const QList< KTextEditor::SmartRange * > KateDocument::documentHighlights ( ) const [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4868 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 797 of file katedocument.h.

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

Reloads the current document from disk if possible.

Implements KTextEditor::Document.

Definition at line 3908 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 3998 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 4006 of file katedocument.cpp.

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

Definition at line 4051 of file katedocument.cpp.

void KateDocument::dynamicHighlightAdded ( KateSmartRange * range ) [signal]

void KateDocument::dynamicHighlightRemoved ( KateSmartRange * range ) [signal]

uint KateDocument::editableMarks ( ) const [virtual]

Implements KTextEditor::MarkInterface.

Definition at line 1938 of file katedocument.cpp.

void KateDocument::editBegin ( Kate::EditSource editSource = Kate::NoEditSource ) [inline]

Same as editStart() with undo.

Definition at line 191 of file katedocument.h.

void KateDocument::editEnd ( )

End a editor operation.

See also:: editStart()

Definition at line 940 of file katedocument.cpp.

bool KateDocument::editInsertLine	(	int	line,
		const QString &	s,
		Kate::EditSource	editSource = `Kate::NoEditSource`
	)

Insert a string at the given line.

Parameters:

	line	line number
	s	string to insert

Returns:: true on success

Definition at line 1379 of file katedocument.cpp.

bool KateDocument::editInsertText	(	int	line,
		int	col,
		const QString &	s,
		Kate::EditSource	editSource = `Kate::NoEditSource`
	)

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 1129 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 1196 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 355 of file katedocument.cpp.

bool KateDocument::editRemoveLine	(	int	line,
		Kate::EditSource	editSource = `Kate::NoEditSource`
	)

Remove a line.

Parameters:

line

line number

Returns:: true on success

Definition at line 1439 of file katedocument.cpp.

bool KateDocument::editRemoveText	(	int	line,
		int	col,
		int	len,
		Kate::EditSource	editSource = `Kate::NoEditSource`
	)

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 1166 of file katedocument.cpp.

void KateDocument::editStart ( Kate::EditSource editSource = Kate::NoEditSource )

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

Parameters:

withUndo

if true, add undo history

Definition at line 906 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 1306 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 1222 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 4073 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 202 of file katedocument.h.

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

Definition at line 667 of file katedocument.h.

QString KateDocument::fileType ( ) const [inline]

Definition at line 922 of file katedocument.h.

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

Definition at line 3685 of file katedocument.cpp.

KateCodeFoldingTree * KateDocument::foldingTree ( )

Definition at line 4062 of file katedocument.cpp.

uint KateDocument::getRealLine ( unsigned int virtualLine )

Definition at line 4989 of file katedocument.cpp.

uint KateDocument::getVirtualLine ( unsigned int realLine )

Definition at line 4994 of file katedocument.cpp.

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

Definition at line 3618 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 1858 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 1870 of file katedocument.cpp.

KateHighlighting * KateDocument::highlight ( ) const

Definition at line 4984 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 1626 of file katedocument.cpp.

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

Warn anyone listening that the current document's highlighting mode has changed.

Parameters:

document

the document which's mode has changed

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 1631 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 1641 of file katedocument.cpp.

KateEditHistory* KateDocument::history ( ) const [inline]

Definition at line 320 of file katedocument.h.

void KateDocument::ignoreModifiedOnDiskOnce ( )

Definition at line 4979 of file katedocument.cpp.

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

Definition at line 2973 of file katedocument.cpp.

void KateDocument::inputMethodEnd ( )

Definition at line 1002 of file katedocument.cpp.

void KateDocument::inputMethodStart ( )

Definition at line 997 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 825 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 836 of file katedocument.cpp.

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

Definition at line 4731 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 664 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 574 of file katedocument.cpp.

bool KateDocument::invokeTemplateHandler ( int key )

Definition at line 4750 of file katedocument.cpp.

bool KateDocument::isEditRunning ( ) const

Definition at line 5035 of file katedocument.cpp.

bool KateDocument::isModifiedOnDisc ( ) [inline]

Returns:: wheather the document is modified on disk since last saved.

Definition at line 809 of file katedocument.h.

bool KateDocument::isOnTheFlySpellCheckingEnabled ( ) const

Definition at line 5301 of file katedocument.cpp.

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

Unwrap a range of lines.

Definition at line 3577 of file katedocument.cpp.

KateTextLine::Ptr KateDocument::kateTextLine ( uint i )

Definition at line 5004 of file katedocument.cpp.

int KateDocument::lastLine ( ) const [inline]

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

Definition at line 654 of file katedocument.h.

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

Implements KTextEditor::Document.

Definition at line 496 of file katedocument.cpp.

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

Definition at line 4057 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 888 of file katedocument.cpp.

int KateDocument::lines ( ) const [virtual]

Implements KTextEditor::Document.

Definition at line 878 of file katedocument.cpp.

void KateDocument::makeAttribs ( bool needInvalidate = true )

Definition at line 2542 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1744 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

Definition at line 1917 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

Definition at line 1927 of file katedocument.cpp.

QPixmap KateDocument::markPixmap ( MarkInterface::MarkTypes type ) const

Definition at line 1911 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1844 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 1957 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 1971 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 1604 of file katedocument.cpp.

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

Warn anyone listening that the current document's mode has changed.

Parameters:

document

the document which's mode has changed

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 1609 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 1646 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 3670 of file katedocument.cpp.

void KateDocument::newLine ( KateView * view )

Definition at line 2729 of file katedocument.cpp.

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

Implements KTextEditor::SmartInterface.

Definition at line 4796 of file katedocument.cpp.

KTextEditor::SmartRange * KateDocument::newSmartRange	(	KTextEditor::SmartCursor *	start,
		KTextEditor::SmartCursor *	end,
		KTextEditor::SmartRange *	parent = `0L`,
		KTextEditor::SmartRange::InsertBehaviors	insertBehavior = `KTextEditor::SmartRange::DoNotExpand`
	)			`[virtual]`

Definition at line 4806 of file katedocument.cpp.

KTextEditor::SmartRange * KateDocument::newSmartRange	(	const KTextEditor::Range &	range,
		KTextEditor::SmartRange *	parent = `0L`,
		KTextEditor::SmartRange::InsertBehaviors	insertBehavior = `KTextEditor::SmartRange::DoNotExpand`
	)			`[virtual]`

Definition at line 4801 of file katedocument.cpp.

int KateDocument::numVisLines ( ) const

Definition at line 883 of file katedocument.cpp.

QPair< KTextEditor::Range, QString > KateDocument::onTheFlyMisspelledItem ( const KTextEditor::Cursor & cursor ) const

Definition at line 5306 of file katedocument.cpp.

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

Definition at line 5281 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

Implements KParts::ReadOnlyPart.

Definition at line 2002 of file katedocument.cpp.

bool KateDocument::ownedView ( KateView * view )

Definition at line 2611 of file katedocument.cpp.

bool KateDocument::pageUpDownMovesCursor ( ) const

Definition at line 4046 of file katedocument.cpp.

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

Definition at line 2895 of file katedocument.cpp.

KateTextLine::Ptr KateDocument::plainKateTextLine ( uint i )

Definition at line 5010 of file katedocument.cpp.

void KateDocument::popEditState ( )

Definition at line 988 of file katedocument.cpp.

void KateDocument::preHighlightChanged ( uint ) [signal]

bool KateDocument::print ( ) [slot]

Definition at line 1950 of file katedocument.cpp.

bool KateDocument::printDialog ( ) [slot]

Definition at line 1945 of file katedocument.cpp.

KEncodingProber::ProberType KateDocument::proberTypeForEncodingAutoDetection ( ) const

Definition at line 4083 of file katedocument.cpp.

void KateDocument::pushEditState ( )

Definition at line 983 of file katedocument.cpp.

bool KateDocument::queryClose ( ) [virtual]

Reimplemented from KParts::ReadWritePart.

Definition at line 5082 of file katedocument.cpp.

bool KateDocument::readOnly ( ) const [inline]

Definition at line 112 of file katedocument.h.

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

Implements KTextEditor::SessionConfigInterface.

Definition at line 1675 of file katedocument.cpp.

void KateDocument::redo ( ) [slot]

Definition at line 1524 of file katedocument.cpp.

uint KateDocument::redoCount ( ) const

Definition at line 1514 of file katedocument.cpp.

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

Definition at line 5333 of file katedocument.cpp.

void KateDocument::releaseRevision ( int revision ) const [virtual]

Implements KTextEditor::SmartInterface.

Definition at line 4776 of file katedocument.cpp.

void KateDocument::removeActionsFromDocument ( KTextEditor::SmartRange * topRange ) [virtual, slot]

Implements KTextEditor::SmartInterface.

Definition at line 4899 of file katedocument.cpp.

void KateDocument::removeActionsFromView	(	KTextEditor::View *	view,
		KTextEditor::SmartRange *	topRange
	)			`[virtual]`

Implements KTextEditor::SmartInterface.

Definition at line 4918 of file katedocument.cpp.

void KateDocument::removeHighlightFromDocument ( KTextEditor::SmartRange * topRange ) [virtual, slot]

Implements KTextEditor::SmartInterface.

Definition at line 4851 of file katedocument.cpp.

void KateDocument::removeHighlightFromView	(	KTextEditor::View *	view,
		KTextEditor::SmartRange *	topRange
	)			`[virtual]`

Implements KTextEditor::SmartInterface.

Definition at line 4878 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 852 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1811 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 754 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 2585 of file katedocument.cpp.

void KateDocument::repaintViews ( bool paintOnlyDirty = true )

Definition at line 3653 of file katedocument.cpp.

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

Definition at line 5481 of file katedocument.cpp.

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

Reimplemented from KTextEditor::Document.

Definition at line 164 of file katedocument.h.

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

Reimplemented from KTextEditor::Document.

Definition at line 4822 of file katedocument.cpp.

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

Definition at line 1849 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 1083 of file katedocument.h.

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

Definition at line 5261 of file katedocument.cpp.

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

Reimplemented from KParts::ReadWritePart.

Definition at line 5149 of file katedocument.cpp.

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

Reimplemented from KParts::ReadWritePart.

Definition at line 5154 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 2147 of file katedocument.cpp.

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

Definition at line 1531 of file katedocument.cpp.

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

Definition at line 2596 of file katedocument.cpp.

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

Implements KTextEditor::AnnotationInterface.

Definition at line 5068 of file katedocument.cpp.

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

Implements KTextEditor::ConfigInterface.

Definition at line 4694 of file katedocument.cpp.

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

Definition at line 5266 of file katedocument.cpp.

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

Definition at line 5185 of file katedocument.cpp.

void KateDocument::setDocName ( QString docName )

Definition at line 3774 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 1663 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1933 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 4067 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 1620 of file katedocument.cpp.

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

Implements KTextEditor::MarkInterface.

Definition at line 1752 of file katedocument.cpp.

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

Definition at line 1906 of file katedocument.cpp.

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

Definition at line 1901 of file katedocument.cpp.

void KateDocument::setMergeAllEdits ( bool merge )

Definition at line 5040 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 1598 of file katedocument.cpp.

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

Reimplemented from KParts::ReadWritePart.

Definition at line 2523 of file katedocument.cpp.

void KateDocument::setModifiedOnDisk ( ModifiedOnDiskReason reason )

Definition at line 3889 of file katedocument.cpp.

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

Implements KTextEditor::ModificationInterface.

Definition at line 3903 of file katedocument.cpp.

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

Definition at line 4041 of file katedocument.cpp.

void KateDocument::setProberTypeForEncodingAutoDetection ( KEncodingProber::ProberType proberType )

Definition at line 4078 of file katedocument.cpp.

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

Reimplemented from KParts::ReadWritePart.

Definition at line 2509 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 532 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 506 of file katedocument.cpp.

void KateDocument::setUndoAllowComplexMerge ( bool allow )

Definition at line 5020 of file katedocument.cpp.

void KateDocument::setUndoDontMerge ( bool dontMerge )

Definition at line 5030 of file katedocument.cpp.

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

Definition at line 4021 of file katedocument.cpp.

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

Definition at line 4031 of file katedocument.cpp.

bool KateDocument::simpleMode ( ) [static]

Definition at line 5056 of file katedocument.cpp.

bool KateDocument::singleViewMode ( ) const [inline]

Definition at line 114 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 3815 of file katedocument.cpp.

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

Definition at line 4626 of file katedocument.cpp.

KateSmartManager* KateDocument::smartManager ( ) const [inline]

Definition at line 581 of file katedocument.h.

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

Implements KTextEditor::Document.

Definition at line 201 of file katedocument.h.

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

Implements KTextEditor::SearchInterface.

Definition at line 1568 of file katedocument.cpp.

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

Definition at line 3640 of file katedocument.cpp.

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

Definition at line 3634 of file katedocument.cpp.

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

Definition at line 4744 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 382 of file katedocument.cpp.

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

Implements KTextEditor::Document.

Definition at line 448 of file katedocument.cpp.

void KateDocument::textRemoved ( ) [signal]

int KateDocument::totalCharacters ( ) const [virtual]

Implements KTextEditor::Document.

Definition at line 863 of file katedocument.cpp.

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

Definition at line 2616 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 3472 of file katedocument.cpp.

KTextEditor::Range KateDocument::translateFromRevision	(	const KTextEditor::Range &	range,
		KTextEditor::SmartRange::InsertBehaviors	insertBehavior = `KTextEditor::SmartRange::ExpandLeft \| KTextEditor::SmartRange::ExpandRight`
	)			const `[virtual]`

Reimplemented from KTextEditor::SmartInterface.

Definition at line 4791 of file katedocument.cpp.

KTextEditor::Cursor KateDocument::translateFromRevision	(	const KTextEditor::Cursor &	cursor,
		KTextEditor::SmartCursor::InsertBehavior	insertBehavior = `KTextEditor::SmartCursor::StayOnInsert`
	)			const `[virtual]`