home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / include / x11 / xmu / displayque.h < prev    next >
Encoding:
C/C++ Source or Header  |  1996-10-17  |  4.8 KB  |  169 lines
  1. /* $XConsortium: DisplayQue.h,v 1.7 94/04/17 20:15:59 rws Exp $ */
  2.  
  3. /*
  4.  
  5. Copyright (c) 1994  X Consortium
  6.  
  7. Permission is hereby granted, free of charge, to any person obtaining a copy
  8. of this software and associated documentation files (the "Software"), to deal
  9. in the Software without restriction, including without limitation the rights
  10. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11. copies of the Software, and to permit persons to whom the Software is
  12. furnished to do so, subject to the following conditions:
  13.  
  14. The above copyright notice and this permission notice shall be included in
  15. all copies or substantial portions of the Software.
  16.  
  17. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  20. X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  21. AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22. CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23.  
  24. Except as contained in this notice, the name of the X Consortium shall not be
  25. used in advertising or otherwise to promote the sale, use or other dealings
  26. in this Software without prior written authorization from the X Consortium.
  27.  
  28. */
  29.  
  30. #ifndef _XMU_DISPLAYQUE_H_
  31. #define _XMU_DISPLAYQUE_H_
  32.  
  33. #include <X11/Xmu/CloseHook.h>
  34. #include <X11/Xfuncproto.h>
  35.  
  36. /*
  37.  *                  Public Entry Points
  38.  * 
  39.  * 
  40.  * XmuDisplayQueue *XmuDQCreate (closefunc, freefunc, data)
  41.  *     XmuCloseDisplayQueueProc closefunc;
  42.  *     XmuFreeDisplayQueueProc freefunc;
  43.  *     XPointer data;
  44.  * 
  45.  *         Creates and returns a queue into which displays may be placed.  When
  46.  *         the display is closed, the closefunc (if non-NULL) is upcalled with
  47.  *         as follows:
  48.  *
  49.  *                 (*closefunc) (queue, entry)
  50.  *
  51.  *         The freeproc, if non-NULL, is called whenever the last display is
  52.  *         closed, notifying the creator that display queue may be released
  53.  *         using XmuDQDestroy.
  54.  *
  55.  *
  56.  * Bool XmuDQDestroy (q, docallbacks)
  57.  *     XmuDisplayQueue *q;
  58.  *     Bool docallbacks;
  59.  * 
  60.  *         Releases all memory for the indicated display queue.  If docallbacks
  61.  *         is true, then the closefunc (if non-NULL) is called for each 
  62.  *         display.
  63.  * 
  64.  * 
  65.  * XmuDisplayQueueEntry *XmuDQLookupDisplay (q, dpy)
  66.  *     XmuDisplayQueue *q;
  67.  *     Display *dpy;
  68.  *
  69.  *         Returns the queue entry for the specified display or NULL if the
  70.  *         display is not in the queue.
  71.  *
  72.  * 
  73.  * XmuDisplayQueueEntry *XmuDQAddDisplay (q, dpy, data)
  74.  *     XmuDisplayQueue *q;
  75.  *     Display *dpy;
  76.  *     XPointer data;
  77.  *
  78.  *         Adds the indicated display to the end of the queue or NULL if it
  79.  *         is unable to allocate memory.  The data field may be used by the
  80.  *         caller to attach arbitrary data to this display in this queue.  The
  81.  *         caller should use XmuDQLookupDisplay to make sure that the display
  82.  *         hasn't already been added.
  83.  * 
  84.  * 
  85.  * Bool XmuDQRemoveDisplay (q, dpy)
  86.  *     XmuDisplayQueue *q;
  87.  *     Display *dpy;
  88.  *
  89.  *         Removes the specified display from the given queue.  If the 
  90.  *         indicated display is not found on this queue, False is returned,
  91.  *         otherwise True is returned.
  92.  */
  93.  
  94. typedef struct _XmuDisplayQueue XmuDisplayQueue;
  95. typedef struct _XmuDisplayQueueEntry XmuDisplayQueueEntry;
  96.  
  97. typedef int (*XmuCloseDisplayQueueProc)(
  98. #if NeedFunctionPrototypes
  99.     XmuDisplayQueue*        /* queue */,
  100.     XmuDisplayQueueEntry*    /* entry */
  101. #endif
  102. );
  103.  
  104. typedef int (*XmuFreeDisplayQueueProc)(
  105. #if NeedFunctionPrototypes
  106.     XmuDisplayQueue*        /* queue */
  107. #endif
  108. );
  109.  
  110. struct _XmuDisplayQueueEntry {
  111.     struct _XmuDisplayQueueEntry *prev, *next;
  112.     Display *display;
  113.     CloseHook closehook;
  114.     XPointer data;
  115. };
  116.  
  117. struct _XmuDisplayQueue {
  118.     int nentries;
  119.     XmuDisplayQueueEntry *head, *tail;
  120.     XmuCloseDisplayQueueProc closefunc;
  121.     XmuFreeDisplayQueueProc freefunc;
  122.     XPointer data;
  123. };
  124.  
  125. _XFUNCPROTOBEGIN
  126.  
  127. extern XmuDisplayQueue *XmuDQCreate(
  128. #if NeedFunctionPrototypes
  129.     XmuCloseDisplayQueueProc    /* closefunc */,
  130.     XmuFreeDisplayQueueProc    /* freefunc */,
  131.     XPointer    /* data */
  132. #endif
  133. );
  134.  
  135. extern Bool XmuDQDestroy(
  136. #if NeedFunctionPrototypes
  137.     XmuDisplayQueue*    /* q */,
  138.     Bool        /* docallbacks */
  139. #endif
  140. );
  141.  
  142. extern XmuDisplayQueueEntry *XmuDQLookupDisplay(
  143. #if NeedFunctionPrototypes
  144.     XmuDisplayQueue*    /* q */,
  145.     Display*        /* dpy */
  146. #endif
  147. );
  148.  
  149. extern XmuDisplayQueueEntry *XmuDQAddDisplay(
  150. #if NeedFunctionPrototypes
  151.     XmuDisplayQueue*    /* q */,
  152.     Display*        /* dpy */,
  153.     XPointer        /* data */
  154. #endif
  155. );
  156.  
  157. extern Bool XmuDQRemoveDisplay(
  158. #if NeedFunctionPrototypes
  159.     XmuDisplayQueue*    /* q */,
  160.     Display*        /* dpy */
  161. #endif
  162. );
  163.  
  164. _XFUNCPROTOEND
  165.  
  166. #define XmuDQNDisplays(q) ((q)->nentries)
  167.  
  168. #endif /* _XMU_DISPLAYQUE_H_ */
  169.