BigBrotherBot v1.8.0
System Development Information for the BigBrotherBot project.

b3::lib::runsnakerun::squaremap::DefaultAdapter Class Reference

Inheritance diagram for b3::lib::runsnakerun::squaremap::DefaultAdapter:
b3::lib::runsnakerun::runsnake::PStatsAdapter b3::lib::runsnakerun::runsnake::DirectoryViewAdapter

List of all members.

Public Member Functions

def children
def value
def label
def overall
def children_sum
def empty
def background_color
def foreground_color
def icon
def parents

Detailed Description

Default adapter class for adapting node-trees to SquareMap API

Member Function Documentation

def b3::lib::runsnakerun::squaremap::DefaultAdapter::background_color (   self,
  node,
  depth 
)
The color to use as background color of the node. 

Reimplemented in b3::lib::runsnakerun::runsnake::PStatsAdapter.

def b3::lib::runsnakerun::squaremap::DefaultAdapter::children (   self,
  node 
)
Retrieve the set of nodes which are children of this node

Reimplemented in b3::lib::runsnakerun::runsnake::DirectoryViewAdapter.

def b3::lib::runsnakerun::squaremap::DefaultAdapter::children_sum (   self,
  children,
  node 
)
Calculate children's total sum
def b3::lib::runsnakerun::squaremap::DefaultAdapter::empty (   self,
  node 
)
Calculate empty space as a fraction of total space

Reimplemented in b3::lib::runsnakerun::runsnake::PStatsAdapter.

def b3::lib::runsnakerun::squaremap::DefaultAdapter::foreground_color (   self,
  node,
  depth 
)
The color to use for the label. 
def b3::lib::runsnakerun::squaremap::DefaultAdapter::icon (   self,
  node,
  isSelected 
)
The icon to display in the node. 
def b3::lib::runsnakerun::squaremap::DefaultAdapter::label (   self,
  node 
)
Return textual description of this node

Reimplemented in b3::lib::runsnakerun::runsnake::PStatsAdapter.

def b3::lib::runsnakerun::squaremap::DefaultAdapter::overall (   self,
  node 
)
Calculate overall size of the node including children and empty space
def b3::lib::runsnakerun::squaremap::DefaultAdapter::parents (   self,
  node 
)
Retrieve/calculate the set of parents for the given node

Reimplemented in b3::lib::runsnakerun::runsnake::PStatsAdapter.

def b3::lib::runsnakerun::squaremap::DefaultAdapter::value (   self,
  node,
  parent = None 
)
Return value used to compare size of this node

Reimplemented in b3::lib::runsnakerun::runsnake::PStatsAdapter.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Properties