XOSD Guide and Reference

This manual is a guide to version 2.2 of the XOSD library.

Legal Notice

Table of Contents

I. XOSD Guide
1. Introduction
1.1. Acknowledgements
2. Installing XOSD
2.1. Installing from Packages
2.1.1. Installing Using Debian
2.1.2. Installing Using Mandrake
2.2. Installing from Source
3. Using libxosd
3.1. Our First XOSD Program
3.1.1. Compiling
3.2. Changing Attributes
3.2.1. Changing the Font
3.2.2. Adding a Shadow
3.2.3. Changing the Colour
3.2.4. Changing the Outline Colour
3.2.5. Changing the Position of the XOSD Window
3.2.6. Conclusion
3.3. Timeouts
3.3.1. Explicitly Hiding a Display
3.3.2. Redisplaying a Window
3.3.3. Using Timeouts
3.4. Error Handling
3.5. Displaying Interger Values
3.5.1. Percentage Bars
3.5.2. Sliders
3.5.3. Changing the Size of the Bar
3.5.4. Bar Example
3.6. Multi-Line Output
3.6.1. Displaying Two Lines of Data
3.6.2. Scrolling
4. Hacking libxosd
4.1. Architecture of XOSD
4.2. Coding Standards
II. Function Reference
I. Creating and Destroying
xosd_create - Create a new XOSD window
xosd_destroy - Destroy an XOSD window
II. Getting and Setting Attributes
xosd_set_pos - Change the vertical position of the XOSD window
xosd_set_align - Change the horizontal position of the XOSD window
xosd_set_vertical_offset - Change the vertical offset of the XOSD window
xosd_set_horizontal_offset - Change the horizontal offset of the XOSD window
xosd_set_colour - Change the colour of the data displayed the XOSD window
xosd_get_colour - Get the colour of the data displayed the XOSD window
xosd_set_shadow_offset - Change the shadow-offset of the XOSD window
xosd_set_outline_offset - Change the size of the outline of the data displayed in the XOSD window
xosd_set_outline_colour - Change the outline colour of the data displayed the XOSD window
xosd_set_font - Change the font used by the XOSD window
xosd_set_timeout - Change the time before the XOSD window is hidden
xosd_get_number_lines - Get the number of lines able to be shown by the XOSD window
xosd_set_bar_length - Change the length of the percentage bar or slider
III. Displaying Data
xosd_display - Display data to an XOSD window
xosd_show - Make the XOSD window visible
xosd_hide - Make the XOSD window invisible
xosd_scroll - Scroll the XOSD window
xosd_is_onscreen - Returns wether the XOSD window is shown
xosd_wait_until_no_display - Suspend execution until the XOSD window is hidden
IV. Command-Line Utilities
osd_cat - X on-screen file displayer
xosd-config - Get information about the installed version of libxosd