doc/color.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE class SYSTEM '/usr/local/xslt/doc.dtd'>
   3 <?xml-stylesheet type='text/xsl' href='class.xsl'?>
   4 <class name='color' system='AXE - ANDROMEDA X windows Encapsulation'>
   5 <title>Color allocation in X</title>
   6 <synopsis>
   7 <verbatim>
   8 #include &lt;AXE/color.h&gt;
   9
  10 class color
  11 </verbatim>
  12 </synopsis>
  13
  14 <description>
  15 <para>
  16 The <strong>color</strong> class encapsulates the <emph>Color</emph>
  17 resource in X.
  18 </para>
  19 </description>
  20
  21 <methods>
  22 <function name='operator unsigned long'>
  23    <title>Convert color to a pixel value</title>
  24 </function>
  25
  26 <function name='color'>
  27    <title>color contructors and destructors</title>
  28 </function>
  29
  30 <function name='Alloc'>
  31    <title>title:Allocate a new color</title>
  32    <arguments>
  33       <argument name='red' type='unsigned'>
  34       </argument>
  35       <argument name='green' type='unsigned'>
  36       </argument>
  37       <argument name='blue' type='unsigned'>
  38       </argument>
  39    </arguments>
  40    <arguments>
  41       <argument name='colorname' type='char *'>
  42       </argument>
  43    </arguments>
  44    <description>
  45    <para>
  46    Allocate a new Color resource in the X server.
  47    </para>
  48    </description>
  49 </function>
  50 </methods>
  51
  52 <h2> SEE ALSO</h2>
  53 <h2> DIAGNOSTICS</h2>
  54
  55 </class>