Johan Lindström > Devel-PerlySense > Devel::PerlySense::Document::Location

Download:
Devel-PerlySense-0.0211.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  0
View/Report Bugs
Module Version: 0.0211   Source  

NAME ^

Devel::PerlySense::Document::Location - A file name + cursor position

SYNOPSIS ^

DESCRIPTION ^

A location describes a cursor position (optional) in a file, and optional properties.

PROPERTIES ^

file

Default: ""

row

The row (0..) of the location. The actual rows are 1.., 0 means N/A.

Default: 0

col

The col (0..) of the location. The actual cols are 1.., 0 means N/A.

Default: 0

rhProperty

Hash ref with (names: name of payload, keys: some payload).

A generic container for whatever things may be attached to this location, like POD text, a PPI::Node, a type string or whatever.

Default: {}

API METHODS ^

new(file => $file, row => $row, col => $col)

Create new Location object.

clone()

Return clone of this object.

Die on errors.

rhInfo()

Return a hash ref with the complete attributes of the class, i.e. both the file and the properties in rhProperty.

AUTHOR ^

Johan Lindstr�m, <johanl[�T]DarSerMan.com>

BUGS ^

Please report any bugs or feature requests to bug-devel-perlysense@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Devel-PerlySense. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2005 Johan Lindstr�m, All Rights Reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: