Eric Wilhelm > dotReader > dtRdr::Range

Download:
dotReader-v0.11.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  1
View/Report Bugs
Source  

NAME ^

dtRdr::Range - a pair of dtRdr::Location objects

Constructor ^

new

$start and $end are both dtRdr::Location objects.

  my $range = dtRdr::Range->new(
    id    => $id,
    start => $start,
    end   => $end
  );

create

A constructor which creates the location objects for you. You must pass a node object for this to work. If you do not provide an id, it will be created for you.

  my $range = dtRdr::Range->create(
    id    => $id,
    node  => $node, # passed to Location constructor
    range => [$start_pos, $end_pos],
    );

Methods ^

get_start_pos

Get the start position as a number.

  my $s = $range->get_start_pos;

Also:

  my $s = $range->start_pos;

Also:

  my $s = $range->a;

get_end_pos

Get the end position as a number.

  my $e = $range->get_end_pos;

Also:

  my $e = $range->b;

set_start

  $range->set_start($location);

set_end

  $range->set_end($location);

set_id

  $range->set_id($id);

get_node

also node(), get_book(), book()

  $range->get_node;

Comparisons ^

encloses

Returns true if the $range encloses $offset.

  $range->encloses($offset);

AUTHOR ^

Eric Wilhelm <ewilhelm at cpan dot org>

Dan Sugalski <dan@sidhe.org>

COPYRIGHT ^

Copyright (C) 2006 by Dan Sugalski, Eric L. Wilhelm, and OSoft, All Rights Reserved.

NO WARRANTY ^

Absolutely, positively NO WARRANTY, neither express or implied, is offered with this software. You use this software at your own risk. In case of loss, no person or entity owes you anything whatsoever. You have been warned.

LICENSE ^

The dotReader(TM) is OSI Certified Open Source Software licensed under the GNU General Public License (GPL) Version 2, June 1991. Non-encrypted and encrypted packages are usable in connection with the dotReader(TM). The ability to create, edit, or otherwise modify content of such encrypted packages is self-contained within the packages, and NOT provided by the dotReader(TM), and is addressed in a separate commercial license.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

syntax highlighting: