xosd_set_horizontal

Prev		Next

Name

xosd_set_horizontal_offset — Change the horizontal offset of the XOSD window

Synopsis

#include <xosd.h>

`int xosd_set_horizontal_offset(`	xosd *	osd,
	int	indent`)`;

Description

xosd_set_horizontal_offset changes the number of pixels the XOSD window is indented to the right. This is done to avoid desktop-panels, such as those provided by GNOME or KDE. By default the horizontal indent is zero; a value of 48 will generally avoid most panels.

Arguments

osd: The XOSD window to change.
indent: The number of pixels the XOSD window is indented to the right.

Return Value

On success, a zero is returned. On error, -1 is returned and xosd_error is set to indicate the reason for the error.

Environment

char *xosd_error: A string describing the error, if one occurred.

History

The xosd_set_horizontal_offset function first appeared in version 2.0 of the XOSD library.

Authors

xosd_set_horizontal_offset was written by Etan Reisner. The XOSD library was originally written by André Renaud, and is currently maintained by Tim Wright. This document was written by Michael JasonSmith.

Bugs

Currently xosd_set_horizontal_offset does not move the XOSD window left when the window is aligned to the right (XOSD_right) of the display. Bug reports can be sent to <xosd@ignavus.net>.