
Class documentation.

$Ident: This file is part of the 'Gt-library' 1.0.0 $
$Copyright: (C) 1997 by Gran Gustafsson $

-------------------------------------------------------------------------

** GtPixmap **
--------------

Name:       GtPixmap
Superclass: GtDrawable
Include:    gtpixmap.h


  This class encapsulates a X pixmap or bitmap. The GtPixmap objects can be
created shared to allow multiple objects to use the same instance of a
pixmap. It is of course not normally a good idea to draw in a shared pixmap
since all users of the same pixmap will be affected.
  The library can be compiled to support creation of XPM pixmaps. A global
function, "sbool GtXpmSupport(void)", is provided for the program to be able
to test for the XPM support of the library.


Tags for GtPixmap:
------------------

   -- GtDrawable tags --
  
  Name                   ISGR  Type            Defaults
  -----------------------------------------------------
  GT_Display            (I.G.) (GtDisplay *)   NULL
  GT_XDrawable          (..G.) (Drawable)      0
  
   -- GtPixmap tags --
  
  Name                   ISGR  Type            Defaults
  -----------------------------------------------------
  GT_Drawable           (I.G.) (GtDrawable *)  DefaultRootWindow()
  GT_Colormap           (I...) (GtColormap *)  DefaultColormap()
  GT_BitmapData         (I.G.) (char *)        NULL
  GT_XpmData            (I.G.) (char **)       NULL
  GT_BitmapName         (I.G.) (char *)        NULL
  GT_XpmName            (I.G.) (char *)        NULL
  GT_XSize              (I.G.) (ulong)         1
  GT_YSize              (I.G.) (ulong)         1
  GT_Depth              (I.G.) (ulong)         1
  GT_HotX               (I.G.) (long)          0
  GT_HotY               (I.G.) (long)          0
  GT_Foreground         (I...) (ulong)         BlackPixel()
  GT_Background	        (I...) (ulong)         WhitePixel()
  GT_DontFreeX          (I.G.) (sbool)         FALSE
  GT_XPixmap            (I.G.) (Pixmap)        0
  GT_XPixmapMask        (..G.) (Pixmap)        0


  * GT_Drawable
    This GtDrawable provide the screen and other attributes for which the
    GtPixmap is to be created for.


  * GT_Colormap
    The GtColormap provided by this tag is used when creating a XPM pixmap.
    

  * GT_BitmapData
    This tag provide bitmap data in memory to use for creating the GtPixmap
    object.


  * GT_XpmData
    As for "GT_BitmapData" but for XPM pixmaps.
    
  
  * GT_BitmapName
    This tag names a file containing bitmap data to use for creating the
    GtPixmap object.


  * GT_XpmName
    As for "GT_BitmapName" but for XPM pixmaps.
  

  * GT_XSize, GT_YSize
    The size of the pixmap in pixels.
  
  
  * GT_Depth
    The depth of the pixmap.

  
  * GT_HotX, GT_HotY
    Position of the hot spot in the pixmap if it is used as a cursor image.
  
  
  * GT_Foreground
    The pixel value of this tag is used as the foreground color of a bitmap
    if it is created as a pixmap with depth greater than 1.


  * GT_Background
    As for "GT_Foreground" but for the background. A symbolic color name
    "background" is also added with the value of this tag if a XPM pixmap is
    created.


  * GT_DontFreeX
    If this tag is true the encapsulated pixmap is not destroy when the
    GtPixmap object is destroyed.


  * GT_XFont
    This tag provide a X pixmap to encapsulate. The "GT_DontFreeX" tag is
    by default true if this tag is used in initializing the GtPixmap.

    NOTE: All features of the encapsulation may not work correctly for
    objects using the "GT_XPixmap" tag in initialization.


  * GT_XPixmapMask
    When a XPM pixmap is created a mask pixmap may also have be created and
    it can be read with this tag.


Callbacks for GtPixmap:
-----------------------

  ** NONE DEFINED **
  

Methods for GtPixmap:
---------------------

   -- User methods --
   
  sbool IsBitmap(void)
  Pixmap XPix(void)
  
   -- GtDrawable methods --
   
  XDr

   -- GtBase methods --
   
  Init, Set, Get, GetClass, IsSubClassOf, InitV, SetV, GetV, GetA,
  PrtErrHeader
   
 ----------------------------------------------------------------------------

  sbool IsBitmap(void)
    
    - <result> : true if object is a bitmap (depth == 1) else false.
    
    This method returns true if the encapsulated pixmap has depth 1.

 ----------------------------------------------------------------------------

  Pixmap XPix(void)
  
    - <result> : X pixmap encapsulated by the object.

    This method returns the encapsulated X pixmap of the object.
