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

   1 /* -*-c-*-
   2  *
   3  * $Id: xatom.h,v 1.2 2004/04/08 01:36:29 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 #ifndef XATOM_H
  30 #define XATOM_H
  31
  32 #ifdef __cplusplus
  33   extern "C" {
  34 #endif
  35
  36 /*----- Header files ------------------------------------------------------*/
  37
  38 #include <X11/Xlib.h>
  39 #include <X11/Xutil.h>
  40
  41 /*----- Functions provided ------------------------------------------------*/
  42
  43 /* --- @xatom_set@ --- *
  44  *
  45  * Arguments:   @Display *d@ = pointer to display
  46  *              @Window w@ = window to set
  47  *              @Atom p@ = property to set
  48  *              @Atom a@ = atom property value
  49  *
  50  * Returns:     ---
  51  *
  52  * Use:         Sets an atom property on a particular window.
  53  */
  54
  55 extern void xatom_set(Display */*d*/, Window /*w*/, Atom /*p*/, Atom /*a*/);
  56
  57 /* --- @xatom_get@ --- *
  58  *
  59  * Arguments:   @Display *d@ = pointer to display
  60  *              @Window w@ = window to set
  61  *              @Atom p@ = property to read
  62  *
  63  * Returns:     Atom which is the value of the property.
  64  *
  65  * Use:         Reads an atom property from a particular window.  The value
  66  *              @None@ is returned if there is no atom value.
  67  */
  68
  69 extern Atom xatom_get(Display */*d*/, Window /*w*/, Atom /*p*/);
  70
  71 /*----- That's all, folks -------------------------------------------------*/
  72
  73 #ifdef __cplusplus
  74   }
  75 #endif
  76
  77 #endif