NAME

DESCRIPTION

METHODS

_init(App::PFM::Screen $screen, App::PFM::Config $config)

Initializes new instances. Called from the constructor.

_wait_loop()

Waits for keyboard input. In unused time, poll jobs and update the on-screen clock.

_highlight(boolean $value)

Highlights the current screen line, if value is true. Otherwise, removes highlight.

currentline( [ int $lineno ] )

Getter/setter for the current line number of the cursor.

baseindex( [ int $index ] )

Getter/setter for the start of the screen window in the current directory.

setview(int $lineno, int $index)

Getter/setter for both the cursor line and screen window at once. Used by handlescroll().

position_at(string $filename [, hashref { force => bool $force, exact => bool $exact } ] )

Getter/setter for the position_at variable, which controls to which file the cursor should go as soon as the main browse loop is resumed.

If the force option is false, the old value of position_at will only be replaced if it was undefined. If true, any old value of position_at will be overwritten.

The exact option indicates that exact placement should be used instead of fuzzy placement.

mouse_mode( [ bool $mouse_mode ] )

Getter/setter for the mouse_mode variable, which indicates if mouse clicks are to be intercepted by the application.

validate_position()

Checks if the current cursor position and the current file lie within the screen window. If not, the screen window is repositioned so that the cursor is on-screen.

handlescroll(char $key)

Handles CTRL-E and CTRL-Y, which scroll the current view of the directory.

handlemove(char $key)

Handles the keys which move around in the current directory.

handle(App::PFM::Event $event)

Attempts to handle the user event (keyboard- or mouse-input). Returns a hash reference with a member 'handled' indicating if this was successful, and a member 'data' with additional data (like the string 'quit' in case the user requested an application quit).

browse()

This sub, the main browse loop, is the heart of pfm. It has the following structure:

  do {
    refresh the screen;
    wait for keypress-, mousedown- or resize-event;
    handle the request;
  } until quit was requested.
    

EVENTS

after_receive_non_motion_input

Called when the input event is not a browsing event. Probably the CommandHandler knows how to handle it.

SEE ALSO