Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xosd_create(3) [debian man page]

XOSD_CREATE(3)															    XOSD_CREATE(3)

NAME
xosd_create - Create a new XOSD object SYNOPSIS
#include <xosd.h> xosd *xosd_create (int number_lines); DESCRIPTION
xosd_init creates a new xosd window that can be used to display textual or numerical data on a X11 display in a unmanaged, shaped window that appears to be transparent. It provides a similar effect to the on-screen display of many televisions and video recorders. ARGUMENTS
number_lines The maximum number of lines of text that the window can display. This value cannot be changed. RETURN VALUE
On success a pointer to a new xosd object is returned, otherwise NULL is returned. ENVIRONMENT
DISPLAY The environment variable that determines which X11 display the XOSD window appears. char *xosd_error A string to a text string describing the error. HISTORY
The xosd_create function first appeared in version 2.0 of the XOSD library, replacing the now depricated xosd_init function. AUTHORS
The XOSD library was originally written by Andre Renaud, and is currenly maintained by Tim Wright. This document was written by Michael Ja- sonSmith. BUGS
There are no known bugs with xosd_create. Bug reports can be sent to <xosd@ignavus.net>. SEE ALSO
xosd_destroy(3), xosd_show(3), xosd_set_pos(3), xosd_set_align(3), xosd_set_shadow_offset(3), xosd_set_offset(3), xosd_set_timeout(3), xosd_set_colour(3), xosd_set_font(3), xosd_show(3), xosd_scroll(3). XOSD_CREATE(3)

Check Out this Related Man Page

UI::Dialog::Backend::XOSD(3pm)				User Contributed Perl Documentation			    UI::Dialog::Backend::XOSD(3pm)

NAME
UI::Dialog::Backend::XOSD 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
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 temporar- ily 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 cre- ated the command pipe. RETURNS TRUE(1) for success and FALSE(0) otherwise. display_text( ) EXAMPLE $xosd->display_start(); $xosd->display_text( "Some string to display." ); DESCRIPTION Uses the command pipe created by display_start() and prints the first argument to the screen. This method does not have any options, save the one string scalar. RETURNS TRUE(1) for success and FALSE(0) otherwise. display_gauge( ) EXAMPLE $xosd->display_start(); $xosd->display_gauge( 50, "display an optional text string." ); DESCRIPTION Uses the command pipe created by display_start() and prints a gauge identical to the regular (stand-alone) gauge() method. There are only to accepted arguments; the desired percentage and an optional text string. RETURNS TRUE(1) for success and FALSE(0) otherwise. display_stop( ) EXAMPLE $xosd->display_start(); $xosd->display_text( "about to stop!" ); $xosd->display_stop(); DESCRIPTION This closes the command pipe opened by the display_start() method. This method takes no arguments and performs only the task for closing and existing command pipe. RETURNS TRUE(1) for success and FALSE(0) otherwise. SEE ALSO
PERLDOC UI::Dialog UI::Dialog::Backend MAN FILES osd_cat(1) BUGS
Please email the author with any bug reports. Include the name of the module in the subject line. AUTHOR
Kevin C. Krinke, <kckrinke@opendoorsoftware.com> COPYRIGHT AND LICENSE
Copyright (C) 2003 Kevin C. Krinke <kckrinke@opendoorsoftware.com> 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 perl v5.8.8 2004-08-01 UI::Dialog::Backend::XOSD(3pm)
Man Page