blob: 445fd0d0b603e2c56c0e442e4828b60addd1a6e5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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>
|
