home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / docs / stringclass.doc < prev    next >
Encoding:
Text File  |  1995-06-05  |  3.1 KB  |  99 lines
  1.  
  2.            File: stringclass.doc
  3.     Description: Stringclass 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. stringclass/--background--
  13. stringclass/Methods
  14. stringclass/Attributes
  15.  
  16. stringclass/--background--                stringclass/--background--
  17.  
  18.     NAME
  19.     Class:        stringclass
  20.     Superclass:    baseclass
  21.     Include File:    <libraries/bgui.h>
  22.  
  23.     FUNCTION
  24.     To provide  gadget  simular  to  the  gadtools.library it's string and
  25.     integer gadget kinds.  Objects from this class sends out the following
  26.     attribute pairs in their notification events:
  27.  
  28.     GA_ID        - Gadget object ID.
  29.     STRINGA_TextVal - Gadget object string contents (string objects).
  30.     STRINGA_LongVal - Gadget object integer contents (integer objects).
  31.  
  32. stringclass/Methods                       stringclass/Methods
  33.  
  34.     NEW METHODS
  35.     SM_FORMAT_STRING -- This method may be used to set a formatted    string
  36.         in a string object. The formatted string may also  contain any
  37.         locale.library compatible formatting codes.  This  method uses
  38.         the following custom message structure:
  39.  
  40.         struct smFormatString {
  41.             ULONG           MethodID;    /* SM_FORMAT_STRING */
  42.             struct GadgetInfo *smfs_GInfo;    /* GadgetInfo        */
  43.             UBYTE          *smfs_FStr;    /* Format string    */
  44.             ULONG           smfs_Arg1;    /* Format arg        */
  45.             /* ULONG       smfs_Arg2; */
  46.             /* ... */
  47.         };
  48.  
  49.         smfs_GInfo -- This must point to a valid  GadgetInfo structure
  50.             if the change must also be shown  visually on  screen.
  51.             The  BGUI_DoGadgetMethod()  call   will  automatically
  52.             construct this for you.
  53.  
  54.         smfs_FStr -- This must point to a  0-terminated  string  which
  55.             contains the formatting codes. Also all locale.library
  56.             it's FormatString()  formatting  codes  are  supported
  57.             when the locale.library is available.
  58.  
  59.         amfs_Arg1 -- This must be the first argument that  the    string
  60.             expects. This can be followed by as much  arguments as
  61.             are expected by the specified formatting string.
  62.  
  63.         NOTE: This method will only work on  string  objects.    Not on
  64.               integer objects.
  65.  
  66.         Returns TRUE uppon success and FALSE uppon failure.
  67.  
  68.     CHANGED METHODS
  69.     None.
  70.  
  71. stringclass/Attributes                    stringclass/Attributes
  72.  
  73.     NOTE
  74.     All  system  strgclass    attributes  are  also supported by this class.
  75.     Please     refere  to  the  documentation  on  the  strgclass  for  more
  76.     information on these attributes.
  77.  
  78.     NAME
  79.     STRINGA_MinCharsVisible -- ( ULONG ) ** V39 **
  80.  
  81.     FUNCTION
  82.     To  make  it  possible    to  determine the minimum amount of characters
  83.     which should always stay visible.
  84.  
  85.     Default is 2. Applicability is (I).
  86.  
  87.     NAME
  88.     STRINGA_IntegerMin, STRINGA_IntegerMax -- ( ULONG ) ** V39 **
  89.  
  90.     FUNCTION
  91.     To  set  the  minimum  and  maximum value which the integer object can
  92.     hold. When a STRINGA_LongVal  is  set    which is out of this range the
  93.     value is adjusted to be inside these boundaries.  Also    when  the user
  94.     enters a value outside these boundaries  the screen will flash and the
  95.     entered value is adjusted and not accepted.
  96.  
  97.     Defaults are 0xEFFFFFFF minimum and 0x0FFFFFFF maximum.  Applicability
  98.     is (ISU).
  99.