Eric Wilhelm > dotReader > dtRdr::Annotation

Download:
dotReader-v0.11.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  1
View/Report Bugs
Source  

NAME ^

dtRdr::Annotation - base class for Note, Bookmark, and Highlight objects

SYNOPSIS ^

Not much happening here. See dtRdr::Annotation::Range.

TYPES ^

The inheritance and traits isn't very easily drawn. This is about the best a 2D picture can get.

                 Range  <-- Location (start, end)
                   |
  Annotation    Selection
    \             /
     \           /
      \         /
       \       /
    Annotation::Range
      |-- Highlight
      |-- Note     (+ Annotation::Trait::Boundless)
      |-- Bookmark (+ Annotation::Trait::Boundless)
      `-- AnnoSelection

Currently, all annotations are range-based. Point-based annotations would be derived from dtRdr::Location, but we haven't found a use for those yet.

Identifier Methods ^

IS_RANGE_TYPE

Required for all annotations. Any annotation derived from this class is a range type, so this is just a constant.

ANNOTATION_TYPE

Must be implemented by subclasses.

make_public

  $anno->make_public(
    owner  => $owner_id,
    server => $server_id,
    rev    => $server_revision
  );

is_mine

Returns true if the annotation is owned by you (whether public or local.)

  my $is = $anno->is_mine;

AUTHOR ^

Eric Wilhelm <ewilhelm at cpan dot org>

http://scratchcomputing.com/

COPYRIGHT ^

Copyright (C) 2006 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: