X11/extensions/scrnsaver.h

0001 /*
0002  *
0003 Copyright (c) 1992  X Consortium
0004
0005 Permission is hereby granted, free of charge, to any person obtaining a copy
0006 of this software and associated documentation files (the "Software"), to deal
0007 in the Software without restriction, including without limitation the rights
0008 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
0009 copies of the Software, and to permit persons to whom the Software is
0010 furnished to do so, subject to the following conditions:
0011
0012 The above copyright notice and this permission notice shall be included in
0013 all copies or substantial portions of the Software.
0014
0015 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
0016 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
0017 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
0018 X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
0019 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
0020 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0021
0022 Except as contained in this notice, the name of the X Consortium shall not be
0023 used in advertising or otherwise to promote the sale, use or other dealings
0024 in this Software without prior written authorization from the X Consortium.
0025  *
0026  * Author:  Keith Packard, MIT X Consortium
0027  */
0028
0029 #ifndef _SCRNSAVER_H_
0030 #define _SCRNSAVER_H_
0031
0032 #include <X11/Xfuncproto.h>
0033 #include <X11/Xlib.h>
0034 #include <X11/extensions/saver.h>
0035
0036 typedef struct {
0037     int type;           /* of event */
0038     unsigned long serial;   /* # of last request processed by server */
0039     Bool send_event;        /* true if this came from a SendEvent request */
0040     Display *display;       /* Display the event was read from */
0041     Window window;      /* screen saver window */
0042     Window root;        /* root window of event screen */
0043     int state;          /* ScreenSaverOff, ScreenSaverOn, ScreenSaverCycle*/
0044     int kind;           /* ScreenSaverBlanked, ...Internal, ...External */
0045     Bool forced;        /* extents of new region */
0046     Time time;          /* event timestamp */
0047 } XScreenSaverNotifyEvent;
0048
0049 typedef struct {
0050     Window  window;     /* screen saver window - may not exist */
0051     int     state;      /* ScreenSaverOff, ScreenSaverOn, ScreenSaverDisabled*/
0052     int     kind;       /* ScreenSaverBlanked, ...Internal, ...External */
0053     unsigned long    til_or_since;   /* time til or since screen saver */
0054     unsigned long    idle;      /* total time since last user input */
0055     unsigned long   eventMask; /* currently selected events for this client */
0056 } XScreenSaverInfo;
0057
0058 _XFUNCPROTOBEGIN
0059
0060 extern Bool XScreenSaverQueryExtension (
0061     Display*    /* display */,
0062     int*    /* event_base */,
0063     int*    /* error_base */
0064 );
0065
0066 extern Status XScreenSaverQueryVersion (
0067     Display*    /* display */,
0068     int*    /* major_version */,
0069     int*    /* minor_version */
0070 );
0071
0072 extern XScreenSaverInfo *XScreenSaverAllocInfo (
0073     void
0074 );
0075
0076 extern Status XScreenSaverQueryInfo (
0077     Display*        /* display */,
0078     Drawable        /* drawable */,
0079     XScreenSaverInfo*   /* info */
0080 );
0081
0082 extern void XScreenSaverSelectInput (
0083     Display*    /* display */,
0084     Drawable    /* drawable */,
0085     unsigned long   /* eventMask */
0086 );
0087
0088 extern void XScreenSaverSetAttributes (
0089     Display*            /* display */,
0090     Drawable            /* drawable */,
0091     int             /* x */,
0092     int             /* y */,
0093     unsigned int        /* width */,
0094     unsigned int        /* height */,
0095     unsigned int        /* border_width */,
0096     int             /* depth */,
0097     unsigned int        /* class */,
0098     Visual *            /* visual */,
0099     unsigned long       /* valuemask */,
0100     XSetWindowAttributes *  /* attributes */
0101 );
0102
0103 extern void XScreenSaverUnsetAttributes (
0104     Display*    /* display */,
0105     Drawable    /* drawable */
0106 );
0107
0108 extern Status XScreenSaverRegister (
0109     Display*    /* display */,
0110     int     /* screen */,
0111     XID     /* xid */,
0112     Atom    /* type */
0113 );
0114
0115 extern Status XScreenSaverUnregister (
0116     Display*    /* display */,
0117     int     /* screen */
0118 );
0119
0120 extern Status XScreenSaverGetRegistered (
0121     Display*    /* display */,
0122     int     /* screen */,
0123     XID*    /* xid */,
0124     Atom*   /* type */
0125 );
0126
0127 extern void XScreenSaverSuspend (
0128     Display*    /* display */,
0129     Bool    /* suspend */
0130 );
0131
0132 _XFUNCPROTOEND
0133
0134 #endif /* _SCRNSAVER_H_ */