Padre::Plugin::SpellCheck::Engine - Spell check engine for the plugin
version 1.21
Create a new engine to be used later on.
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).
$text
$word
$pos
$engine->ignore( $word );
Tell engine to ignore $word for rest of the spell check.
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.
en_US
my @suggestions = $engine->suggestions( $word );
Return suggestions for $word.
For all related information (bug reporting, source code repository, etc.), refer to Padre::Plugin::SpellCheck.
Fayland Lam <fayland at gmail.com>
Jerome Quelin <jquelin@gmail.com>
Ahmad M. Zawawi <ahmad.zawawi@gmail.com>
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.
To install Padre::Plugin::SpellCheck, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Padre::Plugin::SpellCheck
CPAN shell
perl -MCPAN -e shell install Padre::Plugin::SpellCheck
For more information on module installation, please visit the detailed CPAN module installation guide.