From 2c816f314a8f3cc46e72e31f34ed97b4e11d0449 Mon Sep 17 00:00:00 2001 From: ivan Date: Wed, 4 Aug 1999 12:13:27 +0000 Subject: new HTML manpages --- htdocs/docs/man/FS/UI/Base.html | 117 +++++++++++++++++++++++++++++++++++++++ htdocs/docs/man/FS/UI/CGI.html | 115 ++++++++++++++++++++++++++++++++++++++ htdocs/docs/man/FS/UI/Gtk.html | 112 +++++++++++++++++++++++++++++++++++++ htdocs/docs/man/FS/UI/agent.html | 0 4 files changed, 344 insertions(+) create mode 100644 htdocs/docs/man/FS/UI/Base.html create mode 100644 htdocs/docs/man/FS/UI/CGI.html create mode 100644 htdocs/docs/man/FS/UI/Gtk.html create mode 100644 htdocs/docs/man/FS/UI/agent.html (limited to 'htdocs/docs/man/FS/UI') diff --git a/htdocs/docs/man/FS/UI/Base.html b/htdocs/docs/man/FS/UI/Base.html new file mode 100644 index 000000000..91a4df64d --- /dev/null +++ b/htdocs/docs/man/FS/UI/Base.html @@ -0,0 +1,117 @@ + + +FS::UI::Base - Base class for all user-interface objects + + + + + + + +

+ + +

NAME

+FS::UI::Base - Base class for all user-interface objects + +

SYNOPSIS

  use FS::UI::SomeInterface;
+  use FS::UI::some_table;
+

  $interface = new FS::UI::some_table;
+

  $error = $interface->browse;
+  $error = $interface->search;
+  $error = $interface->view;
+  $error = $interface->edit;
+  $error = $interface->process;
+

DESCRIPTION

+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: + +

  package FS::UI::table_name;
+  use vars qw ( @ISA );
+  use FS::UI::Base;
+  @ISA = qw( FS::UI::Base );
+  sub db_table { 'table_name'; }
+

+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. + +

METHODS

new: +
browse: +
title: +
addwidget: +

VERSION

+$Id: Base.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+This documentation is incomplete. + +

+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. + +

HISTORY

+$Log: Base.html,v $ +Revision 1.1 1999-08-04 12:13:27 ivan +new HTML manpages + Revision 1.1 1999/08/04 09:03:53 ivan initial checkin of +module files for proper perl installation + +

+Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code. + + + + diff --git a/htdocs/docs/man/FS/UI/CGI.html b/htdocs/docs/man/FS/UI/CGI.html new file mode 100644 index 000000000..c3efdc746 --- /dev/null +++ b/htdocs/docs/man/FS/UI/CGI.html @@ -0,0 +1,115 @@ + + +FS::UI::CGI - Base class for CGI user-interface objects + + + + + + + +

NAME +
SYNOPSIS +
DESCRIPTION +
METHODS +
VERSION +
BUGS +
SEE ALSO +
HISTORY +

+ + +

NAME

+FS::UI::CGI - Base class for CGI user-interface objects + +

SYNOPSIS

  use FS::UI::CGI;
+  use FS::UI::some_table;
+

  $interface = new FS::UI::some_table;
+

  $error = $interface->browse;
+  $error = $interface->search;
+  $error = $interface->view;
+  $error = $interface->edit;
+  $error = $interface->process;
+

DESCRIPTION

+An FS::UI::CGI object represents a CGI interface object. + +

METHODS

new: +
_header: +
_footer: +
interface: +
+Returns the string `CGI'. Useful for the author of a table-specific UI +class to conditionally specify certain behaviour. + +

VERSION

+$Id: CGI.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+This documentation is incomplete. + +

+In _Tableborder, headers should be links that sort on their fields. + +

+_Link uses a constant $BASE_URL + +

+_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) + +

+Still some small bits of widget code same as FS::UI::Gtk. + +

HISTORY

+$Log: CGI.html,v $ +Revision 1.1 1999-08-04 12:13:27 ivan +new HTML manpages + Revision 1.1 1999/08/04 09:03:53 ivan initial checkin of +module files for proper perl installation + +

+Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code. + + + + diff --git a/htdocs/docs/man/FS/UI/Gtk.html b/htdocs/docs/man/FS/UI/Gtk.html new file mode 100644 index 000000000..cb2a864ac --- /dev/null +++ b/htdocs/docs/man/FS/UI/Gtk.html @@ -0,0 +1,112 @@ + + +FS::UI::Gtk - Base class for Gtk user-interface objects + + + + + + + +

NAME +
SYNOPSIS +
DESCRIPTION +
METHODS +
VERSION +
BUGS +
SEE ALSO +
HISTORY +

+ + +

NAME

+FS::UI::Gtk - Base class for Gtk user-interface objects + +

SYNOPSIS

  use FS::UI::Gtk;
+  use FS::UI::some_table;
+

  $interface = new FS::UI::some_table;
+

  $error = $interface->browse;
+  $error = $interface->search;
+  $error = $interface->view;
+  $error = $interface->edit;
+  $error = $interface->process;
+

DESCRIPTION

+An FS::UI::Gtk object represents a Gtk user interface object. + +

METHODS

new: +
interface: +
+Returns the string `Gtk'. Useful for the author of a table-specific UI +class to conditionally specify certain behaviour. + +

VERSION

+$Id: Gtk.html,v 1.1 1999-08-04 12:13:27 ivan Exp $ + +

BUGS

+This documentation is incomplete. + +

+_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. + +

+There should be a persistant, per-(freeside)-user store for window +positions and sizes and sort fields etc (see BUGS. + +

+Still some small bits of widget code same as FS::UI::CGI. + +

HISTORY

+$Log: Gtk.html,v $ +Revision 1.1 1999-08-04 12:13:27 ivan +new HTML manpages + Revision 1.1 1999/08/04 09:03:53 ivan initial checkin of +module files for proper perl installation + +

+Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code. + + + + diff --git a/htdocs/docs/man/FS/UI/agent.html b/htdocs/docs/man/FS/UI/agent.html new file mode 100644 index 000000000..e69de29bb -- cgit v1.2.1