stripchart.striptableau.TableauItem

Package stripchart :: Module striptableau :: Class TableauItem

[show private | hide private]

Class TableauItem

Item to go insize a StripTableau widget.

This widget is designed to be placed within a StripTableau widget, to graphically display a single channel of data. Ideally, this widget will not be instantiated directly by the user, but rather indirectly via the StripTableau widget's addChannel method.

Once instantiated the TableauItem associated with some data is returned by both the addChannel and getChannel methods of the StripTableau widget.

The TableauItem has a "metadata" region on the right. This metadata region can display the name of the channel and a close button by default, and optionally a caller-specified component which can display additional information. To make this metadata region visible, the caller should do the following:

Set the metawidth instance variable to an appropriate size (eg: 100).
Set the name of the channel.
(Optional) Set the meta instance variable to a gtk.Widget subclass which is displayed beneath the label and button.

Method Summary
	`__init__(self, data, selection, hadjustment, vadjustment)`
	`__delattr__(self, name)` Delete attributes method.
	`__getattr__(self, name)` Get attributes method.
	`__setattr__(self, name, value)` Set attributes method.
	`__init_gui(self, data, selection, hadjustment, vadjustment)` Does initial GUI setup for the `TableauItem`.
	`__set_meta(self, value)` Sets the meta-component for the widget.
	`__set_name(self, name)` Sets the name of the channel displayed by this `TableauItem`.
	`__setup_minbutton(self)` Sets up the minimize button.

Instance Variable Summary
Sequence type.	`data`: Data displayed by the widget.
`int`	`gradewidth`: Width of the `VGrade` on the left of the widget.
`gtk.Adjustment`	`hadjustment`: Controls the horizontal range of the widget.
`gtk.Widget` subclass.	`meta`: Meta-data component for the `TableauItem`.
`int`	`metawidth`: Width of the meta-data area on the right of the widget.
`gtk.Button`	`minbutton`: Minimize button from the `TableauItem`.
`string`	`name`: Name of the channel.
`float`	`period`: Sampling period.
`gtk.Adjustment`	`selection`: Controls the selection of the widget.
`gtk.Adjustment`	`vadjustment`: Controls the vertical range of the widget.
`gtk.Frame`	`widget`: Read-only pseudo-parent widget.

Method Details

delattr(self, name)

Delete attributes method.

: See Also: __setattr__

getattr(self, name)
(Qualification operator)

Get attributes method.

: See Also: __setattr__

setattr(self, name, value)

Set attributes method.

Note that the only class-local instance variables are widget and chart. All others are stored in the chart instance variable. This allows all the special attributes from ScaledStripChart to propagate into this class with the minimum of effort.

__init_gui(self, data, selection, hadjustment, vadjustment=None)

Does initial GUI setup for the TableauItem.

The important parameters that this method sets up are:

__chart
__metaDataTable

Initially, __metaDataTable has no contents.

__set_meta(self, value)

Sets the meta-component for the widget.

__set_name(self, name)

Sets the name of the channel displayed by this TableauItem.

If name is "", an empty string, then the label is removed from the widget. This method also triggers button addition and removal.

Parameters:: name - Name of the channel.
(type=string)

__setup_minbutton(self)

Sets up the minimize button.

Instance Variable Details

data

Data displayed by the widget. See the StripChart widget for information about valid data objects.

Type:: Sequence type.

gradewidth

Width of the VGrade on the left of the widget.

Type:: int

hadjustment

Controls the horizontal range of the widget.

Type:: gtk.Adjustment

metawidth

Width of the meta-data area on the right of the widget.

Type:: int

minbutton

Minimize button from the TableauItem.

Type:: gtk.Button

name

Name of the channel.

Type:: string

period

Sampling period.

Type:: float

selection

Controls the selection of the widget.

Type:: gtk.Adjustment

vadjustment

Controls the vertical range of the widget.

Type:: gtk.Adjustment

widget

Read-only pseudo-parent widget.

Type:: gtk.Frame

Generated by Epydoc 2.0 on Sat Oct 25 11:04:43 2003

http://epydoc.sf.net