data::pager(3pm) [debian man page]
Data::Pager(3pm) User Contributed Perl Documentation Data::Pager(3pm) NAME
Data::Pager - flexible data pager SYNOPSIS
use Data::Pager; my $pager = Data::Pager->new({ current => 100, perpage => 10, offset => 5, limit => 2000, }); #~ accessors: $pager->current; # 100 $pager->next; # 101 $pager->prev; # 99 $pager->limit; # 2000 $pager->start; # 1 # not typical start of a programmer $pager->final; # # 400 (which denotes 2000 / 5 pager links) $pager->end; # / $pager->from; # 495 (may serve in SQL LIMIT clause) $pager->to; # 500 (may serve in SQL LIMIT clause) $pager->list; # 95 96 97 98 99 100 101 102 103 104 105 DESCRIPTION
This class implements the familiar pager where the current position is centered. CONSTRUCTOR
new my $pager = Data::Pager->new({ current => 1, # this is the current pager position perpage => 10, # the pager consists of this number of links (defaults to 10) offset => 5, # this is the number of results (fetched from the DB for example) per result limit => 100, # how far is the pager allowed }); # sample output from html table: id ... ..... ... 1. ... ..... ... 2. ... ..... ... 3. ... ..... ... 4. ... ..... ... 5. ... ..... ... 1 2 3 4 5 6 7 8 9 10 Returns object or undef if current position is beyond the limit. METHODS
current $pager->current(); Returns the current pager position. set_current($digit) $pager->set_current(850); $pager->set_current(850)->next(); Sets the current pager position. Returns the pager object on succes, undef on false. next Returns the next pager position or undef if this is the last one. prev Returns the previous pager position or undef if this is the first one. start Returns 1 - the start pager position. end Returns the end pager position. first Returns the first pager position for this result set. last Returns the last pager position for this result set. from '1' => { 'to' => 5, 'next' => 2, 'prev' => undef, 'from' => 0 }, '2' => { 'to' => 10, 'next' => 3, 'prev' => 1, 'from' => 5 }, ... Returns the start result this pager position refers to. to Returns the end result this pager position refers to. list @_ = $pager->list; $_ = $pager->list; Returns the pager links for this result set. In list context returns the resulting list. In scalar context returns reference to the resulting list. # note the alignment $pager->set_current(10); print $pager->list; # 6 7 8 9 [10] 11 12 13 14 15 $pager->set_current(33); print $pager->list; # 28 29 30 31 32 [33] 34 35 36 37 38 SEE ALSO
Data::Page BUGS
What BUGS? AUTHOR
Vidul Nikolaev Petrov, vidul@cpan.org COPYRIGHT
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module. perl v5.10.0 2006-04-04 Data::Pager(3pm)
Check Out this Related Man Page
term::interact::pager(n) Terminal control term::interact::pager(n) __________________________________________________________________________________________________________________________________________________ NAME
term::interact::pager - Terminal widget, paging SYNOPSIS
package require Tcl 8.4 package require term::interact::pager ?0.1? term::interact::pager object text ?options...? object interact object done object clear object text text object configure object configure option object configure option value... object cget option _________________________________________________________________ DESCRIPTION
This package provides a class for the creation of a simple paging text display. CLASS API
The package exports a single command, the class command, enabling the creation of pager instances. Its API is: term::interact::pager object text ?options...? This command creates a new pager object with the name object, initializes it, and returns the fully qualified name of the object command as its result. The argument is the text to show, possibly followed by configuration options and their values. The options are explained in the sec- tion Configuration. OBJECT API
The objects created by the class command provide the methods listed below: object interact Show the pager in the screen at the configured location and start interacting with it. This opens its own event loop for the pro- cessing of incoming characters. The method returns when the interaction has completed. See section Interaction for a description of the possible interaction. object done This method can be used by user supplied actions to terminate the interaction with the object. object clear This method can be used by user supplied actions to remove the pager from the terminal. object text text This method can be used to change the text shown by the pager. The pager will reset the dispay to show the first line of the text at the top. object configure object configure option object configure option value... object cget option Standard methods to retrieve and configure the options of the pager. CONFIGURATION
A pager instance recognizes the following options: -in chan Specifies the channel to read character sequences from. Defaults to stdin. -out chan Specifies the channel to write the pager contents to. Defaults to stdout. -column int Specifies the column of the terminal where the left margin of the pager display should appear. Defaults to 0, i.e. the left-most column. -line int Specifies the line of the terminal where the top margin of the pager display should appear. Defaults to 0, i.e. the top-most line. -height int Specifies the number of lines of text to show at most in the display. Defaults to 25. -actions dict Specifies a dictionary containing additional actions, using character sequences as keys. Note that these sequences cannot override the hardwired sequences described in section Interaction. INTERACTION
A pager object recognizes the control sequences listed below and acts as described. The user can supply more control sequences to act on via the configuration, but is not able to overide these defaults. Cursor Up The text is scrolled down a single line, making one more line visible at the top. The pager will not react if the first line of the text is already shown. Cursor Down The text is scrolled up a single line, making one more line visible at the bottom. The pager will not react if the last line of the text is already shown. Page Up The text is scrolled down a page. The pager will not react if the first line of the text is already shown. Page Down The text is scrolled up a page. The pager will not react if the last line of the text is already shown. Enter/Return The interaction with the object is terminated. BUGS, IDEAS, FEEDBACK This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category term of the Tcllib SF Trackers [http://sourceforge.net/tracker/?group_id=12883]. Please also report any ideas for enhancements you may have for either package and/or documentation. KEYWORDS
control, pager, terminal, text display CATEGORY
Terminal control COPYRIGHT
Copyright (c) 2006 Andreas Kupries <andreas_kupries@users.sourceforge.net> term 0.1 term::interact::pager(n)