home *** CD-ROM | disk | FTP | other *** search
/ Aminet 18 / aminetcdnumber181997.iso / Aminet / dev / e / EasyGUI_v33b2.lha / Docs / calendar.doc < prev    next >
Text File  |  1996-12-04  |  2KB  |  52 lines
  1. Calendar PLUGIN
  2. ---------------
  3. Draws a calendar of a month and allows a day to be selected.  Uses the
  4. 'calendar.gadget' which needs to be in the normal place of libs:gadgets/
  5. (usually libs: is also assigned to sys:classes/, and .gadget files should
  6. be stored in the sys:classes/gadgets/ directory).
  7.  
  8. Constructors:
  9.  
  10.     calendar(date:PTR TO clockdata,resizex=FALSE,resizey=FALSE,
  11.              disabled=FALSE)
  12.         date     -> The initial date selected
  13.         resizex  -> Whether this gadget can resize in width
  14.         resizey  -> Whether this gadget can resize in height
  15.         disabled -> Whether this gadget is disabled
  16.  
  17. Destructor:
  18.  
  19.     END *must* be called for each NEWed object.
  20.  
  21. Data (should be considered read-only, except as mentioned below):
  22.  
  23.     OBJECT calendar OF plugin
  24.       date:PTR TO clockdata  -> Current date
  25.       disabled               -> Disabled or enabled
  26.     PRIVATE ...
  27.     ENDOBJECT
  28.  
  29. New methods:
  30.  
  31.     setdate(date=NIL:PTR TO clockdata) -> Set the current date
  32.     setdisabled(disabled=TRUE)         -> Disable/enable the gadget
  33.  
  34.     Note: if NIL if specified for setdate() then the current date will be
  35.           used (in which case it's OK to edit the data in self.date just
  36.           before calling setdate()).
  37.     Note: it's up to you to make sure the dates you supply are sensible.
  38.  
  39. Action functions:
  40.  
  41.     Your action function will be called (or your action value returned by
  42.     easygui()) in the following circumstances:
  43.       o When one of the day buttons is pressed
  44.         (the date will reflect the current state)
  45.  
  46. Exceptions:
  47.  
  48.     "cal" will be raised by the constructor if the .gadget file can't be
  49.           opened.
  50.     "cal" will be raised by the render() method if the gadget can't be
  51.           created.
  52.