File Coverage

blib/lib/Scanner/Page.pm

Criterion	Covered	Total	%
statement	9	62	14.5
branch	0	32	0.0
condition			n/a
subroutine	3	17	17.6
pod	10	11	90.9
total	22	122	18.0

line	stmt	bran	sub	pod	time	code
1						#================================= Page.pm ===================================
2						# Filename: Page.pm
3						# Description: Physical Page Class for Scanners.
4						# Original Author: Dale M. Amon
5						# Revised by: $Author: amon $
6						# Date: $Date: 2008-08-28 23:31:44 $
7						# Version: $Revision: 1.3 $
8						# License: LGPL 2.1, Perl Artistic or BSD
9						#
10						#=============================================================================
11	1		1		526	use strict;
	1				2
	1				34
12	1		1		5	use Scanner::Format;
	1				1
	1				30
13
14						package Scanner::Page;
15	1		1		5	use vars qw{@ISA};
	1				1
	1				895
16						@ISA = qw( UNIVERSAL );
17
18						#=============================================================================
19						# CLASS METHODS
20						#=============================================================================
21						$Scanner::Page::DEFAULT_NAME_VERIFIER = undef;
22
23						sub defaultNameVerifierIs {
24	0		0	1		my ($class, $obj) = @_;
25	0	0				if (!defined $obj) {
26	0					$Scanner::Page::DEFAULT_NAME_VERIFIER = undef;
27	0					return 1;
28						}
29	0	0				ref ($obj) \|\| (return 0);
30	0					$Scanner::Page::DEFAULT_NAME_VERIFIER = $obj;
31	0					return 1;
32						}
33
34						#-----------------------------------------------------------------------------
35
36						sub new {
37	0		0	1		my $class = shift;
38	0					my %params = @_;
39	0					my $self = bless {}, $class;
40
41	0	0				$self->_setFormat (\%params) \|\| return undef;
42	0	0				$self->_setPageName (\%params) \|\| return undef;
43
44	0					return $self;
45						}
46
47						#=============================================================================
48						# INSTANCE METHODS
49						#=============================================================================
50
51						sub pagetitle {
52	0		0	1		my $s = shift;
53	0					my @list;
54
55	0					my ($date, $title, $pageid, $subtitle) =
56						@$s{'date','title','pageid','subtitle'};
57	0	0				($pageid = "p" . $pageid) if ($pageid);
58
59	0	0				foreach ( $date, $title, $pageid, $subtitle) {$_ && push @list, $_; }
	0
60	0	0				return undef if ($#list == -1);
61
62	0					my $t = $list[0];
63	0					for (my $i=1; $i < $#list+1; $i++) {$t .= "-" . $list[$i]; }
	0
64	0					return $t;
65						}
66
67						#-----------------------------------------------------------------------------
68
69						sub info ($) {
70	0		0	1		my $self = shift;
71	0					printf "[Page]\n" .
72						"Page Title: %s\n" .
73						"Date: %s\n" .
74						"Title: %s\n" .
75						"PageId: %s\n" .
76						"Subtitle: %s\n",
77						$self->pagetitle,
78						$self->{'date'},
79						$self->{'title'},
80						$self->{'pageid'},
81						$self->{'subtitle'};
82	0					print "\n";
83	0					$self->{'format'}->info ("Scan");
84	0					return $self;
85						}
86
87						#-----------------------------------------------------------------------------
88
89	0		0	1		sub landscape { shift->{'format'}->landscape; }
90	0		0	1		sub portrait { shift->{'format'}->portrait; }
91	0		0	0		sub ScanDimensions {(shift->{'format'}->ScanDimensions);}
92	0		0	1		sub date { shift->{'date'}; }
93	0		0	1		sub title { shift->{'title'}; }
94	0		0	1		sub pageid { shift->{'pageid'}; }
95	0		0	1		sub subtitle { shift->{'subtitle'}; }
96
97						#=============================================================================
98						# INTERNAL CLASS METHODS
99						#=============================================================================
100						# Verify that the list of elements can be used to create a page title.
101
102						sub _validateName {
103	0		0			my ($self,$date,$title,$pageid,$subtitle) = @_;
104
105	0	0				((length($date) + length($title) + length($pageid) + length ($subtitle)) > 0)
106						\|\| return 0;
107
108	0	0				if ($Scanner::Page::DEFAULT_NAME_VERIFIER) {
109	0	0				$Scanner::Page::DEFAULT_NAME_VERIFIER->validateName
110						( @$self{'date','title','pageid','subtitle'} ) \|\| (return 0);
111						}
112	0					return 1;
113						}
114
115						#=============================================================================
116						# INTERNAL OBJECT METHODS
117						#=============================================================================
118
119						sub _setPageName {
120	0		0			my ($self, $params) = @_;
121
122	0					@$self{'date','title', 'pageid','subtitle'} = ("", "", "", "" );
123	0	0				($self->{'date'} = $params->{'date'}) if defined $params->{'date'};
124	0	0				($self->{'title'} = $params->{'title'}) if defined $params->{'title'};
125	0	0				($self->{'pageid'} = $params->{'pageid'}) if defined $params->{'pageid'};
126	0	0				($self->{'subtitle'}= $params->{'subtitle'}) if defined $params->{'subtitle'};
127
128	0	0				Scanner::Page->_validateName ( @$self{'date','title','pageid','subtitle'} )
129						\|\| (return 0);
130	0					return 1;
131						}
132
133						#-----------------------------------------------------------------------------
134
135						sub _setFormat {
136	0		0			my ($self, $params) = @_;
137	0	0				defined $params->{'format'} or return 0;
138
139	0					$self->{'format'} = $params->{'format'};
140	0					return 1;
141						}
142
143						#=============================================================================
144						# POD DOCUMENTATION
145						#=============================================================================
146						# You may extract and format the documention section with the 'perldoc' cmd.
147
148						=head1 NAME
149
150						Scanner::Page - Representation of a Page to be passed to a Scanner.
151
152						=head1 SYNOPSIS
153
154						use Scanner::Page;
155
156						$obj = Scanner::Page->new ( list of named arguments );
157						$bool = Scanner::Page->defaultNameVerifierIs ( $myverifierobj );
158
159						$pagetitle = $obj->pagetitle;
160						$date = $obj->date;
161						$title = $obj->title;
162						$pageid = $obj->pageid;
163						$subtitle = $obj->subtitle;
164						($width, $height) = $obj->ScanDimensions;
165						$flg = $obj->landscape;
166						$flg = $obj->portrait;
167						$obj = $obj->info;
168
169						=head1 Inheritance
170
171						UNIVERSAL
172
173						=head1 Description
174
175						Pages are transient objects used to pass information to Scanner::Device and
176						Document::Directory objects.
177
178						=head1 Examples
179
180						use File::Spec::Scanner::Page;
181
182						my $flg = Scanner::Page->defaultNameVerifierIs ( $myvfyobj );
183
184						my $pg = Scanner::Page->new ( 'format' => $fmt,
185						'date' => "20080818",
186						'title' => "DailyBoggle",
187						'pageid' => "001",
188						);
189
190						if ($pg->landscape) {print "It is a landscape page.\n";}
191						if ($pg->portrait ) {print "It is a portrait page.\n";}
192
193						my ($x,$y) = $pg->ScanDimensions;
194						my $pt = $obj->pagetitle;
195						my $date = $obj->date;
196						my $title = $obj->title;
197						my $pgnum = $obj->pageid;
198						my $stitle = $obj->subtitle;
199
200						=head1 Class Variables
201
202						DEFAULT_NAME_VERIFIER Class used for verifying a page name
203						consisting of the a set or subset of
204						date-title-pageid-subtitle. Default is undef.
205
206						=head1 Instance Variables
207
208						format A Scanner::Format object.
209						date The date part of the page name, eg 19941224.
210						title The document title portion of the name.
211						pageid The pageid, usually a simple page number: 104.
212						subtitle The page title portion of the name.
213
214						=head1 Class Methods
215
216						=over 4
217
218						=item B<$bool = Scanner::Page-EdefaultNameVerifierIs ( $obj )>
219
220						Sets the default verifier object. Returns true if it succeeded. A false return
221						could indicate $obj is not a ref. undef is a valid value and will restore the
222						default behavior of the class, ie to do not much of anything about checking
223						the name related fields.
224
225						A Scanner::Page has several fields for the input of strings used in
226						constructing a full page name. The actual format of these is not directly
227						enforced by this object other than a requirement that the concatenation of
228						them all generate a nonzero string length.
229
230						In practice it is desirable to check that these fields have strings which will
231						create valid file names when put together in the form:
232
233						date-title-pageid-subtitle
234
235						and from which the scanner will eventually create:
236
237						date-title-pageid-subtitle.jpeg
238
239						If you wish each new object to check these fields rather than blindly use them
240						as it does by default, you may load a default object with this Class method.
241						Your object must have a method like this:
242
243						$bool = $myobj->validateName ( $date, $title, $pageid, $subtitle )
244
245						If you do nothing, only the simplest of checks, as noted earlier, are done.
246						This may be adequate for many applications which only wish to use the 'title'
247						field and nothing else.
248
249						=item B<$obj = Scanner::Page-Enew ( named argument list )>
250
251						This is the Class method for creating new Scanner::Page objects. It may have
252						many different arguments. They are in short:
253
254						format -> $fmtobj [REQUIRED]
255						date -> date string [OPT: default is ""]
256						title -> title string [OPT: default is ""]
257						pageid -> pageid string [OPT: default is ""]
258						subtitle -> subtitle string [OPT: default is ""]
259
260						'format' =>
261
262						A format object that defines the orientation and size of the page.
263
264						'date' =>
265
266						A date to be included as the first part of the page name, where a single date
267						is represented as:
268
269						yyyymmdd
270						yyyymmddhhmmss
271
272						and mm and dd may be 00 to represent 'the whole month' or the 'whole year' as
273						in a monthly magazine or a yearly report, or to represent uncertainty, 'it
274						was from sometime in that year'. there may optionally be two dates, so as to
275						represent a period of time associated with the page:
276
277						date1-date2
278
279						The default is the null string: "".
280
281						'title' => </td> </tr> <tr> <td class="h" > <a name="282">282</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="283">283</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> The title associated with the document of which this page is a part or whole </td> </tr> <tr> <td class="h" > <a name="284">284</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> if there is only one page. eg </td> </tr> <tr> <td class="h" > <a name="285">285</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="286">286</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> ModernQuantumTheory </td> </tr> <tr> <td class="h" > <a name="287">287</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="288">288</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> The default is the null string: "". </td> </tr> <tr> <td class="h" > <a name="289">289</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="290">290</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> 'pageid' => <pageid string> </td> </tr> <tr> <td class="h" > <a name="291">291</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="292">292</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> If the document is part of a multi-page document, a representation of the page </td> </tr> <tr> <td class="h" > <a name="293">293</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> number is needed. There may be two adjacent pages if the current page is an </td> </tr> <tr> <td class="h" > <a name="294">294</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> opened booklet on the scanner. Pageid's may look like the following: </td> </tr> <tr> <td class="h" > <a name="295">295</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="296">296</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> 000a </td> </tr> <tr> <td class="h" > <a name="297">297</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> 001 </td> </tr> <tr> <td class="h" > <a name="298">298</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> 043.01 </td> </tr> <tr> <td class="h" > <a name="299">299</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> 001-002 </td> </tr> <tr> <td class="h" > <a name="300">300</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="301">301</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> The default is the null string: "". </td> </tr> <tr> <td class="h" > <a name="302">302</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="303">303</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> 'subtitle' => <subtitle string> </td> </tr> <tr> <td class="h" > <a name="304">304</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="305">305</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> An individual title for the page, the name of an article within a magazine, a </td> </tr> <tr> <td class="h" > <a name="306">306</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> comment about the contents of the page... </td> </tr> <tr> <td class="h" > <a name="307">307</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="308">308</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> TheCatDied-SmithAndWesson-itsNotDeadYet </td> </tr> <tr> <td class="h" > <a name="309">309</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="310">310</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> The default is the null string: "". </td> </tr> <tr> <td class="h" > <a name="311">311</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="312">312</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> It returns either a pointer to the newly created and initialized object or </td> </tr> <tr> <td class="h" > <a name="313">313</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> undef if the object could not be created. </td> </tr> <tr> <td class="h" > <a name="314">314</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="315">315</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =back 4 </td> </tr> <tr> <td class="h" > <a name="316">316</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="317">317</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 Instance Methods </td> </tr> <tr> <td class="h" > <a name="318">318</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="319">319</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =over 4 </td> </tr> <tr> <td class="h" > <a name="320">320</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="321">321</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<$date = $obj-E<gt>date> </td> </tr> <tr> <td class="h" > <a name="322">322</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="323">323</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Return the date string. </td> </tr> <tr> <td class="h" > <a name="324">324</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="325">325</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<($width, $height) = $obj-E>gt>ScanDimensions> </td> </tr> <tr> <td class="h" > <a name="326">326</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="327">327</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Retrieve the page dimensions to be used for scanning. The height may include </td> </tr> <tr> <td class="h" > <a name="328">328</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> extra space for calibration devices as earlier discussed in the </td> </tr> <tr> <td class="h" > <a name="329">329</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Scanner::Page->setDefaultCalibratorFlag section: </td> </tr> <tr> <td class="h" > <a name="330">330</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="331">331</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> (width, height+calibratorheight) </td> </tr> <tr> <td class="h" > <a name="332">332</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="333">333</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> The scanner might of course have something to say about the height or width we </td> </tr> <tr> <td class="h" > <a name="334">334</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> have selected! That, however, is not the Page's problem. It is what it is and </td> </tr> <tr> <td class="h" > <a name="335">335</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> it might be too large for the scanner you have. </td> </tr> <tr> <td class="h" > <a name="336">336</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="337">337</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<$obj = $obj-E<gt>info> </td> </tr> <tr> <td class="h" > <a name="338">338</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="339">339</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Print info on the Scanner::Page to stdout. </td> </tr> <tr> <td class="h" > <a name="340">340</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="341">341</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<$flg = $obj-E<gt>landscape> </td> </tr> <tr> <td class="h" > <a name="342">342</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="343">343</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Return true if it uses a landscape page format. </td> </tr> <tr> <td class="h" > <a name="344">344</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="345">345</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<$pageid = $obj-E<gt>pageid> </td> </tr> <tr> <td class="h" > <a name="346">346</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="347">347</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Return the pageid string. </td> </tr> <tr> <td class="h" > <a name="348">348</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="349">349</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item $pagetitle = $obj->pagetitle </td> </tr> <tr> <td class="h" > <a name="350">350</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="351">351</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Generate the full page title. There are four possible elements, any of which </td> </tr> <tr> <td class="h" > <a name="352">352</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> might be null. The page title is built from whichever of date, title, pageid </td> </tr> <tr> <td class="h" > <a name="353">353</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> and subtitle are non-null. The title is built up in the order: </td> </tr> <tr> <td class="h" > <a name="354">354</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="355">355</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> <date>-<title>-p<pageid>-<subtitle> </td> </tr> <tr> <td class="h" > <a name="356">356</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="357">357</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Possible pagetitles are: </td> </tr> <tr> <td class="h" > <a name="358">358</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="359">359</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> 20040819 </td> </tr> <tr> <td class="h" > <a name="360">360</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> 20040819-QuantumTheory </td> </tr> <tr> <td class="h" > <a name="361">361</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> 20040819-p001 </td> </tr> <tr> <td class="h" > <a name="362">362</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> 20040819-20100918-QuantumTheoryAdvances-p005-010-ForwardByMartians </td> </tr> <tr> <td class="h" > <a name="363">363</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="364">364</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> If somehow all four are null, undef is returned instead of a string. </td> </tr> <tr> <td class="h" > <a name="365">365</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="366">366</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> [Internal code question: how should I handle the 'p' that goes before a </td> </tr> <tr> <td class="h" > <a name="367">367</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> pageid?] </td> </tr> <tr> <td class="h" > <a name="368">368</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="369">369</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<$flg = $obj-E<gt>portrait> </td> </tr> <tr> <td class="h" > <a name="370">370</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="371">371</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Return true if it uses a portrait page format. </td> </tr> <tr> <td class="h" > <a name="372">372</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="373">373</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<$subtitle = $obj-E<gt>subtitle> </td> </tr> <tr> <td class="h" > <a name="374">374</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="375">375</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Return the subtitle string. </td> </tr> <tr> <td class="h" > <a name="376">376</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="377">377</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<$title = $obj-E<gt>title> </td> </tr> <tr> <td class="h" > <a name="378">378</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="379">379</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Return the title string. </td> </tr> <tr> <td class="h" > <a name="380">380</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="381">381</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =back 4 </td> </tr> <tr> <td class="h" > <a name="382">382</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="383">383</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 Private Class Methods </td> </tr> <tr> <td class="h" > <a name="384">384</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="385">385</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> None. </td> </tr> <tr> <td class="h" > <a name="386">386</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="387">387</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 Private Instance Methods </td> </tr> <tr> <td class="h" > <a name="388">388</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="389">389</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> None. </td> </tr> <tr> <td class="h" > <a name="390">390</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="391">391</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 Errors and Warnings </td> </tr> <tr> <td class="h" > <a name="392">392</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="393">393</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> None. </td> </tr> <tr> <td class="h" > <a name="394">394</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="395">395</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 KNOWN BUGS </td> </tr> <tr> <td class="h" > <a name="396">396</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="397">397</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> See TODO. </td> </tr> <tr> <td class="h" > <a name="398">398</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="399">399</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 SEE ALSO </td> </tr> <tr> <td class="h" > <a name="400">400</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="401">401</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> None. </td> </tr> <tr> <td class="h" > <a name="402">402</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="403">403</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 AUTHOR </td> </tr> <tr> <td class="h" > <a name="404">404</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="405">405</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Dale Amon <amon@vnl.com> </td> </tr> <tr> <td class="h" > <a name="406">406</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="407">407</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =cut </td> </tr> <tr> <td class="h" > <a name="408">408</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="409">409</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> #============================================================================= </td> </tr> <tr> <td class="h" > <a name="410">410</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # CVS HISTORY </td> </tr> <tr> <td class="h" > <a name="411">411</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> #============================================================================= </td> </tr> <tr> <td class="h" > <a name="412">412</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # $Log: Page.pm,v $ </td> </tr> <tr> <td class="h" > <a name="413">413</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # Revision 1.3 2008-08-28 23:31:44 amon </td> </tr> <tr> <td class="h" > <a name="414">414</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # Major rewrite. Shuffled code between classes and add lots of features. </td> </tr> <tr> <td class="h" > <a name="415">415</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # </td> </tr> <tr> <td class="h" > <a name="416">416</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # Revision 1.2 2008-08-07 19:52:48 amon </td> </tr> <tr> <td class="h" > <a name="417">417</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # Upgrade source format to current standard. </td> </tr> <tr> <td class="h" > <a name="418">418</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # </td> </tr> <tr> <td class="h" > <a name="419">419</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # Revision 1.1.1.1 2006-06-15 22:06:59 amon </td> </tr> <tr> <td class="h" > <a name="420">420</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # Classes for scanner use abstractions. </td> </tr> <tr> <td class="h" > <a name="421">421</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # </td> </tr> <tr> <td class="h" > <a name="422">422</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # 20060615 Dale Amon <amon@islandone.org> </td> </tr> <tr> <td class="h" > <a name="423">423</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # Added check for an attempt to set a zero hieght or width. </td> </tr> <tr> <td class="h" > <a name="424">424</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # 20040818 Dale Amon <amon@islandone.org> </td> </tr> <tr> <td class="h" > <a name="425">425</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> # Created. </td> </tr> <tr> <td class="h" > <a name="426">426</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> 1; </td> </tr> </table> </body> </html>