/ 
TUI-Vision-v2.0.1
/ TUI::Drivers::Mouse

NAME

TUI::Drivers::Mouse - public mouse driver interface

SYNOPSIS

use TUI::Drivers::Mouse;

# Public driver-layer mouse API
TMouse->resume();

if ( TMouse->present() ) {
  TMouse->show();
  TMouse->setRange(79, 24);

  my %event;
  TMouse->getEvent(\%event);

  TMouse->hide();
}

TMouse->suspend();

DESCRIPTION

TUI::Drivers::Mouse provides the public entry point for mouse handling in the TUI::Vision driver layer.

The module exports the symbolic name TMouse, which resolves to the underlying hardware mouse implementation. All mouse-related operations are delegated to THWMouse.

This module does not implement any logic of its own and exists to provide a user-facing interface.

TMouse is a class-style interface. It must not be instantiated.

Commonly Used Features

Within the driver stack, THWMouse is used to coordinate backend mouse startup/shutdown (resume()/suspend()), query availability (present()), and read raw mouse state (getEvent()).

For complete interface documentation and application-facing usage, see TUI::Drivers::Mouse.

METHODS

show

TMouse->show();

Makes the mouse cursor visible.

hide

TMouse->hide();

Hides the mouse cursor.

setRange

TMouse->setRange($rx, $ry);

Sets the horizontal and vertical movement range of the mouse.

getEvent

TMouse->getEvent(\%event);

Retrieves the next mouse event and stores it in the supplied event structure.

present

my $bool = TMouse->present();

Returns true if mouse hardware is available.

inhibit

TMouse->inhibit();

Temporarily disables mouse event processing.

resume

TMouse->resume();

Initializes mouse handling.

suspend

TMouse->suspend();

Disables mouse handling.

SEE ALSO

TUI::Drivers::HWMouse

AUTHORS

  • Borland International (original Turbo Vision design)

  • J. Schneider <brickpool@cpan.org> (Perl implementation and maintenance)

COPYRIGHT AND LICENSE

Copyright (c) 1990-1994, 1997 by Borland International

Copyright (c) 2021-2026 the "AUTHORS" as listed above.

This software is licensed under the MIT license (see the LICENSE file, which is part of the distribution).