KateViInputModeManager Class Reference

#include <kateviinputmodemanager.h>

Inheritance diagram for KateViInputModeManager:

Classes
class	Completion

Public Member Functions
	KateViInputModeManager (KateView *view, KateViewInternal *viewInternal)
	~KateViInputModeManager ()
void	addJump (KTextEditor::Cursor cursor)
void	addMark (KateDocument *doc, const QChar &mark, const KTextEditor::Cursor &pos, const bool moveoninsert=true, const bool showmark=true)
void	appendKeyEventToLog (const QKeyEvent &e)
void	changeViMode (ViMode newMode)
void	clearCurrentChangeLog ()
void	doNotLogCurrentKeypress ()
void	feedKeyPresses (const QString &keyPresses) const
void	finishRecordingMacro ()
ViMode	getCurrentViMode () const
KateViModeBase *	getCurrentViModeHandler () const
const QString	getLastSearchPattern () const
KTextEditor::Cursor	getMarkPosition (const QChar &mark) const
QString	getMarksOnTheLine (int line)
KTextEditor::Cursor	getNextJump (KTextEditor::Cursor cursor)
KTextEditor::Cursor	getPrevJump (KTextEditor::Cursor cursor)
bool	getTemporaryNormalMode ()
const QString	getVerbatimKeys () const
KateViInsertMode *	getViInsertMode ()
KateViNormalMode *	getViNormalMode ()
KateViReplaceMode *	getViReplaceMode ()
KateViVisualMode *	getViVisualMode ()
bool	handleKeypress (const QKeyEvent *e)
bool	isHandlingKeypress () const
bool	isRecordingMacro ()
bool	isReplayingLastChange () const
bool	isReplayingMacro ()
KateViKeyMapper *	keyMapper ()
bool	lastSearchBackwards () const
bool	lastSearchCaseSensitive ()
bool	lastSearchPlacesCursorAtEndOfMatch ()
void	logCompletionEvent (const Completion &completion)
Completion	nextLoggedCompletion ()
void	PrintJumpList ()
void	readSessionConfig (const KConfigGroup &config)
void	repeatLastChange ()
void	replayMacro (QChar macroRegister)
void	reset ()
void	setLastSearchBackwards (bool b)
void	setLastSearchCaseSensitive (bool caseSensitive)
void	setLastSearchPattern (const QString &p)
void	setLastSearchPlacesCursorAtEndOfMatch (bool b)
void	setTemporaryNormalMode (bool b)
void	startRecordingMacro (QChar macroRegister)
void	storeLastChangeCommand ()
void	syncViMarksAndBookmarks ()
void	viEnterInsertMode ()
void	viEnterNormalMode ()
void	viEnterReplaceMode ()
void	viEnterVisualMode (ViMode visualMode=VisualMode)
void	writeSessionConfig (KConfigGroup &config)

Static Public Member Functions
static QString	modeToString (ViMode mode)

Detailed Description

Definition at line 68 of file kateviinputmodemanager.h.

Constructor & Destructor Documentation

KateViInputModeManager::KateViInputModeManager	(	KateView *	view,
		KateViewInternal *	viewInternal
	)

Definition at line 50 of file kateviinputmodemanager.cpp.

KateViInputModeManager::~KateViInputModeManager

(

)

Definition at line 103 of file kateviinputmodemanager.cpp.

Member Function Documentation

void KateViInputModeManager::addJump

(

KTextEditor::Cursor

cursor

)

Definition at line 656 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::addMark	(	KateDocument *	doc,
		const QChar &	mark,
		const KTextEditor::Cursor &	pos,
		const bool	moveoninsert = true,
		const bool	showmark = true
	)

Add a mark to the document.

By default, the mark is made visible in the document by highlighting its line, and it moves when inserting text at it.

Parameters

doc	the document to insert the mark into
mark	the mark's name
pos	the mark's position
moveoninsert	whether the mark should move or stay behind when inserting text at it
showmark	whether to highlight the mark's line

Definition at line 725 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::appendKeyEventToLog

(

const QKeyEvent &

e

)

append a QKeyEvent to the key event log

Definition at line 270 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::changeViMode

(

ViMode

newMode

)

changes the current vi mode to the given mode

Definition at line 444 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::clearCurrentChangeLog ( )

inline

clear the key event log

Definition at line 163 of file kateviinputmodemanager.h.

void KateViInputModeManager::doNotLogCurrentKeypress

(

)

Definition at line 410 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::feedKeyPresses

(

const QString &

keyPresses

)

const

feed key the given list of key presses to the key handling code, one by one

Definition at line 171 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::finishRecordingMacro

(

)

Definition at line 333 of file kateviinputmodemanager.cpp.

ViMode KateViInputModeManager::getCurrentViMode

(

)

const

Returns

The current vi mode

Definition at line 449 of file kateviinputmodemanager.cpp.

KateViModeBase * KateViInputModeManager::getCurrentViModeHandler

(

)

const

Returns

one of getViNormalMode(), getViVisualMode(), etc, depending on getCurrentViMode().

Definition at line 454 of file kateviinputmodemanager.cpp.

const QString KateViInputModeManager::getLastSearchPattern

(

)

const

The current search pattern.

This is set by the last search.

Returns

the search pattern or the empty string if not set

Definition at line 421 of file kateviinputmodemanager.cpp.

Cursor KateViInputModeManager::getMarkPosition

(

const QChar &

mark

)

const

Definition at line 769 of file kateviinputmodemanager.cpp.

QString KateViInputModeManager::getMarksOnTheLine

(

int

line

)

Definition at line 852 of file kateviinputmodemanager.cpp.

Cursor KateViInputModeManager::getNextJump

(

KTextEditor::Cursor

cursor

)

Definition at line 675 of file kateviinputmodemanager.cpp.

Cursor KateViInputModeManager::getPrevJump

(

KTextEditor::Cursor

cursor

)

Definition at line 692 of file kateviinputmodemanager.cpp.

bool KateViInputModeManager::getTemporaryNormalMode ( )

inline

Definition at line 229 of file kateviinputmodemanager.h.

const QString KateViInputModeManager::getVerbatimKeys

(

)

const

Definition at line 554 of file kateviinputmodemanager.cpp.

KateViInsertMode * KateViInputModeManager::getViInsertMode

(

)

Returns

the KateViInsertMode instance

Definition at line 539 of file kateviinputmodemanager.cpp.

KateViNormalMode * KateViInputModeManager::getViNormalMode

(

)

Returns

the KateViNormalMode instance

Definition at line 534 of file kateviinputmodemanager.cpp.

KateViReplaceMode * KateViInputModeManager::getViReplaceMode

(

)

Returns

the KateViReplaceMode instance

Definition at line 549 of file kateviinputmodemanager.cpp.

KateViVisualMode * KateViInputModeManager::getViVisualMode

(

)

Returns

the KateViVisualMode instance

Definition at line 544 of file kateviinputmodemanager.cpp.

bool KateViInputModeManager::handleKeypress

(

const QKeyEvent *

e

)

feed key the given key press to the command parser

Returns

true if keypress was is [part of a] command, false otherwise

Definition at line 112 of file kateviinputmodemanager.cpp.

bool KateViInputModeManager::isHandlingKeypress

(

)

const

Determines whether we are currently processing a Vi keypress.

Returns

true if we are still in a call to handleKeypress, false otherwise

Definition at line 265 of file kateviinputmodemanager.cpp.

bool KateViInputModeManager::isRecordingMacro

(

)

Definition at line 340 of file kateviinputmodemanager.cpp.

bool KateViInputModeManager::isReplayingLastChange ( ) const

inline

Returns

true if running replaying the last change due to pressing "."

Definition at line 153 of file kateviinputmodemanager.h.

bool KateViInputModeManager::isReplayingMacro

(

)

Definition at line 368 of file kateviinputmodemanager.cpp.

KateViKeyMapper * KateViInputModeManager::keyMapper

(

)

Definition at line 893 of file kateviinputmodemanager.cpp.

bool KateViInputModeManager::lastSearchBackwards ( ) const

inline

get search direction of last search.

(true if backwards, false if forwards)

Definition at line 214 of file kateviinputmodemanager.h.

bool KateViInputModeManager::lastSearchCaseSensitive ( )

inline

Definition at line 225 of file kateviinputmodemanager.h.

bool KateViInputModeManager::lastSearchPlacesCursorAtEndOfMatch ( )

inline

Definition at line 227 of file kateviinputmodemanager.h.

void KateViInputModeManager::logCompletionEvent

(

const Completion &

completion

)

Definition at line 373 of file kateviinputmodemanager.cpp.

QString KateViInputModeManager::modeToString ( ViMode  mode )

static

convert mode to string representation for user

Parameters

mode	mode enum value

Returns

user visible string

Definition at line 866 of file kateviinputmodemanager.cpp.

KateViInputModeManager::Completion KateViInputModeManager::nextLoggedCompletion

(

)

Definition at line 387 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::PrintJumpList

(

)

Definition at line 710 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::readSessionConfig

(

const KConfigGroup &

config

)

Definition at line 576 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::repeatLastChange

(

)

repeat last change by feeding the contents of m_lastChange to feedKeys()

Definition at line 314 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::replayMacro

(

QChar

macroRegister

)

Definition at line 345 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::reset

(

)

Definition at line 651 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::setLastSearchBackwards ( bool  b )

inline

set search direction of last search.

(true if backwards, false if forwards)

Definition at line 219 of file kateviinputmodemanager.h.

void KateViInputModeManager::setLastSearchCaseSensitive ( bool  caseSensitive )

inline

Definition at line 221 of file kateviinputmodemanager.h.

void KateViInputModeManager::setLastSearchPattern

(

const QString &

p

)

Set the current search pattern.

This is used by the "n" and "N" motions.

Parameters

p	the search pattern

Definition at line 433 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::setLastSearchPlacesCursorAtEndOfMatch ( bool  b )

inline

Definition at line 223 of file kateviinputmodemanager.h.

void KateViInputModeManager::setTemporaryNormalMode ( bool  b )

inline

Definition at line 231 of file kateviinputmodemanager.h.

void KateViInputModeManager::startRecordingMacro

(

QChar

macroRegister

)

Definition at line 322 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::storeLastChangeCommand

(

)

copy the contents of the key events log to m_lastChange so that it can be repeated

Definition at line 278 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::syncViMarksAndBookmarks

(

)

Definition at line 808 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::viEnterInsertMode

(

)

set insert mode to be the active vi mode and perform the needed setup work

Definition at line 499 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::viEnterNormalMode

(

)

set normal mode to be the active vi mode and perform the needed setup work

Definition at line 472 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::viEnterReplaceMode

(

)

set replace mode to be the active vi mode and make the needed setup work

Definition at line 526 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::viEnterVisualMode

(

ViMode

visualMode = VisualMode

)

set visual mode to be the active vi mode and make the needed setup work

Definition at line 514 of file kateviinputmodemanager.cpp.

void KateViInputModeManager::writeSessionConfig

(

KConfigGroup &

config

)

Definition at line 612 of file kateviinputmodemanager.cpp.

---

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

• kateviinputmodemanager.h
• kateviinputmodemanager.cpp