CONTENTS

  API examples (compiled binaries can be found in the "bin/" drawer)

COPYIGHT

  ©1999 Dietmar Eilert. All Rights Reserved.

  Dietmar Eilert
  Mies-v-d-Rohe-Str.31, 52074 Aachen, Germany
  Phone: +49-(0)179-5987061 German/English
  E-Mail: Dietmar.Eilert@post.rwth-aachen.de
  E-Mail: dietmar_eilert@yahoo.de (alternative address)
  WWW:    http://members.tripod.com/golded
  Mirror: http://members.xoom.com/golded

INTRODUCTION

  The interesting stuff can always be found in the "funcs.c" file of each  of
  the  projects  listed  below. The other files contain glue code required to
  compile "funcs.c" into a valid  shared  libary  and  should  be  of  little
  interest  to  you  (except  that tag.a and the makefile contain the plug-in
  name). I'd recommend to use DICE for compiling these projects (which  is  a
  freeware  compiler)  even  if  you  are normally using a different compiler
  especially if you are not familiar with developing libaries.

MIRROR

  This plug-in highlights the matching bracket if the cursor is placed over a
  bracket.  The  source  code  demonstrates  how plug-ins can detect keyboard
  events, read text in editor windows and set block markers.

STARTUP

  This plug-in starts a Rexx macro when the plug-in starts. The macro name is
  to  be  provided  by  the  user  as  startup  argument  for this API client
  (arguments for plug-ins can be set with a doubleclick on the  plug-in  name
  in  GoldED's  API  configuration  dialog). The source code demonstrates how
  startup arguments can be used by API clients and how  to  send  synchronous
  Rexx  commands (see REGISTER example for sending asynchronous Rexx commands
  to GoldED).

REXX

  This plug-in adds a few new commands to the  command  set  of  GoldED.  For
  example,  DISPLAYBEEP  will flash the display. The source code demonstrates
  how plug-ins can extend the command set of GoldED.

X

  This plug-in opens a container and renders  a  big  "X".  The  source  code
  demonstrates how to open a container and how to use clipping when rendering
  to it.

INFO

  This plug-in shows help texts related to the word under  the  cursor  in  a
  container. The help texts are read from a configurable dictionary file. The
  source code again demonstrates rendering in containers. The dictionary file
  to  be  used  by  the  plug-in  must  be  configured as startup option (see
  description of STARTUP project). You can use the file of the sas-c  add-on,
  "golded:add-ons/sas-c/quickinfo/os3.words".

TIMER (FOR ADVANCED PROGRAMMERS ONLY !)

  This plug-in shows text lines from  a  song  in  GoldED's  status  bar  and
  updates  the  display  every  second.  The  source code demonstrates how to
  display text in the status bar and how to handle message ports  in  clients
  (for example the message port of a timer device).

BUTTON

  This plug-in opens a container and displays a  single  button.  The  source
  code demonstrates how to use gadgets in plug-ins.

DATATYPE (BETA VERSION, SEE SOURCE CODE FOR KNOWN BUGS)

  This plug-in shows a file (text file, image, guide  file)  in  a  container
  using  the  datatypes  library.  The  name of the file must be specified as
  startup-option. The source code demonstrates how the datatypes library  can
  be used to embed complex objects into editor windows.

REGISTER

  This plug-in adds register buttons to editor windows, one  for  each  text.
  These  buttons  can  be  used to switch quickly between windows. The source
  code demonstrates how container plug-ins can respond to  mouse  clicks  and
  how  to send asynchronous Rexx messages to the editor. It also demonstrates
  the effect of container styles (this example uses a borderless container).