home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / docs / filereqclass.doc < prev    next >
Encoding:
Text File  |  1995-04-24  |  3.0 KB  |  106 lines
  1.  
  2.                File: filereqclass.doc
  3.         Description: Filereqclass 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. filereqclass/--background--
  13. filereqclass/Methods
  14. filereqclass/Attributes
  15.  
  16. filereqclass/--background--                        filereqclass/--background--
  17.  
  18.     NAME
  19.         Class:          filereqclass
  20.         Superclass:     ROOTCLASS
  21.         Include File:   <libraries/bgui.h>
  22.  
  23.     FUNCTION
  24.         To  provide  a  BOOPSI  interface  class to the ASL FileRequester. The
  25.         advantage  of  this  class is that the objects remember their complete
  26.         settings  like  requester  size,  path,  directory,  file  and pattern
  27.         strings as long as the object remains valid.
  28.  
  29. filereqclass/Methods                                      filereqclass/Methods
  30.  
  31.     NEW METHODS
  32.         FRM_DOREQUEST -- Sending  this  method  to  the  object  will open the
  33.                 requester.
  34.  
  35.                 This method can return any of the following return codes:
  36.  
  37.                 FRQ_OK            -- Ok. No problems.
  38.                 FRQ_CANCEL        -- The requester was cancelled by the user.
  39.                 FRQ_ERROR_NO_MEM  -- Out of memory.
  40.                 FRQ_ERROR_NO_FREQ -- Could  not   allocate   a   FileRequester
  41.                         structure.
  42.  
  43.     CHANGED METHODS
  44.         OM_SET -- This method returns 0 when everything went OK. Uppon failure
  45.                 it will return FRQ_ERROR_NO_MEM.
  46.  
  47. filereqclass/Attributes                                filereqclass/Attributes
  48.  
  49.     NOTE
  50.         All  the  ASL filerequester attributes as defined in <libraries/asl.h>
  51.         are  usable  with this class. Applicability  for  these ASL attributes
  52.         is (ISGU).
  53.  
  54.     NAME
  55.         FRQ_Drawer -- ( STRPTR )
  56.  
  57.     FUNCTION
  58.         To obtain a pointer to the directory name of the filerequester.
  59.  
  60.         Applicability is (G).
  61.  
  62.     SEE ALSO
  63.         FRQ_File, FRQ_Pattern, FRQ_Path
  64.  
  65.     NAME
  66.         FRQ_File -- ( STRPTR )
  67.  
  68.     FUNCTION
  69.         To obtain a pointer to the file name of the filerequester.
  70.  
  71.         Applicability is (G).
  72.  
  73.     SEE ALSO
  74.         FRQ_Drawer, FRQ_Pattern, FRQ_Path
  75.  
  76.     NAME
  77.         FRQ_Pattern -- ( STRPTR )
  78.  
  79.     FUNCTION
  80.         To obtain a pointer to the pattern string of the filerequester.
  81.  
  82.         Applicability is (G).
  83.  
  84.     SEE ALSO
  85.         FRQ_Drawer, FRQ_File, FRQ_Path
  86.  
  87.     NAME
  88.         FRQ_Path -- ( STRPTR )
  89.  
  90.     FUNCTION
  91.         To  obtain  a  pointer  to the full path of the filerequester. This is
  92.         simply the directory with the file name AddPart()'d to it.
  93.  
  94.         Applicability is (G)
  95.  
  96.     SEE ALSO
  97.         FRQ_Drawer, FRQ_File, FRQ_Pattern, dos.library/AddPart()
  98.  
  99.     NAME
  100.         FRQ_Left, FRQ_Top, FRQ_Width, FRQ_Height -- ( ULONG )
  101.  
  102.     FUNCTION
  103.         To obtain the current position and size of the filerequester.
  104.  
  105.         Applicability is (G).
  106.