/usr/include/xosd.h is in libxosd-dev 2.2.14-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 | #ifndef XOSD_H
#define XOSD_H
#ifdef __cplusplus
extern "C"
{
#endif
#ifndef __deprecated
#if ( __GNUC__ == 3 && __GNUC_MINOR__ > 0 ) || __GNUC__ > 3
#define __deprecated __attribute__((deprecated))
#else
#define __deprecated
#endif
#endif
/* Error message when a routine returns failure */
extern char *xosd_error;
extern const char *osd_default_font;
extern const char *osd_default_colour;
/* The XOSD display "object" */
typedef struct xosd xosd;
/* The type of data that can be displayed. */
typedef enum
{
XOSD_percentage, /* Percentage bar (like a progress bar) */
XOSD_string, /* Text */
XOSD_printf, /* Formatted Text */
XOSD_slider /* Slider (like a volume control) */
} xosd_command;
/* Position of the display */
typedef enum
{
XOSD_top = 0, /* Top of the screen. */
XOSD_bottom, /* Bottom of the screen. */
XOSD_middle /* middle of the screen. */
} xosd_pos;
/* Alignment of the display */
typedef enum
{
XOSD_left = 0,
XOSD_center,
XOSD_right
} xosd_align;
/* xosd_create -- Create a new xosd "object"
*
* ARGUMENTS
* number_lines Number of lines of the display.
*
* RETURNS
* A new xosd structure.
*/
xosd *xosd_create(int number_lines);
/* xosd_init -- Create a new xosd "object" -- deprecated by xosd_create
*
* ARGUMENTS
* font X Logical Font Descriptor, see "xfontsel".
* colour X colour, see "rgb.txt" that comes with your X11
* distribution.
* timeout Seconds before the display is hidden (-1 for
* never).
* pos Position to write text (top or bottom).
* offset Number of pixels between the "pos" and the
* text.
* shadow_offset Number of pixels that the shadow is offset from
* the text.
* number_lines Number of lines of the display.
*
* RETURNS
* A new xosd structure.
*/
xosd *__deprecated xosd_init(const char *font, const char *colour,
int timeout, xosd_pos pos, int offset,
int shadow_offset, int number_lines);
/* xosd_destroy -- Destroy a xosd "object"
*
* ARGUMENTS
* osd The xosd "object" to destroy.
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_destroy(xosd * osd);
/* xosd_uninit -- Destroy a xosd "object -- deprecated by xosd_destroy
*
* ARGUMENTS
* osd The xosd "object" to destroy.
*
* RETURNS
* 0 on success
* -1 on failure
*/
int __deprecated xosd_uninit(xosd * osd);
/* xosd_set_bar_length -- Set length of percentage and slider bar
*
* ARGUMENTS
* osd The xosd "object"
* length Desired bar length (set to -1 for old behaviour)
*
* RETURNS
* -1 on error (invalid xosd object).
* 0 on success
*/
int xosd_set_bar_length(xosd * osd, int length);
/* xosd_display -- Display information
*
* ARGUMENTS
* osd The xosd "object".
* line Which one of "NLINES" to display.
* command The type of information to display.
* ... The argument to "command":
* int (between 0 and 100) if "command" is
* "XOSD_percentage",
* char * if "command" is "XOSD_string",
* int (between 0 and 100) if "command" is
* "XOSD_slider".
* RETURNS
* The percentage (between 0 and 100) for "XOSD_percentage" or
* "XOSD_slider", or the number of characters displayed for
* "XOSD_string". -1 is returned on failure.
*/
int xosd_display(xosd * osd, int line, xosd_command command, ...);
/* xosd_is_onscreen -- Returns weather the display is show
*
* ARGUMENTS
* osd The xosd "object".
*
* RETURNS
* 1 if the display is shown (mapped)
* 0 otherwise
* -1 on failure
*/
int xosd_is_onscreen(xosd * osd);
/* xosd_wait_until_no_display -- Wait until nothing is displayed
*
* ARGUMENTS
* osd The xosd "object".
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_wait_until_no_display(xosd * osd);
/* xosd_hide -- hide the display
*
* ARGUMENTS
* osd The xosd "object".
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_hide(xosd * osd);
/* xosd_show -- Show the display after being hidden
*
* ARGUMENTS
* osd The xosd "object".
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_show(xosd * osd);
/* xosd_set_pos -- Change the vertical position of the display
*
* ARGUMENTS
* osd The xosd "object".
* pos The new position of the display: top middle bottom
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_set_pos(xosd * osd, xosd_pos pos);
/* xosd_set_align -- Change the horizontal alignment of the display
*
* ARGUMENTS
* osd The xosd "object".
* align The new alignment of the display: left center right
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_set_align(xosd * osd, xosd_align align);
/* xosd_set_shadow_offset -- Change the offset of the text shadow
*
* ARGUMENTS
* osd The xosd "object".
* shadow_offset The new shadow offset in pixels.
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_set_shadow_offset(xosd * osd, int shadow_offset);
/* xosd_set_outline_offset -- Change the offset of the text outline
*
* ARGUMENTS
* osd The xosd "object".
* shadow_offset The new outline offset in pixels.
*
* The outline is drawn over the shadow.
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_set_outline_offset(xosd * osd, int outline_offset);
/* xosd_set_outline_colour -- Change the colour of the outline
*
* ARGUMENTS
* osd The xosd "object".
* colour The new colour of the display. (See "rgb.txt" in the
* X11 distribution of a list of colours.)
*
* RETURNS
* 0 on success
* -1 on failure, and colour is set to black
*/
int xosd_set_outline_colour(xosd * osd, const char *colour);
/* xosd_set_shadow_colour -- Change the colour of the shadow
*
* ARGUMENTS
* osd The xosd "object".
* colour The new colour of the display. (See "rgb.txt" in the
* X11 distribution of a list of colours.)
*
* RETURNS
* 0 on success
* -1 on failure, and colour is set to black
*/
int xosd_set_shadow_colour(xosd * osd, const char *colour);
/* xosd_set_horizontal_offset -- Change the number of pixels the display is
* offset from the position
*
* ARGUMENTS
* osd The xosd "object".
* offset The number of pixels the display is offset from the
* position.
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_set_horizontal_offset(xosd * osd, int offset);
/* xosd_set_vertical_offset -- Change the number of pixels the display is
* offset from the position
*
* ARGUMENTS
* osd The xosd "object".
* offset The number of pixels the display is offset from the
* position.
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_set_vertical_offset(xosd * osd, int offset);
/* xosd_set_timeout -- Change the time before display is hidden.
*
* ARGUMENTS
* osd The xosd "object".
* timeout The number of seconds before the display is hidden.
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_set_timeout(xosd * osd, int timeout);
/* xosd_set_colour -- Change the colour of the display
*
* ARGUMENTS
* osd The xosd "object".
* colour The new colour of the display. (See "rgb.txt" in the
* X11 distribution of a list of colours.)
*
* RETURNS
* 0 on success
* -1 on failure, and colour is set to white
*/
int xosd_set_colour(xosd * osd, const char *colour);
/* xosd_set_font -- Change the text-display font
*
* ARGUMENTS
* osd The xosd "object".
* font The XLFD of the new font, see "xfontsel".
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_set_font(xosd * osd, const char *font);
/* xosd_get_colour -- Gets the RGB value of the display's colour
*
* ARGUMENTS
* osd The xosd "object".
* red Return value for the red value.
* green Return value for the green value.
* blue Return value for the blue value.
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_get_colour(xosd * osd, int *red, int *green, int *blue);
/* xosd_scroll -- Scroll the display
*
* ARGUMENTS
* osd The xosd "object".
* lines The number of lines to scroll the display.
*
* RETURNS
* 0 on success
* -1 on failure
*/
int xosd_scroll(xosd * osd, int lines);
/* xosd_get_number_lines -- Get the maximum number of lines allowed
*
* ARGUMENTS
* osd The xosd "object".
*
* RETURNS
* the number of lines on success
* -1 on failure
*/
int xosd_get_number_lines(xosd * osd);
#ifdef __cplusplus
};
#endif
#endif
|