yi-0.6.2.3: The Haskell-Scriptable Editor Source code Contents Index

Yi.MiniBuffer

Synopsis

spawnMinibufferE :: String -> KeymapEndo -> EditorM BufferRef withMinibufferFree :: String -> (String -> YiM ()) -> YiM () withMinibuffer :: String -> (String -> YiM [String]) -> (String -> YiM ()) -> YiM () withMinibufferGen :: String -> (String -> YiM [String]) -> String -> (String -> YiM String) -> (String -> YiM ()) -> YiM () withMinibufferFin :: String -> [String] -> (String -> YiM ()) -> YiM () 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] anyModeByNameM :: String -> YiM (Maybe AnyMode) anyModeName :: AnyMode -> String newtype t ::: doc = Doc { fromDoc :: t } data LineNumber data RegexTag data FilePatternTag data ToKill newtype CommandArguments = CommandArguments [String]

Documentation

spawnMinibufferE :: String -> KeymapEndo -> EditorM BufferRef Source

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 () Source

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

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 ()) -> YiM () Source

withMinibufferGen proposal getHint prompt completer 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.

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

Open a minibuffer, given a finite number of suggestions.

noHint :: String -> YiM [String] Source

noPossibilities :: String -> YiM [String] Source

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

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

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

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

anyModeByName :: String -> YiM AnyMode Source

getAllModeNames :: YiM [String] Source

matchingBufferNames :: String -> YiM [String] Source

Returns all the buffer names.

anyModeByNameM :: String -> YiM (Maybe AnyMode) Source

anyModeName :: AnyMode -> String Source

newtype t ::: doc Source

Tag a type with a documentation Constructors Doc fromDoc :: t Instances Typeable2 ::: Eq t => Eq (::: t doc) Num t => Num (::: t doc) Show x => Show (::: x t) IsString t => IsString (::: t doc) (DocType doc, Promptable t) => Promptable (::: t doc)

data LineNumber Source

Instances DocType LineNumber

data RegexTag Source

Instances Typeable RegexTag DocType RegexTag

data FilePatternTag Source

Instances Typeable FilePatternTag DocType FilePatternTag

data ToKill Source

Instances DocType ToKill

newtype CommandArguments Source

Constructors CommandArguments [String] Instances Typeable CommandArguments Promptable CommandArguments

Produced by Haddock version 2.6.1