KTextEditor::RangeCommand Class Reference

#include <commandinterface.h>

Public Member Functions
virtual	~RangeCommand ()
virtual bool	exec (KTextEditor::View *view, const QString &cmd, QString &msg, const KTextEditor::Range &range)=0
virtual bool	supportsRange (const QString &cmd)=0

Detailed Description

Extension interface for a Command making the exec method take a line range.

Introduction

The RangeCommand extension extends the Command interface by making it possible to send a range to a command indicating that it should only do its work on those lines.

The method supportsRange() takes a QString reference and should return true if the given command name supports a range and false if not.

See also

KTextEditor::CommandInterface, KTextEditor::Command, KTextEditor::Range

Author

Erlend Hamberg <ehamb.nosp@m.erg@.nosp@m.gmail.nosp@m..com>

Since

4.2

Note

KDE5: merge with KTextEditor::Command?

Definition at line 306 of file commandinterface.h.

Constructor & Destructor Documentation

virtual KTextEditor::RangeCommand::~RangeCommand ( )

inlinevirtual

Virtual destructor.

Definition at line 312 of file commandinterface.h.

Member Function Documentation

virtual bool KTextEditor::RangeCommand::exec ( KTextEditor::View *  view, const QString &  cmd, QString &  msg, const KTextEditor::Range &  range  )

pure virtual

Execute the command for the given range on the given view and cmd string.

Return the success value and a msg for status.

Returns

true on success, otherwise false

virtual bool KTextEditor::RangeCommand::supportsRange ( const QString &  cmd )

pure virtual

Find out if a given command can act on a range.

This is used for checking if a command should be called when the user also gave a range or if an error should be raised.

Returns

true if command supports acting on a range of lines, false if not

---

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

• commandinterface.h