home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 13 / AACD13.ISO / AACD / Programming / MR_Classes / Dev / Source / supermodel / modelclass.doc < prev    next >
Encoding:
Text File  |  2000-08-04  |  2.9 KB  |  127 lines
  1. #include <boopsi/supermodel.h>
  2.  
  3. /****** supermodel.class/--datasheet-- ******************************************
  4. *
  5. *   NAME
  6. *       supermodel.class -- Model and IC class
  7. *
  8. *   SUPERCLASS
  9. *       modelclass
  10. *
  11. *   DESCRIPTION
  12. *       
  13. *
  14. *   METHODS
  15. *       
  16. *
  17. *   ATTRIBUTES
  18. *       SMA_AddMember - calls OM_ADDMEMBER
  19. *
  20. *       SMA_RemMember - calls OM_REMMEMBER
  21. *
  22. *       SMA_GlueFunc - Glue code, does tag mapping/conversion, etc.  
  23. *           See example.
  24. *           see --datasheet-GlueFunc--
  25. *
  26. *       SMA_GlueFuncA6 - If your glue code is in a library, set this to
  27. *           your Library base.
  28. *
  29. *       SMA_GlueFuncUserData - 
  30. *
  31. *       SMA_CacheStringTag - cache string data
  32. *
  33. *       icclass Tags supported also
  34. *
  35. *   NOTES
  36. *
  37. *   BUGS
  38. *
  39. *   SEE ALSO
  40. *
  41. ******************************************************************************
  42. *
  43. */
  44.  
  45. /****** supermodel.class/--datasheet-GlueFunc-- ******************************************
  46. *
  47. *   NAME
  48. *       GlueFunc
  49. *
  50. *   SYNOPSIS
  51. *       rv GlueFunc(GlueData, TagList, [userdata], [a6])
  52. *       d0          a0        a1       a2          a6
  53. *       
  54. *       ULONG GlueFunc(struct smGlueData *, struct TagItem *, APTR, APTR);
  55. *
  56. *   FUNCTION
  57. *       GlueFunc is a function you provide to modify a tag list before
  58. *       being sent to the members and ICA_TARGET of the modelclass.
  59. *
  60. *       You may modify TagList and use the SMTAG_functions to modify 
  61. *       TagList, however, don't free TagList.
  62. *       
  63. *       Call SM_SendGlueAttrsA() to send your new attributes back to the
  64. *       model class for notifiaction.
  65. *
  66. *   NOTES
  67. *       There is room for 50 tags in TagList
  68. *
  69. *   BUGS
  70. *
  71. *   SEE ALSO
  72. *
  73. ******************************************************************************
  74. *
  75. */
  76.  
  77. /****** supermodel.class/--datasheet-supericclass-- ******************************************
  78. *
  79. *   NAME
  80. *       supermodel.class -- IC class
  81. *
  82. *   SUPERCLASS
  83. *       icclass
  84. *
  85. *   DESCRIPTION
  86. *       
  87. *
  88. *   METHODS
  89. *       
  90. *
  91. *   ATTRIBUTES
  92. *       ICA_ attributes supported.
  93. *       ICA_TARGET - targeted object.
  94. *       ICA_MAP - MapList.
  95. *       SICA_Model - Model object pointer, set by model object.
  96. *
  97. *       SICA_InMap -  TagMap, maps tags sent from Model object to Target object.
  98. *       SICA_OutMap - TagMap, maps tags sent from Target object to Model.
  99. *           Both must be allocated with CloneTagItems(), and are given to the
  100. *           ic objects
  101. *
  102. *   NOTES
  103. *
  104. *   BUGS
  105. *
  106. *   SEE ALSO
  107. *
  108. ******************************************************************************
  109. *
  110. */
  111.  
  112. /****** supermodel.class/History ******************************************
  113. *
  114. *   To Do
  115. *
  116. *   44.1 -
  117. *       * GlueCode was freeing memory twice.
  118. *       * Added SMA_CacheStringTag - Anytime this tag is passed through
  119. *         the model class, the string supplied is cached, and ti_Data
  120. *         is updated to point to the cache.
  121. *   44.2 - 
  122. *       * Included version string
  123. *
  124. ******************************************************************************
  125. *
  126. */
  127.