From f3235d39d083518d47f21cd5585e5f9a13070763 Mon Sep 17 00:00:00 2001 From: ivan Date: Mon, 23 Apr 2001 12:40:31 +0000 Subject: documentation and webdemo updates --- htdocs/docs/man/FS/UI/Base.html | 133 +++++++++++++++++---------------------- htdocs/docs/man/FS/UI/CGI.html | 133 +++++++++++++++++---------------------- htdocs/docs/man/FS/UI/Gtk.html | 127 ++++++++++++++++--------------------- htdocs/docs/man/FS/UI/agent.html | 16 +++++ 4 files changed, 183 insertions(+), 226 deletions(-) (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 index 7823090f6..96c60847d 100644 --- a/htdocs/docs/man/FS/UI/Base.html +++ b/htdocs/docs/man/FS/UI/Base.html @@ -1,116 +1,99 @@ FS::UI::Base - Base class for all user-interface objects - + +

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

NAME

-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;
+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;
-
+  $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;
+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.
-
+  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: +
new
+: +
browse
+: +
title
+: +
addwidget
+

VERSION

-$Id: Base.html,v 1.2 2000-03-03 18:22:44 ivan Exp $ - +

VERSION

$Id: Base.html,v 1.3 2001-04-23 12:40:31 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. - +

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

-Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code. +

HISTORY

$Log: Base.html,v $ +

Revision 1.3 2001-04-23 12:40:31 ivan +

documentation and webdemo updates +

+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 index 69bff5671..49991f1aa 100644 --- a/htdocs/docs/man/FS/UI/CGI.html +++ b/htdocs/docs/man/FS/UI/CGI.html @@ -1,114 +1,93 @@ FS::UI::CGI - Base class for CGI user-interface objects - + +

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

NAME

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

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;
+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;
-
+  $error = $interface->process;

DESCRIPTION

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

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

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.2 2000-03-03 18:22:44 ivan Exp $ - +

VERSION

$Id: CGI.html,v 1.3 2001-04-23 12:40:31 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. - +

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

-Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code. +

HISTORY

$Log: CGI.html,v $ +

Revision 1.3 2001-04-23 12:40:31 ivan +

documentation and webdemo updates +

+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 index 3328e9746..24d620087 100644 --- a/htdocs/docs/man/FS/UI/Gtk.html +++ b/htdocs/docs/man/FS/UI/Gtk.html @@ -1,111 +1,90 @@ FS::UI::Gtk - Base class for Gtk user-interface objects - + +

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

NAME

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

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;
+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;
-
+  $error = $interface->process;

DESCRIPTION

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

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

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.2 2000-03-03 18:22:44 ivan Exp $ - +

VERSION

$Id: Gtk.html,v 1.3 2001-04-23 12:40:31 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. - +

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 in the FS::UI::CGI manpage.

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

HISTORY

-$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 - -

-Revision 1.1 1999/01/20 09:30:36 ivan skeletal cross-UI UI code. +

HISTORY

$Log: Gtk.html,v $ +

Revision 1.3 2001-04-23 12:40:31 ivan +

documentation and webdemo updates +

+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 index e69de29bb..8608e4ef4 100644 --- a/htdocs/docs/man/FS/UI/agent.html +++ b/htdocs/docs/man/FS/UI/agent.html @@ -0,0 +1,16 @@ + + +./FS/FS/UI/agent.pm + + + + + + + + + + + + + -- cgit v1.2.1