Yi.MiniBuffer

Documentation

spawnMinibufferE :: String -> KeymapEndo -> EditorM BufferRef

Open a minibuffer window with the given prompt and keymap The third argument is an action to perform after the minibuffer is opened such as move to the first occurence of a searched for string. If you don't need this just supply return ()

withMinibufferFree :: String -> (String -> YiM ()) -> YiM ()

withMinibuffer :: String -> (String -> YiM [String]) -> (String -> YiM ()) -> YiM ()

withMinibuffer prompt completer act: open a minibuffer with prompt. Once a string s is obtained, run act s. completer can be used to complete functions: it returns a list of possible matches.

withMinibufferGen :: String -> (String -> YiM [String]) -> String -> (String -> YiM String) -> (String -> YiM ()) -> (String -> YiM ()) -> YiM ()

withMinibufferGen proposal getHint prompt completer onTyping act: open a minibuffer with prompt, and initial content proposal. Once a string s is obtained, run act s. completer can be used to complete inputs by returning an incrementally better match, and getHint can give an immediate feedback to the user on the current input.

on Typing is an extra action which will fire with every user key-press and receives minibuffer contents. Use something like const $ return () if you don't need this.

withMinibufferFin :: String -> [String] -> (String -> YiM ()) -> YiM ()

Open a minibuffer, given a finite number of suggestions.

noHint :: String -> YiM [String]

noPossibilities :: String -> YiM [String]

mkCompleteFn :: (String -> (String -> Maybe String) -> [String] -> EditorM String) -> (String -> String -> Maybe String) -> (String -> YiM [String]) -> String -> YiM String

simpleComplete :: (String -> YiM [String]) -> String -> YiM String

infixComplete :: (String -> YiM [String]) -> String -> YiM String

infixComplete' :: Bool -> (String -> YiM [String]) -> String -> YiM String

anyModeByName :: String -> YiM AnyMode

getAllModeNames :: YiM [String]

matchingBufferNames :: String -> YiM [String]

Returns all the buffer names.

anyModeByNameM :: String -> YiM (Maybe AnyMode)

anyModeName :: AnyMode -> String

newtype t ::: doc

Tag a type with a documentation

Constructors

Doc

Fields

fromDoc :: t

Instances

Eq t => Eq ((:::) t doc)

Num t => Num ((:::) t doc)

Show x => Show ((:::) x t)

IsString t => IsString ((:::) t doc)

Typeable (* -> * -> *) (:::)

data LineNumber

data RegexTag

Instances

Typeable * RegexTag

data FilePatternTag

Instances

Typeable * FilePatternTag

data ToKill

newtype CommandArguments

Constructors

CommandArguments [String]

Instances

Typeable * CommandArguments