Padre::Plugin::SpellCheck::Engine(3) Check spelling in Padre, The Perl IDE.

VERSION

version: 1.32

PUBLIC METHODS

Constructor

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

Instance methods

  • 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).

  • $engine->set_ignore_word( $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 (e.g. "en_US"). Note that only plain locales are reported, the variations coming with Aspell are stripped.

  • 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 )

AUTHORS

Kevin Dawson <[email protected]>

Ahmad M. Zawawi <[email protected]>

Fayland Lam <[email protected]>

Jerome Quelin <[email protected]>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Fayland Lam, Jerome Quelin. Also Copyright X 2012-2013 AUTHORS and ``CONTRIBUTORS'' as listed above.

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