FileBrowser: document attributes

This commit is contained in:
Jonathan Daugherty 2018-11-30 16:08:23 -08:00
parent 17730e679c
commit 39d5cc340a

View File

@ -462,33 +462,45 @@ attrForFileType Directory = fileBrowserDirectoryAttr
attrForFileType SymbolicLink = fileBrowserSymbolicLinkAttr attrForFileType SymbolicLink = fileBrowserSymbolicLinkAttr
attrForFileType Socket = fileBrowserSocketAttr attrForFileType Socket = fileBrowserSocketAttr
-- | The base attribute for all file browser attributes.
fileBrowserAttr :: AttrName fileBrowserAttr :: AttrName
fileBrowserAttr = "fileBrowser" fileBrowserAttr = "fileBrowser"
-- | The attribute used for the current directory displayed at the top
-- of the browser.
fileBrowserCurrentDirectoryAttr :: AttrName fileBrowserCurrentDirectoryAttr :: AttrName
fileBrowserCurrentDirectoryAttr = fileBrowserAttr <> "currentDirectory" fileBrowserCurrentDirectoryAttr = fileBrowserAttr <> "currentDirectory"
-- | The attribute used for the entry information displayed at the
-- bottom of the browser.
fileBrowserSelectionInfoAttr :: AttrName fileBrowserSelectionInfoAttr :: AttrName
fileBrowserSelectionInfoAttr = fileBrowserAttr <> "selectionInfo" fileBrowserSelectionInfoAttr = fileBrowserAttr <> "selectionInfo"
-- | The attribute used to render directory entries.
fileBrowserDirectoryAttr :: AttrName fileBrowserDirectoryAttr :: AttrName
fileBrowserDirectoryAttr = fileBrowserAttr <> "directory" fileBrowserDirectoryAttr = fileBrowserAttr <> "directory"
-- | The attribute used to render block device entries.
fileBrowserBlockDeviceAttr :: AttrName fileBrowserBlockDeviceAttr :: AttrName
fileBrowserBlockDeviceAttr = fileBrowserAttr <> "block" fileBrowserBlockDeviceAttr = fileBrowserAttr <> "block"
-- | The attribute used to render regular file entries.
fileBrowserRegularFileAttr :: AttrName fileBrowserRegularFileAttr :: AttrName
fileBrowserRegularFileAttr = fileBrowserAttr <> "regular" fileBrowserRegularFileAttr = fileBrowserAttr <> "regular"
-- | The attribute used to render character device entries.
fileBrowserCharacterDeviceAttr :: AttrName fileBrowserCharacterDeviceAttr :: AttrName
fileBrowserCharacterDeviceAttr = fileBrowserAttr <> "char" fileBrowserCharacterDeviceAttr = fileBrowserAttr <> "char"
-- | The attribute used to render named pipe entries.
fileBrowserNamedPipeAttr :: AttrName fileBrowserNamedPipeAttr :: AttrName
fileBrowserNamedPipeAttr = fileBrowserAttr <> "pipe" fileBrowserNamedPipeAttr = fileBrowserAttr <> "pipe"
-- | The attribute used to render symbolic link entries.
fileBrowserSymbolicLinkAttr :: AttrName fileBrowserSymbolicLinkAttr :: AttrName
fileBrowserSymbolicLinkAttr = fileBrowserAttr <> "symlink" fileBrowserSymbolicLinkAttr = fileBrowserAttr <> "symlink"
-- | The attribute used to render Unix socket entries.
fileBrowserSocketAttr :: AttrName fileBrowserSocketAttr :: AttrName
fileBrowserSocketAttr = fileBrowserAttr <> "socket" fileBrowserSocketAttr = fileBrowserAttr <> "socket"