Johan Lindström > Devel-PerlySense-0.0213 > Devel::PerlySense::Editor

Download:
Devel-PerlySense-0.0213.tar.gz

Dependencies

Annotate this POD

CPAN RT

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

NAME ^

Devel::PerlySense::Editor - Integration with editors

DESCRIPTION ^

PROPERTIES ^

oPerlySense

Devel::PerlySense object.

Default: set during new()

widthDisplay

The width of the display in columns, or undef if N/A.

Default: undef

raClassOverviewShowDefault

Names of features to show in the class overview by default.

Default: { ... }

raClassOverviewShow

Names of features to allow being show in the class overview.

Default: { ... }

CLASS METHODS ^

dirExtenal()

Return the absolute directory of the external editor files.

new(oPerlySense, widthDisplay = undef)

Create new Emcacs object.

METHODS ^

classOverview(oClass)

Return string representing the Class Overview of $oClass.

textClassInheritance(oClass)

Return string representing the class hierarchy of $oClass.

textClassNeighbourhood(oClass)

Return string representing the neighbourhood of $oClass.

textClassUses(oClass)

Return string representing the modules used by $oClass. Use the least number of columns to display this.

textTable($raItem, $columnWidthMax, [$rsRenderItem = string-as-is])

Return string with the items in $raItem rendered as a table, with as few columns as possible.

If the $rsRenderItem sub ref is passed, it is called for each item to be rendered:

  $rsRenderItem->($stringItem, $rsItemColumn)

where $stringItem is each individual item, and $rsItemColumn is the items in the current column. The default is to just pass through the $stringItem text.

textClassBookmarks(oClass)

Return string representing the Bookmarks of $oClass.

textClassStructure(oClass)

Return string representing the structure of $oClass.

This includes a Signature Survey string.

textClassApi(oClass)

Return string representing the API of $oClass.

textLineWrapped($text)

Return $text wrapped hard at the available number of columns.

raItemInNGroups($raItem, $countGroup)

Split up the items in $raItem so that they form at most $countGroup array refs.

The items are evenly distributed between the group with the same numer of items in each, except for the last one which may contain fewer items.

Return array ref with $countGroup items, each of which is an array ref with the elements in $raItem.

textCompactGraph(text)

Return compact version of $text.

formatOutputDataStructure(rhData)

Return stringification of $rhData suited for the Editor.

formatOutputItem($item)

Return stringification of $item suited for the Editor. $item can be a scalar, array ref or hash ref.

renameIdentifier($identifier)

Return $identifier changed to suit the Editor.

Default is to do nothing.

stripTrailingWhitespace($string)

Return $string with each line in $string stripped of trailing whitespace.

AUTHOR ^

Johan Lindstrom, <johanl@cpan.org>

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 Lindstrom, 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: