1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "Pod::Simple::PullParserTextToken 3"
132 .TH Pod::Simple::PullParserTextToken 3 "2008-06-03" "perl v5.8.7" "User Contributed Perl Documentation"
134 Pod::Simple::PullParserTextToken \-\- text\-tokens from Pod::Simple::PullParser
136 .IX Header "SYNOPSIS"
137 (See Pod::Simple::PullParser)
139 .IX Header "DESCRIPTION"
140 When you do \f(CW$parser\fR\->get_token on a Pod::Simple::PullParser, you might
141 get an object of this class.
143 This is a subclass of Pod::Simple::PullParserToken and inherits all its methods,
144 and adds these methods:
145 .IP "$token\->text" 4
146 .IX Item "$token->text"
147 This returns the text that this token holds. For example, parsing
148 C\&<foo> will return a C start\-token, a text\-token, and a C end\-token. And
149 if you want to get the \*(L"foo\*(R" out of the text\-token, call \f(CW\*(C`$token\->text\*(C'\fR
150 .IP "$token\->text(\fIsomestring\fR)" 4
151 .IX Item "$token->text(somestring)"
152 This changes the string that this token holds. You probably won't need
154 .IP "$token\->\fItext_r()\fR" 4
155 .IX Item "$token->text_r()"
156 This returns a scalar reference to the string that this token holds.
157 This can be useful if you don't want to memory-copy the potentially
158 large text value (well, as large as a paragraph or a verbatim block)
159 as calling \f(CW$token\fR\->text would do.
161 Or, if you want to alter the value, you can even do things like this:
164 \& for ( ${ $token\->text_r } ) { # Aliases it with $_ !!
168 \& s/ The / the /g; # just for example
172 \& if( 'A' eq chr(65) ) { # (if in an ASCII world)
179 \& ...or however you want to alter the value...
183 You're unlikely to ever need to construct an object of this class for
184 yourself, but if you want to, call
185 \&\f(CW\*(C`Pod::Simple::PullParserTextToken\->new( \f(CItext\f(CW )\*(C'\fR
187 .IX Header "SEE ALSO"
188 Pod::Simple::PullParserToken, Pod::Simple, Pod::Simple::Subclassing
189 .SH "COPYRIGHT AND DISCLAIMERS"
190 .IX Header "COPYRIGHT AND DISCLAIMERS"
191 Copyright (c) 2002 Sean M. Burke. All rights reserved.
193 This library is free software; you can redistribute it and/or modify it
194 under the same terms as Perl itself.
196 This program is distributed in the hope that it will be useful, but
197 without any warranty; without even the implied warranty of
198 merchantability or fitness for a particular purpose.
201 Sean M. Burke \f(CW\*(C`sburke@cpan.org\*(C'\fR