Zane C. Bowers-Hadley > Text-SpellChecker-GUI-0.0.2 > Text::SpellChecker::GUI::Curses

Download:
Text-SpellChecker-GUI-0.0.2.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.0.0   Source  

NAME ^

Text::SpellChecker::GUI::Curses - Implements the Curses backend to Text::SpellChecker::GUI.

VERSION ^

Version 0.0.0

SYNOPSIS ^

    use Text::SpellChecker::GUI::Curses;

    my $sg = Text::SpellChecker::GUI::Curses->new();
    ...

METHODS ^

new

This initilizes the object.

args hash

useX

This is if it should try to use X or not. If it is not defined, ZConf::GUI->useX is used.

zconf

This is the ZConf object to use. If it is not specified the one in the object for zcrunner will be used. If neither zconf or zcrunner is specified, a new one is created.

zcgui

This is the ZConf::GUI object. A new one will be created if it is

check

This checks the specified the specified text for spelling errors.

Only one option is taken and that is the text to be checked.

The returned value is a hash.

returned hash

text

This is the the resulting text.

cancel

If this is defined and true, then the user canceled the check and any changes.

    my %returned=$sg->check($text);
    if($sg->{error}){
        print "Error!\n";
    }else{
        if($returned{cancel}){
            print "The check was canceled.";
        }else{
            $text=$returned{text};
        }
    }

dialogs

This returns the available dailogs.

windows

This returns a list of available windows.

errorblank

This blanks the error storage and is only meant for internal usage.

It does the following.

    $self->{error}=undef;
    $self->{errorString}="";

ERROR CODES ^

1

Failed to initiate ZConf::GUI.

2

Failed to find the required commands in the path.

3

Failed to read temp file.

AUTHOR ^

Zane C. Bowers, <vvelox at vvelox.net>

BUGS ^

Please report any bugs or feature requests to bug-text-spellchecker-gui at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Text-SpellChecker-GUI. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Text::SpellChecker::GUI

You can also look for information at:

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2009 Zane C. Bowers, 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: