t.m.u.s.Visage(gnome.CanvasGroup) : class documentation

Part of twisted.manhole.ui.spelunk_gnome View Source View In Hierarchy

Known subclasses: twisted.manhole.ui.spelunk_gnome.ClassVisage, twisted.manhole.ui.spelunk_gnome.ImmutableVisage, twisted.manhole.ui.spelunk_gnome.InstanceVisage, twisted.manhole.ui.spelunk_gnome.MappingVisage, twisted.manhole.ui.spelunk_gnome.SequenceVisage

A "face" of an object under exploration.

A Visage is a representation of an object presented to the user. The "face" in "interface".

'propertyLabels' and 'groupLabels' are lists of (key, name) 2-ples, with 'key' being the string the property or group is denoted by in the code, and 'name' being the pretty human-readable string you want me to show on the Visage. These attributes are accumulated from base classes as well.

I am a gnome.CanvasItem (more specifically, CanvasGroup).
Method __init__ Place a new Visage of an explorer in a canvas group.
Method fill_properties Fill in values for my properites.
Method fill_property Set a value for a particular property.
Method fill_attributeGroup Provide members of an attribute group.
Method signal_event Undocumented
Method signal_size_allocate Undocumented
Method signal_destroy Undocumented
Method _setup_table Called by __init__ to set up my main table.
def __init__(self, explorer, rootGroup, canvas): (source)

Place a new Visage of an explorer in a canvas group.

I also need a 'canvas' reference is for certain coordinate conversions, and pygnome doesn't give access to my GtkObject's .canvas attribute. :(
def _setup_table(self): (source)

Called by __init__ to set up my main table.

You can easily override me instead of clobbering __init__.
def fill_properties(self, propValues): (source)

Fill in values for my properites.

Takes a list of (name, value) pairs. 'name' should be one of the keys in my propertyLabels, and 'value' either an Explorer or a string.
def fill_property(self, property, value): (source)

Set a value for a particular property.

'property' should be one of the keys in my propertyLabels.
def fill_attributeGroup(self, group, attributes): (source)

Provide members of an attribute group.

'group' should be one of the keys in my groupLabels, and 'attributes' a list of (name, value) pairs, with each value as either an Explorer or string.
def signal_event(self, widget, event=None): (source)
Undocumented
def signal_size_allocate(self, frame_widget, unusable_allocation, unused_data): (source)
Undocumented
def signal_destroy(self, unused_object, unused_data): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.