home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / misc / vcb10a.lha / vcx.doc < prev    next >
Text File  |  1992-10-21  |  4KB  |  133 lines
  1.  
  2.      VCX(1)                AM*GA Programmer's Manual                 VCX(1)
  3.  
  4.  
  5.  
  6.      ¢1mNAME 
  7.           ¢0mVCX 
  8.  
  9.      ¢1mVERSION 
  10.           ¢0m1.0a 
  11.  
  12.      ¢1mABOUT THIS DOCUMENT 
  13.           ¢0mThis  documentation was added because there was a demand for
  14.           information on the creation of scroll bars.  
  15.  
  16.           I do ¢3mnot ¢0mwant to create the impression that the  VCX  BOOPSI
  17.           class  is a self-contained, ready-to-link module that solves
  18.           all your problems!  
  19.  
  20.           VCX is very limited (at least in this  release;  some  basic
  21.           features could   be   added  without  great  effort).    For
  22.           instance, VCX gadgets will  never  send  an  IDCMP  message.
  23.           They only perform ICA_TARGET notification.  
  24.  
  25.  
  26.      ¢1mDESCRIPTION 
  27.           ¢0mVCX stands  for Virtual Co-ordinate Axis.  Don't be confused
  28.           by this blown name!  An instance of this  class  is  nothing
  29.           else but a scroll bar just like the two that every Workbench
  30.           window has.  
  31.  
  32.  
  33.      ¢1mUSAGE 
  34.           ¢0mIn order to create scroll bar gadgets for your application's
  35.           windows, you must link the vcxclass.o module to your code.  
  36.  
  37.           Using VCX  starts  with  creating  the BOOPSI class.  You do
  38.           this  by  calling  the  library   function   initVCXClass().
  39.           freeVCXClass() will  free  that  class again.  Once you have
  40.           the class, you can create as  many  instances  (gadgets)  of
  41.           that class as you want by calling NewObject().  
  42.  
  43.           A   VCX  gadget  is  set  up  similarly  as  a  proportional
  44.           (propgclass)  gadget:  You  have  to  specify   PGA_Freedom,
  45.           PGA_Total,  PGA_Top,  PGA_Visible, GA_Left (or GA_RelRight),
  46.           GA_Top  (or  GA_RelBottom)  and  GA_Width  (GA_RelWidth)  or
  47.           GA_Height (GA_RelHeight).  
  48.  
  49.           If   the   gadget   is   horizontal,   its  height  will  be
  50.           automatically taken to be equal to the height of  the  arrow
  51.           images.  Similarly, if the gadget is vertical, it will be of
  52.           the same  width  as  the  arrow  images.    In  either  case
  53.           redundant tags will be ignored.  
  54.  
  55.           You ¢3mmust ¢0msupply a SYSIA_DrawInfo tag with a proper  DrawInfo
  56.           pointer    (obtainable    using   GetScreenDrawInfo(),   see
  57.           AutoDocs). VCX needs it to create  instances  of  the  arrow
  58.           images.   If  you  are  using a screen resolution other than
  59.           that of default Workbench you must also supply a  SYSIA_Size
  60.           tag  with one of the values SYSISIZE_LOWRES, SYSISIZE_MEDRES
  61.           or SYSISIZE_HIRES defined in <intuition/imageclass.h>.  
  62.  
  63.  
  64.  
  65.      KosmoSoft                        -1-
  66.  
  67.  
  68.      VCX(1)                AM*GA Programmer's Manual                 VCX(1)
  69.  
  70.  
  71.           At present, the only way to be informed of  a  VCX  gadget's
  72.           state change  is  the ICA_TARGET tag.  It should support the
  73.           special  target  ICTARGET_IDCMP,   but   that   feature   is
  74.           untested.  
  75.  
  76.  
  77.      ¢1mEXAMPLE PROGRAM 
  78.           ¢0mThere   is   a   simple   test   program  included  in  this
  79.           distribution, named vcxtest.c.  It shows how to attach a VCX
  80.           gadget to a window (into one of its borders).  
  81.  
  82.  
  83.      ¢1mSEE ALSO 
  84.           ¢0mRKM Libraries, BOOPSI documentation.  
  85.  
  86.  
  87.      ¢1mBUGS 
  88.           ¢0mPlease read the BUGS file which also covers VCX.  
  89.  
  90.  
  91.      ¢1mCONTACT 
  92.           ¢0mStefan Reisner, Aachener Stra▀e 399, 5000 K÷ln 41,  Germany,
  93.           internet srph-cip.uni-koeln.de 
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.      KosmoSoft                        -2-
  132.  
  133.