Node:The tree-buffer-API, Next:Do not with tree-buffer, Previous:Tree-buffer keybindings, Up:tree-buffer

All functions available for tree-buffers and tree-nodes

This chapter lists the complete AI available for tree-buffers and tree-nodes.

IMPORTANT: These are the only functions and macros of tree-buffer.el you are allowed to use for programming with tree-buffers and tree-nodes. If you use other - not here listed - functions, macros or variables of tree-buffer.el then you run the risk of unwanted side-effects or program-behaviors!

The API for a tree-buffer:

See the documentation of these functions (e.g. via C-h f) to get the details how to use it.

• tree-buffer-add-image-icon-maybe
• tree-buffer-find-image
• tree-buffer-create¹
• tree-buffer-defpopup-command
• tree-buffer-destroy²
• tree-buffer-empty-p
• tree-buffer-expand-node
• tree-buffer-get-node-at-point
• tree-buffer-node-data-equal-p
• tree-buffer-recenter
• tree-buffer-highlight-node-data
• tree-buffer-remove-highlight
• tree-buffer-remove-node
• tree-buffer-clear-tree
• tree-buffer-displayed-nodes-copy
• tree-buffer-search-displayed-node-list
• tree-buffer-number-of-displayed-nodes
• tree-buffer-get-data-store
• tree-buffer-set-data-store
• tree-buffer-get-root
• tree-buffer-set-root
• tree-buffer-update
• tree-buffer-update-node

The API for a tree-node

See the documentation of these functions (e.g. via C-h f) to get the details how to use it.

• tree-node-add-children
• tree-node-linelength
• tree-node-new
• tree-node-new-root
• tree-node-remove-child
• tree-node-remove-child-by-data
• tree-node-find-child-by-data
• tree-node-find-child-by-name
• tree-node-search-subtree-by-data
• tree-node-sort-children
• tree-node-toggle-expanded

In addition to these functions the tree-node API contains all accessors for a tree-node which are described in A new tree-node.

Footnotes

1. If the tree-buffer should be used by ECB then you must use defecb-tree-buffer-creator - see the documentation!

2. Not needed when defecb-tree-buffer-creator has been used for creation.