<doc>
  <legacy_id>1497</legacy_id>
  <name>maskPixmapID</name>
  <type>property</type>
  <syntax>
    <example>set the maskPixmapID of <i>image</i> to {empty | <i>windowID</i>}</example>
  </syntax>
  <library></library>
  <objects>
    <image/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Images &amp; Multimedia</category>
    <category>The System Environment</category>
  </classification>
  <references>
    <property tag="imagePixmapID">imagePixmapID Property</property>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <linux/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
  </classes>
  <security>
  </security>
  <summary>Specifies the window ID of the X11 <glossary tag="pixmap">pixmap</glossary> used to <glossary tag="mask">mask</glossary> an <keyword tag="image">image</keyword>.</summary>
  <examples>
    <example>set the maskPixmapID of image ID 4500 to empty</example>
  </examples>
  <description>
    <p>Use the <b>maskPixmapID</b> <glossary tag="property">property</glossary> to pass to an <glossary tag="external">external</glossary> that needs to manipulate the <keyword tag="image">image</keyword> <glossary tag="mask">mask</glossary>.</p><p/><p><b>Value:</b></p><p>The <b>maskPixmapID</b> of a <object tag="stack">stack</object> is an <keyword tag="integer">integer</keyword>.</p><p/><p>By default, the <b>maskPixmapID</b> of newly created <glossary tag="image">images</glossary> is empty.</p><p/><p><b>Comments:</b></p><p>The <b>maskPixmapID</b> is provided by the operating system and indicates the <glossary tag="pixmap">pixmap</glossary> used to <glossary tag="mask">mask</glossary> an <keyword tag="image">image</keyword>. The <glossary tag="mask">mask</glossary> is a 1-bit <keyword tag="image">image</keyword> map. <property tag="pixels">Pixels</property> in the <keyword tag="image">image</keyword> that correspond to a <function tag="value">value</function> of zero in the <glossary tag="mask">mask</glossary> are transparent to mouse clicks, and <property tag="pixels">pixels</property> corresponding to a <function tag="value">value</function> of 1 can receive mouse clicks. If the <b>maskPixmapID</b> is empty, all the <property tag="pixels">pixels</property> in the <keyword tag="image">image</keyword> can receive mouse clicks (as though the <glossary tag="mask">mask</glossary> consisted of all 1s).</p><p/><p>This property is not supported on Mac OS and Windows systems.</p>
  </description>
</doc>