home *** CD-ROM | disk | FTP | other *** search
/ Aminet 18 / aminetcdnumber181997.iso / Aminet / dev / e / EasyGUI_v33b2.lha / Docs / animcontrol.doc next >
Text File  |  1996-12-04  |  2KB  |  62 lines
  1. AnimControl PLUGIN
  2. ------------------
  3. Consists of play, rewind, fast forward, stop and frame number gadgets.
  4. Uses the 'tapedeck.gadget' which needs to be in the normal place of
  5. libs:gadgets/ (usually libs: is also assigned to sys:classes/, and .gadget
  6. files should be stored in the sys:classes/gadgets/ directory).
  7.  
  8. Constructors:
  9.  
  10.     animcontrol(frame=0,frames=8,play=FALSE,disabled=FALSE)
  11.         frame    -> The first frame (=position of slider)
  12.         frames   -> The number of frames (=extent of slider)
  13.         play     -> Whether the play button is pressed initially
  14.         disabled -> Whether this gadget is disabled
  15.  
  16. Destructor:
  17.  
  18.     END *must* be called for each NEWed object.
  19.  
  20. Data (should be considered read-only):
  21.  
  22.     OBJECT animcontrol OF plugin
  23.       frame     -> Current frame number
  24.       mode      -> Current mode
  25.       disabled  -> Disabled or enabled
  26.     PRIVATE ...
  27.     ENDOBJECT
  28.  
  29.     The mode is taken from 'gadgets/tapedeck'.  It will be:
  30.       o BUT_PLAY if playing
  31.       o BUT_STOP if stopped
  32.       o BUT_FORWARD if fast forward is being held
  33.       o BUT_REWIND if rewind is being held
  34.  
  35. New methods:
  36.  
  37.     setframe(n)                -> Set the current frame number
  38.     setplay(play=TRUE)         -> Set play/stop mode
  39.     setdisabled(disabled=TRUE) -> Disable/enable the gadget
  40.  
  41. Action functions:
  42.  
  43.     Your action function will be called (or your action value returned
  44.     by easygui()) in the following circumstances:
  45.       o The rewind or fast forward button has been pressed
  46.         (mode will be BUT_FORWARD or BUT_REWIND)
  47.       o The rewind or fast forward button has been released
  48.         (mode will be BUT_STOP)
  49.       o The play button has been pressed (and released)
  50.         (mode will be BUT_PLAY)
  51.       o The stop button has been pressed (and released)
  52.         (mode will be BUT_STOP)
  53.       o The frame slider has been moved
  54.         (mode will be BUT_STOP, frame may have changed)
  55.  
  56. Exceptions:
  57.  
  58.     "anim" will be raised by the constructor if the .gadget file can't
  59.            be opened.
  60.     "anim" will be raised by the render() method if the gadget can't
  61.            be created.
  62.