Miles Crawford > Solstice > Solstice::HelpService

Download:
Solstice-1440.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
Report a bug
Module Version: 3364   Source  

NAME ^

Solstice::HelpService - A service for building a queue of text strings

SYNOPSIS ^

  use Solstice::HelpService;
  my $help_service = new Solstice::HelpService;

  my $str = 'Blah blah';
  
  $help_service->addHelp($str);
  $help_service->clearPageHelp();

  # Returns an array ref
  my $help_list = $help_service->getPageHelp();

DESCRIPTION ^

Superclass

Solstice::Service

Export

No symbols exported.

Methods

new()

Creates a new HelpSystem object.

addHelp($string)
getPageHelp()

Returns an array ref of all help objects added to the page.

clearPageHelp()

Removes all help objects added to the page.

Private Methods

_getClassName()

Return the class name. Overridden to avoid a ref() in the superclass.

Modules Used

Solstice::Service.

AUTHOR ^

Catalyst Group, <catalyst@u.washington.edu>

VERSION ^

$Revision: 3364 $

COPYRIGHT ^

Copyright 1998-2007 Office of Learning Technologies, University of Washington

Licensed under the Educational Community License, Version 1.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.opensource.org/licenses/ecl1.php

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.