File: org-fold.el.html

This file contains code handling temporary invisibility (folding and unfolding) of text in org buffers.

The folding is implemented using generic org-fold-core library. This file contains org-specific implementation of the folding. Also, various useful functions from org-fold-core are aliased under shorted org-fold prefix.

The following features are implemented:
- Folding/unfolding various Org mode elements and regions of Org buffers:
  + Region before first heading;
  + Org headings, their text, children (subtree), siblings, parents, etc;
  + Org blocks and drawers
- Revealing Org structure around invisible point location
- Revealing folded Org elements broken by user edits

Defined variables (4)

org-fold-catch-invisible-editsCheck if in invisible region before inserting or deleting a character.
org-fold-catch-invisible-edits-commandsAlist of commands where Org checks for invisible edits.
org-fold-reveal-start-hookHook run before revealing a location.
org-fold-show-context-detailAlist between context and visibility span when revealing a location.

Defined functions (49)

org-fold--advice-edit-commands()
org-fold--extend-changed-region(FROM TO)
org-fold--hide-drawers(BEGIN END)
org-fold--hide-wrapper-toggle(ELEMENT CATEGORY FORCE NO-ERROR)
org-fold--isearch-reveal(POS)
org-fold--reveal-drawer-or-block-maybe(REGION SPEC)
org-fold--reveal-headline-at-point()
org-fold--reveal-outline-maybe(REGION _)
org-fold-add-folding-spec(SPEC &optional PROPERTIES BUFFER APPEND)
org-fold-check-before-invisible-edit(KIND)
org-fold-check-before-invisible-edit-maybe(&rest _)
org-fold-flag-above-first-heading(&optional ARG)
org-fold-folded-p(&optional POS SPEC-OR-ALIAS)
org-fold-folding-spec-p(SPEC-OR-ALIAS)
org-fold-get-folding-spec(&optional SPEC-OR-ALIAS POM)
org-fold-get-folding-specs-in-region(BEG END)
org-fold-get-region-at-point(&optional SPEC-OR-ALIAS POM)
org-fold-get-regions
org-fold-heading(FLAG &optional ENTRY)
org-fold-hide-archived-subtrees(BEG END)
org-fold-hide-block-all()
org-fold-hide-block-toggle(&optional FORCE NO-ERROR ELEMENT)
org-fold-hide-drawer-all(&optional BEGIN END)
org-fold-hide-drawer-toggle(&optional FORCE NO-ERROR ELEMENT)
org-fold-hide-entry()
org-fold-hide-sublevels(LEVELS)
org-fold-hide-subtree()
org-fold-initialize(ELLIPSIS)
org-fold-next-folding-state-change(&optional SPEC-OR-ALIAS POS LIMIT PREVIOUS-P)
org-fold-next-visibility-change(&optional POS LIMIT IGNORE-HIDDEN-P PREVIOUS-P)
org-fold-previous-folding-state-change(&optional SPEC-OR-ALIAS POS LIMIT)
org-fold-previous-visibility-change(&optional POS LIMIT IGNORE-HIDDEN-P)
org-fold-region(FROM TO FLAG &optional SPEC-OR-ALIAS)
org-fold-regions
org-fold-remove-folding-spec(SPEC &optional BUFFER)
org-fold-reveal(&optional SIBLINGS)
org-fold-save-outline-visibility(USE-MARKERS &rest BODY)
org-fold-search-forward(SPEC-OR-ALIAS &optional LIMIT)
org-fold-show-all(&optional TYPES)
org-fold-show-branches()
org-fold-show-branches-buffer()
org-fold-show-children(&optional LEVEL)
org-fold-show-context(&optional KEY)
org-fold-show-entry(&optional HIDE-DRAWERS)
org-fold-show-hidden-entry(&optional ARG1)
org-fold-show-set-visibility(DETAIL)
org-fold-show-siblings()
org-fold-show-subtree()
org-fold-subtree(FLAG)

Defined faces (0)