Pendisplay.mui Class Reference¶

BOOPSI custom class Pendisplay.mui (MUI 3.8 dev). Each ### sub-section below documents one of the class's attributes or methods. Sub-classes of Pendisplay.mui are listed at the end under Sub-classes; the class hierarchy itself is documented in the MUI classes index.

Function index¶

Class definition

• Pendisplay.mui

Attributes

• MUIA_Pendisplay_Pen
• MUIA_Pendisplay_Reference
• MUIA_Pendisplay_RGBcolor
• MUIA_Pendisplay_Spec

Methods

• MUIM_Pendisplay_SetColormap
• MUIM_Pendisplay_SetMUIPen
• MUIM_Pendisplay_SetRGB

---

Pendisplay.mui¶

---

MUIA_Pendisplay_Pen¶

**MUIA_Pendisplay_Pen -- (V13) [..G], Object ***

Function

Between MUIM_Setup and MUIM_Cleanup, this attribute returns the pen number MUI uses for color representation of the current pendisplay object. This attribute returns -1 when outside of MUIM_Setup/MUIM_Cleanup or when the pendisplay object didnt allocate a color on its own (e.g. because MUIA_Pendisplay_Reference).

See also

MUIA_Pendisplay_Reference

---

MUIA_Pendisplay_Reference¶

**MUIA_Pendisplay_Reference -- (V13) [ISG], Object ***

Function

Display exactly this pen, dont allocate one on your own.

See also

MUIA_Pendisplay_Pen

---

MUIA_Pendisplay_RGBcolor¶

**MUIA_Pendisplay_RGBcolor -- (V11) [ISG], struct MUI_RGBcolor ***

Function

Private attribute, only for PSI.

---

MUIA_Pendisplay_Spec¶

**MUIA_Pendisplay_Spec -- (V11) [ISG], struct MUI_PenSpec ***

Function

The black box structure MUI_PenSpec specifies a drawing pen which should be displayed by Pendisplay class. If you use Poppen class to allow your users to configure custom drawing pens, its this attribute that you need to get() and save in your preferences. Use the functions MUI_ObtainPen() and MUI_ReleasePen() from muimaster.library and the MUIPEN() macro to get a usable value for SetAPen() from a struct MUI_PenSpec. NOTE: In allmost all cases you will use Poppen class which is a subclass of Pendisplay class.

See also

MUI_ObtainPen(), MUI_ReleasePen()

---

MUIM_Pendisplay_SetColormap¶

MUIM_Pendisplay_SetColormap (V13) — SYNOPSIS — DoMethod(obj,MUIM_Pendisplay_SetColormap,LONG colormap);

Function

Switch the pendisplay object to a specific colormap entry.

See also

MUIM_Pendisplay_SetMUIPen, MUIM_Pendisplay_SetRGB

---

MUIM_Pendisplay_SetMUIPen¶

MUIM_Pendisplay_SetMUIPen (V13) — SYNOPSIS — DoMethod(obj,MUIM_Pendisplay_SetMUIPen,LONG muipen);

Function

Switch the pendisplay object to a specific mui pen (MPEN_SHINE, MPEN_SHADOW, ...)

See also

MUIM_Pendisplay_SetColormap, MUIM_Pendisplay_SetRGB

---

MUIM_Pendisplay_SetRGB¶

MUIM_Pendisplay_SetRGB (V13) — SYNOPSIS — DoMethod(obj,MUIM_Pendisplay_SetRGB,ULONG red, ULONG green, ULONG blue);

Function

Switch the pendisplay object to an RGB value.

See also

MUIM_Pendisplay_SetMUIPen, MUIM_Pendisplay_SetColormap

---