Osd(3p)               User Contributed Perl Documentation              Osd(3p)



NAME
       X::Osd - Perl extension to the X On Screen Display library (xosd)

SYNOPSIS
         use X::Osd;
         my $osd = X::Osd->new(NULL, 2);
         $osd->set_font("-*-lucidatypewriter-medium-r-normal-*-*-25-*-*-*-*-*-*");
         $osd->set_colour("Green");
         $osd->set_timeout(3);
         $osd->set_pos(XOSD_top);
         $osd->set_align(XOSD_right);
         $osd->set_horizontal_offset(0);
         $osd->set_vertical_offset(10);
         $osd->set_shadow_offset(2);

         $osd->string(0,'Hello World!');
         $osd->percentage(0,56);
         $osd->slider(0,34);

DESCRIPTION
       XOSD displays text on your screen, sounds simple right? The difference
       is it is unmanaged and shaped, so it appears transparent. This gives
       the effect of an On Screen Display, like your TV/VCR etc..

       It currently supports 3 type of writes, string for simple text, printf
       formatted text, slider and percentage display.

       You need to have libxosd installed.  You can get it from
       http://www.ignavus.net/software.html

   EXPORT
       None by default.

   Exported constants
         XOSD_top
         XOSD_middle
         XOSD_bottom
         XOSD_left
         XOSD_center
         XOSD_right

   Exportable functions
       o   create(disp, number_lines);

       o   string(line,string)

       o   printf(line, string)

       o   percentage(line,percentage)

                   where percentage is between 0 and 100

       o   slider(line,percentage)

                   where percentage is between 0 and 100

       o   get_colour(red,green,blue)

       o   get_shadow_colour(red,green,blue)

       o   get_outline_colour(red,green,blue)

       o   hide()

       o   show()

       o   set_bar_length(osd, lenght)

       o   set_colour(color)

       o   set_shadow_colour(shadow_colour)

       o   set_outline_colour(outline_colour)

       o   set_font(font)

       o   set_vertical_offset(offset)

       o   set_horizontal_offset(offset)

       o   set_pos(pos)

           where pos is one of (XOSD_top, XOSD_middle, XOSD_bottom)

       o   set_align(align)

           where align is one of (XOSD_left, XOSD_center, XOSD_right)

       o   set_shadow_offset(shadow_offset)

       o   set_outline_offset(outline_offset)

       o   set_timeout(timeout)

       o   is_onscreen()

       o   wait_until_no_display()

       o   scroll(lines)

       o   get_number_lines()

AUTHOR
       Philippe M. Chiasson <gozer@cpan.org>

CREDITS
        Bjorn Bringert E<lt>bjorn@bringert.netE<gt> xosd-1.0.x fixes
        Etan Reisner E<lt>deryni@eden.rutgers.eduE<gt> provided a patch for new xosd faatures

VERSION
       This is revision $Id: Osd.pm,v 1.17 2003/07/01 12:52:19 gozer Exp $

CVS The CVS repository of X::Osd is avaliabe thru anoncvs at:
        $> cvs -d :pserver:anoncvs@cvs.ectoplasm.org:/home/anoncvs login
        password: anoncvs
        $> cvs -d :pserver:anoncvs@cvs.ectoplasm.org:/home/anoncvs co X-Osd

COPYRIGHT
       Copyright (c) 2002-2003 Philippe M. Chiasson. All rights reserved. This
       program is free software, you can redistribute it and/or modify it
       under the same terms as Perl itself.

SEE ALSO
       perl

       Home & Author of XOSD http://www.ignavus.net/software.html
       <spoonboy@ignavus.net>



perl v5.12.2                      2003-07-01                           Osd(3p)
