home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 13 / amigaformatcd13.iso / mui / mui_developer / autodocs / mui_pendisplay.doc < prev    next >
Text File  |  1997-03-10  |  3KB  |  113 lines
  1. TABLE OF CONTENTS
  2.  
  3. Pendisplay.mui/Pendisplay.mui
  4. Pendisplay.mui/MUIA_Pendisplay_Pen
  5. Pendisplay.mui/MUIA_Pendisplay_Reference
  6. Pendisplay.mui/MUIA_Pendisplay_RGBcolor
  7. Pendisplay.mui/MUIA_Pendisplay_Spec
  8. Pendisplay.mui/MUIM_Pendisplay_SetColormap
  9. Pendisplay.mui/MUIM_Pendisplay_SetMUIPen
  10. Pendisplay.mui/MUIM_Pendisplay_SetRGB
  11. Pendisplay.mui/Pendisplay.mui
  12.  
  13.     Pendisplay class takes a struct MUI_PenSpec and displays it.
  14.     Its main use is to be sub-classed by Poppen class which adds
  15.     a popup window to adjust the MUI_PenSpec. Poppen class should
  16.     be used by every application that allows users to configure
  17.     custom drawing pens.
  18. Pendisplay.mui/MUIA_Pendisplay_Pen
  19.  
  20.     NAME
  21.     MUIA_Pendisplay_Pen -- (V13) [..G], Object *
  22.  
  23.     FUNCTION
  24.     Between MUIM_Setup and MUIM_Cleanup, this attribute returns the
  25.     pen number MUI uses for color representation of the current
  26.     pendisplay object.
  27.  
  28.     This attribute returns -1 when outside of MUIM_Setup/MUIM_Cleanup
  29.     or when the pendisplay object didnt allocate a color on its
  30.     own (e.g. because MUIA_Pendisplay_Reference).
  31.  
  32.     SEE ALSO
  33.     MUIA_Pendisplay_Reference
  34. Pendisplay.mui/MUIA_Pendisplay_Reference
  35.  
  36.     NAME
  37.     MUIA_Pendisplay_Reference -- (V13) [ISG], Object *
  38.  
  39.     FUNCTION
  40.     Display exactly this pen, dont allocate one on your own.
  41.  
  42.     SEE ALSO
  43.     MUIA_Pendisplay_Pen
  44. Pendisplay.mui/MUIA_Pendisplay_RGBcolor
  45.  
  46.     NAME
  47.     MUIA_Pendisplay_RGBcolor -- (V11) [ISG], struct MUI_RGBcolor *
  48.  
  49.     FUNCTION
  50.     Private attribute, only for PSI.
  51. Pendisplay.mui/MUIA_Pendisplay_Spec
  52.  
  53.     NAME
  54.     MUIA_Pendisplay_Spec -- (V11) [ISG], struct MUI_PenSpec  *
  55.  
  56.     FUNCTION
  57.     The black box structure MUI_PenSpec specifies a drawing
  58.     pen which should be displayed by Pendisplay class. If you
  59.     use Poppen class to allow your users to configure custom
  60.     drawing pens, its this attribute that you need to get()
  61.     and save in your preferences.
  62.  
  63.     Use the functions MUI_ObtainPen() and MUI_ReleasePen()
  64.     from muimaster.library and the MUIPEN() macro to get
  65.     a usable value for SetAPen() from a struct MUI_PenSpec.
  66.  
  67.     NOTE: In allmost all cases you will use Poppen class which
  68.     is a subclass of Pendisplay class. 
  69.  
  70.     SEE ALSO
  71.     muimaster.library/MUI_ObtainPen(),
  72.     muimaster.library/MUI_ReleasePen()
  73. Pendisplay.mui/MUIM_Pendisplay_SetColormap
  74.  
  75.     NAME
  76.     MUIM_Pendisplay_SetColormap (V13)
  77.  
  78.     SYNOPSIS
  79.     DoMethod(obj,MUIM_Pendisplay_SetColormap,LONG colormap);
  80.  
  81.     FUNCTION
  82.     Switch the pendisplay object to a specific colormap entry.
  83.  
  84.     SEE ALSO
  85.     MUIM_Pendisplay_SetMUIPen, MUIM_Pendisplay_SetRGB
  86. Pendisplay.mui/MUIM_Pendisplay_SetMUIPen
  87.  
  88.     NAME
  89.     MUIM_Pendisplay_SetMUIPen (V13)
  90.  
  91.     SYNOPSIS
  92.     DoMethod(obj,MUIM_Pendisplay_SetMUIPen,LONG muipen);
  93.  
  94.     FUNCTION
  95.     Switch the pendisplay object to a specific mui pen
  96.     (MPEN_SHINE, MPEN_SHADOW, ...)
  97.  
  98.     SEE ALSO
  99.     MUIM_Pendisplay_SetColormap, MUIM_Pendisplay_SetRGB
  100. Pendisplay.mui/MUIM_Pendisplay_SetRGB
  101.  
  102.     NAME
  103.     MUIM_Pendisplay_SetRGB (V13)
  104.  
  105.     SYNOPSIS
  106.     DoMethod(obj,MUIM_Pendisplay_SetRGB,ULONG red, ULONG green, ULONG blue);
  107.  
  108.     FUNCTION
  109.     Switch the pendisplay object to an RGB value.
  110.  
  111.     SEE ALSO
  112.     MUIM_Pendisplay_SetMUIPen, MUIM_Pendisplay_SetColormap
  113.