debian man page for padre::plugin::spellcheck::engine

Padre::Plugin::SpellCheck::Engine(3pm)			User Contributed Perl Documentation		    Padre::Plugin::SpellCheck::Engine(3pm)

NAME
       Padre::Plugin::SpellCheck::Engine - Check spelling in Padre, The Perl IDE.

VERSION
       version 1.29

PUBLIC METHODS
   Constructor
       my $engine = PPS::Engine->new;
	   Create a new engine to be used later on.

   Instance methods
       o   my ($word, $pos) = $engine->check( $text );

	   Spell check $text (according to current speller), and return the first error encountered (undef if no spelling mistake). An error is
	   reported as the faulty $word, as well as the $pos of the word in the text (position of the start of the faulty word).

       o   $engine->set_ignore_word( $word );

	   Tell engine to ignore $word for rest of the spell check.

       o   my @dictionaries = $engine->dictionaries;

	   Return a (reduced) list of dictionaries installed with aspell. The names returned are the dictionary locale names (eg "en_US"). Note
	   that only plain locales are reported, the variations coming with aspell are stripped.

       o   my @suggestions = $engine->get_suggestions( $word );

	   Return suggestions for $word.

BUGS AND LIMITATIONS
       Text::Hunspell hard coded for /usr/share/hunspell/

DEPENDENCIES
       Padre, Class::XSAccessor and either or ( Text::Hunspell or Text::Aspell )

SEE ALSO
       For all related information (bug reporting, source code repository, etc.), refer to Padre::Plugin::SpellCheck.

AUTHORS
       Kevin Dawson <bowtie@cpan.org>

       Ahmad M. Zawawi <ahmad.zawawi@gmail.com>

       Fayland Lam <fayland@gmail.com>

       Jerome Quelin <jquelin@gmail.com>

COPYRIGHT AND LICENSE
       This software is copyright (c) 2010 by Fayland Lam, Jerome Quelin.

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

perl v5.14.2							    2012-06-19				    Padre::Plugin::SpellCheck::Engine(3pm)