home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 13 / AACD13.ISO / AACD / Programming / MR_Classes / Dev / Source / palette / palette.doc < prev    next >
Encoding:
Text File  |  2000-08-04  |  3.5 KB  |  131 lines
  1. /****** palette.requester/--datasheet-- ******************************************
  2. *
  3. *   NAME
  4. *       palette.requester -- Requester for editing a color palette
  5. *
  6. *   REQUIRES
  7. *       supermodel.class
  8. *       tcpalette.gadget
  9. *       Reaction gadgets
  10. *
  11. *   METHODS
  12. *       OM_NEW - 
  13. *       OM_DISPOSE
  14. *       OM_SET
  15. *       OM_GET
  16. *       RM_DOREQUEST - open requester
  17. *       RM_DOREQUESTASYNC - unimplemented
  18. *
  19. *   ATTRIBUTES
  20. *       PR_Screen - Screen to open requester on.
  21. *       (OM_NEW, OM_SET)
  22. *       
  23. *       PR_Window - Parent Window
  24. *       (OM_NEW, OM_SET)
  25. *
  26. *       PR_PubScreenName - Public Screen Name
  27. *       (OM_NEW, OM_SET)
  28. *
  29. *       PR_Colors - Number of colors to edit 1..256
  30. *       (OM_NEW, OM_SET)
  31. *
  32. *       PR_Palette - Palette to edit, must be at least 
  33. *         PR_Colors entries in the array of struct prRGB.
  34. *         When you get this attribute, you must supply a buffer
  35. *         with enough memory to hold and PR_Colors size array of 
  36. *         struct prRGB
  37. *       (OM_NEW, OM_SET, OM_GET)
  38. *
  39. *       PR_TextAttr - TextAttr of gadget Text.
  40. *       (OM_SET)
  41. *
  42. *       PR_TitleText - Text of window
  43. *       (OM_NEW, OM_SET)
  44. *
  45. *       PR_PositiveText - "Ok"
  46. *       (OM_NEW, OM_SET)
  47. *
  48. *       PR_NegativeText - "Cancel"
  49. *       (OM_NEW, OM_SET)
  50. *
  51. *       PR_InitialTopEdge,LeftEdge,Width,Height - Initial values for window. 
  52. *         not implemented.
  53. *       (OM_NEW, OM_SET)
  54. *
  55. *       PR_Red/Green/BlueBits - Bits per component. not implemented. 
  56. *
  57. *   RESULT
  58. *
  59. *   EXAMPLE
  60. *
  61. *   NOTES
  62. *       While this requester keeps 32bit per component (RGB), due to limitations
  63. *       of the slider gadget, edits only 8bits per component, only 256 levels.  
  64. *       Future versions may fix this.
  65. *
  66. *   BUGS
  67. *       Bad things will happen if you OM_GET PR_Palette with an array that 
  68. *       doesn't have atleast PR_Colors entries.
  69. *
  70. *       The Undo gadget won't disable on the first pen edited.
  71. *
  72. *   SEE ALSO
  73. *
  74. ******************************************************************************
  75. *
  76. */
  77.  
  78. /****** palette.requester/PREQ_NewRequester ******************************************
  79. *
  80. *   NAME
  81. *       PREQ_NewRequester -- Allocate a new Palette requester.
  82. *
  83. *   SYNOPSIS
  84. *       Object = PREQ_NewRequester(Tags,...)
  85. *
  86. *       Object *PREQ_NewRequester(Tag, ...);
  87. *       a0                        a0
  88. *
  89. *       Object *PREQ_NewRequesterA(struct TagItem *)
  90. *       a0                                a0
  91. *
  92. *   FUNCTION
  93. *       Allocates a new Palette requester object.
  94. *       The palette requester is a BOOPSI object.
  95. *       Further settings can be changed or read
  96. *       with SetAttrs() or GetAttr().
  97. *
  98. *
  99. *   SEE ALSO
  100. *       palette.requester/--datasheet--
  101. *
  102. ******************************************************************************
  103. *
  104. */
  105.  
  106. /****** palette.requester/PREQ_DisposeRequester ******************************************
  107. *
  108. *   NAME
  109. *       PREQ_DisposeRequester -- Dispose palette requester.
  110. *
  111. ******************************************************************************
  112. *
  113. */
  114.  
  115. /****** palette.requester/--history-- ******************************************
  116. *
  117. *   To Do -
  118. *       * Maybe cause requester to notify other object WHILE open?
  119. *       * Create pop-up gadget class (similar to GetScreenMode etc.)
  120. *
  121. *   44.1 - 
  122. *       * OM_GET wasn't handled in the dispatcher.
  123. *       * Getting PR_Palette now works - requester was kinda useless before.
  124. *       * Setting PR_Screen, Window, PubScreenName will center the requester
  125. *   44.2 - 
  126. *       *Included version string
  127. *
  128. ******************************************************************************
  129. *
  130. */
  131.