NAME

DESCRIPTION

METHODS

_init(App::PFM::Application $pfm, App::PFM::Screen $screen)

Initializes new instances by storing the application object. Called from the constructor.

_maxpan(string $banner, int $width)

Determines how many times a banner (menu or footer) can be panned.

_fitbanner(string $banner, int $width)

Chops off part of the banner (menu or footer), and returns the part that will fit on the screen, as indicated by width. Pan key marks < and > will be added.

_getmenu( [ int $menu_mode ] )

Returns the menu for the given menu mode. This uses the MENU_* constants as defined in App::PFM::Screen::Frame.

_getheadings( [ int $heading_mode ] )

Returns the headings line for the current application state. The heading_mode parameter indicates the type of headings line that is shown, using the HEADING_* constants as defined in App::PFM::Screen::Frame.

_getfooter( [ int $footer_mode ] )

Returns the footer for the current application state. The footer_mode parameter indicates the type of footer that is shown, using the FOOTER_* constants as defined in App::PFM::Screen::Frame.

fieldheadings()

Getter for the hash that defines the column headings to be printed.

currentpan( [ int $pan_value ] )

Getter/setter for the amount by which the menu and footer are currently panned.

bookmark_headings()

Getter for the correct bookmark headings for the current screenwidth and format.

rcsrunning( [ bool $rcsrunning_value ] )

Getter/setter for the flag that indicates whether an rcs command is running.

show(hashref { menu => int $menu_mode, footer => int $footer_mode, headings => int $heading_mode, prompt => string $prompt } )

Displays menu, footer and headings according to the specified modes. If a prompt is specified, no menu is shown, but a prompt is shown instead.

show_menu_or_prompt(hashref { menu => int $menu_mode, prompt => string $prompt } )

Unified interface for displaying either the menu (i.e., the top line on the screen), using show_menu(), or a prompt.

show_menu(int $menu_mode)

Displays the menu, i.e., the top line on the screen. The menu_mode argument indicates which kind of menu is to be shown, using the MENU_ constants as defined in App::PFM::Screen::Frame.

show_headings(bool $swapmode, int $heading_mode)

Displays the column headings. The heading_mode argument indicates which kind of information is shown in the diskinfo column, using the HEADING_ constants as defined in App::PFM::Screen::Frame.

show_footer( [ int $footer_mode ] )

Displays the footer, i.e. the last line on screen with the status info.

update_headings()

Updates the column headings in case of a mode change.

pan(string $key, $string $menu_mode)

Pans the menu and footer according to the key pressed. The menu_mode parameter indicates the type of menu that should be shown, using the MENU_ constants as defined in App::PFM::Screen::Frame.

CONSTANTS

MENU_SINGLE

The standard menu for single file mode.

MENU_MULTI

The standard menu for multiple file mode.

MENU_MORE

The menu for the More command.

MENU_SORT

The menu for the F6 command.

MENU_INCLUDE

The menu for the Include command.

MENU_EXCLUDE

The menu for the eXclude command.

MENU_LNKTYPE

The menu for the Link command.

MENU_NONE

Display no menu.

HEADING_DISKINFO

The standard heading for single file mode (diskinfo is shown).

HEADING_YCOMMAND

The heading for the Your command ('your' commands are shown).

HEADING_SORT

The heading for the F6 command (sort modes are shown).

HEADING_ESCAPE

The heading for cOmmand (the =1 etc. escapes are shown).

HEADING_CRITERIA

The for Include and e<X>clude (selection criteria are shown).

HEADING_BOOKMARKS

The heading for bookmarks.

FOOTER_SINGLE

The standard footer for single file mode.

FOOTER_MULTI

The standard footer for single file mode.

FOOTER_NONE

Display no footer.

These constants may be provided to the methods that display menu, headings and footer, e.g.

    $frame->show_menu(MENU_SORT);

SEE ALSO