ocempgui.access.IIndexable.IIndexable

Package ocempgui :: Package access :: Module IIndexable :: Class IIndexable

[show private | hide private]

Type IIndexable

object --+
         |
        IIndexable

IIndexable () -> IIndexable

Abstract class providing methods for easy navigation.

The IIndexable interface class provides a minimal method set, a class should implement to allow easy navigation through objects.

Objects can be added to the indexing system using the add_index() method and be removed by the counterpart remove_index().

To cycle through the objects, the switch_index() method has to be implemented by an inheriting class. This causes - dependant on the implementation - another object to get the navigation focus (preferably the next object in the logical index list).

Method Summary
	`add_index(self, *objects)` I.add_index (...) -> None
	`remove_index(self, *objects)` I.remove_index (...) -> None
	`switch_index(self)` I.switch_index () -> None
	`update_index(self, *objects)` I.update_index () -> None
Inherited from object
	`__init__(...)` x.__init__(...) initializes x; see x.__class__.__doc__ for signature
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Method Details

add_index(self, *objects)

I.add_index (...) -> None

Adds one or more objects to the indexing system.

This method has to be implemented by inherited classes.

remove_index(self, *objects)

I.remove_index (...) -> None

Removes one or more objects from the indexing system.

This method has to be implemented by inherited classes.

switch_index(self)

I.switch_index () -> None

Passes the input focus to another object from the list.

This method has to be implemented by inherited classes.

update_index(self, *objects)

I.update_index () -> None

Updates the index for one or more objects.

This method has to be implemented by inherited classes.

Generated by Epydoc 2.1 on Thu Jan 10 10:18:44 2008

http://epydoc.sf.net