UI::Dialog::Backend::XOSD (3)

Leading comments

Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/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 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

None

INHERITS

UI::Dialog::Backend

CONSTRUCTOR

new( @options )

EXAMPLE

 my $xosd = new UI::Dialog::Backend::XOSD ( );

DESCRIPTION

This is the Class Constructor method. It accepts a list of key => value pairs and uses them as the defaults when interacting with the various widgets. All methods accept the same arguments as new() except that the arguments passed to the methods are temporarily used instead of making them the default as the new() method does. In the case of the 'wait' option, any (non-zero) value enables the option as it's a switch and not a string argument.

RETURNS

A blessed object reference of the UI::Dialog::Backend::XOSD class.

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.

offset = \d+ (0) *

align = \w+ ('left') *

indent = \d+ (0) *

font = x-font-string ('fixed') *

colour = \w+ ('red') *

delay = \d+ (5) *

lines = \d+ (5) *

shadow = \d+ (0) *

age = \d+ (0) *

wait = 0,1 (0) *

METHODS

1=head2 line( )

EXAMPLE

 $xosd->line( text => "some text to display" );

DESCRIPTION

Display a simple string on the screen.

RETURNS

Nothing.

file( )

EXAMPLE

 $xosd->file( file => "/path/to/a/file" );

DESCRIPTION

Display a file on the screen.

RETURNS

Nothing.

gauge( )

EXAMPLE

 $xosd->gauge( text => "",
               percent => $current_percentage,
               length => 40,
               bar => "-",
               mark => "|" );

DESCRIPTION

Display a gauge bar with a percentage mark on the screen with an optional message.

RETURNS

Nothing.

display_start( )

EXAMPLE

 $xosd->display_start( );

DESCRIPTION

Opens a pipe command to the osd_cat(1) program for prolonged interactivity. This accepts all of the standard options but has nothing else to offer. The other display_*() methods (detailed below) return zero unless this method has been used and has created the command pipe.

RETURNS

TRUE \fIs0(1) for success and

FALSE \fIs0(0) otherwise.