HTMLObject::HDMLDeck(3)

NAME
HDMLDeck - Object used to build a HDMLDeck Object Class.

SYNOPSIS
  use HTMLObject::HDMLDeck;
  my $obj = HTMLObject::HDMLDeck->new;
  if ($obj->didErrorOccur())
  {
    die $obj->errorMessage();
  }

DESCRIPTION
HDMLDeck is a HDMLDeck class.

Exported FUNCTIONS
  scalar new(version, ttl, markable, public, accessdomain, accesspath)
    Creates a new instance of the HTMLObject::HDMLDeck
    object.  version is the only required value and must = "3.0".

  bool isValid(void)
    Returns 0 or 1 to indicate if the object is valid.  The error will
    be available via errorMessage().

  void setError(errorString)
    sets error and errorString to indicate an error occurred.

  scalar didErrorOccur(void)
    Returns the value of error.

  scalar errorMessage(void)
    Returns the value of errorString.

  int createCard(cardType, id, arguments for card)
    Creates a new HDMLCard Object and stores it in the cards hash under
    the id value.  The focus is automatically set to this new card
    until changed by the user.  Returns -1 if the card already exists.

  scalar setFocus(scalar)
    This sets the focus to the new card id and returns the old card id
    that previously had the focus.  If no card was previously created it
    will return an empty string.  If no value is given, then it just
    returns the card that has the focus.

  scalar setCardFocus(scalar)
    Sets the focus of the currently selected card to the specified
    location and returns the old focus.

  void print(scalar)
    Prints the contents of the string passed in to the card that
    currently has the focus.  If no card is defined, then we blow an
    error.

  scalar display(void)
    Returns the <hdml version="" ...>...</hdml> string that represents
    the contents of this HDMLDeck Object.

  NOTE:  All data fields are accessible by specifying the object
         and pointing to the data member to be modified on the
         left-hand side of the assignment.
         Ex.  $obj->variable($newValue); or $value = $obj->variable;

AUTHOR
James A. Pattie (mailto:htmlobject@pcxperience.com)

SEE ALSO
perl(1), HTMLObject::WAP(3)