docutils.transforms.misc.CallBack Class Reference

Inheritance diagram for docutils.transforms.misc.CallBack:

Collaboration diagram for docutils.transforms.misc.CallBack:

Public Member Functions
	apply (self)
Public Member Functions inherited from docutils.transforms.Transform
	__init__ (self, document, startnode=None)

Static Public Attributes
int	default_priority = 990
Static Public Attributes inherited from docutils.transforms.Transform
	default_priority = None

Additional Inherited Members
Public Attributes inherited from docutils.transforms.Transform
	document
	startnode
	language

Detailed Description

Inserts a callback into a document.  The callback is called when the
transform is applied, which is determined by its priority.

For use with `nodes.pending` elements.  Requires a ``details['callback']``
entry, a bound method or function which takes one parameter: the pending
node.  Other data can be stored in the ``details`` attribute or in the
object hosting the callback method.

Member Function Documentation

apply()

docutils.transforms.misc.CallBack.apply

(

self

)

Override to apply the transform to the document tree.

Reimplemented from docutils.transforms.Transform.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/transforms/misc.py