diff options
Diffstat (limited to 'httemplate/docs/man/FS/UI')
| -rw-r--r-- | httemplate/docs/man/FS/UI/Base.html | 100 | ||||
| -rw-r--r-- | httemplate/docs/man/FS/UI/CGI.html | 94 | ||||
| -rw-r--r-- | httemplate/docs/man/FS/UI/Gtk.html | 91 | ||||
| -rw-r--r-- | httemplate/docs/man/FS/UI/agent.html | 16 |
4 files changed, 301 insertions, 0 deletions
diff --git a/httemplate/docs/man/FS/UI/Base.html b/httemplate/docs/man/FS/UI/Base.html new file mode 100644 index 000000000..445fd0d0b --- /dev/null +++ b/httemplate/docs/man/FS/UI/Base.html @@ -0,0 +1,100 @@ +<HTML> +<HEAD> +<TITLE>FS::UI::Base - Base class for all user-interface objects</TITLE> +<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> + <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</P> +<P> +<HR> +<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->browse; + $error = $interface->search; + $error = $interface->view; + $error = $interface->edit; + $error = $interface->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; + 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.</P> +<P> +<HR> +<H1><A NAME="methods">METHODS</A></H1> +<DL> +<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.3 2002-01-29 17:42:46 ivan Exp $</P> +<P> +<HR> +<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">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 $ +<P>Revision 1.3 2002-01-29 17:42:46 ivan +<P>weight, plan and plandata fields in part_bill_event +<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> + +</HTML> diff --git a/httemplate/docs/man/FS/UI/CGI.html b/httemplate/docs/man/FS/UI/CGI.html new file mode 100644 index 000000000..22b6c76b8 --- /dev/null +++ b/httemplate/docs/man/FS/UI/CGI.html @@ -0,0 +1,94 @@ +<HTML> +<HEAD> +<TITLE>FS::UI::CGI - Base class for CGI user-interface objects</TITLE> +<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> + <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</P> +<P> +<HR> +<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->browse; + $error = $interface->search; + $error = $interface->view; + $error = $interface->edit; + $error = $interface->process;</PRE> +<P> +<HR> +<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> +<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.3 2002-01-29 17:42:46 ivan Exp $</P> +<P> +<HR> +<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">the FS::UI::Base manpage</A></P> +<P> +<HR> +<H1><A NAME="history">HISTORY</A></H1> +<P>$Log: CGI.html,v $ +<P>Revision 1.3 2002-01-29 17:42:46 ivan +<P>weight, plan and plandata fields in part_bill_event +<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> + +</HTML> diff --git a/httemplate/docs/man/FS/UI/Gtk.html b/httemplate/docs/man/FS/UI/Gtk.html new file mode 100644 index 000000000..6f203c7bb --- /dev/null +++ b/httemplate/docs/man/FS/UI/Gtk.html @@ -0,0 +1,91 @@ +<HTML> +<HEAD> +<TITLE>FS::UI::Gtk - Base class for Gtk user-interface objects</TITLE> +<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> + <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</P> +<P> +<HR> +<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->browse; + $error = $interface->search; + $error = $interface->view; + $error = $interface->edit; + $error = $interface->process;</PRE> +<P> +<HR> +<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> +<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.3 2002-01-29 17:42:46 ivan Exp $</P> +<P> +<HR> +<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">the FS::UI::Base manpage</A></P> +<P> +<HR> +<H1><A NAME="history">HISTORY</A></H1> +<P>$Log: Gtk.html,v $ +<P>Revision 1.3 2002-01-29 17:42:46 ivan +<P>weight, plan and plandata fields in part_bill_event +<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> + +</HTML> diff --git a/httemplate/docs/man/FS/UI/agent.html b/httemplate/docs/man/FS/UI/agent.html new file mode 100644 index 000000000..8608e4ef4 --- /dev/null +++ b/httemplate/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> |