home *** CD-ROM | disk | FTP | other *** search
/ Aminet 18 / aminetcdnumber181997.iso / Aminet / dev / e / EasyGUI_v33b2.lha / Docs / password.doc < prev    next >
Text File  |  1996-12-04  |  2KB  |  49 lines
  1. Password PLUGIN
  2. ---------------
  3. Makes a rudimentary password entry gadget.  Uses a standard GadTools string
  4. gadget so you need to specify TRUE for the optional `isgt' field of the
  5. PLUGIN gadget to use it (otherwise you get a black rectangle!).
  6.  
  7. Constructors:
  8.  
  9.     password(estr,label=NIL,over=FALSE,relx=0,disabled=FALSE)
  10.         estr     -> The initial password (must be an E-string)
  11.         label    -> The label for the gadget
  12.         over     -> Whether the string gadget is in overwrite mode
  13.         relx     -> Relative width (default is 5)
  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 password OF plugin
  23.       estr      -> Current password
  24.       disabled  -> Disabled or enabled
  25.     PRIVATE ...
  26.     ENDOBJECT
  27.  
  28. New methods:
  29.  
  30.     setpass(str)               -> Set the password to str (copied)
  31.     setdisabled(disabled=TRUE) -> Disable/enable the gadget
  32.  
  33. Action functions:
  34.  
  35.     Your action function will be called (or your action value returned by
  36.     easygui()) in the following circumstances:
  37.       o When the return or tab is pressed in the gadget
  38.  
  39.     Note: unlike normal STR gadgets, the estr is *always* up-to-date.
  40.  
  41. Exceptions:
  42.  
  43.     "pass" will be raised by the constructor if the gadtools.library can't
  44.            be opened.
  45.     "pass" will be raised by the render() method if the gadget can't be
  46.            created.
  47.     "MEM"  will be raised by the constructor or setpass() method if the
  48.            temporary string can't be created.
  49.