freeplane_tools.base.BaseNode : API documentation

class documentation

class BaseNode(object):

Base Node Class.

Method	`__init__`	Initialize Node Class.
Instance Variable	`tag`	Beautiful Soup Tag.
Instance Variable	`text`	Node Text.
Instance Variable	`link`	Node text (if it exists).
Instance Variable	`depth`	Node depth in hierachy of Mindmap.
Property	`note`	Node "note" Property
Property	`list_depth`	Return integer representing the depth of the node in the mindmap tree.
Property	`flags`	Custom attribute flags for the node (see FLAG_*).
Method	`list_format`	How to format list elements when parents have the FLAG_LIST attribute set.
Method	`img_link`	Return a link that has IMG_EXTS in the link text.
Property	`has_img_link`	Return true if a node link ends in a value from IMG_EXTS.
Property	`toc_entry`	Return the nodes TOC entry.
Method	`format`	Abstract for the node format.
Property	`_toc_name`	Abstract table of contents name.

def __init__(self, tag):

Initialize Node Class.

Parameters tag Undocumented (type: Tag)

tag =

Beautiful Soup Tag.

text =

Node Text.

link =

Node text (if it exists).

depth =

Node depth in hierachy of Mindmap.

@property
note =

Node "note" Property

This iterates through the html inside the note and strips the start padding

@property
list_depth =

Return integer representing the depth of the node in the mindmap tree.

@property
flags =

Custom attribute flags for the node (see FLAG_*).

def list_format(self):

How to format list elements when parents have the FLAG_LIST attribute set.

def img_link(self, desc=None):

Return a link that has IMG_EXTS in the link text.

@property
has_img_link =

Return true if a node link ends in a value from IMG_EXTS.

@property
_toc_name =

overridden in freeplane_tools.bitbucket.BitBucketNode, freeplane_tools.github.GithubNode

Abstract table of contents name.

@property
toc_entry =

Return the nodes TOC entry.

def format(self):

overridden in freeplane_tools.bitbucket.BitBucketNode, freeplane_tools.github.GithubNode

Abstract for the node format.

API Documentation for freeplane_tools, generated by pydoctor 21.2.2 at 1996-06-17 15:00:00.