File: tabulated-list.el.html

This file defines Tabulated List mode, a generic major mode for displaying lists of tabulated data, intended for other major modes to inherit from. It provides several utility routines, e.g. for pretty-printing lines of tabulated data to fit into the appropriate columns.

For usage information, see the documentation of tabulated-list-mode.

This package originated from Tom Tromey's Package Menu mode, extended and generalized to be used by other modes.

Defined variables (18)

tabulated-list--header-stringHolds the header if ‘tabulated-list-use-header-line’ is nil.
tabulated-list-entriesEntries displayed in the current Tabulated List buffer.
tabulated-list-formatThe format of the current Tabulated List mode buffer.
tabulated-list-groupsGroups displayed in the current Tabulated List buffer.
tabulated-list-gui-sort-indicator-ascIndicator for columns sorted in ascending order, for GUI frames.
tabulated-list-gui-sort-indicator-descIndicator for columns sorted in descending order, for GUI frames.
tabulated-list-mode-abbrev-tableAbbrev table for ‘tabulated-list-mode’.
tabulated-list-mode-hookHook run after entering ‘tabulated-list-mode’.
tabulated-list-mode-mapLocal keymap for ‘tabulated-list-mode’ buffers.
tabulated-list-mode-syntax-tableSyntax table for ‘tabulated-list-mode’.
tabulated-list-paddingNumber of characters preceding each Tabulated List mode entry.
tabulated-list-printerFunction for inserting a Tabulated List entry at point.
tabulated-list-revert-hookHook run before reverting a Tabulated List buffer.
tabulated-list-sort-button-mapLocal keymap for ‘tabulated-list-mode’ sort buttons.
tabulated-list-sort-keySort key for the current Tabulated List mode buffer.
tabulated-list-tty-sort-indicator-ascIndicator for columns sorted in ascending order, for text-mode frames.
tabulated-list-tty-sort-indicator-descIndicator for columns sorted in ascending order, for text-mode frames.
tabulated-list-use-header-lineWhether the Tabulated List buffer should use a header line.

Defined functions (34)

tabulated-list--available-space(WIDTH N)
tabulated-list--col-local-max-widths(COL)
tabulated-list--column-number(NAME)
tabulated-list--get-sorter()
tabulated-list--sort-by-column-name(NAME)
tabulated-list-clear-all-tags()
tabulated-list-col-sort(&optional E)
tabulated-list-delete-entry()
tabulated-list-get-entry(&optional POS)
tabulated-list-get-id(&optional POS)
tabulated-list-groups(ENTRIES METADATA)
tabulated-list-groups-categorize(ENTRIES PATH-FUNCTION)
tabulated-list-groups-flatten(TREE)
tabulated-list-groups-sort(TREE SORT-FUNCTION &optional LEVEL)
tabulated-list-header-overlay-p(&optional POS)
tabulated-list-init-header()
tabulated-list-line-number-width()
tabulated-list-make-glyphless-char-display-table()
tabulated-list-mode()
tabulated-list-narrow-current-column(&optional N)
tabulated-list-next-column(&optional ARG)
tabulated-list-previous-column(&optional ARG)
tabulated-list-print(&optional REMEMBER-POS UPDATE)
tabulated-list-print-col(N COL-DESC X)
tabulated-list-print-entries(ENTRIES SORTER UPDATE ENTRY-ID)
tabulated-list-print-entry(ID COLS)
tabulated-list-print-fake-header()
tabulated-list-put-tag(TAG &optional ADVANCE)
tabulated-list-revert(&rest IGNORED)
tabulated-list-set-col(COL DESC &optional CHANGE-ENTRY-DATA)
tabulated-list-sort(&optional N)
tabulated-list-watch-line-number-width(WINDOW)
tabulated-list-widen-current-column(&optional N)
tabulated-list-window-scroll-function(WINDOW START)

Defined faces (1)

tabulated-list-fake-headerFace used on fake header lines.