Gtk2::Spell (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Gtk2::Spell.3pm".)

NAME

Gtk2::Spell - Bindings for GtkSpell with Gtk2

SYNOPSIS

  use Gtk2;
  use Gtk2::Spell;

  $txtview = Gtk2::TextView->new;
  $spell = Gtk2::Spell->new_attach($txtview);
  $spell2 = Gtk2::Spell->get_from_text_view($txtview);
  # $spell2 will be the same object as $spell
  $spell->set_language(SOME_LANG);
  $spell->recheck_all;
  $spell->detach;

ABSTRACT

  Perl bindings to GtkSpell, used in concert with Gtk2::TextView.

DESCRIPTION

Perl bindings to GtkSpell, used in concert with Gtk2::TextView. Provides mis-spelled word highlighting in red and offers a right click pop-up menu with suggested corrections.

FUNCTIONS

$spell = Gtk2::Spell->new(

GTK2_TEXT_VIEW

)

$spell = Gtk2::Spell->new_attach(

GTK2_TEXT_VIEW

)

Creates and returns a new Gtk2::Spell object attached to

GTK2_TEXT_VIEW.

$spell->set_language(

LANG_STR

)

Sets the language which the underlying spell-checker will use. According to the GtkSpell

API

reference this 'appears to be a locale specifier.'

$spell->recheck_all

Rechecks the spelling of the entire text view buffer.

Gtk2::Spell->get_from_text_view(

GTK2_TEXT_VIEW

)

Returns the Gtk2::Spell object attached to the given Gtk2::TextBuffer or undef if there isn't one attached.

$spell->detach

Detaches the Gtk2::Spell from it's associated text view.

SEE ALSO

perl(1), Glib(1), Gtk2(1).

AUTHOR

rwmcfa1 <rwmcfa1@neces.com>

COPYRIGHT AND LICENSE

Copyright 2003 by rwmcfa1

Copyright 2003 by the gtk2-perl team.

This library is free software; you can redistribute it and/or modify it under the terms of the

Library General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but

; without even the implied warranty of or See the Library General Public License for more details.

You should have received a copy of the

Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, 02111-1307