chiark - git - mdw - xtoys/blob - xatom.h

   1 /* -*-c-*-
   2  *
   3  * $Id: xatom.h,v 1.1 1999/08/20 07:28:44 mdw Exp $
   4  *
   5  * Set and fetch X atom properties
   6  *
   7  * (c) 1999 Straylight/Edgeware
   8  */
   9
  10 /*----- Licensing notice --------------------------------------------------*
  11  *
  12  * This file is part of the Edgeware X tools collection.
  13  *
  14  * X tools is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * X tools is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with X tools; if not, write to the Free Software Foundation,
  26  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  27  */
  28
  29 /*----- Revision history --------------------------------------------------*
  30  *
  31  * $Log: xatom.h,v $
  32  * Revision 1.1  1999/08/20 07:28:44  mdw
  33  * New source file for manipulating atom-valued window properties.
  34  *
  35  */
  36
  37 #ifndef XATOM_H
  38 #define XATOM_H
  39
  40 #ifdef __cplusplus
  41   extern "C" {
  42 #endif
  43
  44 /*----- Header files ------------------------------------------------------*/
  45
  46 #include <X11/Xlib.h>
  47 #include <X11/Xutil.h>
  48
  49 /*----- Functions provided ------------------------------------------------*/
  50
  51 /* --- @xatom_set@ --- *
  52  *
  53  * Arguments:   @Display *d@ = pointer to display
  54  *              @Window w@ = window to set
  55  *              @Atom p@ = property to set
  56  *              @Atom a@ = atom property value
  57  *
  58  * Returns:     ---
  59  *
  60  * Use:         Sets an atom property on a particular window.
  61  */
  62
  63 extern void xatom_set(Display */*d*/, Window /*w*/, Atom /*p*/, Atom /*a*/);
  64
  65 /* --- @xatom_get@ --- *
  66  *
  67  * Arguments:   @Display *d@ = pointer to display
  68  *              @Window w@ = window to set
  69  *              @Atom p@ = property to read
  70  *
  71  * Returns:     Atom which is the value of the property.
  72  *
  73  * Use:         Reads an atom property from a particular window.  The value
  74  *              @None@ is returned if there is no atom value.
  75  */
  76
  77 extern Atom xatom_get(Display */*d*/, Window /*w*/, Atom /*p*/);
  78
  79 /*----- That's all, folks -------------------------------------------------*/
  80
  81 #ifdef __cplusplus
  82   }
  83 #endif
  84
  85 #endif