.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Gtk2::Spell 3pm" .TH Gtk2::Spell 3pm "2015-12-18" "perl v5.24.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Gtk2::Spell \- Bindings for GtkSpell with Gtk2 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& 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; .Ve .SH "ABSTRACT" .IX Header "ABSTRACT" .Vb 1 \& Perl bindings to GtkSpell, used in concert with Gtk2::TextView. .Ve .SH "DESCRIPTION" .IX Header "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. .SH "FUNCTIONS" .IX Header "FUNCTIONS" .ie n .IP "$spell = Gtk2::Spell\->new(\s-1GTK2_TEXT_VIEW\s0)" 4 .el .IP "\f(CW$spell\fR = Gtk2::Spell\->new(\s-1GTK2_TEXT_VIEW\s0)" 4 .IX Item "$spell = Gtk2::Spell->new(GTK2_TEXT_VIEW)" .PD 0 .ie n .IP "$spell = Gtk2::Spell\->new_attach(\s-1GTK2_TEXT_VIEW\s0)" 4 .el .IP "\f(CW$spell\fR = Gtk2::Spell\->new_attach(\s-1GTK2_TEXT_VIEW\s0)" 4 .IX Item "$spell = Gtk2::Spell->new_attach(GTK2_TEXT_VIEW)" .PD Creates and returns a new Gtk2::Spell object attached to \s-1GTK2_TEXT_VIEW. \s0 .ie n .IP "$spell\->set_language(\s-1LANG_STR\s0)" 4 .el .IP "\f(CW$spell\fR\->set_language(\s-1LANG_STR\s0)" 4 .IX Item "$spell->set_language(LANG_STR)" Sets the language which the underlying spell-checker will use. According to the GtkSpell \s-1API\s0 reference this 'appears to be a locale specifier.' .ie n .IP "$spell\->recheck_all" 4 .el .IP "\f(CW$spell\fR\->recheck_all" 4 .IX Item "$spell->recheck_all" Rechecks the spelling of the entire text view buffer. .IP "Gtk2::Spell\->get_from_text_view(\s-1GTK2_TEXT_VIEW\s0)" 4 .IX Item "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. .ie n .IP "$spell\->detach" 4 .el .IP "\f(CW$spell\fR\->detach" 4 .IX Item "$spell->detach" Detaches the Gtk2::Spell from it's associated text view. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIperl\fR\|(1), \fIGlib\fR\|(1), \fIGtk2\fR\|(1). .SH "AUTHOR" .IX Header "AUTHOR" rwmcfa1 .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2003 by rwmcfa1 .PP Copyright 2003 by the gtk2\-perl team. .PP This library is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 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. .PP This library is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE. \s0 See the \s-1GNU\s0 Library General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place \- Suite 330, Boston, \s-1MA 02111\-1307 USA.\s0