KateCommands::CoreCommands Class Reference

#include <katecmds.h>

Inherits Command, CommandExtension, and RangeCommand.

Public Member Functions
	~CoreCommands ()
const QStringList &	cmds ()
KCompletion *	completionObject (KTextEditor::View *, const QString &)
bool	exec (class KTextEditor::View *view, const QString &cmd, QString &errorMsg)
bool	exec (class KTextEditor::View *view, const QString &cmd, QString &errorMsg, const KTextEditor::Range &range=KTextEditor::Range(-1,-0,-1, 0))
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 &)

Static Public Member Functions
static CoreCommands *	self ()

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 49 of file katecmds.h.

Constructor & Destructor Documentation

KateCommands::CoreCommands::~CoreCommands ( )

inline

Definition at line 56 of file katecmds.h.

Member Function Documentation

const QStringList & KateCommands::CoreCommands::cmds

(

)

supported commands as prefixes

Returns

prefix list

Definition at line 71 of file katecmds.cpp.

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

override completionObject from interfaces/document.h .

Definition at line 509 of file katecmds.cpp.

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

execute command

Parameters

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

Returns

success

Definition at line 221 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)
	)

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

Definition at line 228 of file katecmds.cpp.

virtual void KateCommands::CoreCommands::flagCompletions ( QStringList &  )

inlinevirtual

Definition at line 95 of file katecmds.h.

bool KateCommands::CoreCommands::help	(	class KTextEditor::View *	,
		const QString &	cmd,
		QString &	msg
	)

This command does not have help.

See also

KTextEditor::Command::help

Definition at line 90 of file katecmds.cpp.

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

inlinevirtual

Definition at line 97 of file katecmds.h.

static CoreCommands* KateCommands::CoreCommands::self ( )

inlinestatic

Definition at line 99 of file katecmds.h.

bool KateCommands::CoreCommands::supportsRange

(

const QString &

range

)

Definition at line 498 of file katecmds.cpp.

virtual bool KateCommands::CoreCommands::wantsToProcessText ( const QString &  )

inlinevirtual

Definition at line 96 of file katecmds.h.

---

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

• katecmds.h
• katecmds.cpp