Function: org-fold-get-regions

org-fold-get-regions is a function alias for org-fold-core-get-regions, defined in org-fold-core.el.gz.

Signature

(org-fold-get-regions &key SPECS FROM TO WITH-MARKERS RELATIVE)

Documentation

Find all the folded regions in current buffer.

Each element of the returned list represent folded region boundaries and the folding spec: (BEG END SPEC).

Search folds intersecting with (FROM TO) buffer region if FROM and TO are provided.

If FROM is non-nil and TO is nil, search the folded regions at FROM.

When both FROM and TO are nil, search folded regions in the whole buffer.

When SPECS is non-nil it should be a list of folding specs or a symbol. Only return the matching fold types.

When WITH-MARKERS is non-nil, use markers to represent region boundaries.

When RELATIVE is a buffer position, regions boundaries are given relative to that position. When RELATIVE is t, use FROM as the position. WITH-MARKERS must be nil when RELATIVE is non-nil.

Aliases

org-fold-get-regions