home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 9 / FreshFishVol9-CD2.bin / bbs / dev / bgui-1.1a.lha / BGUI / docs / progressclass.doc < prev    next >
Encoding:
Text File  |  1994-07-05  |  2.3 KB  |  84 lines
  1.  
  2.            $RCSfile: progressclass.doc,v $
  3.         Description: Progressclass documentation.
  4.           Copyright: (C) Copyright 1994 Jaba Development.
  5.                      (C) Copyright 1994 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8.             $Author: jaba $
  9.           $Revision: 1.1 $
  10.               $Date: 1994/07/04 21:05:30 $
  11. ------------------------------------------------------------------------------
  12.  
  13. TABLE OF CONTENTS
  14.  
  15. progressclass/--background--
  16. progressclass/Methods
  17. progressclass/Attributes
  18.  
  19. progressclass/--background--                      progressclass/--background--
  20.  
  21.     NAME
  22.         Class:          progressclass
  23.         Superclass:     baseclass
  24.         Include File:   <libraries/bgui.h>
  25.  
  26.     FUNCTION
  27.         To  provide  a  progression  indicator  in  the  form of a fuel guage.
  28.         Objects from this class will send out the following attribute pairs in
  29.         notification events:
  30.  
  31.         GA_ID           - Gadget object ID.
  32.         PROGRESS_Done   - Current level of progression.
  33.  
  34. progressclass/Methods                                    progressclass/Methods
  35.  
  36.     NEW METHODS
  37.         None.
  38.  
  39.     CHANGED METHODS
  40.         None.
  41.  
  42. progressclass/Attributes                              progressclass/Attributes
  43.  
  44.     NAME
  45.         PROGRESS_Min, PROGRESS_Max - ( LONG )
  46.  
  47.     FUNCTION
  48.         Set the minimum and maximum possible progression.
  49.  
  50.         Defaults are 0 minimum and 100 maximum. Applicability is (IS).
  51.  
  52.     SEE ALSO
  53.         PROGRESS_Done
  54.  
  55.     NAME
  56.         PROGRESS_Done -- ( LONG )
  57.  
  58.     FUNCTION
  59.         Set or update the current level of progression.
  60.  
  61.         Default is 0. Applicability is (ISGNU).
  62.  
  63.     SEE ALSO
  64.         PROGRESS_Min, PROGRESS_Max
  65.  
  66.     NAME
  67.         PROGRESS_Vertical -- ( BOOL )
  68.  
  69.     FUNCTION
  70.         To  make  the  indication vertical. By default the guage is horizontal
  71.         which  is  filled  from left to right. A vertical guage is filled from
  72.         bottom to top.
  73.  
  74.         Default is FALSE. Applicability is (I).
  75.  
  76.     NAME
  77.         PROGRESS_Divisor -- ( ULONG )
  78.  
  79.     FUNCTION
  80.         Set  a divisor which is used to devide the level of progression before
  81.         it  is  rendered.  This  is necessary when the progression minimum and
  82.         maximum levels are very far appart (I.E. 0 to 0xFFFFFFFF).  This way a
  83.         fairly accurate progression is displayed.
  84.