NAME
        label_ic -- image class for creating idenification labels

    SUPERCLASS
        imageclass

    REQUIRES
        None.

    DESCRIPTION
        Label is an image class suitable for creating identification labels,
        such as might appear next to or inside a gadget, or as some kind of
        title in a window.  A label consists of text and graphics mixed in
        a variety of ways.

    METHODS
        OM_NEW--Create the label image.  Passed to superclass, then OM_SET.

        OM_GET--Get object attributes.  Passed to superclass first.

        OM_SET--Set object attributes.  Passed to superclass first.

        OM_UPDATE--Set object notification attributes.  Passed to superclass
            first.

        IM_DRAW--Renders the images.  Overrides the superclass.

        All other methods are passed to the superclass, including OM_DISPOSE.

    ATTRIBUTES
        IA_Font (struct textattr *)
            Font to use for any label text.  Only affects text passed AFTER
            this tag is given.  If you did not use the LABEL_DrawInfo tag
            then you MUST use this tag to specify what font to use.

            Applicability is (OM_NEW)

        IA_FGPen (LONG)
            Foreground pen for any label text.  Only affects text passed AFTER
            this tag is given.

            Defaults to pen 1.

            Applicability is (OM_NEW)

        IA_BGPen (LONG)
            Background pen for any label text.  Only affects text passed AFTER
            this tag is given.

            Defaults to pen 0.

            Applicability is (OM_NEW)

        IA_Mode (UBYTE)
            draw mode for rendering text.  only affects text passed after
            this tag is given.

            Defaults to JAM1.

            Applicability is (OM_NEW)

        LABEL_DrawInfo (struct drawinfo *)
            Contains important pen information.  This is used to get default
            font information.  If you do not use IA_Font to specify fonts
            then you MUST pass the screen drawinfo before you give the
            LABEL_Text tag.

            Defaults to NULL.

            Applicability is (OM_NEW, OM_GET)

        LABEL_Text (STRPTR)
            A text string to render.  A 'n' in the string will cause the
            text position to move to a new line.  The first underscore ('_')
            in the string will be used to underline the proceeding character
            in the string.  Any number of text strings and images can be
            provided in a label, mixed at will.

            Applicability is (OM_NEW)

        LABEL_SoftStyle (UBYTE)
            SoftStyle for any label text.  Only affects text passed AFTER
            this tag is given.

            Defaults to FS_NORMAL.

            Applicability is (OM_NEW)


        LABEL_Image (struct image *)
            An image to render.  Any number of text strings and images can
            be provided in a label, mixed at will.

            Applicability is (OM_NEW)

        LABEL_DisposeImage (BOOL)
            Indicates that you want the NEXT image passed via LABEL_Image
            to be disposed automatically when the label instance is
            disposed.  This implies that the next image passed MUST be a
            BOOPSI image (since static images cannot be disposed).  This
            will only affect the next image passed, therefore you must
            specify this tag for every image you wish to have disposed of
            automatically.

            Defaults to FALSE.

            Applicability is (OM_NEW)

        LABEL_Mapping (UWORD *)
            Pen mapping array, affects the NEXT image passed via
            LABEL_Image ONLY.  You should pass a mapping for non-BOOPSI
            images only, it is expected that BOOPSI images would be
            correctly pen-mapped.

            The mapping array must have at least as many elements as the
            image has bit planes (i.e. 1 << Image.Depth).  For element
            i in the array you put in the new pen that you want pen i in
            your image to be mapped to.  For a typical 4-colour image, you
            might use the following mapping:

                uword mapping[4];
                struct drawinfo *drinfo;

                /* Before hand we'll have obtained the screen's drawinfo.
                 */
                mapping[0] = drinfo->dri_Pens[BACKGROUNDPEN];
                mapping[1] = drinfo->dri_Pens[SHADOWPEN];
                mapping[2] = drinfo->dri_Pens[SHINEPEN];
                mapping[3] = drinfo->dri_Pens[FILLPEN];

            Applicability is (OM_NEW)

        LABEL_Justification (UWORD)
            Justification for entire label.  This can be either LJ_LEFT
            (the default), LJ_CENTRE or LJ_RIGHT.

            Applicability is (OM_NEW, OM_GET)

        LABEL_Key (UWORD)
            For getting the key that was underscored in text passed with
            LABEL_Text.

            Applicability is (OM_GET)

    SEE ALSO
        intuition.library/getscreendrawinfo()