<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> <!-- Scopes/Synopsis/Formatters/HTML/Views/FileListing/FileListing.html --> <!-- this view was generated by Scope --> <head> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"/> <title >Synopsis - Synopsis.Formatters.HTML.Views.FileListing.FileListing</title> <link href="../../../../../../style.css" type="text/css" rel="stylesheet" /> </head> <body class="Scope"> <div class="navigation"> <span class="normal"><a href="../../../../../Synopsis.html" >Global Package</a></span> <span class="normal"><a href="../../../../../../InheritanceTree.html" >Inheritance Tree</a></span> <span class="normal"><a href="../../../../../../InheritanceGraph.html" >Inheritance Graph</a></span> <span class="normal"><a href="../../../../../../NameIndex.html" >Name Index</a></span> </div> <!-- this part was generated by Heading --> <div class="class-module">module <a href="../../../../../Synopsis.html" >Synopsis</a>.<a href="../../../../Formatters.html" >Formatters</a>.<a href="../../../HTML.html" >HTML</a>.<a href="../../Views.html" >Views</a>.<a href="../FileListing.html" >FileListing</a> </div><div class="class-name">class FileListing </div><div class="links"><div class="file">File: <a href="../../../../../../File/Synopsis/Formatters/HTML/Views/FileListing.py.html" target="detail">../Synopsis/Formatters/HTML/Views/FileListing.py</a></div> <div class="xref"><a href="../../../../../../XRef/xref14.html#Synopsis.Formatters.HTML.Views.FileListing.FileListing" ><img src="../../../../../../xref.png" alt="references"/></a></div> <div class="source"><a href="../../../../../../Source/Synopsis/Formatters/HTML/Views/FileListing.py.html#line16" ><img src="../../../../../../src-py.png" alt="source code"/></a></div></div> <img alt="FileListing-inheritance" src="FileListing-inheritance.png" hspace="8" vspace="8" border="0" usemap="#FileListing-inheritance_map" /> <map name="FileListing-inheritance_map"></map> <div class="doc">A view 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 view is created for each file, listing the major declarations for that file, eg: classes, global functions, namespaces, etc.</div> <!-- this part was generated by Summary --> <div class="summary"> <div class="heading">Protected Methods Summary:</div> <div class="item"><div class="synopsis">  <span class="name"><a href="FileListing.html#_node_sorter" >_node_sorter</a></span>(<span class="variable">self</span>, <span class="variable">a</span>, <span class="variable">b</span>) </div> <div class="xref"><a href="../../../../../../XRef/xref14.html#Synopsis.Formatters.HTML.Views.FileListing.FileListing._node_sorter" ><img src="../../../../../../xref.png" alt="references"/></a></div> <div class="source"><a href="../../../../../../Source/Synopsis/Formatters/HTML/Views/FileListing.py.html#line54" ><img src="../../../../../../src-py.png" alt="source code"/></a></div> <div class="doc"></div></div> </div><!-- summary --> <div class="summary"> <div class="heading">Methods Summary:</div> <div class="item"><div class="synopsis">  <a class="name" id="filename">filename</a>(<span class="variable">self</span>) </div> <div class="xref"><a href="../../../../../../XRef/xref14.html#Synopsis.Formatters.HTML.Views.FileListing.FileListing.filename" ><img src="../../../../../../xref.png" alt="references"/></a></div> <div class="source"><a href="../../../../../../Source/Synopsis/Formatters/HTML/Views/FileListing.py.html#line22" ><img src="../../../../../../src-py.png" alt="source code"/></a></div> <div class="doc"></div></div> <div class="item"><div class="synopsis">  <a class="name" id="title">title</a>(<span class="variable">self</span>) </div> <div class="xref"><a href="../../../../../../XRef/xref14.html#Synopsis.Formatters.HTML.Views.FileListing.FileListing.title" ><img src="../../../../../../xref.png" alt="references"/></a></div> <div class="source"><a href="../../../../../../Source/Synopsis/Formatters/HTML/Views/FileListing.py.html#line29" ><img src="../../../../../../src-py.png" alt="source code"/></a></div> <div class="doc"></div></div> <div class="item"><div class="synopsis">  <a class="name" id="root">root</a>(<span class="variable">self</span>) </div> <div class="xref"><a href="../../../../../../XRef/xref14.html#Synopsis.Formatters.HTML.Views.FileListing.FileListing.root" ><img src="../../../../../../xref.png" alt="references"/></a></div> <div class="source"><a href="../../../../../../Source/Synopsis/Formatters/HTML/Views/FileListing.py.html#line33" ><img src="../../../../../../src-py.png" alt="source code"/></a></div> <div class="doc"></div></div> <div class="item"><div class="synopsis">  <span class="name"><a href="FileListing.html#register_filenames" >register_filenames</a></span>(<span class="variable">self</span>) </div> <div class="xref"><a href="../../../../../../XRef/xref14.html#Synopsis.Formatters.HTML.Views.FileListing.FileListing.register_filenames" ><img src="../../../../../../xref.png" alt="references"/></a></div> <div class="source"><a href="../../../../../../Source/Synopsis/Formatters/HTML/Views/FileListing.py.html#line37" ><img src="../../../../../../src-py.png" alt="source code"/></a></div> <div class="doc">Registers a view for each file indexed.</div></div> <div class="item"><div class="synopsis">  <span class="name"><a href="FileListing.html#process" >process</a></span>(<span class="variable">self</span>) </div> <div class="xref"><a href="../../../../../../XRef/xref14.html#Synopsis.Formatters.HTML.Views.FileListing.FileListing.process" ><img src="../../../../../../xref.png" alt="references"/></a></div> <div class="source"><a href="../../../../../../Source/Synopsis/Formatters/HTML/Views/FileListing.py.html#line42" ><img src="../../../../../../src-py.png" alt="source code"/></a></div> <div class="doc"></div></div> <div class="item"><div class="synopsis">  <span class="name"><a href="FileListing.html#process_file_tree_node" >process_file_tree_node</a></span>(<span class="variable">self</span>, <span class="variable">node</span>) </div> <div class="xref"><a href="../../../../../../XRef/xref14.html#Synopsis.Formatters.HTML.Views.FileListing.FileListing.process_file_tree_node" ><img src="../../../../../../xref.png" alt="references"/></a></div> <div class="source"><a href="../../../../../../Source/Synopsis/Formatters/HTML/Views/FileListing.py.html#line64" ><img src="../../../../../../src-py.png" alt="source code"/></a></div> <div class="doc">Creates a portion of the tree for the given file node.</div></div> </div><!-- summary --> <!-- this part was generated by Inheritance --> <!-- this part was generated by Detail --> <div class="detail"> <div class="heading">Protected Methods Details:</div> <div class="item"><div class="synopsis">  <a class="name" id="_node_sorter">_node_sorter</a>(<span class="variable">self</span>, <span class="variable">a</span>, <span class="variable">b</span>) </div> <div class="xref"><a href="../../../../../../XRef/xref14.html#Synopsis.Formatters.HTML.Views.FileListing.FileListing._node_sorter" ><img src="../../../../../../xref.png" alt="references"/></a></div> <div class="source"><a href="../../../../../../Source/Synopsis/Formatters/HTML/Views/FileListing.py.html#line54" ><img src="../../../../../../src-py.png" alt="source code"/></a></div> <div class="doc">Compares file nodes a and b depending on whether they are leaves or not</div></div> </div><!-- detail --> <div class="detail"> <div class="heading">Methods Details:</div> <div class="item"><div class="synopsis">  <a class="name" id="register_filenames">register_filenames</a>(<span class="variable">self</span>) </div> <div class="xref"><a href="../../../../../../XRef/xref14.html#Synopsis.Formatters.HTML.Views.FileListing.FileListing.register_filenames" ><img src="../../../../../../xref.png" alt="references"/></a></div> <div class="source"><a href="../../../../../../Source/Synopsis/Formatters/HTML/Views/FileListing.py.html#line37" ><img src="../../../../../../src-py.png" alt="source code"/></a></div> <div class="doc">Registers a view for each file indexed.</div></div> <div class="item"><div class="synopsis">  <a class="name" id="process">process</a>(<span class="variable">self</span>) </div> <div class="xref"><a href="../../../../../../XRef/xref14.html#Synopsis.Formatters.HTML.Views.FileListing.FileListing.process" ><img src="../../../../../../xref.png" alt="references"/></a></div> <div class="source"><a href="../../../../../../Source/Synopsis/Formatters/HTML/Views/FileListing.py.html#line42" ><img src="../../../../../../src-py.png" alt="source code"/></a></div> <div class="doc">Creates the listing using the recursive process_file_tree_node method</div></div> <div class="item"><div class="synopsis">  <a class="name" id="process_file_tree_node">process_file_tree_node</a>(<span class="variable">self</span>, <span class="variable">node</span>) </div> <div class="xref"><a href="../../../../../../XRef/xref14.html#Synopsis.Formatters.HTML.Views.FileListing.FileListing.process_file_tree_node" ><img src="../../../../../../xref.png" alt="references"/></a></div> <div class="source"><a href="../../../../../../Source/Synopsis/Formatters/HTML/Views/FileListing.py.html#line64" ><img src="../../../../../../src-py.png" alt="source code"/></a></div> <div class="doc">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).</div></div> </div><!-- detail --> <div class="logo">Generated on Thu Apr 16 16:27:10 2009 by <br/> <a href="http://synopsis.fresco.org" target="_blank"><img src="../../../../../../synopsis.png" alt="logo"/> synopsis</a> (version devel)</div> </body> </html>