.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Zoidberg::Fish 3"
.TH Zoidberg::Fish 3 "2008-01-12" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Zoidberg::Fish \- Base class for loadable Zoidberg plugins
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  package My_Zoid_Plugin;
\&  use base 'Zoidberg::Fish';
.Ve
.PP
.Vb 1
\&  FIXME some example code
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Once this base class is used your module smells like fish \*(-- Zoidberg \s-1WILL\s0 eat it.
It supplies stub methods for hooks and has some routines to simplefy the interface to
Zoidberg. One should realize that the bases of a plugin is not the module but
the config file. Any module can be used as plugin as long as it's properly configged.
The \fBdeveloper manual\fR should describe this in more detail.
.PP
\&\s-1FIXME\s0 update the above text
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP """new($shell, $zoidname)""" 4
.el .IP "\f(CWnew($shell, $zoidname)\fR" 4
.IX Item "new($shell, $zoidname)"
Simple constructor that bootstraps same attributes. When your module smells like fish
Zoidberg will give it's constructor two arguments, a reference to itself and the name by
which your module is identified. From this all other config can be deducted.
.Sp
.Vb 1
\&        # Default attributes created by this constructor:
.Ve
.Sp
.Vb 4
\&        $self->{shell}     # a reference to the parent Zoidberg object
\&        $self->{zoidname}  # name by which your module is identified
\&        $self->{settings}  # reference to hash with global settings
\&        $self->{config}    # hash with plugin specific config
.Ve
.ie n .IP """init()""" 4
.el .IP "\f(CWinit()\fR" 4
.IX Item "init()"
To be overloaded, will be called directly after the constructor. 
Do things you normally do in the constructor like loading files, opening sockets 
or setting defaults here.
.ie n .IP """config()""" 4
.el .IP "\f(CWconfig()\fR" 4
.IX Item "config()"
.PD 0
.ie n .IP """shell()""" 4
.el .IP "\f(CWshell()\fR" 4
.IX Item "shell()"
.PD
These methods return a reference to the attributes by the same name.
.ie n .IP """plug()""" 4
.el .IP "\f(CWplug()\fR" 4
.IX Item "plug()"
A stub doing absolutely nothing, but by calling it from
a dispatch table the plugin is loaded.
.ie n .IP """unplug()""" 4
.el .IP "\f(CWunplug()\fR" 4
.IX Item "unplug()"
Removes this plugin from the various dispatchtables, and deletes the object.
.ie n .IP """broadcast($event_name, @_)""" 4
.el .IP "\f(CWbroadcast($event_name, @_)\fR" 4
.IX Item "broadcast($event_name, @_)"
Broadcast an event to whoever might be listening.
.ie n .IP """add_events({ event => sub { .. } })""" 4
.el .IP "\f(CWadd_events({ event => sub { .. } })\fR" 4
.IX Item "add_events({ event => sub { .. } })"
.PD 0
.ie n .IP """add_events(qw/event1 event2/)""" 4
.el .IP "\f(CWadd_events(qw/event1 event2/)\fR" 4
.IX Item "add_events(qw/event1 event2/)"
.PD
Used to add new event hooks.
In the second form the events are hooked to call the likely
named subroutine in the current object.
.ie n .IP """wipe_events(qw/event1 event2/)""" 4
.el .IP "\f(CWwipe_events(qw/event1 event2/)\fR" 4
.IX Item "wipe_events(qw/event1 event2/)"
Removes an event. Wipes the stacks for the named events
of all routines belonging to this plugin.
.ie n .IP """add_commands({ command => sub { .. } })""" 4
.el .IP "\f(CWadd_commands({ command => sub { .. } })\fR" 4
.IX Item "add_commands({ command => sub { .. } })"
.PD 0
.ie n .IP """add_commands(qw/command1 command2/)""" 4
.el .IP "\f(CWadd_commands(qw/command1 command2/)\fR" 4
.IX Item "add_commands(qw/command1 command2/)"
.PD
Used to add new builtin commands.
In the second form the commands are hooked to call the likely
named subroutine in the current object.
.ie n .IP """wipe_commands(qw/command1 command2/)""" 4
.el .IP "\f(CWwipe_commands(qw/command1 command2/)\fR" 4
.IX Item "wipe_commands(qw/command1 command2/)"
Removes a command. Wipes the stacks for the named commands
of all routines belonging to this plugin.
.ie n .IP """add_expansion(regex_ref ="" sub { ... })>" 4
.el .IP "\f(CWadd_expansion(regex_ref =\fR sub { ... })>" 4
.IX Item "add_expansion(regex_ref = sub { ... })>"
\&\s-1TODO\s0
.ie n .IP """wipe_expansions()""" 4
.el .IP "\f(CWwipe_expansions()\fR" 4
.IX Item "wipe_expansions()"
\&\s-1TODO\s0
.ie n .IP """add_context(%config)""" 4
.el .IP "\f(CWadd_context(%config)\fR" 4
.IX Item "add_context(%config)"
See man zoiddevel(1) for the context configuration details.
.ie n .IP """ask($question, $default)""" 4
.el .IP "\f(CWask($question, $default)\fR" 4
.IX Item "ask($question, $default)"
Get interactive input. The default is optional.
If the default is either 'Y' or 'N' a boolean value is returned.
.ie n .IP """round_up()""" 4
.el .IP "\f(CWround_up()\fR" 4
.IX Item "round_up()"
Is called when the plugin is unloaded or when a sudden \s-1DESTROY\s0 occurs.
To be overloaded, do things like saving files or closing sockets here.
.SH "AUTHOR"
.IX Header "AUTHOR"
R.L. Zwart, <rlzwart@cpan.org>
.PP
Jaap Karssenberg || Pardus [Larus] <pardus@cpan.org>
.PP
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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Zoidberg,
Zoidberg::Shell,
Zoidberg::Utils,
<http://zoidberg.sourceforge.net>