wiki:Documentation/API/MUI_Pendisplay

Pendisplay.mui

Super class

Area.mui

Inherited by

Poppen.mui

Background

Pendisplay class takes a struct MUI_PenSpec and displays it. Its main use is to be sub-classed by Poppen class which adds a popup window to adjust the MUI_PenSpec. Poppen class should be used by every application that allows users to configure custom drawing pens.

Attributes

Attribute Version ISG Type
MUIA_Pendisplay_Pen V13..GULONG
MUIA_Pendisplay_Reference V13ISGObject *
MUIA_Pendisplay_RGBcolor V11ISGstruct MUI_RGBcolor *
MUIA_Pendisplay_Spec V11ISGstruct MUI_PenSpec *


Methods

Method Version
MUIM_Pendisplay_SetColormap V13
MUIM_Pendisplay_SetMUIPen V13
MUIM_Pendisplay_SetRGB V13


MUIA_Pendisplay_Pen

NAME

MUIA_Pendisplay_Pen — V13 [..G], ULONG, 0x8042a748

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 didn't allocate a color on its own, e.g. because of MUIA_Pendisplay_Reference.

SEE ALSO

MUIA_Pendisplay_Reference

MUIA_Pendisplay_Reference

NAME

MUIA_Pendisplay_Reference — V13 [ISG], Object *, 0x8042dc24

FUNCTION

Display exactly this pen, don't allocate one on your own.

SEE ALSO

MUIA_Pendisplay_Pen

MUIA_Pendisplay_RGBcolor

NAME

MUIA_Pendisplay_RGBcolor — V11 [ISG], struct MUI_RGBcolor *, 0x8042a1a9

FUNCTION

Private attribute, only for PSI.

MUIA_Pendisplay_Spec

NAME

MUIA_Pendisplay_Spec — V11 [ISG], struct MUI_PenSpec *, 0x8042a204

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.

NOTES

In allmost all cases you will use Poppen class which is a subclass of Pendisplay class.

SEE ALSO

muimaster.library/MUI_ObtainPen(), muimaster.library/MUI_ReleasePen()

MUIM_Pendisplay_SetColormap

NAME

MUIM_Pendisplay_SetColormap — V13, 0x80426c80

SYNOPSIS

DoMethod(obj, MUIM_Pendisplay_SetColormap, LONG colormap);

FUNCTION

Switch the pendisplay object to a specific colormap entry.

LONG colormap
colormap number

SEE ALSO

MUIM_Pendisplay_SetMUIPen, MUIM_Pendisplay_SetRGB

MUIM_Pendisplay_SetMUIPen

NAME

MUIM_Pendisplay_SetMUIPen — V13, 0x8042039d

SYNOPSIS

DoMethod(obj, MUIM_Pendisplay_SetMUIPen, LONG muipen);

FUNCTION

Switch the pendisplay object to a specific MUI pen (MPEN_SHINE, MPEN_SHADOW, …)

INPUTS

LONG muipen
MUI pen number

SEE ALSO

MUIM_Pendisplay_SetColormap, MUIM_Pendisplay_SetRGB

MUIM_Pendisplay_SetRGB

NAME

MUIM_Pendisplay_SetRGB — V13, 0x8042c131

SYNOPSIS

DoMethod(obj, MUIM_Pendisplay_SetRGB, ULONG red, ULONG green, ULONG blue);

FUNCTION

Switch the pendisplay object to an RGB value.

INPUTS

ULONG red
red color value
ULONG green
green color value
ULONG blue
blue color value

SEE ALSO

MUIM_Pendisplay_SetMUIPen, MUIM_Pendisplay_SetColormap


Copyright © 1992-2006 by Stefan Stuntz
Copyright © 2006-2017 by Thore Böckelmann, Jens Maus

MUI for AmigaOS - MUI-Autodocs

Updated: 13-Jul-2017

Last modified 5 months ago Last modified on Mar 27, 2017, 4:07:05 PM