.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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 .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "CodeText::Perl 3pm" .TH CodeText::Perl 3pm "2023-01-03" "perl v5.36.0" "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" Tk::CodeText::Perl \- a Plugin for Perl syntax highlighting .SH "SYNOPSIS" .IX Header "SYNOPSIS" Tk::CodeText::Perl inherits Syntax::Highlight::Perl; .PP For its limitations see also there. This module provides extra methods to provide syntax highlighting for the Perl programming language. .SH "METHODS" .IX Header "METHODS" .IP "\fBhighlight\fR(\fI\f(CI$string\fI\fR);" 4 .IX Item "highlight($string);" returns a list of string snippets and tags that can be inserted in a Tk::Text like widget instantly. .IP "\fBrules\fR(\fI\f(CI$txtwidget\fI\fR,\fI\e@list\fR)" 4 .IX Item "rules($txtwidget,@list)" sets and returns a reference to a list of tagnames and options. By default it is set to: .Sp .Vb 10 \& [ \& [\*(AqComment_Normal\*(Aq, \-foreground => \*(Aqlightblue\*(Aq], \& [\*(AqComment_Pod\*(Aq, \-foreground => \*(Aqlightblue\*(Aq], \& [\*(AqDirective\*(Aq, \-foreground => \*(Aqblack\*(Aq], \& [\*(AqLabel\*(Aq, \-foreground => \*(Aqblack\*(Aq], \& [\*(AqQuote\*(Aq, \-foreground => \*(Aqred\*(Aq], \& [\*(AqString\*(Aq, \-foreground => \*(Aqred\*(Aq], \& [\*(AqVariable_Scalar\*(Aq, \-foreground => \*(Aqblue\*(Aq], \& [\*(AqVariable_Array\*(Aq, \-foreground => \*(Aqblue\*(Aq], \& [\*(AqVariable_Hash\*(Aq, \-foreground => \*(Aqblue\*(Aq], \& [\*(AqSubroutine\*(Aq, \-foreground => \*(Aqorange\*(Aq], \& [\*(AqCharacter\*(Aq, \-foreground => \*(Aqmagenta\*(Aq], \& [\*(AqKeyword\*(Aq, \-foreground => \*(Aqdarkgreen\*(Aq], \& [\*(AqBuiltin_Operator\*(Aq, \-foreground => \*(Aqdarkgreen\*(Aq], \& [\*(AqOperator\*(Aq, \-foreground => \*(Aqbrown\*(Aq], \& [\*(AqNumber\*(Aq, \-foreground => \*(Aqdarkblue\*(Aq], \& ] .Ve .IP "\fBrulesConfigure\fR(\fI\f(CI$txtwidget\fI\fR,\fI\e@list\fR)" 4 .IX Item "rulesConfigure($txtwidget,@list)" Used internally. Don't call it yourself. .IP "\fBrulesDelete\fR(\fI\f(CI$txtwidget\fI\fR,\fI\e@list\fR)" 4 .IX Item "rulesDelete($txtwidget,@list)" .PD 0 .IP "\fBstateCompare\fR(\e@state);" 4 .IX Item "stateCompare(@state);" .PD Compares \f(CW@state\fR to the current state of the formatter. returns true when equal. .IP "\fBstateGet\fR" 4 .IX Item "stateGet" Returns a list of the current state of the formatter. Called by the highlighting routines in Tk::CodeText. .IP "\fBstateSet\fR(\fI\f(CI@list\fI\fR)" 4 .IX Item "stateSet(@list)" Sets the state of the formatter. Called by the highlighting routines in Tk::CodeText. .SH "AUTHOR" .IX Header "AUTHOR" Hans Jeuken (haje@toneel.demon.nl) .SH "BUGS" .IX Header "BUGS" Propably plenty