home *** CD-ROM | disk | FTP | other *** search
/ Amiga Times / AmigaTimes.iso / programme / GoldED / developer / api / README
Encoding:
Text File  |  1998-10-06  |  1.6 KB  |  37 lines

  1.                         API Release 2 Application Interface
  2.  
  3. COPYIGHT
  4.  
  5.   ©1996  Dietmar  Eilert  (e-mail:  DIETMAR@TOMATE.TNG.OCHE.DE).  All  Rights
  6.   Reserved. Neither icons, binaries nor code may be reused/reproduced without
  7.   written permission of the author.
  8.  
  9.   Dietmar Eilert
  10.   Mies-v-d-Rohe-Str.31, 52074 Aachen, Germany
  11.   E-Mail: DIETMAR@TOMATE.TNG.OCHE.DE
  12.   Tel: +49-(0)241-81665
  13.        +49-(0)2525-7776
  14.   Fax: +49-(0)241-81665
  15.  
  16. BASICS
  17.  
  18.   GoldED offers a fast interface to connect to external applications: the API
  19.   interface.  The  API  interface  may  be  used by third party developers to
  20.   connect  their  applications  with  API  aware  hosts  like  GoldED:  after
  21.   registration  clients  recieve  notify  messages from the host application.
  22.   Depending on these messages they can take approbiate  actions  (e.g.  close
  23.   their  windows  if  the host is about to close a screen, indicating this by
  24.   sending API_ACTION_HIDE messages to all registered clients). ARexx  usually
  25.   is  used to control applications. The API interface is used by applications
  26.   to control clients.
  27.  
  28. HOW TO RUN CLIENTS
  29.  
  30.   Clients are automatically launched by GoldED depending on  the  file  types
  31.   currently  used.  Clients  are  libraries.  They  provide  a  fixed  set of
  32.   functions called by the editor. Several example  API  clients  are  shipped
  33.   with  GoldED;  please have a look at the provided source code to understand
  34.   the basic meachanisms. Old message-based API clients released for GoldED  3
  35.   or earlier versions of GoldED are not supported by this release of GoldED -
  36.   you will have to install API Release 2 aware updates made for GoldED 4.
  37.