3 <TITLE>FS::UI::Base - Base class for all user-interface objects</TITLE>
4 <LINK REV="made" HREF="mailto:none">
13 <LI><A HREF="#NAME">NAME</A>
14 <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
15 <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
16 <LI><A HREF="#METHODS">METHODS</A>
17 <LI><A HREF="#VERSION">VERSION</A>
18 <LI><A HREF="#BUGS">BUGS</A>
19 <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
20 <LI><A HREF="#HISTORY">HISTORY</A>
26 <H1><A NAME="NAME">NAME</A></H1>
28 FS::UI::Base - Base class for all user-interface objects
32 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
34 <PRE> use FS::UI::SomeInterface;
35 use FS::UI::some_table;
38 <PRE> $interface = new FS::UI::some_table;
41 <PRE> $error = $interface->browse;
42 $error = $interface->search;
43 $error = $interface->view;
44 $error = $interface->edit;
45 $error = $interface->process;
49 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
51 An FS::UI::Base object represents a user interface object. FS::UI::Base is
52 intended as a base class for table-specfic classes to inherit from, i.e.
53 FS::UI::cust_main. The simplest case, which will provide a default UI for
54 your new table, is as follows:
57 <PRE> package FS::UI::table_name;
60 @ISA = qw( FS::UI::Base );
61 sub db_table { 'table_name'; }
64 Currently available interfaces are: FS::UI::Gtk, an X-Windows UI
65 implemented using the Gtk+ toolkit FS::UI::CGI, a web interface implemented
70 <H1><A NAME="METHODS">METHODS</A></H1>
72 <DT><STRONG><A NAME="item_new">new</A></STRONG><DD>
73 <DT><STRONG><A NAME="item_browse">browse</A></STRONG><DD>
74 <DT><STRONG><A NAME="item_title">title</A></STRONG><DD>
75 <DT><STRONG><A NAME="item_addwidget">addwidget</A></STRONG><DD>
79 <H1><A NAME="VERSION">VERSION</A></H1>
81 $Id: Base.html,v 1.2 2000-03-03 18:22:44 ivan Exp $
85 <H1><A NAME="BUGS">BUGS</A></H1>
87 This documentation is incomplete.
90 There should be some sort of per-(freeside)-user preferences and the
91 ability for specific FS::UI:: modules to put their own values there as
96 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
98 <A HREF="../../FS/UI/Gtk.html">FS::UI::Gtk</A>, <A HREF="../../FS/UI/CGI.html">FS::UI::CGI</A>
104 <H1><A NAME="HISTORY">HISTORY</A></H1>
107 Revision 1.2 2000-03-03 18:22:44 ivan
108 changes from 1.2.3 release, fixes from webdemo
109 Revision 1.1 1999/08/04 09:03:53 ivan initial checkin of
110 module files for proper perl installation
113 Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code.