acme.textui.ACMEContainerConfigurations.ACMEConfigurationTree

class documentation

class ACMEConfigurationTree(TextualTree):

Constructor: ACMEConfigurationTree(*args, **kwargs)

View In Hierarchy

Configurations view for the ACME text UI.

Method __init__ Constructor.
Method on_mount Called when the widget is mounted to the app.
Method on_show Called when the widget is shown.
Method on_tree_node_highlighted Called when a node is highlighted. Show the documentation for the node.
Instance Variable parentContainer The parent container.
Instance Variable prefixLen The length of the prefix.
Method _showDocumentation Show the documentation for a topic.
Instance Variable _app A reference to the text UI application.
def __init__(self, *args: Any, **kwargs: Any):

Constructor.

An extra parameter "parentContainer" is added to the constructor.

Parameters
*args:AnyVariable length argument list.
**kwargs:AnyArbitrary keyword arguments.
def on_mount(self):

Called when the widget is mounted to the app.

def on_show(self):

Called when the widget is shown.

def on_tree_node_highlighted(self, node: TextualTree.NodeHighlighted):

Called when a node is highlighted. Show the documentation for the node.

Parameters
node:TextualTree.NodeHighlightedThe node.
parentContainer: ACMEContainerConfigurations =

The parent container.

prefixLen: int =

The length of the prefix.

def _showDocumentation(self, topic: str):

Show the documentation for a topic.

Parameters
topic:strThe topic.
_app =

A reference to the text UI application.