home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 114 / af114sub.adf / GadToolsBox3.lzx / GadToolsBox3 / Developers / progress.gadget / autodocs / progress_gc.doc
Encoding:
Text File  |  1996-11-11  |  2.3 KB  |  70 lines
  1. TABLE OF CONTENTS
  2.  
  3. progress.gadget/progress.gadget
  4. progress.gadget/GetProgressClass
  5.  
  6. progress.gadget/progress.gadget
  7.  
  8.    NAME
  9.         progress.gadget -- create standard progress indicator gadget (V36)
  10.  
  11.    FUNCTION
  12.         This class provides ability to create standarized progress
  13.         gadget. With this class you can easly show how many was done
  14.         of current work. You can set any number of maximum value
  15.         for this gadget. Progress.gadget provides for you ability to
  16.         convert current values to number of percents (eg: copied
  17.         file is 4500 bytes long, so when copying it you can show user
  18.         what percent of file was copied, instead of current bytes copied).
  19.  
  20.    TAGS
  21.         PROG_MaxVal (ULONG) - Sets/Gets maximum available value.
  22.                 Default for this tag is 100. Applicability is (ISG).
  23.  
  24.         PROG_CurVal (ULONG) - Sets/Gets current value.
  25.                 Default for this tag is 0. Applicability is (ISGNU).
  26.  
  27.         PROG_TextFont (struct TextFont *) - Sets/Gets font used for
  28.                 text rendering. Default for this tag is current font.
  29.                 Applicability is (IG).
  30.  
  31.         PROG_ConvertToPercents (BOOL) - If set to true all values
  32.                 rendered in gadget will be converted to percents.
  33.                 Default for this tag is TRUE. Applicability is (ISG).
  34.  
  35.         PROG_Format (STRPTR) - Sets format of text rendering. Default
  36.                 for this tag is "%d". Applicability is (ISG).
  37.  
  38.         PROG_Border (BOOL) - Set to TRUE if you want bevelled box around
  39.                 gadget. Default for this tag is TRUE. Applicability is (ISG).
  40.  
  41.         PROG_Placement (ULONG) - Sets placement of text set by PROG_Format.
  42.                 Available values are: PLACETEXT_#? (IN, ABOVE, BELOW, LEFT,
  43.                 RIGHT). Default for this tag is PLACETEXT_IN. Applicability
  44.                 is (ISG).
  45.                 
  46.  
  47. progress.gadget/GetProgressClass
  48.  
  49.    NAME
  50.        GetProgressClass -- get base class of gadget (V36)
  51.  
  52.    SYNOPSIS
  53.  
  54.        class = GetProgressClass()
  55.        D0
  56.  
  57.        Class *GetProgressClass( void );
  58.  
  59.    FUNCTION
  60.        Retrives base address of class to use later with
  61.        intuition.library/NewObject().
  62.  
  63.    RESULT
  64.        A boopsi class which can be used to use with NewObject().
  65.  
  66.    SEE ALSO
  67.        intuition.library/NewObject().
  68.  
  69.  
  70.