Modules | Files | Inheritance Tree | Inheritance Graph | Name Index | Config
module Synopsis::Formatter::HTML::FileListing
class FileListing
Files: Synopsis/Formatter/HTML/FileListing.py
FileListing-inheritance

A page that creates an index of files, and an index for each file. First the index of files is created, intended for the top-left frame. Second a page is created for each file, listing the major declarations for that file, eg: classes, global functions, namespaces, etc.


Operations Summary:
 __init__(self, manager) [Source]
 filename(self)
Returns the filename [Source]
 title(self)
Returns the title [Source]
 register(self)
Registers this page for the top-left frame [Source]
 register_filenames(self, start)
Registers a page for each file indexed [Source]
 process(self, start)
Creates the listing using the recursive processFileTreeNode method [Source]
 _node_sorter(self, a, b)
Compares file nodes a and b depending on whether they are leaves or not [Source]
 processFileTreeNode(self, node)
Creates a portion of the tree for the given file node. [Source]

Operation Details:
  processFileTreeNode(self, node)

Creates a portion of the tree for the given file node. This method assumes that the file is already in progress, and just appends to it. This method is recursive, calling itself for each child of node (file or directory).