
Class documentation.

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

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

  ** GtCursor **
  --------------
  
Name:       GtCursor
Superclass: GtBase
Include:    gtcursor.h


  This class encapsulates a X cursor. It is a simple encapsulation since
very few operations on cursors exists. After the cursor is created only it's
color can be changed. This fact makes it possible to often share cursors in
a program. GtCursor objects can therefore be created as shared objects.


Tags for GtCursor:
------------------

  Name           ISGR  Type            Defaults
  ---------------------------------------------
  GT_Display    (I.G.) (GtDisplay *)   -
  GT_Shape      (I.G.) (long)          XC_top_left_arrow
  GT_Pixmap     (I.G.) (GtPixmap *)    NULL
  GT_PixmapMask (I.G.) (GtPixmap *)    NULL
  GT_Font       (I.G.) (GtFont *)      NULL
  GT_FontMask   (I.G.) (GtFont *)      NULL
  GT_ShapeChar  (I.G.) (long)          0
  GT_MaskChar   (I.G.) (long)          0
  GT_Foreground (ISG.) (XColor *)      Black
  GT_Background (ISG.) (XColor *)      White
  GT_DontFreeX  (I.G.) (sbool)         FALSE
  GT_XCursor    (I.G.) (Cursor)        0
  
  
  * GT_Display
    This tag provide the GtDisplay object to be used by the GtCursor. It is
    not normally used since the GtDisplay object is provided as an argument
    to the special "Init()" method of this class.
    
  
  * GT_Shape
    This tag determine which standard shape the cursor is to have. Any of
    the defines in the "cursorfont.h" include file can be used.
    
    
  * GT_Pixmap
    This tag provide a GtPixmap shape for the cursor.
    
    
  * GT_PixmapMask
    This tag provide a GtPixmap to use as mask for the cursor shape. It
    will have no effect if not used together with "GT_Pixmap".
    
    
  * GT_Font
    This tag provide a GtFont to use for cursor shape.
    
    
  * GT_FontMask
    This tag provide a GtFont to use as mask for the cursor shape. It will
    have no effect if not used together with "GT_Font".
    
  
  * GT_ShapeChar
    This tag gives the character from a GtFont to use as cursor shape. It
    will have no effect if not used with "GT_Font".
    
    
  * GT_MaskChar
    This tag gives the character from a GtFont to use as mask for the cursor
    shape. It will have no effect if not used with "GT_Font".
    
    
  * GT_Foreground 
    This tag provide a pointer to a XColor structure with the RGB value of
    the cursor's foreground color. Since this cursor expects a pointer to a
    XColor structure it can not be read by the "GetA()" method.


  * GT_Background
    This tag provide a pointer to a XColor structure with the RGB value of
    the cursor's background color. Since this cursor expects a pointer to a
    XColor structure it can not be read by the "GetA()" method.
  
  
  * GT_DontFreeX
    If this tag is true the encapsulated cursor is not destroy when the
    GtCursor object is destroyed.
    

  * GT_XCursor
    This tag provide a X cursor to encapsulate. The "GT_DontFreeX" tag is
    by default true if this tag is used in initializing the GtCursor.

    NOTE: All features of the encapsulation may not work correctly for
    objects using the "GT_XCursor" tag in initialization.
  
  
  Since there is a number of tags to determine the shape of the cursor from
multiple sources the last occurrence of one of the shape tags is used.


Callbacks for GtCursor:
-----------------------

  ** NONE DEFINED **

  
Methods for GtCursor:
---------------------

   -- User methods --

  Cursor XCurs(void)
  
   -- GtBase methods --
  
  Init, Set, Get, GetClass, IsSubClassOf, InitV, SetV, GetV, GetA,
  PrtErrHeader

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

  Cursor XCurs(void)

    - <result> : the encapsulated cursor.
    
    This method returns the X cursor that the GtCursor encapsulates.
