home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / FileMover / HF-OM1.DMS / in.adf / OpusSDK.lha / SDK / docs / progress.doc < prev    next >
Encoding:
Text File  |  1996-09-01  |  7.8 KB  |  250 lines
  1. dopus5.library/CheckProgressAbort           dopus5.library/CheckProgressAbort
  2.  
  3.     NAME
  4.         CheckProgressAbort - check for abort in progress window
  5.  
  6.     SYNOPSIS
  7.         CheckProgressAbort(handle)
  8.                              A0
  9.  
  10.         BOOL CheckProgressAbort(APTR);
  11.  
  12.     FUNCTION
  13.         Allows you to check the state of the abort flag in the specified
  14.         progress window.
  15.  
  16.     INPUTS
  17.         handle - progress window handle
  18.  
  19.     RESULT
  20.         Returns TRUE if the Abort button has been clicked.
  21.  
  22.     SEE ALSO
  23.         OpenProgressWindow()
  24.  
  25. dopus5.library/CloseProgressWindow         dopus5.library/CloseProgressWindow
  26.  
  27.     NAME
  28.         CloseProgressWindow - close a progress window
  29.  
  30.     SYNOPSIS
  31.         CloseProgressWindow(handle)
  32.                               A0
  33.  
  34.         void CloseProgressWindow(APTR);
  35.  
  36.     FUNCTION
  37.         Closes the specified progress window.
  38.  
  39.     INPUTS
  40.         handle - progress window to close
  41.  
  42.     SEE ALSO
  43.         OpenProgressWindow()
  44.  
  45. dopus5.library/GetProgressWindow             dopus5.library/GetProgressWindow
  46.  
  47.     NAME
  48.         GetProgressWindow - get progress window information
  49.  
  50.     SYNOPSIS
  51.         GetProgressWindow(handle, tags)
  52.                             A0     A1
  53.  
  54.         void GetProgressWindow(APTR, struct TagItem *);
  55.  
  56.         void GetProgressWindowTags(APTR, Tag, ...);
  57.  
  58.     FUNCTION
  59.         Returns information about the progress window. Currently available
  60.         information is :
  61.  
  62.             PW_Window      - returns Window pointer
  63.  
  64.     INPUTS
  65.         handle - progress window handle
  66.         tags   - inquiry tags
  67.  
  68.     RESULT
  69.         The result of each tag query is stored in the ti_Data field of the
  70.         TagItem.
  71.  
  72.     SEE ALSO
  73.         OpenProgressWindow(), SetProgressWindow()
  74.  
  75. dopus5.library/HideProgressWindow           dopus5.library/HideProgressWindow
  76.  
  77.     NAME
  78.         HideProgressWindow - hide a progress window
  79.  
  80.     SYNOPSIS
  81.         HideProgressWindow(handle)
  82.                              A0
  83.  
  84.         void HideProgressWindow(APTR);
  85.  
  86.     FUNCTION
  87.         Removes the specified progress window from the display. The progress
  88.         window is still operative; it can still be updated and even closed
  89.         while it is hidden.
  90.  
  91.     INPUTS
  92.         handle - progress window handle
  93.  
  94.     SEE ALSO
  95.         OpenProgressWindow(), ShowProgressWindow()
  96.  
  97. dopus5.library/OpenProgressWindow           dopus5.library/OpenPRogressWindow
  98.  
  99.     NAME
  100.         OpenProgressWindow - open a progress window display
  101.  
  102.     SYNOPSIS
  103.         OpenProgressWindow(tags)
  104.                             A0
  105.  
  106.         APTR OpenProgressWindow(struct TagItem *);
  107.  
  108.         APTR OpenProgressWindowTags(Tag, ...);
  109.  
  110.     FUNCTION
  111.         Opens a progress window that your application can use to display the
  112.         progression of some operation. The progress window can have a filename
  113.         display, file counter and progress guage.
  114.  
  115.     INPUTS
  116.         tags - control tags. Control tags are:
  117.  
  118.             PW_Screen    - screen to open on. The progress window will
  119.                            appear centered in the screen. Use of this tag
  120.                            overrides PW_Window.
  121.  
  122.             PW_Window    - window to open over. The progress window will
  123.                            appear centered over the supplied window.
  124.  
  125.             PW_Title     - title for the progress window
  126.  
  127.             PW_SigTask   - task to signal when the abort gadget is pressed.
  128.  
  129.             PW_SigBit    - bit to signal task with (signal bit, not mask)
  130.  
  131.             PW_FileName  - initial filename for display
  132.  
  133.             PW_FileSize  - initial file size
  134.     
  135.             PW_FileCount - initial file count
  136.  
  137.             PW_Flags     - control flags
  138.  
  139.         The control flags for the PW_Flags tag are :
  140.  
  141.             PWF_FILENAME  - specify if you want a filename display
  142.             PWF_FILESIZE  - specify if you want a file size display (1)
  143.             PWF_INFO      - specify if you want an information line
  144.             PWF_GRAPH     - specify if you want a bar graph display (1)
  145.             PWF_NOABORT   - specify if you don't want an Abort button (2)
  146.             PWF_INVISIBLE - if you want the progress window to open in 'hidden'
  147.                             mode (ie you need to call ShowProgressWindow() to
  148.                             make it visible)
  149.             PWF_ABORT     - specify if you do want an Abort button (2)
  150.  
  151.         1. Ordinarily, the file size is displayed as a "xxxxxx bytes" string in
  152.            the top-right of the progress window, and the bar graph is used to
  153.            represent "x out of y files". If, however, you specify both
  154.            PWF_FILESIZE and PWF_GRAPH, the meanings of these displays is
  155.            automatically swapped around. The current file progress (eg bytes
  156.            copied) is displayed in the bar graph, and the current operation
  157.            progress (eg files copied) is displayed in text in the top-right
  158.            corner.
  159.  
  160.         2. If you specify a signal task with the pw_SigTask flag, the
  161.            progress window will automatically get an Abort button. You can use
  162.            the PWF_NOABORT flag to stop this happening.
  163.  
  164.            If you do not specify the pw_SigTask flag, you can use the PWF_ABORT
  165.            flag to add an Abort button without signalling (you will need to
  166.            call CheckProgressAbort() to detect an abort).
  167.  
  168.     RESULT
  169.         Returns a handle to the newly created progress window, or NULL for
  170.         failure.
  171.  
  172.     SEE ALSO
  173.         SetProgressWindow(), CloseProgressWindow()
  174.  
  175. dopus5.library/SetProgressWindow             dopus5.library/SetProgressWindow
  176.  
  177.     NAME
  178.         SetProgressWindow - update progress window information
  179.  
  180.     SYNOPSIS
  181.         SetProgressWindow(handle, tags)
  182.                             A0     A1
  183.  
  184.         void SetProgressWindow(APTR, struct TagItem *);
  185.  
  186.         void SetProgressWindowTags(APTR, Tag, ...);
  187.  
  188.     FUNCTION
  189.         This is the routine you use to update the information displayed in
  190.         a progress window.
  191.  
  192.     INPUTS
  193.         handle - progress window handle
  194.         tags   - control tags. Valid tags are :
  195.  
  196.             PW_Title       - change the window title
  197.  
  198.             PW_FileName    - change the displayed filename
  199.  
  200.             PW_FileSize    - change the total size of the current file
  201.  
  202.             PW_FileDone    - change the "done" size of the current file
  203.                              (eg, if the file size was 12800 and you had
  204.                              copied half of it, the done size would be
  205.                              6400).
  206.  
  207.             PW_Info        - change the information field display
  208.  
  209.             PW_FileCount   - change the total number of files
  210.  
  211.             PW_FileNum     - change the number of files processed (eg,
  212.                              if the total file count was 84 and you had
  213.                              processed a quarter of them, the current
  214.                              file number would be 21).
  215.  
  216.     RESULT
  217.         The changes are displayed immediately. If the progress window is
  218.         currently hidden, the changes are still effective and will be
  219.         visible when the progress window is revealed.
  220.  
  221.     SEE ALSO
  222.         OpenProgressWindow()
  223.  
  224. dopus5.library/ShowProgressWindow           dopus5.library/ShowProgressWindow
  225.  
  226.     NAME
  227.         ShowProgressWindow - reveal a hidden progress window
  228.  
  229.     SYNOPSIS
  230.         ShowProgressWindow(handle, screen, window)
  231.                              A0      A1      A2
  232.  
  233.         void ShowProgressWindow(APTR, struct Screen *, struct Window *);
  234.  
  235.     FUNCTION
  236.         Reveals a progress window that was hidden with HideProgressWindow().
  237.  
  238.     INPUTS
  239.         handle - progress window handle
  240.         screen - new parent screen (if no window supplied)
  241.         window - new owner window (if no screen supplied)
  242.  
  243.     RESULT
  244.         The progress window is revealed. If possible, it will be displayed
  245.         at the same position on the screen as it was when it was hidden.
  246.  
  247.     SEE ALSO
  248.         OpenProgressWindow(), HideProgressWindow()
  249.  
  250.