Inherits from NSObject
Declared in ViMap.h

Overview

A mapping of a key sequence to an editor action, macro or Nu expression.

New mappings are created in a ViMap.

Constants

Map flags

  • ViMapSetsDot: This command sets the dot command
  • ViMapNeedMotion: This command needs a following motion command (ie, it’s an operator)
  • ViMapIsMotion: This is a motion command
  • ViMapLineMode: This command operates on whole lines
  • ViMapNeedArgument: This command needs a following character argument

Tasks

Getting mapping attributes

Properties

action

The editor action.

@property (nonatomic, readonly) SEL action

Declared In

ViMap.h

expression

@property (nonatomic, readonly) NuBlock *expression

Declared In

ViMap.h

keySequence

An array of NSNumbers that make up the key sequence.

@property (nonatomic, readonly) NSArray *keySequence

Declared In

ViMap.h

keyString

A string describing the key sequence.

@property (nonatomic, readonly) NSString *keyString

Declared In

ViMap.h

macro

A key string describing the keys that make up the macro.

@property (nonatomic, readonly) NSString *macro

Declared In

ViMap.h

parameter

Any parameter that should be passed to the command.

@property (nonatomic, readonly) id parameter

Declared In

ViMap.h

recursive

YES if this macro should be evaluated recursively.

@property (nonatomic, readonly) BOOL recursive

Declared In

ViMap.h

scopeSelector

The scope this mapping applies to.

@property (nonatomic, readonly) NSString *scopeSelector

Declared In

ViMap.h

Instance Methods

isAction

YES if the mapping is an editor action.

- (BOOL)isAction

Declared In

ViMap.h

isExpression

YES if the mapping is a Nu expression.

- (BOOL)isExpression

Declared In

ViMap.h

isLineMode

YES if the mapping is an editor action that works on whole lines.

- (BOOL)isLineMode

Declared In

ViMap.h

isMacro

YES if the mapping is a macro.

- (BOOL)isMacro

Declared In

ViMap.h

isMotion

YES if the mapping is a motion action.

- (BOOL)isMotion

Declared In

ViMap.h

isOperator

YES if the mapping is an operator action that requires a motion component.

- (BOOL)isOperator

Declared In

ViMap.h

needsArgument

YES if the mapping is an editor action that needs a character argument, like the vi f command.

- (BOOL)needsArgument

Declared In

ViMap.h