/ 
Zoidberg-0.1b-unstable
River stage zero No dependents
/ Zoidberg::Fish

NAME

Zoidberg::Fish - Base class for loadable Zoidberg plugins

SYNOPSIS

package My::Dynamic::ZoidPlugin
use base 'Zoidberg::Fish';

DESCRIPTION

Base class for loadable Zoidberg plugins has many stubs
to provide compatability with Zoidberg

Ones this base class is used your module looks and smells
like fish -- Zoidberg WILL eat it.

See other (?) documentation on how to load these objects
in Zoidberg.

EXPORT

None by default.

METHODS

new($parent, \%config, $zoid_name)

$self->{parent} a reference to parent Zoidberg object
$self->{config} hash with some config
$self->{zoid_name} name as known by parent object

init()

To be overloaded, should be called by parent object.
Do things like loading files here.

parent()

returns ref to parent

print()

calls parent->print

config()

return ref to config

event($event_name, @_)

is called by parent when event is broadcasted

broadcast_event($event_name, @_)

calls parent->broadcast_event

register_event($event_name)

register self by parent for event $event_name
this means that when this event occurs
$self->event is called

unregister_event($event_name)

unregister self for event $event_name

unregister_all_events()

unregister self for event all events

registered_events()

list events self is registered for

help()

Stub help function, should return string
with dynamic content for the zoidberg help system.

round_up()

Is called when parent wants to stop
or when sudden DESTROY occurs
To be overloaded, do things like saving files here

AUTHOR

R.L. Zwart, <carlos@caremail.nl>

Copyright (c) 2002 Raoul L. Zwart. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

Zoidberg

Zoidberg::Help

http://zoidberg.sourceforge.net