home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / Classes / AreaClass / areaclass.doc < prev    next >
Encoding:
Text File  |  1995-05-29  |  3.3 KB  |  103 lines
  1.  
  2.                File: areaclass.doc
  3.         Description: AreaClass documentation.
  4.           Copyright: (C) Copyright 1994-1995 Jaba Development.
  5.                      (C) Copyright 1994-1995 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8. ------------------------------------------------------------------------------
  9.  
  10. TABLE OF CONTENTS
  11.  
  12. areaclass/--background--
  13. areaclass/Methods
  14. areaclass/Attributes
  15.  
  16. areaclass/--background--                              areaclass/--background--
  17.  
  18.     NAME
  19.         Class:          areaclass
  20.         Superclass:     baseclass
  21.         Include File:   "AreaClass.h"
  22.  
  23.     FUNCTION
  24.         To  provide  you  with an  area in a BGUI window to do your own custom
  25.         rendering.  All  rendering  you do inside the area is done on your own
  26.         task so lengthy drawing operations are now problem whatsoever.
  27.  
  28.         Objects  from  this  class  send  out the following attribute pairs in
  29.         their notification messages:
  30.  
  31.         GA_ID                   - Gadget object ID.
  32.  
  33.     NOTE
  34.         This class is provided as source code.  To  make use of this class you
  35.         must compile it into an object module  and link it  in with  your main
  36.         program.
  37.  
  38.         Also your program must open the following libraries:
  39.  
  40.         intuition.library       - V37 or better.
  41.         utility.library         - V37 or better.
  42.         bgui.library            - V37 or better.
  43.  
  44.         Ofcourse these libraries must remain open until you are done using the
  45.         class.
  46.  
  47. areaclass/Methods                                            areaclass/Methods
  48.  
  49.     NEW METHODS
  50.         None.
  51.  
  52.     CHANGED METHODS
  53.         None.
  54.  
  55. areaclass/Attributes                                      areaclass/Attributes
  56.  
  57.     NOTE:
  58.         All baseclass attributes are also valid for this class.
  59.  
  60.     NAME
  61.         AREA_MinWidth, AREA_MinHeight -- ( ULONG )
  62.  
  63.     FUNCTION
  64.         Since the class has no idea of the smallest area you  require  you are
  65.         obligated to supply this information.  The values you pass here should
  66.         be  the  absolute  minimum  width  and height of the area you require.
  67.         These values are required to be larger than 0  or  the object creation
  68.         will fail.
  69.  
  70.         Default 0 (failure). Applicability is (I).
  71.  
  72.     NAME
  73.         AREA_AreaBox -- ( struct IBox * )
  74.  
  75.     FUNCTION
  76.         To  supply  you  with  the  current  bounds  of the area to render in.
  77.         When your event handler receives the ID of the  object you  must abort
  78.         the current rendering action in the area and get this attribute. After
  79.         you  done  this  you  may restart  rendering in the area using the new
  80.         bounds.
  81.  
  82.         Applicability is (G).
  83.  
  84.     NAME
  85.         ICA_TARGET -- ( Object * )
  86.  
  87.     FUNCTION
  88.         You  must  set  this  attribute to ICTARGET_IDCMP otherwise your event
  89.         handler will never get signalled when the area bounds change.
  90.  
  91.         Default is NULL. Applicability is (IS).
  92.  
  93.     NAME
  94.         GA_ID -- ( ULONG )
  95.  
  96.     FUNCTION
  97.         To set the ID of the area object. The ID you supply here is the ID you
  98.         receive  in  your  event  handler  when you must restart rendering the
  99.         area.  When  you receive the ID in your event handler it usually means
  100.         that the area size has changed or a refresh is required.
  101.  
  102.         Default is 0. Applicability is (IS).
  103.