home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / program / gempp15b / gema.man < prev    next >
Encoding:
Text File  |  1993-10-23  |  2.8 KB  |  86 lines
  1.                      GEM++ - C++ LIBRARIES FOR GEM/AES/VDI
  2.  
  3.  
  4.  
  5. NAME
  6.      GEMactivity - an interaction with the user through the GEM interface.
  7.  
  8. DESCRIPTION
  9.      An interaction is defined by a collection of objects - a menu, some
  10.      windows, a desk accessory, a keysink and timer, all of which are
  11.      optional.
  12.  
  13.      Objects add themselves to the activity when they are created
  14.      and deleted.  For example:
  15.  
  16.               GEMactivity myactivity;
  17.               GEMrsc myrsc;
  18.               GEMmenu mymenu(myactivity, myrsc, RSC_INDEX_OF_MENU);
  19.  
  20.      During the interaction, objects are passed relevent GEMevents,
  21.      and they return GEMfeedback.  The interaction continues until
  22.      one of the objects returns a GEMfeedback message indicating that
  23.      the interaction should end - for example, the GEMmenu might
  24.      return EndInteraction when the "Quit" item is selected.
  25.  
  26.      A GEMactivity may only have one menu, one desk accessory and one
  27.      keysink, so declare at most one of each of these object types
  28.      (this should change in the future).
  29.  
  30. CONSTRUCTORS
  31.      GEMactivity()
  32.        Create a GEMactivity containing no objects.
  33.  
  34. METHODS
  35.      void Do()
  36.        Conduct a user interaction until one of the event processing
  37.        objects signals for the interaction to end - see GEMfeedback.
  38.  
  39.      void BeginDo()
  40.      GEMfeedback OneDo()
  41.      void EndDo()
  42.        By using these three calls, the interaction can be done in
  43.        a polling manner - useful for adding GEM++ code as a front
  44.        end to a non-event-driven program - such as one that is centred
  45.        around a keyboard which is _read_ by the program rather than
  46.        the user interface driving the program.  The Do() method
  47.        above is equivalent to:
  48.  
  49.             BeginDo();
  50.             while (OneDo()!=EndInteraction) /* continue */;
  51.             EndDo();
  52.  
  53.      GEMactivity does contain other methods that are used by components
  54.      to register and deregister themselves.  They are not needed by the
  55.      library user.
  56.  
  57. USAGE
  58.      Declare a GEMapplication (always do this once before you use GEM).
  59.      Declare a GEMrsc (you'll usually need one!).
  60.      Declare a GEMactivity.
  61.      Declare component objects that are to be in the activity.
  62.      Do() the activity.
  63.      Exit your program. 
  64.  
  65. SEE ALSO
  66.      GEMmenu, GEMwindow, GEMformwindow, GEMdesktop, GEMdeskaccessory,
  67.      GEMkeysink, GEMtimer.
  68.  
  69. BUGS
  70.      Bugs in GEM++ should be reported to warwick@cs.uq.oz.au
  71.  
  72. AUTHOR
  73.      Warwick Allison, 1993.
  74.      warwick@cs.uq.oz.au
  75.  
  76. COPYING
  77.      This functionality is part of the GEM++ library,
  78.      and is Copyright 1993 by Warwick W. Allison.
  79.  
  80.      GEM++ is free and protected under the GNU Library General Public
  81.      License.
  82.  
  83.      You are free to copy and modify these sources, provided you
  84.      acknowledge the origin by retaining this notice, and adhere to
  85.      the conditions described in the GNU LGPL.
  86.