home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 13 / AACD13.ISO / AACD / Graphics / PPT / Docs / externals.doc < prev    next >
Text File  |  2000-02-06  |  7KB  |  256 lines
  1. TABLE OF CONTENTS
  2.  
  3. effects/EffectExec
  4. effects/EffectGetArgs
  5. effects/EffectInquire
  6. iomodule/IOCheck
  7. iomodule/IOGetArgs
  8. iomodule/IOLoad
  9. iomodule/IOSave
  10. effects/EffectExec                                            effects/EffectExec
  11.  
  12.    NAME
  13.         EffectExec -- The actual execution routine.
  14.  
  15.    SYNOPSIS
  16.         newframe = EffectExec( frame, tags, PPTBase )
  17.         D0                     A0     A1    A3
  18.  
  19.         FRAME *EffectExec( FRAME *, struct TagItem *, struct PPTBase * );
  20.  
  21.    FUNCTION
  22.         This function performs the actual effect.  During the execution,
  23.         you should utilize the InitProgress()/Progress()/FinishProgress()
  24.         calls so that the user knows that something is happening.
  25.  
  26.         You should note that this function may be called several times
  27.         from different tasks, so that it definately should be re-entrant
  28.         (ie use no global variables but allocate everything from the stack).
  29.  
  30.    INPUTS
  31.         frame - The source frame for the effect. If the PPTX_NoNewFrame
  32.             was set to FALSE (which is the default) in the module tag
  33.             array, this is actually also the destination frame. You can
  34.             modify the data in it any way you like. If the tag was set to
  35.             TRUE, then you will get the original frame to which you should
  36.             not make modifications, but you should use MakeFrame(),
  37.             InitFrame() or DupFrame() to create the new frame.
  38.         tags - Optional arguments (like the REXX message) can
  39.             be found from this array. See the documentation on the REXX
  40.             interface for more documentation.
  41.  
  42.    RESULT
  43.         newframe - The frame which contains the modified data. If you made
  44.             a new frame using the MakeFrame() / DupFrame() calls, you should
  45.             return a pointer to that frame. If you just modified the
  46.             existing data, you should return the frame pointer you got
  47.             from PPT in the first place.
  48.  
  49.             If an error occurred, you should set the appropriate error code
  50.             with SetErrorCode/Msg() and return NULL. Of course, in this case
  51.             any frames allocated by you must be released with RemFrame().
  52.  
  53.    EXAMPLE
  54.         See the examples directory.
  55.  
  56.    NOTES
  57.  
  58.    BUGS
  59.  
  60.    SEE ALSO
  61.  
  62. effects/EffectGetArgs                                      effects/EffectGetArgs
  63.  
  64.    NAME
  65.         EffectGetArgs (added in PPT v6)
  66.  
  67.    SYNOPSIS
  68.         result = EffectGetArgs( frame, tags, PPTBase )
  69.         D0                      A0     A1    A3
  70.  
  71.         PERROR EffectGetArgs( FRAME *, struct TagItem *, struct PPTBase * );
  72.  
  73.    FUNCTION
  74.         This function should query the user for the options and
  75.         then print it to a string buffer.  The format should be
  76.         exactly the same as for the REXX message, so that PPT can
  77.         then call this effect multiple times using the same
  78.         argument string.
  79.  
  80.    INPUTS
  81.         frame - The source frame for the effect. If the PPTX_NoNewFrame
  82.             was set to FALSE (which is the default) in the module tag
  83.             array, this is actually also the destination frame. You can
  84.             modify the data in it any way you like. If the tag was set to
  85.             TRUE, then you will get the original frame to which you should
  86.             not make modifications, but you should use MakeFrame(),
  87.             InitFrame() or DupFrame() to create the new frame.
  88.         tags - Optional arguments (like the REXX message) can
  89.             be found from this array. See the documentation on the REXX
  90.             interface for more documentation.
  91.  
  92.    RESULT
  93.         Returns standard PPT error code.
  94.  
  95.    EXAMPLE
  96.         See the example effect source codes.
  97.  
  98.    NOTES
  99.         Effect version should be over 3 or over.  It is not actually checked
  100.         but it makes life slightly easier.
  101.  
  102.    BUGS
  103.  
  104.    SEE ALSO
  105.  
  106. effects/EffectInquire                                      effects/EffectInquire
  107.  
  108.    NAME
  109.         EffectInquire -- Inform about an effect
  110.  
  111.    SYNOPSIS
  112.         data = EffectInquire( attribute, PPTBase )
  113.         D0                    D0         A3
  114.  
  115.         ULONG EffectInquire( ULONG, struct PPTBase * );
  116.  
  117.    FUNCTION
  118.         Return an attribute concerning this effect.
  119.  
  120.    INPUTS
  121.         attribute - The attribute PPT wishes information on.
  122.  
  123.    RESULT
  124.         data - The data concerning this attribute.
  125.  
  126.    EXAMPLE
  127.  
  128.    NOTES
  129.  
  130.    BUGS
  131.  
  132.    SEE ALSO
  133.  
  134. iomodule/IOCheck                                                iomodule/IOCheck
  135.  
  136.    NAME
  137.         IOCheck - Checks if this module can handle files of this type.
  138.  
  139.    SYNOPSIS
  140.         success = IOCheck( fh, len, buf, PPTBase )
  141.         D0                 D0  D1   A0   A3
  142.  
  143.         BOOL IOCheck( BPTR, ULONG, UBYTE *, struct PPTBase * );
  144.  
  145.    FUNCTION
  146.         Checks if the given file is in a correct format.
  147.  
  148.    INPUTS
  149.         fh - open filehandle to the file to be checked.
  150.         len - how many bytes are in buf
  151.         buf - len bytes from the beginning of the file
  152.  
  153.    RESULT
  154.         Returns TRUE, if this IO module can handle this file,
  155.         otherwise FALSE.
  156.  
  157.    EXAMPLE
  158.  
  159.    NOTES
  160.  
  161.    BUGS
  162.  
  163.    SEE ALSO
  164.  
  165. iomodule/IOGetArgs                                            iomodule/IOGetArgs
  166.  
  167.    NAME
  168.         IOGetArgs (added in PPT v6)
  169.  
  170.    SYNOPSIS
  171.         result = IOGetArgs( type, frame, tags, PPTBase )
  172.         D0                  D1    A0     A1    A3
  173.  
  174.         PERROR IOGetArgs( ULONG, FRAME *, struct TagItem *, struct PPTBase * );
  175.  
  176.    FUNCTION
  177.         Gets an argument string from the user for later use in AREXX.
  178.  
  179.    INPUTS
  180.         tags - This array contains a special PPTX_ArgBuffer tag,
  181.             whose ti_Data points to a string where you should
  182.             then print your argument array.
  183.  
  184.    RESULT
  185.  
  186.    EXAMPLE
  187.  
  188.    NOTES
  189.         IO module version should be over 3 or over.  It is not actually checked
  190.         but it makes life slightly easier.
  191.  
  192.    BUGS
  193.         Entry incomplete
  194.  
  195.    SEE ALSO
  196.         effect/EffectGetArgs
  197.  
  198. iomodule/IOLoad                                                  iomodule/IOLoad
  199.  
  200.    NAME
  201.         IOLoad - Loads an image from the disk.
  202.  
  203.    SYNOPSIS
  204.         result = IOLoad( fh, frame, tags, PPTBase )
  205.         D0               D0  A0     A1    A3
  206.  
  207.         PERROR IOLoad( BPTR, FRAME *, struct TagItem *, struct PPTBase * );
  208.  
  209.    FUNCTION
  210.         This function should perform the actual loading.
  211.         Please see the actual example code.
  212.  
  213.    INPUTS
  214.  
  215.    RESULT
  216.  
  217.    EXAMPLE
  218.  
  219.    NOTES
  220.  
  221.    BUGS
  222.         Entry incomplete
  223.  
  224.    SEE ALSO
  225.  
  226. iomodule/IOSave                                                  iomodule/IOSave
  227.  
  228.    NAME
  229.         IOSave - Saves the frame.
  230.  
  231.    SYNOPSIS
  232.         result = IOSave( fh, type, frame, tags, PPTBase )
  233.         D0               D0  D1    A0     A1    A3
  234.  
  235.         PERROR IOSave( BPTR, ULONG, FRAME *, struct TagItem *, struct PPTBase * );
  236.  
  237.    FUNCTION
  238.         This function should save the frame.
  239.  
  240.    INPUTS
  241.         type - Tells the type of the file.  If CSF_LUT, then
  242.             you should use GetBitmapRow() to read the data from the
  243.             frame, as it is in bitmapped format.
  244.  
  245.    RESULT
  246.  
  247.    EXAMPLE
  248.  
  249.    NOTES
  250.  
  251.    BUGS
  252.         Entry incomplete
  253.  
  254.    SEE ALSO
  255.  
  256.