EBook::EPUB::NCX::NavPoint.3pm

Langue: en

Version: 2010-03-19 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

EBook::EPUB::NCX::NavPoint

SYNOPSIS

Entry in Navigation Center that refers to part of a document (e.g. chapter)

SUBROUTINES/METHODS

new(%opts)
%opts is an anonymous hash that might containe followig keys: 
     class
     content
     id 
     play_order
     label
add_navpoint(%opts)
Add refrence to an OPS Content Document that is a part of publication, subsection of the part current object references to. %opts is an anonymous hash, for possible key values see new() method description. Method returns created EBook::EPUB::NCX::NavPoint object that could be used later for adding subsections.
all_navpoints()
Returns array of EBook::EPUB::NCX::NavPoint objects, subsections of current one
encode($xmlwriter)
Encode object to XML form using XML::Writer instance
class([$class])
Get/set class of navigation point
content([$content])
Get/set URI to the part navPoint references to
id([$id])
Get/set ID of navigation point
label([$label])
Get/set human readable description of part navPoint references to
play_order([$play_order])
Get/set play order (number) of text part.

AUTHOR

Oleksandr Tymoshenko, <gonzo@bluezbox.com>

BUGS

Please report any bugs or feature requests to <gonzo@bluezbox.com> Copyright 2009, 2010 Oleksandr Tymoshenko.

<http://bluezbox.com>

This module is free software; you can redistribute it and/or modify it under the terms of the BSD license. See the LICENSE file included with this distribution.