NAME

OnSearch::UI.pm - User interface library for OnSearch.

DESCRIPTION

OnSearch::UI provides an object oriented user interface for the OnSearch search engine and page templates for the application's dynamic HTML content.

EXPORTS

DESTROY (objectref)

Perl calls DESTROY when deleting unused OnSearch::UI objects.

METHODS

The UI.pm methods are listed and described below.

$ui -> parbreak ();

Template for a paragraph break.

  $ui -> parbreak -> wprint;

$ui -> input_form (search_preferences, volume_preferences);

OnSearch search page template. The arguments are hash references of user preferences.

$ui -> process_error (message);

User warning template. When called from OnSearch::browser_warn(), also logs the message.

    $ui -> process_error ($message) -> wprint;

$ui -> brief_warning (message);

Template that formats a warning about a user errror. To print the warning to the browser, use the following method calls.

    $ui -> brief_warning ($message) -> wprint;

$ui -> header_css (title);

HTTP header template that includes a link for an external style sheet named, "styles.css."

$ui -> navbar_map ();

Graphical navbar image map template.

$ui -> header_back ();

HTTP header template the Web browser to the previous page.

$ui -> navbar ();

Template for graphical and text-mode navigation bars.

$ui -> javascripts ();

Javascript function HTML template.

$ui -> error_dialog (message);

Template for a HTTP header that uses Javascript to pop up an error dialog box.

$ui -> critical_error_form (message);

Template for a critical error form that is compatible with all Web browsers.

$ui -> results_form (results_list, searchterm, matchcase)

Template to format the results of a matching document.

$ui -> results_header ();

Template for the page numbers that appear at the top of each page of results.

For page number and results counts, and formatting the results header and results footer, UI.pm uses _queue_indexes to calculate the indexes.

$ui -> results_footer ();

Format the page numbers and results totals that appear at the bottom of each page of results.

$ui -> admin_page (lastindex, indexinterval,, backup_opt, digitsonly_opt);

Template for the OnSearch administrator page.

$ui -> fileindex_form ();

Template for the file uploading and indexing form.

$ui -> archive_title ();

Template for the Archive page title.

$ui -> webindex_form (preferences);

Template for the Web index form.

$ui -> volume_info (volume_list, user_prefs);

Matches site volume information with user preferences.

$ui -> volume_form (volume_list);

Template for the volume list.

$ui -> wprint (fh);

Output text or a page template to the Web browser.

    $ui -> admin_page -> wprint;

Prints to the filehandle given as an argument, or to STDOUT, either directly or via PerlIO::OnSearchIO, if called without an argument.

$ui -> m_subs ();

Perform macro substitutions in templates if necessary.

$ui -> header_cookie (title, key, val, expires);

Template for a HTTP header to set a cookie.

$ui -> header_expires (title, datestr);

Template for a HTTP header with, "Expires," field.

$ui -> querytitle ();

Template for the query title that appears at the top of each page of results.

$ui -> html_footer ();

Template for the HTML tags that end the document.

$ui -> restore_session (class, id);

Retrieve stored results from OnSearch's data directory.

$ui -> new (module);

This is the OnSearch::UI constructor method.

$ui -> DESTROY ();

OnSearch::UI object destructor, also called by Perl to delete unused objects.

VERSION AND CREDITS

$Id: UI.pm,v 1.26 2005/08/16 05:34:03 kiesling Exp $

Written by Robert Kiesling <rkies@cpan.org> and licensed under the same terms a Perl. Refer to the file, "Artistic," for information.

SEE ALSO

OnSearch(3), OnSearch::Base64(3), OnSearch::AppConfig(3)

cpanm OnSearch

perl -MCPAN -e shell
install OnSearch