summaryrefslogtreecommitdiff
path: root/htdocs/docs/man/FS/UI
diff options
context:
space:
mode:
authorivan <ivan>2001-04-23 12:40:31 +0000
committerivan <ivan>2001-04-23 12:40:31 +0000
commitf3235d39d083518d47f21cd5585e5f9a13070763 (patch)
treeeb1dbbe21e2bee5b92586c884bfc6025c5d035fe /htdocs/docs/man/FS/UI
parentece31063b782031e21ba1f57476afab555af5363 (diff)
documentation and webdemo updates
Diffstat (limited to 'htdocs/docs/man/FS/UI')
-rw-r--r--htdocs/docs/man/FS/UI/Base.html133
-rw-r--r--htdocs/docs/man/FS/UI/CGI.html133
-rw-r--r--htdocs/docs/man/FS/UI/Gtk.html127
-rw-r--r--htdocs/docs/man/FS/UI/agent.html16
4 files changed, 183 insertions, 226 deletions
diff --git a/htdocs/docs/man/FS/UI/Base.html b/htdocs/docs/man/FS/UI/Base.html
index 7823090f6..96c60847d 100644
--- a/htdocs/docs/man/FS/UI/Base.html
+++ b/htdocs/docs/man/FS/UI/Base.html
@@ -1,116 +1,99 @@
<HTML>
<HEAD>
<TITLE>FS::UI::Base - Base class for all user-interface objects</TITLE>
-<LINK REV="made" HREF="mailto:none">
+<LINK REV="made" HREF="mailto:perl@packages.debian.org">
</HEAD>
<BODY>
+<A NAME="__index__"></A>
<!-- INDEX BEGIN -->
<UL>
- <LI><A HREF="#NAME">NAME</A>
- <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
- <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
- <LI><A HREF="#METHODS">METHODS</A>
- <LI><A HREF="#VERSION">VERSION</A>
- <LI><A HREF="#BUGS">BUGS</A>
- <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
- <LI><A HREF="#HISTORY">HISTORY</A>
+ <LI><A HREF="#name">NAME</A></LI>
+ <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
+ <LI><A HREF="#description">DESCRIPTION</A></LI>
+ <LI><A HREF="#methods">METHODS</A></LI>
+ <LI><A HREF="#version">VERSION</A></LI>
+ <LI><A HREF="#bugs">BUGS</A></LI>
+ <LI><A HREF="#see also">SEE ALSO</A></LI>
+ <LI><A HREF="#history">HISTORY</A></LI>
</UL>
<!-- INDEX END -->
<HR>
<P>
-<H1><A NAME="NAME">NAME</A></H1>
-<P>
-FS::UI::Base - Base class for all user-interface objects
-
+<H1><A NAME="name">NAME</A></H1>
+<P>FS::UI::Base - Base class for all user-interface objects</P>
<P>
<HR>
-<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
-<P>
-<PRE> use FS::UI::SomeInterface;
- use FS::UI::some_table;
-</PRE>
-<P>
-<PRE> $interface = new FS::UI::some_table;
-</PRE>
-<P>
-<PRE> $error = $interface-&gt;browse;
+<H1><A NAME="synopsis">SYNOPSIS</A></H1>
+<PRE>
+ use FS::UI::SomeInterface;
+ use FS::UI::some_table;</PRE>
+<PRE>
+ $interface = new FS::UI::some_table;</PRE>
+<PRE>
+ $error = $interface-&gt;browse;
$error = $interface-&gt;search;
$error = $interface-&gt;view;
$error = $interface-&gt;edit;
- $error = $interface-&gt;process;
-</PRE>
+ $error = $interface-&gt;process;</PRE>
<P>
<HR>
-<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
-<P>
-An FS::UI::Base object represents a user interface object. FS::UI::Base is
-intended as a base class for table-specfic classes to inherit from, i.e.
-FS::UI::cust_main. The simplest case, which will provide a default UI for
-your new table, is as follows:
-
-<P>
-<PRE> package FS::UI::table_name;
+<H1><A NAME="description">DESCRIPTION</A></H1>
+<P>An FS::UI::Base object represents a user interface object. FS::UI::Base
+is intended as a base class for table-specfic classes to inherit from, i.e.
+FS::UI::cust_main. The simplest case, which will provide a default UI for your
+new table, is as follows:</P>
+<PRE>
+ package FS::UI::table_name;
use vars qw ( @ISA );
use FS::UI::Base;
@ISA = qw( FS::UI::Base );
- sub db_table { 'table_name'; }
-</PRE>
-<P>
-Currently available interfaces are: FS::UI::Gtk, an X-Windows UI
-implemented using the Gtk+ toolkit FS::UI::CGI, a web interface implemented
-using CGI.pm, etc.
-
+ sub db_table { 'table_name'; }</PRE>
+<P>Currently available interfaces are:
+ FS::UI::Gtk, an X-Windows UI implemented using the Gtk+ toolkit
+ FS::UI::CGI, a web interface implemented using CGI.pm, etc.</P>
<P>
<HR>
-<H1><A NAME="METHODS">METHODS</A></H1>
+<H1><A NAME="methods">METHODS</A></H1>
<DL>
-<DT><STRONG><A NAME="item_new">new</A></STRONG><DD>
-<DT><STRONG><A NAME="item_browse">browse</A></STRONG><DD>
-<DT><STRONG><A NAME="item_title">title</A></STRONG><DD>
-<DT><STRONG><A NAME="item_addwidget">addwidget</A></STRONG><DD>
+<DT><STRONG><A NAME="item_new">new</A></STRONG><BR>
+<DD>
+<DT><STRONG><A NAME="item_browse">browse</A></STRONG><BR>
+<DD>
+<DT><STRONG><A NAME="item_title">title</A></STRONG><BR>
+<DD>
+<DT><STRONG><A NAME="item_addwidget">addwidget</A></STRONG><BR>
+<DD>
</DL>
<P>
<HR>
-<H1><A NAME="VERSION">VERSION</A></H1>
-<P>
-$Id: Base.html,v 1.2 2000-03-03 18:22:44 ivan Exp $
-
+<H1><A NAME="version">VERSION</A></H1>
+<P>$Id: Base.html,v 1.3 2001-04-23 12:40:31 ivan Exp $</P>
<P>
<HR>
-<H1><A NAME="BUGS">BUGS</A></H1>
-<P>
-This documentation is incomplete.
-
-<P>
-There should be some sort of per-(freeside)-user preferences and the
-ability for specific FS::UI:: modules to put their own values there as
-well.
-
+<H1><A NAME="bugs">BUGS</A></H1>
+<P>This documentation is incomplete.</P>
+<P>There should be some sort of per-(freeside)-user preferences and the ability
+for specific FS::UI:: modules to put their own values there as well.</P>
<P>
<HR>
-<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
-<P>
-<A HREF="../../FS/UI/Gtk.html">FS::UI::Gtk</A>, <A HREF="../../FS/UI/CGI.html">FS::UI::CGI</A>
-
-
-
+<H1><A NAME="see also">SEE ALSO</A></H1>
+<P><A HREF="../.././FS/UI/Gtk.html">the FS::UI::Gtk manpage</A>, <A HREF="../.././FS/UI/CGI.html">the FS::UI::CGI manpage</A></P>
<P>
<HR>
-<H1><A NAME="HISTORY">HISTORY</A></H1>
-<P>
-$Log: Base.html,v $
-Revision 1.2 2000-03-03 18:22:44 ivan
-changes from 1.2.3 release, fixes from webdemo
- Revision 1.1 1999/08/04 09:03:53 ivan initial checkin of
-module files for proper perl installation
-
-<P>
-Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code.
+<H1><A NAME="history">HISTORY</A></H1>
+<P>$Log: Base.html,v $
+<P>Revision 1.3 2001-04-23 12:40:31 ivan
+<P>documentation and webdemo updates
+<P>
+Revision 1.1 1999/08/04 09:03:53 ivan
+initial checkin of module files for proper perl installation</P>
+<P>Revision 1.1 1999/01/20 09:30:36 ivan
+skeletal cross-UI UI code.</P>
</BODY>
diff --git a/htdocs/docs/man/FS/UI/CGI.html b/htdocs/docs/man/FS/UI/CGI.html
index 69bff5671..49991f1aa 100644
--- a/htdocs/docs/man/FS/UI/CGI.html
+++ b/htdocs/docs/man/FS/UI/CGI.html
@@ -1,114 +1,93 @@
<HTML>
<HEAD>
<TITLE>FS::UI::CGI - Base class for CGI user-interface objects</TITLE>
-<LINK REV="made" HREF="mailto:none">
+<LINK REV="made" HREF="mailto:perl@packages.debian.org">
</HEAD>
<BODY>
+<A NAME="__index__"></A>
<!-- INDEX BEGIN -->
<UL>
- <LI><A HREF="#NAME">NAME</A>
- <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
- <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
- <LI><A HREF="#METHODS">METHODS</A>
- <LI><A HREF="#VERSION">VERSION</A>
- <LI><A HREF="#BUGS">BUGS</A>
- <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
- <LI><A HREF="#HISTORY">HISTORY</A>
+ <LI><A HREF="#name">NAME</A></LI>
+ <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
+ <LI><A HREF="#description">DESCRIPTION</A></LI>
+ <LI><A HREF="#methods">METHODS</A></LI>
+ <LI><A HREF="#version">VERSION</A></LI>
+ <LI><A HREF="#bugs">BUGS</A></LI>
+ <LI><A HREF="#see also">SEE ALSO</A></LI>
+ <LI><A HREF="#history">HISTORY</A></LI>
</UL>
<!-- INDEX END -->
<HR>
<P>
-<H1><A NAME="NAME">NAME</A></H1>
-<P>
-FS::UI::CGI - Base class for CGI user-interface objects
-
+<H1><A NAME="name">NAME</A></H1>
+<P>FS::UI::CGI - Base class for CGI user-interface objects</P>
<P>
<HR>
-<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
-<P>
-<PRE> use FS::UI::CGI;
- use FS::UI::some_table;
-</PRE>
-<P>
-<PRE> $interface = new FS::UI::some_table;
-</PRE>
-<P>
-<PRE> $error = $interface-&gt;browse;
+<H1><A NAME="synopsis">SYNOPSIS</A></H1>
+<PRE>
+ use FS::UI::CGI;
+ use FS::UI::some_table;</PRE>
+<PRE>
+ $interface = new FS::UI::some_table;</PRE>
+<PRE>
+ $error = $interface-&gt;browse;
$error = $interface-&gt;search;
$error = $interface-&gt;view;
$error = $interface-&gt;edit;
- $error = $interface-&gt;process;
-</PRE>
+ $error = $interface-&gt;process;</PRE>
<P>
<HR>
-<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
-<P>
-An FS::UI::CGI object represents a CGI interface object.
-
+<H1><A NAME="description">DESCRIPTION</A></H1>
+<P>An FS::UI::CGI object represents a CGI interface object.</P>
<P>
<HR>
-<H1><A NAME="METHODS">METHODS</A></H1>
+<H1><A NAME="methods">METHODS</A></H1>
<DL>
-<DT><STRONG><A NAME="item_new">new</A></STRONG><DD>
-<DT><STRONG><A NAME="item__header">_header</A></STRONG><DD>
-<DT><STRONG><A NAME="item__footer">_footer</A></STRONG><DD>
-<DT><STRONG><A NAME="item_interface">interface</A></STRONG><DD>
-<P>
-Returns the string `CGI'. Useful for the author of a table-specific UI
-class to conditionally specify certain behaviour.
-
-</DL>
+<DT><STRONG><A NAME="item_new">new</A></STRONG><BR>
+<DD>
+<DT><STRONG><A NAME="item__header">_header</A></STRONG><BR>
+<DD>
+<DT><STRONG><A NAME="item__footer">_footer</A></STRONG><BR>
+<DD>
+<DT><STRONG><A NAME="item_interface">interface</A></STRONG><BR>
+<DD>
+Returns the string `CGI'. Useful for the author of a table-specific UI class
+to conditionally specify certain behaviour.
+<P></P></DL>
<P>
<HR>
-<H1><A NAME="VERSION">VERSION</A></H1>
-<P>
-$Id: CGI.html,v 1.2 2000-03-03 18:22:44 ivan Exp $
-
+<H1><A NAME="version">VERSION</A></H1>
+<P>$Id: CGI.html,v 1.3 2001-04-23 12:40:31 ivan Exp $</P>
<P>
<HR>
-<H1><A NAME="BUGS">BUGS</A></H1>
-<P>
-This documentation is incomplete.
-
-<P>
-In _Tableborder, headers should be links that sort on their fields.
-
-<P>
-_Link uses a constant <CODE>$BASE_URL</CODE>
-
-<P>
-_Link passes the arguments as a manually-constructed GET string instead of
-POSTing, for compatability while the web interface is upgraded. Once this
-is done it should pass arguements properly (i.e. as a POST, 8-bit clean)
-
-<P>
-Still some small bits of widget code same as FS::UI::Gtk.
-
+<H1><A NAME="bugs">BUGS</A></H1>
+<P>This documentation is incomplete.</P>
+<P>In _Tableborder, headers should be links that sort on their fields.</P>
+<P>_Link uses a constant $BASE_URL</P>
+<P>_Link passes the arguments as a manually-constructed GET string instead
+of POSTing, for compatability while the web interface is upgraded. Once
+this is done it should pass arguements properly (i.e. as a POST, 8-bit clean)</P>
+<P>Still some small bits of widget code same as FS::UI::Gtk.</P>
<P>
<HR>
-<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
-<P>
-<A HREF="../../FS/UI/Base.html">FS::UI::Base</A>
-
-
-
+<H1><A NAME="see also">SEE ALSO</A></H1>
+<P><A HREF="../.././FS/UI/Base.html">the FS::UI::Base manpage</A></P>
<P>
<HR>
-<H1><A NAME="HISTORY">HISTORY</A></H1>
-<P>
-$Log: CGI.html,v $
-Revision 1.2 2000-03-03 18:22:44 ivan
-changes from 1.2.3 release, fixes from webdemo
- Revision 1.1 1999/08/04 09:03:53 ivan initial checkin of
-module files for proper perl installation
-
-<P>
-Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code.
+<H1><A NAME="history">HISTORY</A></H1>
+<P>$Log: CGI.html,v $
+<P>Revision 1.3 2001-04-23 12:40:31 ivan
+<P>documentation and webdemo updates
+<P>
+Revision 1.1 1999/08/04 09:03:53 ivan
+initial checkin of module files for proper perl installation</P>
+<P>Revision 1.1 1999/01/20 09:30:36 ivan
+skeletal cross-UI UI code.</P>
</BODY>
diff --git a/htdocs/docs/man/FS/UI/Gtk.html b/htdocs/docs/man/FS/UI/Gtk.html
index 3328e9746..24d620087 100644
--- a/htdocs/docs/man/FS/UI/Gtk.html
+++ b/htdocs/docs/man/FS/UI/Gtk.html
@@ -1,111 +1,90 @@
<HTML>
<HEAD>
<TITLE>FS::UI::Gtk - Base class for Gtk user-interface objects</TITLE>
-<LINK REV="made" HREF="mailto:none">
+<LINK REV="made" HREF="mailto:perl@packages.debian.org">
</HEAD>
<BODY>
+<A NAME="__index__"></A>
<!-- INDEX BEGIN -->
<UL>
- <LI><A HREF="#NAME">NAME</A>
- <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
- <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
- <LI><A HREF="#METHODS">METHODS</A>
- <LI><A HREF="#VERSION">VERSION</A>
- <LI><A HREF="#BUGS">BUGS</A>
- <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
- <LI><A HREF="#HISTORY">HISTORY</A>
+ <LI><A HREF="#name">NAME</A></LI>
+ <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
+ <LI><A HREF="#description">DESCRIPTION</A></LI>
+ <LI><A HREF="#methods">METHODS</A></LI>
+ <LI><A HREF="#version">VERSION</A></LI>
+ <LI><A HREF="#bugs">BUGS</A></LI>
+ <LI><A HREF="#see also">SEE ALSO</A></LI>
+ <LI><A HREF="#history">HISTORY</A></LI>
</UL>
<!-- INDEX END -->
<HR>
<P>
-<H1><A NAME="NAME">NAME</A></H1>
-<P>
-FS::UI::Gtk - Base class for Gtk user-interface objects
-
+<H1><A NAME="name">NAME</A></H1>
+<P>FS::UI::Gtk - Base class for Gtk user-interface objects</P>
<P>
<HR>
-<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
-<P>
-<PRE> use FS::UI::Gtk;
- use FS::UI::some_table;
-</PRE>
-<P>
-<PRE> $interface = new FS::UI::some_table;
-</PRE>
-<P>
-<PRE> $error = $interface-&gt;browse;
+<H1><A NAME="synopsis">SYNOPSIS</A></H1>
+<PRE>
+ use FS::UI::Gtk;
+ use FS::UI::some_table;</PRE>
+<PRE>
+ $interface = new FS::UI::some_table;</PRE>
+<PRE>
+ $error = $interface-&gt;browse;
$error = $interface-&gt;search;
$error = $interface-&gt;view;
$error = $interface-&gt;edit;
- $error = $interface-&gt;process;
-</PRE>
+ $error = $interface-&gt;process;</PRE>
<P>
<HR>
-<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
-<P>
-An FS::UI::Gtk object represents a Gtk user interface object.
-
+<H1><A NAME="description">DESCRIPTION</A></H1>
+<P>An FS::UI::Gtk object represents a Gtk user interface object.</P>
<P>
<HR>
-<H1><A NAME="METHODS">METHODS</A></H1>
+<H1><A NAME="methods">METHODS</A></H1>
<DL>
-<DT><STRONG><A NAME="item_new">new</A></STRONG><DD>
-<DT><STRONG><A NAME="item_interface">interface</A></STRONG><DD>
-<P>
-Returns the string `Gtk'. Useful for the author of a table-specific UI
-class to conditionally specify certain behaviour.
-
-</DL>
+<DT><STRONG><A NAME="item_new">new</A></STRONG><BR>
+<DD>
+<DT><STRONG><A NAME="item_interface">interface</A></STRONG><BR>
+<DD>
+Returns the string `Gtk'. Useful for the author of a table-specific UI class
+to conditionally specify certain behaviour.
+<P></P></DL>
<P>
<HR>
-<H1><A NAME="VERSION">VERSION</A></H1>
-<P>
-$Id: Gtk.html,v 1.2 2000-03-03 18:22:44 ivan Exp $
-
+<H1><A NAME="version">VERSION</A></H1>
+<P>$Id: Gtk.html,v 1.3 2001-04-23 12:40:31 ivan Exp $</P>
<P>
<HR>
-<H1><A NAME="BUGS">BUGS</A></H1>
-<P>
-This documentation is incomplete.
-
-<P>
-_Tableborder is just a _Table now. _Tableborders should scroll (but not the
-headers) and need and need more decoration. (data in white section ala
-gtksql and sliding field widths) headers should be buttons that callback to
-sort on their fields.
-
-<P>
-There should be a persistant, per-(freeside)-user store for window
-positions and sizes and sort fields etc (see <A HREF="../../FS/UI/CGI.html#BUGS">BUGS</A>.
-
-<P>
-Still some small bits of widget code same as FS::UI::CGI.
-
+<H1><A NAME="bugs">BUGS</A></H1>
+<P>This documentation is incomplete.</P>
+<P>_Tableborder is just a _Table now. _Tableborders should scroll (but not the
+headers) and need and need more decoration. (data in white section ala gtksql
+and sliding field widths) headers should be buttons that callback to sort on
+their fields.</P>
+<P>There should be a persistant, per-(freeside)-user store for window positions
+and sizes and sort fields etc (see <A HREF="../.././FS/UI/CGI.html#bugs">BUGS in the FS::UI::CGI manpage</A>.</P>
+<P>Still some small bits of widget code same as FS::UI::CGI.</P>
<P>
<HR>
-<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
-<P>
-<A HREF="../../FS/UI/Base.html">FS::UI::Base</A>
-
-
-
+<H1><A NAME="see also">SEE ALSO</A></H1>
+<P><A HREF="../.././FS/UI/Base.html">the FS::UI::Base manpage</A></P>
<P>
<HR>
-<H1><A NAME="HISTORY">HISTORY</A></H1>
-<P>
-$Log: Gtk.html,v $
-Revision 1.2 2000-03-03 18:22:44 ivan
-changes from 1.2.3 release, fixes from webdemo
- Revision 1.1 1999/08/04 09:03:53 ivan initial checkin of
-module files for proper perl installation
-
-<P>
-Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code.
+<H1><A NAME="history">HISTORY</A></H1>
+<P>$Log: Gtk.html,v $
+<P>Revision 1.3 2001-04-23 12:40:31 ivan
+<P>documentation and webdemo updates
+<P>
+Revision 1.1 1999/08/04 09:03:53 ivan
+initial checkin of module files for proper perl installation</P>
+<P>Revision 1.1 1999/01/20 09:30:36 ivan
+skeletal cross-UI UI code.</P>
</BODY>
diff --git a/htdocs/docs/man/FS/UI/agent.html b/htdocs/docs/man/FS/UI/agent.html
index e69de29bb..8608e4ef4 100644
--- a/htdocs/docs/man/FS/UI/agent.html
+++ b/htdocs/docs/man/FS/UI/agent.html
@@ -0,0 +1,16 @@
+<HTML>
+<HEAD>
+<TITLE>./FS/FS/UI/agent.pm</TITLE>
+<LINK REV="made" HREF="mailto:perl@packages.debian.org">
+</HEAD>
+
+<BODY>
+
+<A NAME="__index__"></A>
+<!-- INDEX BEGIN -->
+<!-- INDEX END -->
+
+
+</BODY>
+
+</HTML>