Yi.Config

Documentation

data UIConfig

Constructors

UIConfig

Fields

configVtyEscDelay :: Int

configFontName :: Maybe String

Font name, for the UI that support it.

configFontSize :: Maybe Int

Font size, for the UI that support it.

configScrollStyle :: Maybe ScrollStyle

Style of scroll

configScrollWheelAmount :: Int

Amount to move the buffer when using the scroll wheel

configLeftSideScrollBar :: Bool

Should the scrollbar be shown on the left side?

configAutoHideScrollBar :: Bool

Hide scrollbar automatically if text fits on one page.

configAutoHideTabBar :: Bool

Hide the tabbar automatically if only one tab is present

configLineWrap :: Bool

Wrap lines at the edge of the window if too long to display.

configCursorStyle :: CursorStyle

configWindowFill :: Char

The char with which to fill empty window space. Usually '~' for vi-like editors, ' ' for everything else.

configTheme :: Theme

UI colours

data CursorStyle

When should we use a "fat" cursor (i.e. 2 pixels wide, rather than 1)? Fat cursors have only been implemented for the Pango frontend.

Constructors

AlwaysFat

NeverFat

FatWhenFocused

FatWhenFocusedAndInserting

configStyle :: UIConfig -> UIStyle

data Config

Configuration record. All Yi hooks can be set here.

Constructors

Config

Fields

startFrontEnd :: UIBoot

UI to use.

configUI :: UIConfig

UI-specific configuration.

startActions :: [Action]

Actions to run when the editor is started.

initialActions :: [Action]

Actions to run after startup (after startActions) or reload.

defaultKm :: KeymapSet

Default keymap to use.

configInputPreprocess :: P Event Event

modeTable :: [AnyMode]

List modes by order of preference.

debugMode :: Bool

Produce a .yi.dbg file with a lot of debug information.

configRegionStyle :: RegionStyle

Set to Exclusive for an emacs-like behaviour.

configKillringAccumulate :: Bool

Set to True for an emacs-like behaviour, where all deleted text is accumulated in a killring.

configCheckExternalChangesObsessively :: Bool

bufferUpdateHandler :: [[Update] -> BufferM ()]

layoutManagers :: [AnyLayoutManager]

List of layout managers for cycleLayoutManagersNext

configVars :: ConfigVariables

Custom configuration, containing the YiConfigVariables. Configure with configVariableA.

Instances

MonadReader Config EditorM

MonadState Config ConfigM

configFundamentalMode :: Config -> AnyMode

configTopLevelKeymap :: Config -> Keymap

type UIBoot = Config -> (Event -> IO ()) -> ([Action] -> IO ()) -> Editor -> IO UI

configVarsA :: T Config ConfigVariables

layoutManagersA :: T Config [AnyLayoutManager]

bufferUpdateHandlerA :: T Config [[Update] -> BufferM ()]

configCheckExternalChangesObsessivelyA :: T Config Bool

configKillringAccumulateA :: T Config Bool

configRegionStyleA :: T Config RegionStyle

debugModeA :: T Config Bool

modeTableA :: T Config [AnyMode]

configInputPreprocessA :: T Config (P Event Event)

defaultKmA :: T Config KeymapSet

initialActionsA :: T Config [Action]

startActionsA :: T Config [Action]

configUIA :: T Config UIConfig

startFrontEndA :: T Config UIBoot

configThemeA :: T UIConfig Theme

configWindowFillA :: T UIConfig Char

configCursorStyleA :: T UIConfig CursorStyle

configLineWrapA :: T UIConfig Bool

configAutoHideTabBarA :: T UIConfig Bool

configAutoHideScrollBarA :: T UIConfig Bool

configLeftSideScrollBarA :: T UIConfig Bool

configScrollWheelAmountA :: T UIConfig Int

configScrollStyleA :: T UIConfig (Maybe ScrollStyle)

configFontSizeA :: T UIConfig (Maybe Int)

configFontNameA :: T UIConfig (Maybe String)

configVtyEscDelayA :: T UIConfig Int