home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / docs / indicatorclass.doc < prev    next >
Encoding:
Text File  |  1995-04-24  |  2.5 KB  |  91 lines
  1.  
  2.                File: indicatorclass.doc
  3.         Description: Indicatorclass documentation.
  4.           Copyright: (C) Copyright 1994-1995 Jaba Development.
  5.                      (C) Copyright 1994-1995 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8. ------------------------------------------------------------------------------
  9.  
  10. TABLE OF CONTENTS
  11.  
  12. indicatorclass/--background--
  13. indicatorclass/Methods
  14. indicatorclass/Attributes
  15.  
  16. indicatorclass/--background--                    indicatorclass/--background--
  17.  
  18.     NAME
  19.         Class:          indicatorclass
  20.         Superclass:     baseclass
  21.         Include File:   <libraries/bgui.h>
  22.  
  23.     FUNCTION
  24.         To  provide  a  textual level indicator for gadget objects which might
  25.         need this like the slider and progress classes. As this class may also
  26.         be  useful  in  conjunction with other third party classes it has been
  27.         made available.
  28.  
  29.         Objects of this class do not send out notification events.
  30.  
  31. indicatorclass/Methods                                  indicatorclass/Methods
  32.  
  33.     NEW METHODS
  34.         None.
  35.  
  36.     CHANGED METHODS
  37.         None.
  38.  
  39. indicatorclass/Attributes                            indicatorclass/Attributes
  40.  
  41.     NAME
  42.         INDIC_Min, INDIC_Max -- ( LONG )
  43.  
  44.     FUNCTION
  45.         Set the minimum and maximum possible level indication.
  46.  
  47.         Defaults are 0 minimum and 100 maximum. Applicability is (I).
  48.  
  49.     SEE ALSO
  50.         INDIC_Level
  51.  
  52.     NAME
  53.         INDIC_Level -- ( LONG )
  54.  
  55.     FUNCTION
  56.         Set or update the current level to indication.
  57.  
  58.         Default is 0. Applicability is (ISU).
  59.  
  60.     SEE ALSO
  61.         INDIC_Min, INDIC_Max, INDIC_FormatString
  62.  
  63.     NAME
  64.         INDIC_FormatString -- ( STRPTR )
  65.  
  66.     FUNCTION
  67.         Set  the  C-style  format  string  which is used to format the current
  68.         level before rendering.
  69.  
  70.         NOTE: Since  V38  of  the  library  it  is  possible  to  use locale's
  71.               FormatString()  formatting  codes.  Locale  specific  formatting
  72.               codes will only work when the locale.library is available.
  73.  
  74.         Default is "%ld". Applicability is (I).
  75.  
  76.     SEE ALSO
  77.         exec.library/RawDoFmt(), INDIC_Level
  78.  
  79.     NAME
  80.         INDIC_Justification -- ( ULONG )
  81.  
  82.     FUNCTION
  83.         Set  the  justification  of the textual output. These are the possible
  84.         justification types:
  85.  
  86.         IDJ_LEFT        - Left-justify text output.
  87.         IDJ_CENTER      - Center text output.
  88.         IDF_RIGHT       - Right-justify text output.
  89.  
  90.         Default is IDJ_LEFT. Applicability is (I).
  91.