KateCommands::CoreCommands Class Reference

This KTextEditor::Command provides access to a lot of the core functionality of kate part, settings, utilities, navigation etc. More...

#include <katecmds.h>

Inheritance diagram for KateCommands::CoreCommands:

List of all members.

Public Member Functions
const QStringList &	cmds ()
KCompletion *	completionObject (KTextEditor::View *, const QString &)
bool	exec (class KTextEditor::View *view, const QString &cmd, QString &errorMsg, const KTextEditor::Range &range=KTextEditor::Range(-1,-0,-1, 0))
bool	exec (class KTextEditor::View *view, const QString &cmd, QString &errorMsg)
virtual void	flagCompletions (QStringList &)
bool	help (class KTextEditor::View *, const QString &, QString &)
virtual void	processText (KTextEditor::View *, const QString &)
bool	supportsRange (const QString &range)
virtual bool	wantsToProcessText (const QString &)

---

Detailed Description

This KTextEditor::Command provides access to a lot of the core functionality of kate part, settings, utilities, navigation etc.

it needs to get a kateview pointer, it will cast the kate::view pointer hard to kateview

Definition at line 44 of file katecmds.h.

---

Member Function Documentation

const QStringList & KateCommands::CoreCommands::cmds

(

)

[virtual]

supported commands as prefixes

Returns:

prefix list

Implements KTextEditor::Command.

Definition at line 70 of file katecmds.cpp.

KCompletion * KateCommands::CoreCommands::completionObject	(	KTextEditor::View *	view,
		const QString &	cmd
	)			[virtual]

override completionObject from interfaces/document.h .

Implements KTextEditor::CommandExtension.

Definition at line 359 of file katecmds.cpp.

bool KateCommands::CoreCommands::exec	(	class KTextEditor::View *	view,
		const QString &	cmd,
		QString &	errorMsg,
		const KTextEditor::Range &	range = KTextEditor::Range(-1, -0, -1, 0)
	)			[virtual]

execute command on given range

Parameters:

	view	view to use for execution
	cmd	cmd string
	errorMsg	error to return if no success
	rangeStart	first line in range
	rangeEnd	last line in range

Returns:

success

Implements KTextEditor::RangeCommand.

Definition at line 98 of file katecmds.cpp.

bool KateCommands::CoreCommands::exec	(	class KTextEditor::View *	view,
		const QString &	cmd,
		QString &	errorMsg
	)			[virtual]

execute command

Parameters:

	view	view to use for execution
	cmd	cmd string
	errorMsg	error to return if no success

Returns:

success

Implements KTextEditor::Command.

Definition at line 91 of file katecmds.cpp.

virtual void KateCommands::CoreCommands::flagCompletions

(

QStringList &

)

[inline, virtual]

Implements KTextEditor::CommandExtension.

Definition at line 85 of file katecmds.h.

bool KateCommands::CoreCommands::help	(	class KTextEditor::View *	,
		const QString &	,
		QString &
	)			[inline, virtual]

This command does not have help.

See also:

KTextEditor::Command::help

Implements KTextEditor::Command.

Definition at line 72 of file katecmds.h.

virtual void KateCommands::CoreCommands::processText	(	KTextEditor::View *	,
		const QString &
	)			[inline, virtual]

Implements KTextEditor::CommandExtension.

Definition at line 87 of file katecmds.h.

bool KateCommands::CoreCommands::supportsRange

(

const QString &

range

)

[virtual]

Implements KTextEditor::RangeCommand.

Definition at line 348 of file katecmds.cpp.

virtual bool KateCommands::CoreCommands::wantsToProcessText

(

const QString &

)

[inline, virtual]

Implements KTextEditor::CommandExtension.

Definition at line 86 of file katecmds.h.

---

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

• katecmds.h
• katecmds.cpp