Padre::Plugin::SpellCheck::Engine.3pm

Langue: en

Version: 2009-06-20 (ubuntu - 24/10/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

Padre::Plugin::SpellCheck::Engine - spell engine for plugin

DESCRIPTION

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

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

Return suggestions for $word.

SEE ALSO

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

AUTHOR

Jerome Quelin, "<jquelin@cpan.org>" Copyright (c) 2009 Jerome Quelin, all rights reserved.

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