UI::Dialog::Backend::XOSD(3pm) | User Contributed Perl Documentation | UI::Dialog::Backend::XOSD(3pm) |
NAME
UI::Dialog::Backend::XOSD - backend for the osd_cat(1).
SYNOPSIS
use UI::Dialog::Backend::XOSD; my $xosd = new UI::Dialog::Backend::XOSD (); $xosd->line( text => "Something to display...");
ABSTRACT
UI::Dialog::Backend::XOSD is an OOPerl wrapper for the osd_cat(1) program.
DESCRIPTION
Use this module to present feedback to the end user via an on-screen display (like an on-screen TV volume meter). When you use any of the UI::Dialog meta classes (UI::Dialog, UI::Dialog::GNOME, etc.) access to this backend is provided via the $d->xosd method. ie: replace $xosd with $d->xosd in the synopsis example (provided you made $d with something like my $d = new UI::Dialog...). Also, UI::Dialog (and friends) only load this module when you first use the $d->xosd method (this may silently fail, but you can test by ref() for success).
EXPORT
INHERITS
CONSTRUCTOR
new( @options )
my $xosd = new UI::Dialog::Backend::XOSD ( );
- DESCRIPTION
- OPTIONS
- The (...)'s after each option indicate the default for the option. An * denotes support by all the widget methods on a per-use policy defaulting to the values decided during object creation.
METHODS
line( )
$xosd->line( text => "some text to display" );
- DESCRIPTION
file( )
$xosd->file( file => "/path/to/a/file" );
- DESCRIPTION
gauge( )
$xosd->gauge( text => "", percent => $current_percentage, length => 40, bar => "-", mark => "|" );
- DESCRIPTION
display_start( )
$xosd->display_start( );
- DESCRIPTION
display_text( )
$xosd->display_start(); $xosd->display_text( "Some string to display." );
- DESCRIPTION
display_gauge( )
$xosd->display_start(); $xosd->display_gauge( 50, "display an optional text string." );
- DESCRIPTION
display_stop( )
$xosd->display_start(); $xosd->display_text( "about to stop!" ); $xosd->display_stop();
- DESCRIPTION
SEE ALSO
BUGS
Please email the author with any bug reports. Include the name of the module in the subject line.
AUTHOR
Kevin C. Krinke, <kevin@krinke.ca>
COPYRIGHT AND LICENSE
Copyright (C) 2004-2016 Kevin C. Krinke <kevin@krinke.ca> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
2018-10-27 | perl v5.28.0 |